Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . alexaforbusiness ]



Searches contacts and lists the ones that meet a set of filter and sort criteria.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--filters <value>]
[--sort-criteria <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--filters (list)

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Shorthand Syntax:

Key=string,Values=string,string ...

JSON Syntax:

    "Key": "string",
    "Values": ["string", ...]

--sort-criteria (list)

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "ASC"|"DESC"

--next-token (string)

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

--max-results (integer)

The maximum number of results to include in the response. If more results exist than the specified max-results value, a token is included in the response so that the remaining results can be retrieved.

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

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

See 'aws help' for descriptions of global parameters.


Contacts -> (list)

The contacts that meet the specified set of filter criteria, in sort order.


Information related to a contact.

ContactArn -> (string)

The ARN of the contact.

DisplayName -> (string)

The name of the contact to display on the AWS management console.

FirstName -> (string)

The first name of the contact that is used to call the contact on the device.

LastName -> (string)

The last name of the contact that is used to call the contact on the device.

PhoneNumber -> (string)

The phone number of the contact.

NextToken -> (string)

The token returned to indicate that there is more data available.

TotalCount -> (integer)

The total number of contacts returned.