get-import-job¶
Description¶
Provides information about an import job.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-import-job
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--job-id (string)
The ID of the import job.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
JobId -> (string)
A string that represents the import job ID.
ImportDestination -> (structure)
The destination of the import job.
SuppressionListDestination -> (structure)
An object that contains the action of the import job towards suppression list.
SuppressionListImportAction -> (string)
The type of action that you want to perform on the address. Acceptable 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 -> (structure)
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 that you want to perform on the addresses. Acceptable 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 -> (structure)
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 -> (structure)
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 -> (timestamp)
The time stamp of when the import job was created.
CompletedTimestamp -> (timestamp)
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.