Struct aws_sdk_connect::operation::claim_phone_number::builders::ClaimPhoneNumberFluentBuilder
source · pub struct ClaimPhoneNumberFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ClaimPhoneNumber
.
Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created.
For more information about how to use this operation, see Claim a phone number in your country and Claim phone numbers to traffic distribution groups in the Amazon Connect Administrator Guide.
You can call the SearchAvailablePhoneNumbers API for available phone numbers that you can claim. Call the DescribePhoneNumber API to verify the status of a previous ClaimPhoneNumber operation.
If you plan to claim and release numbers frequently during a 30 day period, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until 30 days past the oldest number released has expired.
By default you can claim and release up to 200% of your maximum number of active phone numbers during any 30 day period. If you claim and release phone numbers using the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 30 days past the oldest number released has expired.
For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket.
Implementations§
source§impl ClaimPhoneNumberFluentBuilder
impl ClaimPhoneNumberFluentBuilder
sourcepub fn as_input(&self) -> &ClaimPhoneNumberInputBuilder
pub fn as_input(&self) -> &ClaimPhoneNumberInputBuilder
Access the ClaimPhoneNumber as a reference.
sourcepub async fn send(
self
) -> Result<ClaimPhoneNumberOutput, SdkError<ClaimPhoneNumberError, HttpResponse>>
pub async fn send( self ) -> Result<ClaimPhoneNumberOutput, SdkError<ClaimPhoneNumberError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<ClaimPhoneNumberOutput, ClaimPhoneNumberError, Self>, SdkError<ClaimPhoneNumberError>>
pub async fn customize( self ) -> Result<CustomizableOperation<ClaimPhoneNumberOutput, ClaimPhoneNumberError, Self>, SdkError<ClaimPhoneNumberError>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn target_arn(self, input: impl Into<String>) -> Self
pub fn target_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
sourcepub fn set_target_arn(self, input: Option<String>) -> Self
pub fn set_target_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
sourcepub fn get_target_arn(&self) -> &Option<String>
pub fn get_target_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.
sourcepub fn phone_number(self, input: impl Into<String>) -> Self
pub fn phone_number(self, input: impl Into<String>) -> Self
The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
sourcepub fn set_phone_number(self, input: Option<String>) -> Self
pub fn set_phone_number(self, input: Option<String>) -> Self
The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
sourcepub fn get_phone_number(&self) -> &Option<String>
pub fn get_phone_number(&self) -> &Option<String>
The phone number you want to claim. Phone numbers are formatted [+] [country code] [subscriber number including area code]
.
sourcepub fn phone_number_description(self, input: impl Into<String>) -> Self
pub fn phone_number_description(self, input: impl Into<String>) -> Self
The description of the phone number.
sourcepub fn set_phone_number_description(self, input: Option<String>) -> Self
pub fn set_phone_number_description(self, input: Option<String>) -> Self
The description of the phone number.
sourcepub fn get_phone_number_description(&self) -> &Option<String>
pub fn get_phone_number_description(&self) -> &Option<String>
The description of the phone number.
Adds a key-value pair to Tags
.
To override the contents of this collection use set_tags
.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Trait Implementations§
source§impl Clone for ClaimPhoneNumberFluentBuilder
impl Clone for ClaimPhoneNumberFluentBuilder
source§fn clone(&self) -> ClaimPhoneNumberFluentBuilder
fn clone(&self) -> ClaimPhoneNumberFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more