MailManager / Client / list_address_list_import_jobs

list_address_list_import_jobs¶

MailManager.Client.list_address_list_import_jobs(**kwargs)¶

Lists jobs for an address list.

Request Syntax

response = client.list_address_list_import_jobs(
    AddressListId='string',
    NextToken='string',
    PageSize=123
)

Parameters:

AddressListId (string) –
[REQUIRED]

The unique identifier of the address list for listing import jobs.
NextToken (string) – If you received a pagination token from a previous call to this API, you can provide it here to continue paginating through the next page of results.
PageSize (integer) – The maximum number of import jobs that are returned per call. You can use NextToken to retrieve the next page of jobs.

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'
        },
    ],
    'NextToken': 'string'
}

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.
- NextToken (string) –
  
  If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Exceptions

MailManager.Client.exceptions.ValidationException
MailManager.Client.exceptions.AccessDeniedException
MailManager.Client.exceptions.ResourceNotFoundException
MailManager.Client.exceptions.ThrottlingException