Struct ClaimPhoneNumberFluentBuilder

pub struct ClaimPhoneNumberFluentBuilder { /* private fields */ }

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, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 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. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 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 180 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

impl ClaimPhoneNumberFluentBuilder

pub fn as_input(&self) -> &ClaimPhoneNumberInputBuilder

Access the ClaimPhoneNumber as a reference.

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.

pub fn customize( self, ) -> CustomizableOperation<ClaimPhoneNumberOutput, ClaimPhoneNumberError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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 number inbound traffic is routed through. You must enter InstanceId or TargetArn.

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 number inbound traffic is routed through. You must enter InstanceId or TargetArn.

pub fn get_target_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn.

pub fn instance_id(self, input: impl Into<String>) -> Self

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

pub fn set_instance_id(self, input: Option<String>) -> Self

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

pub fn get_instance_id(&self) -> &Option<String>

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn.

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\].

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\].

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\].

pub fn phone_number_description(self, input: impl Into<String>) -> Self

The description of the phone number.

pub fn set_phone_number_description(self, input: Option<String>) -> Self

The description of the phone number.

pub fn get_phone_number_description(&self) -> &Option<String>

The description of the phone number.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

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"} }.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

pub fn get_tags(&self) -> &Option<HashMap<String, String>>

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

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}$

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}$

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

impl Clone for ClaimPhoneNumberFluentBuilder

fn clone(&self) -> ClaimPhoneNumberFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClaimPhoneNumberFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.