list-phone-numbers¶
Description¶
Provides information about the phone numbers for the specified Amazon Connect instance.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-phone-numbers is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: PhoneNumberSummaryList
Synopsis¶
list-phone-numbers
--instance-id <value>
[--phone-number-types <value>]
[--phone-number-country-codes <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--instance-id (string)
The identifier of the Amazon Connect instance.
--phone-number-types (list)
The type of phone number.
(string)
Syntax:
"string" "string" ...
Where valid values are:
TOLL_FREE
DID
--phone-number-country-codes (list)
The ISO country code.
(string)
Syntax:
"string" "string" ...
Where valid values are:
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
--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.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom 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
NextTokenis provided in the command’s output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse 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. 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.
Examples¶
To list the phone numbers in an instance
The following list-phone-numbers example lists the phone numbers in the specified Amazon Connect instance.
aws connect list-phone-numbers \
--instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
Output:
{
"PhoneNumberSummaryList": [
{
"Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/xyz80zxy-xyz1-80zx-zx80-11111EXAMPLE",
"PhoneNumber": "+17065551212",
"PhoneNumberType": "DID",
"PhoneNumberCountryCode": "US"
},
{
"Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"Arn": "arn:aws:connect:us-west-2:123456789012:instance/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/phone-number/ccc0ccc-xyz1-80zx-zx80-22222EXAMPLE",
"PhoneNumber": "+18555551212",
"PhoneNumberType": "TOLL_FREE",
"PhoneNumberCountryCode": "US"
}
]
}
For more information, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
Output¶
PhoneNumberSummaryList -> (list)
Information about the phone numbers.
(structure)
Contains summary information about a phone number for a contact center.
Id -> (string)
The identifier of the phone number.
Arn -> (string)
The Amazon Resource Name (ARN) of the phone number.
PhoneNumber -> (string)
The phone number.
PhoneNumberType -> (string)
The type of phone number.
PhoneNumberCountryCode -> (string)
The ISO country code.
NextToken -> (string)
If there are additional results, this is the token for the next set of results.