[ aws . chime ]



Searches phone numbers that can be ordered.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--area-code <value>]
[--city <value>]
[--country <value>]
[--state <value>]
[--toll-free-prefix <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--area-code (string)

The area code used to filter results.

--city (string)

The city used to filter results.

--country (string)

The country used to filter results.

--state (string)

The state used to filter results.

--toll-free-prefix (string)

The toll-free prefix that you use to filter results.

--max-results (integer)

The maximum number of results to return in a single call.

--next-token (string)

The token to use to retrieve the next page of results.

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.


To search available phone numbers

The following search-available-phone-numbers example searches available phone numbers by area code.

aws chime search-available-phone-numbers \
    --area-code "206"


    "E164PhoneNumbers": [

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


E164PhoneNumbers -> (list)

List of phone numbers, in E.164 format.