import_jobs

Creates, updates, deletes, gets or lists an import_jobs resource.

Overview

Name	import_jobs
Type	Resource
Id	aws.sesv2.import_jobs

Fields

The following fields are returned by SELECT queries:

get_import_job

Name	Datatype	Description
completed_timestamp	string (date-time)	The time stamp of when the import job was completed.
created_timestamp	string (date-time)	The time stamp of when the import job was created.
failed_records_count	integer	The number of records that failed processing because of invalid input or other reasons.
failure_info	object	The failure details about an import job.
import_data_source	object	An object that contains details about the data source of the import job.
import_destination	object	An object that contains details about the resource destination the import job is going to target.
job_id	string	A string that represents a job ID.
job_status	string	The status of the import job. (CREATED, PROCESSING, COMPLETED, FAILED, CANCELLED)
processed_records_count	integer	The current number of records processed.

list_import_jobs

Name	Datatype	Description
import_jobs	array	A list of the import job summaries.
next_token	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_import_job	select	job_id, region		Provides information about an import job.
list_import_jobs	select	region		Lists all of the import jobs.
create_import_job	insert	region, ImportDestination, ImportDataSource		Creates an import job for a data destination.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
job_id	string	The ID of the import job.
region	string	AWS region (default: us-east-1)

SELECT examples

get_import_job

Provides information about an import job.

SELECT
completed_timestamp,
created_timestamp,
failed_records_count,
failure_info,
import_data_source,
import_destination,
job_id,
job_status,
processed_records_count
FROM aws.sesv2.import_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_import_jobs

Lists all of the import jobs.

SELECT
import_jobs,
next_token
FROM aws.sesv2.import_jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_import_job

Creates an import job for a data destination.

INSERT INTO aws.sesv2.import_jobs (
ImportDestination,
ImportDataSource,
region
)
SELECT 
'{{ ImportDestination }}' /* required */,
'{{ ImportDataSource }}' /* required */,
'{{ region }}'
RETURNING
job_id
;

Manifest

# Description fields are for documentation purposes
- name: import_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the import_jobs resource.
  - name: ImportDestination
    description: |
      An object that contains details about the resource destination the import job is going to target.
    value:
      SuppressionListDestination:
        SuppressionListImportAction: "{{ SuppressionListImportAction }}"
      ContactListDestination:
        ContactListName: "{{ ContactListName }}"
        ContactListImportAction: "{{ ContactListImportAction }}"
  - name: ImportDataSource
    description: |
      An object that contains details about the data source of the import job.
    value:
      S3Url: "{{ S3Url }}"
      DataFormat: "{{ DataFormat }}"