CustomerProfiles / Client / get_segment_snapshot

get_segment_snapshot#

CustomerProfiles.Client.get_segment_snapshot(**kwargs)#

Retrieve the latest status of a segment snapshot.

Request Syntax

response = client.get_segment_snapshot(
    DomainName='string',
    SegmentDefinitionName='string',
    SnapshotId='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The unique identifier of the domain.
SegmentDefinitionName (string) –
[REQUIRED]

The unique name of the segment definition.
SnapshotId (string) –
[REQUIRED]

The unique identifier of the segment snapshot.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotId': 'string',
    'Status': 'COMPLETED'|'IN_PROGRESS'|'FAILED',
    'StatusMessage': 'string',
    'DataFormat': 'CSV'|'JSONL'|'ORC',
    'EncryptionKey': 'string',
    'RoleArn': 'string',
    'DestinationUri': 'string'
}

Response Structure

(dict) –
- SnapshotId (string) –
  
  The unique identifier of the segment snapshot.
- Status (string) –
  
  The status of the asynchronous job for exporting the segment snapshot.
- StatusMessage (string) –
  
  The status message of the asynchronous job for exporting the segment snapshot.
- DataFormat (string) –
  
  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.

Exceptions

CustomerProfiles.Client.exceptions.BadRequestException
CustomerProfiles.Client.exceptions.ResourceNotFoundException
CustomerProfiles.Client.exceptions.AccessDeniedException
CustomerProfiles.Client.exceptions.ThrottlingException
CustomerProfiles.Client.exceptions.InternalServerException