Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateSegmentSnapshot

Triggers a job to export a segment to a specified destination.

Request Syntax


POST /domains/DomainName/segments/SegmentDefinitionName/snapshots HTTP/1.1
Content-type: application/json

{
   "DataFormat": "string",
   "DestinationUri": "string",
   "EncryptionKey": "string",
   "RoleArn": "string"
}

URI Request Parameters

The request uses the following URI parameters.

DomainName

The unique name of the domain.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

SegmentDefinitionName

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

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

DataFormat

The format in which the segment will be exported.

Type: String

Valid Values: CSV | JSONL | ORC

Required: Yes

DestinationUri

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

EncryptionKey

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

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.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:iam:.*:[0-9]+:.*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "SnapshotId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SnapshotId

The unique identifier of the segment snapshot.

Type: String

Pattern: [a-f0-9]{32}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

InternalServerException

An internal service error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

ThrottlingException

You exceeded the maximum number of requests.

HTTP Status Code: 429