aws_sdk_customerprofiles/client/
create_segment_snapshot.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateSegmentSnapshot`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain_name(impl Into<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::domain_name) / [`set_domain_name(Option<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::set_domain_name):<br>required: **true**<br><p>The unique name of the domain.</p><br>
    ///   - [`segment_definition_name(impl Into<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::segment_definition_name) / [`set_segment_definition_name(Option<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::set_segment_definition_name):<br>required: **true**<br><p>The name of the segment definition used in this snapshot request.</p><br>
    ///   - [`data_format(DataFormat)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::data_format) / [`set_data_format(Option<DataFormat>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::set_data_format):<br>required: **true**<br><p>The format in which the segment will be exported.</p><br>
    ///   - [`encryption_key(impl Into<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::encryption_key) / [`set_encryption_key(Option<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::set_encryption_key):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the KMS key used to encrypt the exported segment.</p><br>
    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::set_role_arn):<br>required: **false**<br><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><br>
    ///   - [`destination_uri(impl Into<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::destination_uri) / [`set_destination_uri(Option<String>)`](crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::set_destination_uri):<br>required: **false**<br><p>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.</p><br>
    /// - On success, responds with [`CreateSegmentSnapshotOutput`](crate::operation::create_segment_snapshot::CreateSegmentSnapshotOutput) with field(s):
    ///   - [`snapshot_id(String)`](crate::operation::create_segment_snapshot::CreateSegmentSnapshotOutput::snapshot_id): <p>The unique identifier of the segment snapshot.</p>
    /// - On failure, responds with [`SdkError<CreateSegmentSnapshotError>`](crate::operation::create_segment_snapshot::CreateSegmentSnapshotError)
    pub fn create_segment_snapshot(&self) -> crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder {
        crate::operation::create_segment_snapshot::builders::CreateSegmentSnapshotFluentBuilder::new(self.handle.clone())
    }
}