check_if_phone_number_is_opted_out¶
Operation¶
check_if_phone_number_is_opted_out
¶
check_if_phone_number_is_opted_out(request: CheckIfPhoneNumberIsOptedOutInput | CheckIfPhoneNumberIsOptedOutInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CheckIfPhoneNumberIsOptedOutInputDict]) -> CheckIfPhoneNumberIsOptedOutOutput
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the
OptInPhoneNumber action.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CheckIfPhoneNumberIsOptedOutInput | CheckIfPhoneNumberIsOptedOutInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CheckIfPhoneNumberIsOptedOutInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CheckIfPhoneNumberIsOptedOutOutput
|
An instance of |
check_if_phone_number_is_opted_out
async
¶
check_if_phone_number_is_opted_out(request: CheckIfPhoneNumberIsOptedOutInput | CheckIfPhoneNumberIsOptedOutInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CheckIfPhoneNumberIsOptedOutInputDict]) -> CheckIfPhoneNumberIsOptedOutOutput
Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.
To resume sending messages, you can opt in the number by using the
OptInPhoneNumber action.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CheckIfPhoneNumberIsOptedOutInput | CheckIfPhoneNumberIsOptedOutInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[CheckIfPhoneNumberIsOptedOutInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CheckIfPhoneNumberIsOptedOutOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
CheckIfPhoneNumberIsOptedOutOutput
dataclass
¶
Bases: _SerdeShape
The response from the CheckIfPhoneNumberIsOptedOut action.
Attributes¶
is_opted_out
class-attribute
instance-attribute
¶
is_opted_out: bool = ...
Indicates whether the phone number is opted out:
-
true-- The phone number is opted out, meaning you cannot publish SMS messages to it. -
false-- The phone number is opted in, meaning you can publish SMS messages to it.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.