Documentation

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

See: newClaimedPhoneNumberSummary smart constructor.

Create a value of ClaimedPhoneNumberSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:phoneNumber:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_phoneNumber - The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

$sel:phoneNumberArn:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_phoneNumberArn - The Amazon Resource Name (ARN) of the phone number.

$sel:phoneNumberCountryCode:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_phoneNumberCountryCode - The ISO country code.

$sel:phoneNumberDescription:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_phoneNumberDescription - The description of the phone number.

$sel:phoneNumberId:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_phoneNumberId - A unique identifier for the phone number.

$sel:phoneNumberStatus:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_phoneNumberStatus - The status of the phone number.

• CLAIMED means the previous ClaimedPhoneNumber or UpdatePhoneNumber operation succeeded.
• IN_PROGRESS means a ClaimedPhoneNumber or UpdatePhoneNumber 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 ClaimedPhoneNumber 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.

$sel:phoneNumberType:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_phoneNumberType - The type of phone number.

$sel:tags:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_tags - The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

$sel:targetArn:ClaimedPhoneNumberSummary', claimedPhoneNumberSummary_targetArn - The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.

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

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

The ISO country code.

The description of the phone number.

A unique identifier for the phone number.

The status of the phone number.

• CLAIMED means the previous ClaimedPhoneNumber or UpdatePhoneNumber operation succeeded.
• IN_PROGRESS means a ClaimedPhoneNumber or UpdatePhoneNumber 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 ClaimedPhoneNumber 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.

The type of phone number.

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

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.