aws-sdk-connect 1.182.0

AWS SDK for Amazon Connect Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateAttachedFileInput {
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
    /// <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub instance_id: ::std::option::Option<::std::string::String>,
    /// <p>The use case for the file.</p><important>
    /// <p>Only <code>VOICE_RECORDING</code> is supported.</p>
    /// </important>
    pub file_use_case_type: ::std::option::Option<crate::types::FileUseCaseType>,
    /// <p>The S3 URI of the file to be attached. Only S3 source URIs are supported.</p>
    pub file_source_uri: ::std::option::Option<::std::string::String>,
    /// <p>The ARN of the completed voice contact to attach the file to. Only voice contacts with Telephony subtype are supported.</p><note>
    /// <p>This value must be a valid ARN.</p>
    /// </note>
    pub associated_resource_arn: ::std::option::Option<::std::string::String>,
    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreateAttachedFileInput {
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
    /// <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn instance_id(&self) -> ::std::option::Option<&str> {
        self.instance_id.as_deref()
    }
    /// <p>The use case for the file.</p><important>
    /// <p>Only <code>VOICE_RECORDING</code> is supported.</p>
    /// </important>
    pub fn file_use_case_type(&self) -> ::std::option::Option<&crate::types::FileUseCaseType> {
        self.file_use_case_type.as_ref()
    }
    /// <p>The S3 URI of the file to be attached. Only S3 source URIs are supported.</p>
    pub fn file_source_uri(&self) -> ::std::option::Option<&str> {
        self.file_source_uri.as_deref()
    }
    /// <p>The ARN of the completed voice contact to attach the file to. Only voice contacts with Telephony subtype are supported.</p><note>
    /// <p>This value must be a valid ARN.</p>
    /// </note>
    pub fn associated_resource_arn(&self) -> ::std::option::Option<&str> {
        self.associated_resource_arn.as_deref()
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
}
impl CreateAttachedFileInput {
    /// Creates a new builder-style object to manufacture [`CreateAttachedFileInput`](crate::operation::create_attached_file::CreateAttachedFileInput).
    pub fn builder() -> crate::operation::create_attached_file::builders::CreateAttachedFileInputBuilder {
        crate::operation::create_attached_file::builders::CreateAttachedFileInputBuilder::default()
    }
}

/// A builder for [`CreateAttachedFileInput`](crate::operation::create_attached_file::CreateAttachedFileInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateAttachedFileInputBuilder {
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
    pub(crate) instance_id: ::std::option::Option<::std::string::String>,
    pub(crate) file_use_case_type: ::std::option::Option<crate::types::FileUseCaseType>,
    pub(crate) file_source_uri: ::std::option::Option<::std::string::String>,
    pub(crate) associated_resource_arn: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl CreateAttachedFileInputBuilder {
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    /// This field is required.
    pub fn instance_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.instance_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn set_instance_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.instance_id = input;
        self
    }
    /// <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
    pub fn get_instance_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.instance_id
    }
    /// <p>The use case for the file.</p><important>
    /// <p>Only <code>VOICE_RECORDING</code> is supported.</p>
    /// </important>
    /// This field is required.
    pub fn file_use_case_type(mut self, input: crate::types::FileUseCaseType) -> Self {
        self.file_use_case_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>The use case for the file.</p><important>
    /// <p>Only <code>VOICE_RECORDING</code> is supported.</p>
    /// </important>
    pub fn set_file_use_case_type(mut self, input: ::std::option::Option<crate::types::FileUseCaseType>) -> Self {
        self.file_use_case_type = input;
        self
    }
    /// <p>The use case for the file.</p><important>
    /// <p>Only <code>VOICE_RECORDING</code> is supported.</p>
    /// </important>
    pub fn get_file_use_case_type(&self) -> &::std::option::Option<crate::types::FileUseCaseType> {
        &self.file_use_case_type
    }
    /// <p>The S3 URI of the file to be attached. Only S3 source URIs are supported.</p>
    /// This field is required.
    pub fn file_source_uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.file_source_uri = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The S3 URI of the file to be attached. Only S3 source URIs are supported.</p>
    pub fn set_file_source_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.file_source_uri = input;
        self
    }
    /// <p>The S3 URI of the file to be attached. Only S3 source URIs are supported.</p>
    pub fn get_file_source_uri(&self) -> &::std::option::Option<::std::string::String> {
        &self.file_source_uri
    }
    /// <p>The ARN of the completed voice contact to attach the file to. Only voice contacts with Telephony subtype are supported.</p><note>
    /// <p>This value must be a valid ARN.</p>
    /// </note>
    /// This field is required.
    pub fn associated_resource_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.associated_resource_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ARN of the completed voice contact to attach the file to. Only voice contacts with Telephony subtype are supported.</p><note>
    /// <p>This value must be a valid ARN.</p>
    /// </note>
    pub fn set_associated_resource_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.associated_resource_arn = input;
        self
    }
    /// <p>The ARN of the completed voice contact to attach the file to. Only voice contacts with Telephony subtype are supported.</p><note>
    /// <p>This value must be a valid ARN.</p>
    /// </note>
    pub fn get_associated_resource_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.associated_resource_arn
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.tags.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.tags = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>The tags used to organize, track, or control access for this resource. For example, <code>{ "Tags": {"key1":"value1", "key2":"value2"} }</code>.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`CreateAttachedFileInput`](crate::operation::create_attached_file::CreateAttachedFileInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::create_attached_file::CreateAttachedFileInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::create_attached_file::CreateAttachedFileInput {
            client_token: self.client_token,
            instance_id: self.instance_id,
            file_use_case_type: self.file_use_case_type,
            file_source_uri: self.file_source_uri,
            associated_resource_arn: self.associated_resource_arn,
            tags: self.tags,
        })
    }
}