Skip to content

CreateSegmentSnapshotRequest

Source code in docs_src/capo_customer_profiles/types/create_segment_snapshot_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class CreateSegmentSnapshotRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    segment_definition_name: "capo_customer_profiles.types.name.name"
    """<p>The name of the segment definition used in this snapshot request.</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.

domain_name instance-attribute 

domain_name: name

The unique name of the domain.

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.

segment_definition_name instance-attribute 

segment_definition_name: name

The name of the segment definition used in this snapshot request.