aws_sdk_sns/client/
check_if_phone_number_is_opted_out.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 [`CheckIfPhoneNumberIsOptedOut`](crate::operation::check_if_phone_number_is_opted_out::builders::CheckIfPhoneNumberIsOptedOutFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`phone_number(impl Into<String>)`](crate::operation::check_if_phone_number_is_opted_out::builders::CheckIfPhoneNumberIsOptedOutFluentBuilder::phone_number) / [`set_phone_number(Option<String>)`](crate::operation::check_if_phone_number_is_opted_out::builders::CheckIfPhoneNumberIsOptedOutFluentBuilder::set_phone_number):<br>required: **true**<br><p>The phone number for which you want to check the opt out status.</p><br>
7    /// - On success, responds with [`CheckIfPhoneNumberIsOptedOutOutput`](crate::operation::check_if_phone_number_is_opted_out::CheckIfPhoneNumberIsOptedOutOutput) with field(s):
8    ///   - [`is_opted_out(bool)`](crate::operation::check_if_phone_number_is_opted_out::CheckIfPhoneNumberIsOptedOutOutput::is_opted_out): <p>Indicates whether the phone number is opted out:</p> <ul>  <li>   <p><code>true</code> – The phone number is opted out, meaning you cannot publish SMS messages to it.</p></li>  <li>   <p><code>false</code> – The phone number is opted in, meaning you can publish SMS messages to it.</p></li> </ul>
9    /// - On failure, responds with [`SdkError<CheckIfPhoneNumberIsOptedOutError>`](crate::operation::check_if_phone_number_is_opted_out::CheckIfPhoneNumberIsOptedOutError)
10    pub fn check_if_phone_number_is_opted_out(
11        &self,
12    ) -> crate::operation::check_if_phone_number_is_opted_out::builders::CheckIfPhoneNumberIsOptedOutFluentBuilder {
13        crate::operation::check_if_phone_number_is_opted_out::builders::CheckIfPhoneNumberIsOptedOutFluentBuilder::new(self.handle.clone())
14    }
15}