| Column Name | Column 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 |
segment_id Required Input Column
The unique identifier for the segment. | VARCHAR |
page_size Input Column
The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics. | VARCHAR |
token Input Column
The NextToken string that specifies which page of results to return in a paginated response. | 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 |
import_jobs_response
Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files. | STRUCT(
"item" STRUCT(
"application_id" VARCHAR,
"completed_pieces" BIGINT,
"completion_date" VARCHAR,
"creation_date" VARCHAR,
"definition" STRUCT(
"define_segment" BOOLEAN,
"external_id" VARCHAR,
"format" VARCHAR,
"register_endpoints" BOOLEAN,
"role_arn" VARCHAR,
"s3_url" VARCHAR,
"segment_id" VARCHAR,
"segment_name" VARCHAR
),
"failed_pieces" BIGINT,
"failures" VARCHAR[],
"id" VARCHAR,
"job_status" VARCHAR,
"total_failures" BIGINT,
"total_pieces" BIGINT,
"total_processed" BIGINT,
"type" VARCHAR
)[],
"next_token" VARCHAR
) |
Show child fields- import_jobs_response.item[]
Show child fields- import_jobs_response.item[].application_id
The unique identifier for the application that's associated with the import job. - import_jobs_response.item[].completed_pieces
The number of pieces that were processed successfully (completed) by the import job, as of the time of the request. - import_jobs_response.item[].completion_date
The date, in ISO 8601 format, when the import job was completed. - import_jobs_response.item[].creation_date
The date, in ISO 8601 format, when the import job was created. - import_jobs_response.item[].definition
The resource settings that apply to the import job. Show child fields- import_jobs_response.item[].definition.define_segment
Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported. - import_jobs_response.item[].definition.external_id
(Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint. - import_jobs_response.item[].definition.format
The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format. - import_jobs_response.item[].definition.register_endpoints
Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported. - import_jobs_response.item[].definition.role_arn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from. - import_jobs_response.item[].definition.s3_url
The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains. The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects. - import_jobs_response.item[].definition.segment_id
The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment. - import_jobs_response.item[].definition.segment_name
The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
- import_jobs_response.item[].failed_pieces
The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request. - import_jobs_response.item[].failures[]
- import_jobs_response.item[].id
The unique identifier for the import job. - import_jobs_response.item[].job_status
The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job. - import_jobs_response.item[].total_failures
The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred. - import_jobs_response.item[].total_pieces
The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job. - import_jobs_response.item[].total_processed
The total number of endpoint definitions that were processed by the import job. - import_jobs_response.item[].type
The job type. This value is IMPORT for import jobs.
- import_jobs_response.next_token
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
|