MailManager / Paginator / ListAddressListImportJobs

ListAddressListImportJobs

class MailManager.Paginator.ListAddressListImportJobs

paginator = client.get_paginator('list_address_list_import_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MailManager.Client.list_address_list_import_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AddressListId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AddressListId (string) –

  [REQUIRED]

  The unique identifier of the address list for listing import jobs.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

Response Structure

• (dict) –

  • ImportJobs (list) –

    The list of import jobs.

    • (dict) –

      Details about an import job.

      • AddressListId (string) –

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

      • CompletedTimestamp (datetime) –

        The timestamp of when the import job was completed.

      • CreatedTimestamp (datetime) –

        The timestamp of when the import job was created.

      • Error (string) –

        The reason for failure of an import job.

      • FailedItemsCount (integer) –

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

      • ImportDataFormat (dict) –

        The format of the input for the import job.

        • ImportDataType (string) –

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

      • ImportedItemsCount (integer) –

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

      • JobId (string) –

        The identifier of the import job.

      • Name (string) –

        A user-friendly name for the import job.

      • PreSignedUrl (string) –

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

      • StartTimestamp (datetime) –

        The timestamp of when the import job was started.

      • Status (string) –

        The status of the import job.