MailManager / Client / get_address_list_import_job

get_address_list_import_job

MailManager.Client.get_address_list_import_job(**kwargs)

Fetch attributes of an import job.

See also: AWS API Documentation

Request Syntax

response = client.get_address_list_import_job(
    JobId='string'
)

Parameters:

JobId (string) –

[REQUIRED]

The identifier of the import job that needs to be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string',
    'Name': 'string',
    'Status': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED'|'STOPPED',
    'PreSignedUrl': 'string',
    'ImportedItemsCount': 123,
    'FailedItemsCount': 123,
    'ImportDataFormat': {
        'ImportDataType': 'CSV'|'JSON'
    },
    'AddressListId': 'string',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'StartTimestamp': datetime(2015, 1, 1),
    'CompletedTimestamp': datetime(2015, 1, 1),
    'Error': 'string'
}

Response Structure

• (dict) –

  • JobId (string) –

    The identifier of the import job.

  • Name (string) –

    A user-friendly name for the import job.

  • Status (string) –

    The status of the import job.

  • PreSignedUrl (string) –

    The pre-signed URL target for uploading the input file.

  • ImportedItemsCount (integer) –

    The number of input addresses successfully imported into the address list.

  • FailedItemsCount (integer) –

    The number of input addresses that failed to be imported into the address list.

  • ImportDataFormat (dict) –

    The format of the input for an import job.

    • ImportDataType (string) –

      The type of file that would be passed as an input for the address list import job.

  • AddressListId (string) –

    The unique identifier of the address list the import job was created for.

  • CreatedTimestamp (datetime) –

    The timestamp of when the import job was created.

  • StartTimestamp (datetime) –

    The timestamp of when the import job was started.

  • CompletedTimestamp (datetime) –

    The timestamp of when the import job was completed.

  • Error (string) –

    The reason for failure of an import job.

Exceptions

• MailManager.Client.exceptions.ValidationException

• MailManager.Client.exceptions.AccessDeniedException

• MailManager.Client.exceptions.ResourceNotFoundException

• MailManager.Client.exceptions.ThrottlingException