aws-sdk-pinpointsmsvoicev2 1.124.0

AWS SDK for Amazon Pinpoint SMS Voice V2
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateRcsAgent`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`deletion_protection_enabled(bool)`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::deletion_protection_enabled) / [`set_deletion_protection_enabled(Option<bool>)`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::set_deletion_protection_enabled):<br>required: **false**<br><p>By default this is set to false. When set to true the RCS agent can't be deleted. You can change this value using the <code>UpdateRcsAgent</code> action.</p><br>
    ///   - [`opt_out_list_name(impl Into<String>)`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::opt_out_list_name) / [`set_opt_out_list_name(Option<String>)`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::set_opt_out_list_name):<br>required: **false**<br><p>The OptOutList to associate with the RCS agent. Valid values are either OptOutListName or OptOutListArn.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::set_tags):<br>required: **false**<br><p>An array of tags (key and value pairs) associated with the RCS agent.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::set_client_token):<br>required: **false**<br><p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.</p><br>
    /// - On success, responds with [`CreateRcsAgentOutput`](crate::operation::create_rcs_agent::CreateRcsAgentOutput) with field(s):
    ///   - [`rcs_agent_arn(String)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::rcs_agent_arn): <p>The Amazon Resource Name (ARN) of the newly created RCS agent.</p>
    ///   - [`rcs_agent_id(String)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::rcs_agent_id): <p>The unique identifier for the RCS agent.</p>
    ///   - [`status(RcsAgentStatus)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::status): <p>The current status of the RCS agent.</p>
    ///   - [`deletion_protection_enabled(bool)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::deletion_protection_enabled): <p>When set to true deletion protection is enabled. By default this is set to false.</p>
    ///   - [`opt_out_list_name(Option<String>)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::opt_out_list_name): <p>The name of the OptOutList associated with the RCS agent.</p>
    ///   - [`created_timestamp(DateTime)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::created_timestamp): <p>The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    ///   - [`self_managed_opt_outs_enabled(bool)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::self_managed_opt_outs_enabled): <p>By default this is set to false. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.</p>
    ///   - [`two_way_channel_arn(Option<String>)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::two_way_channel_arn): <p>The Amazon Resource Name (ARN) of the two way channel.</p>
    ///   - [`two_way_channel_role(Option<String>)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::two_way_channel_role): <p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>
    ///   - [`two_way_enabled(bool)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::two_way_enabled): <p>By default this is set to false. When set to true you can receive incoming text messages from your end recipients.</p>
    ///   - [`two_way_media_s3_bucket_name(Option<String>)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::two_way_media_s3_bucket_name): <p>The name of the S3 bucket where inbound RCS media files are stored.</p>
    ///   - [`two_way_media_s3_key_prefix(Option<String>)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::two_way_media_s3_key_prefix): <p>The key prefix used for inbound RCS media objects in the S3 bucket.</p>
    ///   - [`two_way_media_s3_role(Option<String>)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::two_way_media_s3_role): <p>The ARN of the IAM role used to write inbound RCS media files to the S3 bucket. The role must have <code>s3:PutObject</code> permission on the bucket and a trust policy allowing <code>sms-voice.amazonaws.com</code> to assume it.</p>
    ///   - [`two_way_rcs_events_enabled(Option<Vec::<String>>)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::two_way_rcs_events_enabled): <p>The list of RCS event types enabled for two-way messaging on the agent.</p>
    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::create_rcs_agent::CreateRcsAgentOutput::tags): <p>An array of tags (key and value pairs) associated with the RCS agent.</p>
    /// - On failure, responds with [`SdkError<CreateRcsAgentError>`](crate::operation::create_rcs_agent::CreateRcsAgentError)
    pub fn create_rcs_agent(&self) -> crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder {
        crate::operation::create_rcs_agent::builders::CreateRcsAgentFluentBuilder::new(self.handle.clone())
    }
}