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 [`UpdateRcsAgent`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`rcs_agent_id(impl Into<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::rcs_agent_id) / [`set_rcs_agent_id(Option<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_rcs_agent_id):<br>required: **true**<br><p>The unique identifier of the RCS agent to update. You can use either the RcsAgentId or RcsAgentArn.</p><br>
    ///   - [`deletion_protection_enabled(bool)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::deletion_protection_enabled) / [`set_deletion_protection_enabled(Option<bool>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::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.</p><br>
    ///   - [`opt_out_list_name(impl Into<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::opt_out_list_name) / [`set_opt_out_list_name(Option<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::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>
    ///   - [`self_managed_opt_outs_enabled(bool)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::self_managed_opt_outs_enabled) / [`set_self_managed_opt_outs_enabled(Option<bool>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_self_managed_opt_outs_enabled):<br>required: **false**<br><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><br>
    ///   - [`two_way_channel_arn(impl Into<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::two_way_channel_arn) / [`set_two_way_channel_arn(Option<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_two_way_channel_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the two way channel.</p><br>
    ///   - [`two_way_channel_role(impl Into<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::two_way_channel_role) / [`set_two_way_channel_role(Option<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_two_way_channel_role):<br>required: **false**<br><p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p><br>
    ///   - [`two_way_enabled(bool)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::two_way_enabled) / [`set_two_way_enabled(Option<bool>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_two_way_enabled):<br>required: **false**<br><p>By default this is set to false. When set to true you can receive incoming text messages from your end recipients.</p><br>
    ///   - [`two_way_media_s3_bucket_name(impl Into<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::two_way_media_s3_bucket_name) / [`set_two_way_media_s3_bucket_name(Option<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_two_way_media_s3_bucket_name):<br>required: **false**<br><p>The name of the S3 bucket where inbound RCS media files are stored. Two-way messaging must be enabled on the agent. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3Role.</p><br>
    ///   - [`two_way_media_s3_key_prefix(impl Into<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::two_way_media_s3_key_prefix) / [`set_two_way_media_s3_key_prefix(Option<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_two_way_media_s3_key_prefix):<br>required: **false**<br><p>The key prefix used for inbound RCS media objects in the S3 bucket.</p><br>
    ///   - [`two_way_media_s3_role(impl Into<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::two_way_media_s3_role) / [`set_two_way_media_s3_role(Option<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_two_way_media_s3_role):<br>required: **false**<br><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. To remove the media configuration, pass the sentinel value <code>UNSET_RCS_MEDIA_CONFIGURATION</code> for both this field and TwoWayMediaS3BucketName.</p><br>
    ///   - [`two_way_rcs_events_enabled(impl Into<String>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::two_way_rcs_events_enabled) / [`set_two_way_rcs_events_enabled(Option<Vec::<String>>)`](crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::set_two_way_rcs_events_enabled):<br>required: **false**<br><p>The list of RCS event types to enable for two-way messaging. Pass an empty list to disable all event types. The special value <code>ALL</code> enables all current and future event types and must be the sole element if used.</p><br>
    /// - On success, responds with [`UpdateRcsAgentOutput`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput) with field(s):
    ///   - [`rcs_agent_arn(String)`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput::rcs_agent_arn): <p>The Amazon Resource Name (ARN) of the updated RCS agent.</p>
    ///   - [`rcs_agent_id(String)`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput::rcs_agent_id): <p>The unique identifier for the RCS agent.</p>
    ///   - [`status(RcsAgentStatus)`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput::status): <p>The current status of the RCS agent.</p>
    ///   - [`created_timestamp(DateTime)`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput::created_timestamp): <p>The time when the RCS agent was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    ///   - [`deletion_protection_enabled(bool)`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput::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::update_rcs_agent::UpdateRcsAgentOutput::opt_out_list_name): <p>The name of the OptOutList associated with the RCS agent.</p>
    ///   - [`self_managed_opt_outs_enabled(bool)`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput::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::update_rcs_agent::UpdateRcsAgentOutput::two_way_channel_arn): <p>The Amazon Resource Name (ARN) of the two way channel.</p>
    ///   - [`two_way_channel_role(Option<String>)`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput::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::update_rcs_agent::UpdateRcsAgentOutput::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::update_rcs_agent::UpdateRcsAgentOutput::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::update_rcs_agent::UpdateRcsAgentOutput::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::update_rcs_agent::UpdateRcsAgentOutput::two_way_media_s3_role): <p>The ARN of the IAM role used to write inbound RCS media files to the S3 bucket.</p>
    ///   - [`two_way_rcs_events_enabled(Option<Vec::<String>>)`](crate::operation::update_rcs_agent::UpdateRcsAgentOutput::two_way_rcs_events_enabled): <p>The list of RCS event types enabled for two-way messaging on the agent.</p>
    /// - On failure, responds with [`SdkError<UpdateRcsAgentError>`](crate::operation::update_rcs_agent::UpdateRcsAgentError)
    pub fn update_rcs_agent(&self) -> crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder {
        crate::operation::update_rcs_agent::builders::UpdateRcsAgentFluentBuilder::new(self.handle.clone())
    }
}