Create Segment Snapshot

customerprofiles_create_segment_snapshot

R Documentation

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

Description¶

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

Usage¶

customerprofiles_create_segment_snapshot(DomainName,
  SegmentDefinitionName, DataFormat, EncryptionKey, RoleArn,
  DestinationUri)

Arguments¶

DomainName

[required] The unique name of the domain.

SegmentDefinitionName

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

DataFormat

[required] The format in which the segment will be exported.

EncryptionKey

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

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.

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.

Value¶

A list with the following syntax:

list(
  SnapshotId = "string"
)

Request syntax¶

svc$create_segment_snapshot(
  DomainName = "string",
  SegmentDefinitionName = "string",
  DataFormat = "CSV"|"JSONL"|"ORC",
  EncryptionKey = "string",
  RoleArn = "string",
  DestinationUri = "string"
)