Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]

describe-phone-number

Description

Gets details and status of a phone number that’s claimed to your Amazon Connect instance

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-phone-number
--phone-number-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--phone-number-id (string)

A unique identifier for the phone number.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ClaimedPhoneNumberSummary -> (structure)

Information about a phone number that's been claimed to your Amazon Connect instance.

PhoneNumberId -> (string)

A unique identifier for the phone number.

PhoneNumberArn -> (string)

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

PhoneNumber -> (string)

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

PhoneNumberCountryCode -> (string)

The ISO country code.

PhoneNumberType -> (string)

The type of phone number.

PhoneNumberDescription -> (string)

The description of the phone number.

TargetArn -> (string)

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

Tags -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

PhoneNumberStatus -> (structure)

The status of the phone number.

Status -> (string)

The status.

Message -> (string)

The status message.