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 . chime ]

get-phone-number¶

Description¶

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

Synopsis¶

  get-phone-number
--phone-number-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--phone-number-id (string)

The phone number ID.

--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.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To get phone number details

The following get-phone-number example displays the details of the specified phone number.

aws chime get-phone-number \
    --phone-number-id +12065550100

Output:

{
    "PhoneNumber": {
        "PhoneNumberId": "%2B12065550100",
        "E164PhoneNumber": "+12065550100",
        "Type": "Local",
        "ProductType": "VoiceConnector",
        "Status": "Unassigned",
        "Capabilities": {
            "InboundCall": true,
            "OutboundCall": true,
            "InboundSMS": true,
            "OutboundSMS": true,
            "InboundMMS": true,
            "OutboundMMS": true
        },
       "Associations": [
            {
                "Value": "abcdef1ghij2klmno3pqr4",
                "Name": "VoiceConnectorId",
                "AssociatedTimestamp": "2019-10-28T18:40:37.453Z"
            }
        ],
        "CallingNameStatus": "UpdateInProgress",
        "CreatedTimestamp": "2019-08-09T21:35:21.445Z",
        "UpdatedTimestamp": "2019-08-09T21:35:31.745Z"
    }
}

For more information, see Working with Phone Numbers in the Amazon Chime Administration Guide.

Output¶

PhoneNumber -> (structure)

The phone number details.

PhoneNumberId -> (string)

The phone number ID.

E164PhoneNumber -> (string)

The phone number, in E.164 format.

Country -> (string)

The phone number country. Format: ISO 3166-1 alpha-2.

Type -> (string)

The phone number type.

ProductType -> (string)

The phone number product type.

Status -> (string)

The phone number status.

Capabilities -> (structure)

The phone number capabilities.

InboundCall -> (boolean)

Allows or denies inbound calling for the specified phone number.

OutboundCall -> (boolean)

Allows or denies outbound calling for the specified phone number.

InboundSMS -> (boolean)

Allows or denies inbound SMS messaging for the specified phone number.

OutboundSMS -> (boolean)

Allows or denies outbound SMS messaging for the specified phone number.

InboundMMS -> (boolean)

Allows or denies inbound MMS messaging for the specified phone number.

OutboundMMS -> (boolean)

Allows or denies outbound MMS messaging for the specified phone number.

Associations -> (list)

The phone number associations.

(structure)

The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

Value -> (string)

Contains the ID for the entity specified in Name.

Name -> (string)

Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

AssociatedTimestamp -> (timestamp)

The timestamp of the phone number association, in ISO 8601 format.

CallingName -> (string)

The outbound calling name associated with the phone number.

CallingNameStatus -> (string)

The outbound calling name status.

CreatedTimestamp -> (timestamp)

The phone number creation timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated phone number timestamp, in ISO 8601 format.

DeletionTimestamp -> (timestamp)

The deleted phone number timestamp, in ISO 8601 format.

Table Of Contents

Feedback

User Guide