[ aws . sesv2 ]

create-import-job

Description

Creates an import job for a data destination.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-import-job
--import-destination <value>
--import-data-source <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--import-destination (structure)

The destination for 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.

Shorthand Syntax:

SuppressionListDestination={SuppressionListImportAction=string},ContactListDestination={ContactListName=string,ContactListImportAction=string}

JSON Syntax:

{
  "SuppressionListDestination": {
    "SuppressionListImportAction": "DELETE"|"PUT"
  },
  "ContactListDestination": {
    "ContactListName": "string",
    "ContactListImportAction": "DELETE"|"PUT"
  }
}

--import-data-source (structure)

The data source for 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.

Shorthand Syntax:

S3Url=string,DataFormat=string

JSON Syntax:

{
  "S3Url": "string",
  "DataFormat": "CSV"|"JSON"
}

--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.