Skip to content

aws.pinpoint.get_export_job

Example SQL Queries

SELECT * FROM
aws.pinpoint.get_export_job
WHERE
"application_id" = 'VALUE'
AND "job_id" = 'VALUE';

Description

Retrieves information about the status and settings of a specific export job for an application.

Table Definition

Column NameColumn Data Type
application_id Required Input Column

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

VARCHAR
job_id Required Input Column

The unique identifier for the job.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
export_job_response

Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

STRUCT(
"application_id" VARCHAR,
"completed_pieces" BIGINT,
"completion_date" VARCHAR,
"creation_date" VARCHAR,
"definition" STRUCT(
"role_arn" VARCHAR,
"s3_url_prefix" VARCHAR,
"segment_id" VARCHAR,
"segment_version" BIGINT
),
"failed_pieces" BIGINT,
"failures" VARCHAR[],
"id" VARCHAR,
"job_status" VARCHAR,
"total_failures" BIGINT,
"total_pieces" BIGINT,
"total_processed" BIGINT,
"type" VARCHAR
)
Show child fields
export_job_response.application_id

The unique identifier for the application that's associated with the export job.

export_job_response.completed_pieces

The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

export_job_response.completion_date

The date, in ISO 8601 format, when the export job was completed.

export_job_response.creation_date

The date, in ISO 8601 format, when the export job was created.

export_job_response.definition

The resource settings that apply to the export job.

Show child fields
export_job_response.definition.role_arn

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

export_job_response.definition.s3_url_prefix

The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

export_job_response.definition.segment_id

The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

export_job_response.definition.segment_version

The version of the segment that the endpoint definitions were exported from.

export_job_response.failed_pieces

The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

export_job_response.failures[]
export_job_response.id

The unique identifier for the export job.

export_job_response.job_status

The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

export_job_response.total_failures

The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

export_job_response.total_pieces

The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

export_job_response.total_processed

The total number of endpoint definitions that were processed by the export job.

export_job_response.type

The job type. This value is EXPORT for export jobs.