segment_export_jobs

Creates, updates, deletes, gets or lists a segment_export_jobs resource.

Overview

Name	segment_export_jobs
Type	Resource
Id	aws.pinpoint.segment_export_jobs

Fields

The following fields are returned by SELECT queries:

get_segment_export_jobs

Name	Datatype	Description
item	array	An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
next_token	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_segment_export_jobs	select	application-id, segment-id, region	page-size, token	Retrieves information about the status and settings of the export jobs for a segment.

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
application-id	string	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
region	string	AWS region (default: us-east-1)
segment-id	string	The unique identifier for the segment.
page-size	string	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.
token	string	The NextToken string that specifies which page of results to return in a paginated response.

SELECT examples

get_segment_export_jobs

Retrieves information about the status and settings of the export jobs for a segment.

SELECT
item,
next_token
FROM aws.pinpoint.segment_export_jobs
WHERE `application-id` = '{{ application-id }}' -- required
AND `segment-id` = '{{ segment-id }}' -- required
AND region = '{{ region }}' -- required
AND `page-size` = '{{ page-size }}'
AND token = '{{ token }}'
;