Skip to content

ExportJobRequest

Used by
Source code in docs_src/capo_pinpoint/types/export_job_request.py 
12
13
14
15
16
17
18
19
20
class ExportJobRequest(TypedDict, closed=True):
    role_arn: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.</p>"""
    s3_url_prefix: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://<replaceable>bucket-name</replaceable>/<replaceable>folder-name</replaceable>/.</p>"""
    segment_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.</p>"""
    segment_version: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The version of the segment to export endpoint definitions from, if specified.</p>"""

role_arn instance-attribute 

role_arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

s3_url_prefix instance-attribute 

s3_url_prefix: NotRequired[__string]

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

segment_id instance-attribute 

segment_id: NotRequired[__string]

The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

segment_version instance-attribute 

segment_version: NotRequired[__integer]

The version of the segment to export endpoint definitions from, if specified.