get_import_job

get_import_job(**kwargs)

Provides information about an import job.

See also: AWS API Documentation

Request Syntax

response = client.get_import_job(
    JobId='string'
)
Parameters
JobId (string) --

[REQUIRED]

The ID of the import job.

Return type
dict
Returns
Response Syntax
{
    'JobId': 'string',
    'ImportDestination': {
        'SuppressionListDestination': {
            'SuppressionListImportAction': 'DELETE'|'PUT'
        },
        'ContactListDestination': {
            'ContactListName': 'string',
            'ContactListImportAction': 'DELETE'|'PUT'
        }
    },
    'ImportDataSource': {
        'S3Url': 'string',
        'DataFormat': 'CSV'|'JSON'
    },
    'FailureInfo': {
        'FailedRecordsS3Url': 'string',
        'ErrorMessage': 'string'
    },
    'JobStatus': 'CREATED'|'PROCESSING'|'COMPLETED'|'FAILED',
    'CreatedTimestamp': datetime(2015, 1, 1),
    'CompletedTimestamp': datetime(2015, 1, 1),
    'ProcessedRecordsCount': 123,
    'FailedRecordsCount': 123
}

Response Structure

  • (dict) --

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

    • JobId (string) --

      A string that represents the import job ID.

    • ImportDestination (dict) --

      The destination of the import job.

      • 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.
    • ImportDataSource (dict) --

      The data source of the import job.

      • S3Url (string) --

        An Amazon S3 URL in the format s3://<bucket_name> /<object> .

      • DataFormat (string) --

        The data format of the import job's data source.

    • FailureInfo (dict) --

      The failure details about an import job.

      • FailedRecordsS3Url (string) --

        An Amazon S3 presigned URL that contains all the failed records and related information.

      • ErrorMessage (string) --

        A message about why the import job failed.

    • JobStatus (string) --

      The status of the import job.

    • CreatedTimestamp (datetime) --

      The time stamp of when the import job was created.

    • CompletedTimestamp (datetime) --

      The time stamp of when the import job was completed.

    • ProcessedRecordsCount (integer) --

      The current number of records processed.

    • FailedRecordsCount (integer) --

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

Exceptions

  • SESV2.Client.exceptions.BadRequestException
  • SESV2.Client.exceptions.NotFoundException
  • SESV2.Client.exceptions.TooManyRequestsException