Skip to content

GetSegmentSnapshotResponse

Source code in docs_src/capo_customer_profiles/types/get_segment_snapshot_response.py
class GetSegmentSnapshotResponse(TypedDict, closed=True):
    snapshot_id: "capo_customer_profiles.types.uuid.uuid"
    """<p>The unique identifier of the segment snapshot.</p>"""
    status: "capo_customer_profiles.types.segment_snapshot_status.SegmentSnapshotStatus"
    """<p>The status of the asynchronous job for exporting the segment snapshot.</p>"""
    status_message: NotRequired[
        "capo_customer_profiles.types.string1_to1000.string1To1000"
    ]
    """<p>The status message of the asynchronous job for exporting the segment snapshot.</p>"""
    data_format: "capo_customer_profiles.types.data_format.DataFormat"
    """<p>The format in which the segment will be exported.</p>"""
    encryption_key: NotRequired[
        "capo_customer_profiles.types.encryption_key.encryptionKey"
    ]
    """<p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.</p>"""
    role_arn: NotRequired["capo_customer_profiles.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.</p>"""
    destination_uri: NotRequired[
        "capo_customer_profiles.types.string1_to255.string1To255"
    ]
    """<p>The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Connect Customer Admin Website.</p>"""

data_format instance-attribute

data_format: DataFormat

The format in which the segment will be exported.

destination_uri instance-attribute

destination_uri: NotRequired[string1To255]

The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Connect Customer Admin Website.

encryption_key instance-attribute

encryption_key: NotRequired[encryptionKey]

The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting KMS and S3 operations.

snapshot_id instance-attribute

snapshot_id: uuid

The unique identifier of the segment snapshot.

status instance-attribute

The status of the asynchronous job for exporting the segment snapshot.

status_message instance-attribute

status_message: NotRequired[string1To1000]

The status message of the asynchronous job for exporting the segment snapshot.