aws_sdk_pinpointsmsvoicev2/client/
delete_pool.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DeletePool`](crate::operation::delete_pool::builders::DeletePoolFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`pool_id(impl Into<String>)`](crate::operation::delete_pool::builders::DeletePoolFluentBuilder::pool_id) / [`set_pool_id(Option<String>)`](crate::operation::delete_pool::builders::DeletePoolFluentBuilder::set_pool_id):<br>required: **true**<br><p>The PoolId or PoolArn of the pool to delete. You can use <code>DescribePools</code> to find the values for PoolId and 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>
7    /// - On success, responds with [`DeletePoolOutput`](crate::operation::delete_pool::DeletePoolOutput) with field(s):
8    ///   - [`pool_arn(Option<String>)`](crate::operation::delete_pool::DeletePoolOutput::pool_arn): <p>The Amazon Resource Name (ARN) of the pool that was deleted.</p>
9    ///   - [`pool_id(Option<String>)`](crate::operation::delete_pool::DeletePoolOutput::pool_id): <p>The PoolId of the pool that was deleted.</p>
10    ///   - [`status(Option<PoolStatus>)`](crate::operation::delete_pool::DeletePoolOutput::status): <p>The current status of the pool.</p> <ul>  <li>   <p>CREATING: The pool is currently being created and isn't yet available for use.</p></li>  <li>   <p>ACTIVE: The pool is active and available for use.</p></li>  <li>   <p>DELETING: The pool is being deleted.</p></li> </ul>
11    ///   - [`message_type(Option<MessageType>)`](crate::operation::delete_pool::DeletePoolOutput::message_type): <p>The message type that was associated with the deleted pool.</p>
12    ///   - [`two_way_enabled(bool)`](crate::operation::delete_pool::DeletePoolOutput::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>
13    ///   - [`two_way_channel_arn(Option<String>)`](crate::operation::delete_pool::DeletePoolOutput::two_way_channel_arn): <p>The Amazon Resource Name (ARN) of the TwoWayChannel.</p>
14    ///   - [`two_way_channel_role(Option<String>)`](crate::operation::delete_pool::DeletePoolOutput::two_way_channel_role): <p>An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.</p>
15    ///   - [`self_managed_opt_outs_enabled(bool)`](crate::operation::delete_pool::DeletePoolOutput::self_managed_opt_outs_enabled): <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>
16    ///   - [`opt_out_list_name(Option<String>)`](crate::operation::delete_pool::DeletePoolOutput::opt_out_list_name): <p>The name of the OptOutList that was associated with the deleted pool.</p>
17    ///   - [`shared_routes_enabled(bool)`](crate::operation::delete_pool::DeletePoolOutput::shared_routes_enabled): <p>Indicates whether shared routes are enabled for the pool.</p>
18    ///   - [`created_timestamp(Option<DateTime>)`](crate::operation::delete_pool::DeletePoolOutput::created_timestamp): <p>The time when the pool was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
19    /// - On failure, responds with [`SdkError<DeletePoolError>`](crate::operation::delete_pool::DeletePoolError)
20    pub fn delete_pool(&self) -> crate::operation::delete_pool::builders::DeletePoolFluentBuilder {
21        crate::operation::delete_pool::builders::DeletePoolFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_pinpointsmsvoicev2/client/delete_pool.rs

aws_sdk_pinpointsmsvoicev2/client/
delete_pool.rs
