aws_sdk_pinpointsmsvoicev2/client/

update_pool.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdatePool`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`pool_id(impl Into<String>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::pool_id) / [`set_pool_id(Option<String>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::set_pool_id):<br>required: **true**<br><p>The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.</p><important>  <p>If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
    ///   - [`two_way_enabled(bool)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::two_way_enabled) / [`set_two_way_enabled(Option<bool>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::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_channel_arn(impl Into<String>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::two_way_channel_arn) / [`set_two_way_channel_arn(Option<String>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::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_pool::builders::UpdatePoolFluentBuilder::two_way_channel_role) / [`set_two_way_channel_role(Option<String>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::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>
    ///   - [`self_managed_opt_outs_enabled(bool)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::self_managed_opt_outs_enabled) / [`set_self_managed_opt_outs_enabled(Option<bool>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::set_self_managed_opt_outs_enabled):<br>required: **false**<br><p>By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. 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>
    ///   - [`opt_out_list_name(impl Into<String>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::opt_out_list_name) / [`set_opt_out_list_name(Option<String>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::set_opt_out_list_name):<br>required: **false**<br><p>The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.</p><important>  <p>If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).</p> </important><br>
    ///   - [`shared_routes_enabled(bool)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::shared_routes_enabled) / [`set_shared_routes_enabled(Option<bool>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::set_shared_routes_enabled):<br>required: **false**<br><p>Indicates whether shared routes are enabled for the pool.</p><br>
    ///   - [`deletion_protection_enabled(bool)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::deletion_protection_enabled) / [`set_deletion_protection_enabled(Option<bool>)`](crate::operation::update_pool::builders::UpdatePoolFluentBuilder::set_deletion_protection_enabled):<br>required: **false**<br><p>When set to true the pool can't be deleted.</p><br>
    /// - On success, responds with [`UpdatePoolOutput`](crate::operation::update_pool::UpdatePoolOutput) with field(s):
    ///   - [`pool_arn(Option<String>)`](crate::operation::update_pool::UpdatePoolOutput::pool_arn): <p>The ARN of the pool.</p>
    ///   - [`pool_id(Option<String>)`](crate::operation::update_pool::UpdatePoolOutput::pool_id): <p>The unique identifier of the pool.</p>
    ///   - [`status(Option<PoolStatus>)`](crate::operation::update_pool::UpdatePoolOutput::status): <p>The current status of the pool update request.</p>
    ///   - [`message_type(Option<MessageType>)`](crate::operation::update_pool::UpdatePoolOutput::message_type): <p>The type of message for the pool to use.</p>
    ///   - [`two_way_enabled(bool)`](crate::operation::update_pool::UpdatePoolOutput::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_channel_arn(Option<String>)`](crate::operation::update_pool::UpdatePoolOutput::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_pool::UpdatePoolOutput::two_way_channel_role): <p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>
    ///   - [`self_managed_opt_outs_enabled(bool)`](crate::operation::update_pool::UpdatePoolOutput::self_managed_opt_outs_enabled): <p>When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. 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>
    ///   - [`opt_out_list_name(Option<String>)`](crate::operation::update_pool::UpdatePoolOutput::opt_out_list_name): <p>The name of the OptOutList associated with the pool.</p>
    ///   - [`shared_routes_enabled(bool)`](crate::operation::update_pool::UpdatePoolOutput::shared_routes_enabled): <p>Indicates whether shared routes are enabled for the pool.</p>
    ///   - [`deletion_protection_enabled(bool)`](crate::operation::update_pool::UpdatePoolOutput::deletion_protection_enabled): <p>When set to true the pool can't be deleted.</p>
    ///   - [`created_timestamp(Option<DateTime>)`](crate::operation::update_pool::UpdatePoolOutput::created_timestamp): <p>The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
    /// - On failure, responds with [`SdkError<UpdatePoolError>`](crate::operation::update_pool::UpdatePoolError)
    pub fn update_pool(&self) -> crate::operation::update_pool::builders::UpdatePoolFluentBuilder {
        crate::operation::update_pool::builders::UpdatePoolFluentBuilder::new(self.handle.clone())
    }
}