SESV2 / Client / list_import_jobs

list_import_jobs#

SESV2.Client.list_import_jobs(**kwargs)#

Lists all of the import jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_import_jobs(
    ImportDestinationType='SUPPRESSION_LIST'|'CONTACT_LIST',
    NextToken='string',
    PageSize=123
)
Parameters:

  • ImportDestinationType (string) – The destination of the import job, which can be used to list import jobs that have a certain ImportDestinationType.

  • NextToken (string) – A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs.

  • PageSize (integer) – Maximum number of import jobs to return at once. Use this parameter to paginate results. If additional import jobs exist beyond the specified limit, the NextToken element is sent in the response. Use the NextToken value in subsequent requests to retrieve additional addresses.

Return type:

dict

Returns:

Response Syntax

{
    'ImportJobs': [
        {
            'JobId': 'string',
            'ImportDestination': {
                'SuppressionListDestination': {
                    'SuppressionListImportAction': 'DELETE'|'PUT'
                },
                'ContactListDestination': {
                    'ContactListName': 'string',
                    'ContactListImportAction': 'DELETE'|'PUT'
                }
            },
            'JobStatus': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'ProcessedRecordsCount': 123,
            'FailedRecordsCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    An HTTP 200 response if the request succeeds, or an error message if the request fails.

    • ImportJobs (list) –

      A list of the import job summaries.

      • (dict) –

        A summary of the import job.

        • JobId (string) –

          A string that represents a job ID.

        • ImportDestination (dict) –

          An object that contains details about the resource destination the import job is going to target.

          • SuppressionListDestination (dict) –

            An object that contains the action of the import job towards suppression list.

            • SuppressionListImportAction (string) –

              The type of action to perform on the address. The following are possible values:

              • PUT: add the addresses to the suppression list. If the record already exists, it will override it with the new value.

              • DELETE: remove the addresses from the suppression list.

          • ContactListDestination (dict) –

            An object that contains the action of the import job towards a contact list.

            • ContactListName (string) –

              The name of the contact list.

            • ContactListImportAction (string) –

              >The type of action to perform on the addresses. The following are the possible values:

              • PUT: add the addresses to the contact list. If the record already exists, it will override it with the new value.

              • DELETE: remove the addresses from the contact list.

        • JobStatus (string) –

          The status of a job.

          • CREATED – Job has just been created.

          • PROCESSING – Job is processing.

          • ERROR – An error occurred during processing.

          • COMPLETED – Job has completed processing successfully.

        • CreatedTimestamp (datetime) –

          The date and time when the import job was created.

        • ProcessedRecordsCount (integer) –

          The current number of records processed.

        • FailedRecordsCount (integer) –

          The number of records that failed processing because of invalid input or other reasons.

    • NextToken (string) –

      A string token indicating that there might be additional import jobs available to be listed. Copy this token to a subsequent call to ListImportJobs with the same parameters to retrieve the next page of import jobs.

Exceptions