| 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 |
campaign_id Required Input Column
The unique identifier for the campaign. | 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 |
activities_response
Provides information about the activities that were performed by a campaign. | STRUCT(
"item" STRUCT(
"application_id" VARCHAR,
"campaign_id" VARCHAR,
"end" VARCHAR,
"id" VARCHAR,
"result" VARCHAR,
"scheduled_start" VARCHAR,
"start" VARCHAR,
"state" VARCHAR,
"successful_endpoint_count" BIGINT,
"timezones_completed_count" BIGINT,
"timezones_total_count" BIGINT,
"total_endpoint_count" BIGINT,
"treatment_id" VARCHAR,
"execution_metrics" MAP(VARCHAR, VARCHAR)
)[],
"next_token" VARCHAR
) |
Show child fields- activities_response.item[]
Show child fields- activities_response.item[].application_id
The unique identifier for the application that the campaign applies to. - activities_response.item[].campaign_id
The unique identifier for the campaign that the activity applies to. - activities_response.item[].end
The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED. - activities_response.item[].execution_metrics
A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide. - activities_response.item[].id
The unique identifier for the activity. - activities_response.item[].result
Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL. - activities_response.item[].scheduled_start
The scheduled start time, in ISO 8601 format, for the activity. - activities_response.item[].start
The actual start time, in ISO 8601 format, of the activity. - activities_response.item[].state
The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED. - activities_response.item[].successful_endpoint_count
The total number of endpoints that the campaign successfully delivered messages to. - activities_response.item[].timezones_completed_count
The total number of time zones that were completed. - activities_response.item[].timezones_total_count
The total number of unique time zones that are in the segment for the campaign. - activities_response.item[].total_endpoint_count
The total number of endpoints that the campaign attempted to deliver messages to. - activities_response.item[].treatment_id
The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
- activities_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.
|