address_list_import_jobs

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

Overview

Name	address_list_import_jobs
Type	Resource
Id	aws.mailmanager.address_list_import_jobs

Fields

The following fields are returned by SELECT queries:

get_address_list_import_job

Name	Datatype	Description
address_list_id	string	The unique identifier of the address list the import job was created for. (pattern: <code>[a-zA-Z0-9-]+</code>)
completed_timestamp	string (date-time)	The timestamp of when the import job was completed.
created_timestamp	string (date-time)	The timestamp of when the import job was created.
error	string	The reason for failure of an import job.
failed_items_count	integer	The number of input addresses that failed to be imported into the address list.
import_data_format	object	The format of the input for an import job.
imported_items_count	integer	The number of input addresses successfully imported into the address list.
job_id	string	The identifier of the import job. (pattern: <code>[a-zA-Z0-9-]+</code>)
name	string	A user-friendly name for the import job. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
pre_signed_url	string	The pre-signed URL target for uploading the input file.
start_timestamp	string (date-time)	The timestamp of when the import job was started.
status	string	The status of the import job. (CREATED, PROCESSING, COMPLETED, FAILED, STOPPED)

list_address_list_import_jobs

Name	Datatype	Description
address_list_id	string	The unique identifier of the address list the import job was created for. (pattern: <code>[a-zA-Z0-9-]+</code>)
completed_timestamp	string (date-time)	The timestamp of when the import job was completed.
created_timestamp	string (date-time)	The timestamp of when the import job was created.
error	string	The reason for failure of an import job.
failed_items_count	integer	The number of addresses in the input that failed to get imported into address list.
import_data_format	object	The format of the input for the import job.
imported_items_count	integer	The number of addresses in the input that were successfully imported into the address list.
job_id	string	The identifier of the import job. (pattern: <code>[a-zA-Z0-9-]+</code>)
name	string	A user-friendly name for the import job. (pattern: <code>[a-zA-Z0-9_.-]+</code>)
pre_signed_url	string	The pre-signed URL target for uploading the input file.
start_timestamp	string (date-time)	The timestamp of when the import job was started.
status	string	The status of the import job. (CREATED, PROCESSING, COMPLETED, FAILED, STOPPED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_address_list_import_job	select	region		Fetch attributes of an import job.
list_address_list_import_jobs	select	region		Lists jobs for an address list.
create_address_list_import_job	insert	region, AddressListId, ImportDataFormat		Creates an import job for an address list.

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
region	string	AWS region (default: us-east-1)

SELECT examples

get_address_list_import_job

Fetch attributes of an import job.

SELECT
address_list_id,
completed_timestamp,
created_timestamp,
error,
failed_items_count,
import_data_format,
imported_items_count,
job_id,
name,
pre_signed_url,
start_timestamp,
status
FROM aws.mailmanager.address_list_import_jobs
WHERE region = '{{ region }}' -- required
;

list_address_list_import_jobs

Lists jobs for an address list.

SELECT
address_list_id,
completed_timestamp,
created_timestamp,
error,
failed_items_count,
import_data_format,
imported_items_count,
job_id,
name,
pre_signed_url,
start_timestamp,
status
FROM aws.mailmanager.address_list_import_jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_address_list_import_job

Creates an import job for an address list.

INSERT INTO aws.mailmanager.address_list_import_jobs (
ClientToken,
AddressListId,
Name,
ImportDataFormat,
region
)
SELECT 
'{{ ClientToken }}',
'{{ AddressListId }}' /* required */,
'{{ Name }}',
'{{ ImportDataFormat }}' /* required */,
'{{ region }}'
RETURNING
job_id,
pre_signed_url
;

Manifest

# Description fields are for documentation purposes
- name: address_list_import_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the address_list_import_jobs resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique token that Amazon SES uses to recognize subsequent retries of the same request.
  - name: AddressListId
    value: "{{ AddressListId }}"
    description: |
      The unique identifier of the address list for importing addresses to.
  - name: Name
    value: "{{ Name }}"
    description: |
      A user-friendly name for the import job.
  - name: ImportDataFormat
    description: |
      The format of the input for an import job.
    value:
      ImportDataType: "{{ ImportDataType }}"