CustomerProfiles / Client / create_segment_snapshot
create_segment_snapshot#
- CustomerProfiles.Client.create_segment_snapshot(**kwargs)#
Triggers a job to export a segment to a specified destination.
See also: AWS API Documentation
Request Syntax
response = client.create_segment_snapshot( DomainName='string', SegmentDefinitionName='string', DataFormat='CSV'|'JSONL'|'ORC', EncryptionKey='string', RoleArn='string', DestinationUri='string' )
- Parameters:
DomainName (string) –
[REQUIRED]
The unique name of the domain.
SegmentDefinitionName (string) –
[REQUIRED]
The name of the segment definition used in this snapshot request.
DataFormat (string) –
[REQUIRED]
The format in which the segment will be exported.
EncryptionKey (string) – The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.
RoleArn (string) – 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.
DestinationUri (string) – The destination to which the segment will be exported. This field must be provided if the request is not submitted from the Amazon Connect Admin Website.
- Return type:
dict
- Returns:
Response Syntax
{ 'SnapshotId': 'string' }
Response Structure
(dict) –
SnapshotId (string) –
The unique identifier of the segment snapshot.
Exceptions