Skip to content

ExportJobResource

Source code in docs_src/capo_pinpoint/types/export_job_resource.py
class ExportJobResource(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 authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported 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 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://<replaceable>bucket-name</replaceable>/<replaceable>folder-name</replaceable>/.</p>"""
    segment_id: NotRequired["capo_pinpoint.types.__string.__string"]
    """<p>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.</p>"""
    segment_version: NotRequired["capo_pinpoint.types.__integer.__integer"]
    """<p>The version of the segment that the endpoint definitions were exported from.</p>"""

role_arn instance-attribute

role_arn: NotRequired[__string]

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.

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 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/.

segment_id instance-attribute

segment_id: NotRequired[__string]

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.

segment_version instance-attribute

segment_version: NotRequired[__integer]

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