Class: Aws::Connect::Types::PhoneNumberStatus

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connect/types.rb

Overview

The status of the phone number.

  • ‘CLAIMED` means the previous [ClaimPhoneNumber] or

    UpdatePhoneNumber][2

    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][2

    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.

[1]: docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html [2]: docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html [3]: docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html [4]: docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#messageString

The status message.

Returns:

  • (String)


15158
15159
15160
15161
15162
15163
# File 'lib/aws-sdk-connect/types.rb', line 15158

class PhoneNumberStatus < Struct.new(
  :status,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status.

Returns:

  • (String)


15158
15159
15160
15161
15162
15163
# File 'lib/aws-sdk-connect/types.rb', line 15158

class PhoneNumberStatus < Struct.new(
  :status,
  :message)
  SENSITIVE = []
  include Aws::Structure
end