Struct ClaimedPhoneNumberSummary

#[non_exhaustive]
pub struct ClaimedPhoneNumberSummary {
    pub phone_number_id: Option<String>,
    pub phone_number_arn: Option<String>,
    pub phone_number: Option<String>,
    pub phone_number_country_code: Option<PhoneNumberCountryCode>,
    pub phone_number_type: Option<PhoneNumberType>,
    pub phone_number_description: Option<String>,
    pub target_arn: Option<String>,
    pub instance_id: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub phone_number_status: Option<PhoneNumberStatus>,
    pub source_phone_number_arn: Option<String>,
}

Information about a phone number that has been claimed to your Amazon Connect instance or traffic distribution group.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

phone_number_id: Option<String>

A unique identifier for the phone number.

phone_number_arn: Option<String>

The Amazon Resource Name (ARN) of the phone number.

phone_number: Option<String>

The phone number. Phone numbers are formatted \[+\] \[country code\] \[subscriber number including area code\].

phone_number_country_code: Option<PhoneNumberCountryCode>

The ISO country code.

phone_number_type: Option<PhoneNumberType>

The type of phone number.

phone_number_description: Option<String>

The description of the phone number.

target_arn: Option<String>

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

instance_id: 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.

tags: Option<HashMap<String, String>>

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

phone_number_status: Option<PhoneNumberStatus>

The status of the phone number.

• CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

• IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

• FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

You will not be billed for the phone number during the 1-day period if number claiming fails.

source_phone_number_arn: Option<String>

The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.

Implementations

impl ClaimedPhoneNumberSummary

pub fn phone_number_id(&self) -> Option<&str>

A unique identifier for the phone number.

pub fn phone_number_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the phone number.

pub fn phone_number(&self) -> Option<&str>

The phone number. Phone numbers are formatted \[+\] \[country code\] \[subscriber number including area code\].

pub fn phone_number_country_code(&self) -> Option<&PhoneNumberCountryCode>

The ISO country code.

pub fn phone_number_type(&self) -> Option<&PhoneNumberType>

The type of phone number.

pub fn phone_number_description(&self) -> Option<&str>

The description of the phone number.

pub fn target_arn(&self) -> Option<&str>

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

pub fn instance_id(&self) -> Option<&str>

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.

pub fn 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 phone_number_status(&self) -> Option<&PhoneNumberStatus>

The status of the phone number.

• CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.

• IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed.

• FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the failure reason. A common reason for a failure may be that the TargetArn value you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received a FAILED status from a ClaimPhoneNumber API call, you have one day to retry claiming the phone number before the number is released back to the inventory for other customers to claim.

You will not be billed for the phone number during the 1-day period if number claiming fails.

pub fn source_phone_number_arn(&self) -> Option<&str>

The claimed phone number ARN that was previously imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number that was imported from Amazon Web Services End User Messaging.

impl ClaimedPhoneNumberSummary

pub fn builder() -> ClaimedPhoneNumberSummaryBuilder

Creates a new builder-style object to manufacture ClaimedPhoneNumberSummary.

Trait Implementations

impl Clone for ClaimedPhoneNumberSummary

fn clone(&self) -> ClaimedPhoneNumberSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClaimedPhoneNumberSummary

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

Formats the value using the given formatter.

impl PartialEq for ClaimedPhoneNumberSummary

fn eq(&self, other: &ClaimedPhoneNumberSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ClaimedPhoneNumberSummary