AlexaForBusiness / Paginator / SearchProfiles

SearchProfiles

class AlexaForBusiness.Paginator.SearchProfiles

paginator = client.get_paginator('search_profiles')

paginate(**kwargs)

Creates an iterator that will paginate through responses from AlexaForBusiness.Client.search_profiles().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

  • (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 room profiles. Supported sort keys are ProfileName and Address.

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Profiles': [
        {
            'ProfileArn': 'string',
            'ProfileName': 'string',
            'IsDefault': True|False,
            'Address': 'string',
            'Timezone': 'string',
            'DistanceUnit': 'METRIC'|'IMPERIAL',
            'TemperatureUnit': 'FAHRENHEIT'|'CELSIUS',
            'WakeWord': 'ALEXA'|'AMAZON'|'ECHO'|'COMPUTER',
            'Locale': 'string'
        },
    ],
    'TotalCount': 123
}

Response Structure

• (dict) –

  • Profiles (list) –

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

    • (dict) –

      The data of a room profile.

      • ProfileArn (string) –

        The ARN of a room profile.

      • ProfileName (string) –

        The name of a room profile.

      • IsDefault (boolean) –

        Retrieves if the profile data is default or not.

      • Address (string) –

        The address of a room profile.

      • Timezone (string) –

        The time zone of a room profile.

      • DistanceUnit (string) –

        The distance unit of a room profile.

      • TemperatureUnit (string) –

        The temperature unit of a room profile.

      • WakeWord (string) –

        The wake word of a room profile.

      • Locale (string) –

        The locale of a room profile. (This is currently available only to a limited preview audience.)

  • TotalCount (integer) –

    The total number of room profiles returned.