export_jobs

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

Overview

Name	export_jobs
Type	Resource
Id	aws.sesv2.export_jobs

Fields

The following fields are returned by SELECT queries:

get_export_job

Name	Datatype	Description
completed_timestamp	string (date-time)	The timestamp of when the export job was completed.
created_timestamp	string (date-time)	The timestamp of when the export job was created.
export_data_source	object	An object that contains details about the data source of the export job. It can only contain one of MetricsDataSource or MessageInsightsDataSource object.
export_destination	object	An object that contains details about the destination of the export job.
export_source_type	string	The type of source of the export job. (METRICS_DATA, MESSAGE_INSIGHTS)
failure_info	object	The failure details about an export job.
job_id	string	A string that represents a job ID.
job_status	string	The status of the export job. (CREATED, PROCESSING, COMPLETED, FAILED, CANCELLED)
statistics	object	The statistics about the export job.

list_export_jobs

Name	Datatype	Description
export_jobs	array	A list of the export job summaries.
next_token	string	A string token indicating that there might be additional export jobs available to be listed. Use this token to a subsequent call to ListExportJobs with the same parameters to retrieve the next page of export jobs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_export_job	select	job_id, region		Provides information about an export job.
list_export_jobs	select	region		Lists all of the export jobs.
create_export_job	insert	region, ExportDataSource, ExportDestination		Creates an export job for a data source and destination. You can execute this operation no more than once per second.

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

SELECT examples

get_export_job

Provides information about an export job.

SELECT
completed_timestamp,
created_timestamp,
export_data_source,
export_destination,
export_source_type,
failure_info,
job_id,
job_status,
statistics
FROM aws.sesv2.export_jobs
WHERE job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_export_jobs

Lists all of the export jobs.

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

INSERT examples

create_export_job

Creates an export job for a data source and destination. You can execute this operation no more than once per second.

INSERT INTO aws.sesv2.export_jobs (
ExportDataSource,
ExportDestination,
region
)
SELECT 
'{{ ExportDataSource }}' /* required */,
'{{ ExportDestination }}' /* required */,
'{{ region }}'
RETURNING
job_id
;

Manifest

# Description fields are for documentation purposes
- name: export_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the export_jobs resource.
  - name: ExportDataSource
    description: |
      An object that contains details about the data source of the export job. It can only contain one of MetricsDataSource or MessageInsightsDataSource object.
    value:
      MetricsDataSource:
        Dimensions: "{{ Dimensions }}"
        Namespace: "{{ Namespace }}"
        Metrics:
          - Name: "{{ Name }}"
            Aggregation: "{{ Aggregation }}"
        StartDate: "{{ StartDate }}"
        EndDate: "{{ EndDate }}"
      MessageInsightsDataSource:
        StartDate: "{{ StartDate }}"
        EndDate: "{{ EndDate }}"
        Include:
          FromEmailAddress:
            - "{{ FromEmailAddress }}"
          Destination:
            - "{{ Destination }}"
          Subject:
            - "{{ Subject }}"
          Isp:
            - "{{ Isp }}"
          LastDeliveryEvent:
            - "{{ LastDeliveryEvent }}"
          LastEngagementEvent:
            - "{{ LastEngagementEvent }}"
        Exclude:
          FromEmailAddress:
            - "{{ FromEmailAddress }}"
          Destination:
            - "{{ Destination }}"
          Subject:
            - "{{ Subject }}"
          Isp:
            - "{{ Isp }}"
          LastDeliveryEvent:
            - "{{ LastDeliveryEvent }}"
          LastEngagementEvent:
            - "{{ LastEngagementEvent }}"
        MaxResults: {{ MaxResults }}
  - name: ExportDestination
    description: |
      An object that contains details about the destination of the export job.
    value:
      DataFormat: "{{ DataFormat }}"
      S3Url: "{{ S3Url }}"