aws_sdk_pinpointsmsvoicev2/client/put_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 [`PutOptedOutNumber`](crate::operation::put_opted_out_number::builders::PutOptedOutNumberFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`opt_out_list_name(impl Into<String>)`](crate::operation::put_opted_out_number::builders::PutOptedOutNumberFluentBuilder::opt_out_list_name) / [`set_opt_out_list_name(Option<String>)`](crate::operation::put_opted_out_number::builders::PutOptedOutNumberFluentBuilder::set_opt_out_list_name):<br>required: **true**<br><p>The OptOutListName or OptOutListArn to add the phone number to.</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::put_opted_out_number::builders::PutOptedOutNumberFluentBuilder::opted_out_number) / [`set_opted_out_number(Option<String>)`](crate::operation::put_opted_out_number::builders::PutOptedOutNumberFluentBuilder::set_opted_out_number):<br>required: **true**<br><p>The phone number to add to the OptOutList in E.164 format.</p><br>
8 /// - On success, responds with [`PutOptedOutNumberOutput`](crate::operation::put_opted_out_number::PutOptedOutNumberOutput) with field(s):
9 /// - [`opt_out_list_arn(Option<String>)`](crate::operation::put_opted_out_number::PutOptedOutNumberOutput::opt_out_list_arn): <p>The OptOutListArn that the phone number was removed from.</p>
10 /// - [`opt_out_list_name(Option<String>)`](crate::operation::put_opted_out_number::PutOptedOutNumberOutput::opt_out_list_name): <p>The OptOutListName that the phone number was removed from.</p>
11 /// - [`opted_out_number(Option<String>)`](crate::operation::put_opted_out_number::PutOptedOutNumberOutput::opted_out_number): <p>The phone number that was added to the OptOutList.</p>
12 /// - [`opted_out_timestamp(Option<DateTime>)`](crate::operation::put_opted_out_number::PutOptedOutNumberOutput::opted_out_timestamp): <p>The time that the phone number was added to the OptOutList, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.</p>
13 /// - [`end_user_opted_out(bool)`](crate::operation::put_opted_out_number::PutOptedOutNumberOutput::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<PutOptedOutNumberError>`](crate::operation::put_opted_out_number::PutOptedOutNumberError)
15 pub fn put_opted_out_number(&self) -> crate::operation::put_opted_out_number::builders::PutOptedOutNumberFluentBuilder {
16 crate::operation::put_opted_out_number::builders::PutOptedOutNumberFluentBuilder::new(self.handle.clone())
17 }
18}