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 ]

search-available-phone-numbers¶

Description¶

Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.

Synopsis¶

  search-available-phone-numbers
[--target-arn <value>]
[--instance-id <value>]
--phone-number-country-code <value>
--phone-number-type <value>
[--phone-number-prefix <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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¶

--target-arn (string)

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter InstanceId or TargetArn .

--instance-id (string)

The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter InstanceId or TargetArn .

--phone-number-country-code (string)

The ISO country code.

Possible values:

AF

AL

DZ

AS

AD

AO

AI

AQ

AG

AR

AM

AW

AU

AT

AZ

BS

BH

BD

BB

BY

BE

BZ

BJ

BM

BT

BO

BA

BW

BR

IO

VG

BN

BG

BF

BI

KH

CM

CA

CV

KY

CF

TD

CL

CN

CX

CC

CO

KM

CK

CR

HR

CU

CW

CY

CZ

CD

DK

DJ

DM

DO

TL

EC

EG

SV

GQ

ER

EE

ET

FK

FO

FJ

FI

FR

PF

GA

GM

GE

DE

GH

GI

GR

GL

GD

GU

GT

GG

GN

GW

GY

HT

HN

HK

HU

IS

IN

ID

IR

IQ

IE

IM

IL

IT

CI

JM

JP

JE

JO

KZ

KE

KI

KW

KG

LA

LV

LB

LS

LR

LY

LI

LT

LU

MO

MK

MG

MW

MY

MV

ML

MT

MH

MR

MU

YT

MX

FM

MD

MC

MN

ME

MS

MA

MZ

MM

NA

NR

NP

NL

AN

NC

NZ

NI

NE

NG

NU

KP

MP

NO

OM

PK

PW

PA

PG

PY

PE

PH

PN

PL

PT

PR

QA

CG

RE

RO

RU

RW

BL

SH

KN

LC

MF

PM

VC

WS

SM

ST

SA

SN

RS

SC

SL

SG

SX

SK

SI

SB

SO

ZA

KR

ES

LK

SD

SR

SJ

SZ

SE

CH

SY

TW

TJ

TZ

TH

TG

TK

TO

TT

TN

TR

TM

TC

TV

VI

UG

UA

AE

GB

US

UY

UZ

VU

VA

VE

VN

WF

EH

YE

ZM

ZW

--phone-number-type (string)

The type of phone number.

Possible values:

TOLL_FREE

DID

UIFN

SHARED

THIRD_PARTY_TF

THIRD_PARTY_DID

SHORT_CODE

--phone-number-prefix (string)

The prefix of the phone number. If provided, it must contain + as part of the country code.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

Output¶

NextToken -> (string)

If there are additional results, this is the token for the next set of results.

AvailableNumbersList -> (list)

A list of available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group.

(structure)

Information about available phone numbers.

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.

Table Of Contents

Feedback

User Guide