Struct aws_sdk_connect::client::fluent_builders::ClaimPhoneNumber

source ·

pub struct ClaimPhoneNumber { /* 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.

Implementations§

source §

impl ClaimPhoneNumber

source

pub async fn customize(
self
) -> Result<CustomizableOperation<ClaimPhoneNumber, AwsResponseRetryClassifier>, SdkError<ClaimPhoneNumberError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

source

pub async fn send(
self
) -> Result<ClaimPhoneNumberOutput, SdkError<ClaimPhoneNumberError>>

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.

source

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.

source

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.

source

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

source

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

source

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

The description of the phone number.

source

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

The description of the phone number.

source

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

source

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

source

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

source

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