aws_sdk_pinpointsmsvoicev2/client/
delete_opted_out_number.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 [`DeleteOptedOutNumber`](crate::operation::delete_opted_out_number::builders::DeleteOptedOutNumberFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`opt_out_list_name(impl Into<String>)`](crate::operation::delete_opted_out_number::builders::DeleteOptedOutNumberFluentBuilder::opt_out_list_name) / [`set_opt_out_list_name(Option<String>)`](crate::operation::delete_opted_out_number::builders::DeleteOptedOutNumberFluentBuilder::set_opt_out_list_name):<br>required: **true**<br><p>The OptOutListName or OptOutListArn to remove the phone number from.</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    ///   - [`opted_out_number(impl Into<String>)`](crate::operation::delete_opted_out_number::builders::DeleteOptedOutNumberFluentBuilder::opted_out_number) / [`set_opted_out_number(Option<String>)`](crate::operation::delete_opted_out_number::builders::DeleteOptedOutNumberFluentBuilder::set_opted_out_number):<br>required: **true**<br><p>The phone number, in E.164 format, to remove from the OptOutList.</p><br>
8    /// - On success, responds with [`DeleteOptedOutNumberOutput`](crate::operation::delete_opted_out_number::DeleteOptedOutNumberOutput) with field(s):
9    ///   - [`opt_out_list_arn(Option<String>)`](crate::operation::delete_opted_out_number::DeleteOptedOutNumberOutput::opt_out_list_arn): <p>The OptOutListArn that the phone number was removed from.</p>
10    ///   - [`opt_out_list_name(Option<String>)`](crate::operation::delete_opted_out_number::DeleteOptedOutNumberOutput::opt_out_list_name): <p>The OptOutListName that the phone number was removed from.</p>
11    ///   - [`opted_out_number(Option<String>)`](crate::operation::delete_opted_out_number::DeleteOptedOutNumberOutput::opted_out_number): <p>The phone number that was removed from the OptOutList.</p>
12    ///   - [`opted_out_timestamp(Option<DateTime>)`](crate::operation::delete_opted_out_number::DeleteOptedOutNumberOutput::opted_out_timestamp): <p>The time that the number was removed at, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
13    ///   - [`end_user_opted_out(bool)`](crate::operation::delete_opted_out_number::DeleteOptedOutNumberOutput::end_user_opted_out): <p>This is true if it was the end user who requested their phone number be removed.</p>
14    /// - On failure, responds with [`SdkError<DeleteOptedOutNumberError>`](crate::operation::delete_opted_out_number::DeleteOptedOutNumberError)
15    pub fn delete_opted_out_number(&self) -> crate::operation::delete_opted_out_number::builders::DeleteOptedOutNumberFluentBuilder {
16        crate::operation::delete_opted_out_number::builders::DeleteOptedOutNumberFluentBuilder::new(self.handle.clone())
17    }
18}