AlexaForBusiness / Client / search_address_books

search_address_books#

AlexaForBusiness.Client.search_address_books(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.search_address_books(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • Filters (list) –

    The filters to use to list a specified set of address books. The supported filter key is AddressBookName.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria.

      • Key (string) – [REQUIRED]

        The key of a filter.

      • Values (list) – [REQUIRED]

        The values of a filter.

        • (string) –

  • SortCriteria (list) –

    The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

    • (dict) –

      An object representing a sort criteria.

      • Key (string) – [REQUIRED]

        The sort key of a sort object.

      • Value (string) – [REQUIRED]

        The sort value of a sort object.

  • NextToken (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.

  • MaxResults (integer) – The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'AddressBooks': [
        {
            'AddressBookArn': 'string',
            'Name': 'string',
            'Description': 'string'
        },
    ],
    'NextToken': 'string',
    'TotalCount': 123
}

Response Structure

  • (dict) –

    • AddressBooks (list) –

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

      • (dict) –

        Information related to an address book.

        • AddressBookArn (string) –

          The ARN of the address book.

        • Name (string) –

          The name of the address book.

        • Description (string) –

          The description of the address book.

    • NextToken (string) –

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

    • TotalCount (integer) –

      The total number of address books returned.