[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--phone-number-id (string)

A unique identifier for the phone number.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.