PhoneNumberStatus
The status of the phone number.
-
CLAIMEDmeans the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded. -
IN_PROGRESSmeans 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. -
FAILEDindicates 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 theTargetArnvalue you are claiming or updating a phone number to has reached its limit of total claimed numbers. If you received aFAILEDstatus from aClaimPhoneNumberAPI 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.
Contents
- Message
-
The status message.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 255.
Pattern:
^[\W\S_]*Required: No
- Status
-
The status.
Type: String
Valid Values:
CLAIMED | IN_PROGRESS | FAILEDRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
