AlexaForBusiness / Paginator / SearchRooms

SearchRooms

class AlexaForBusiness.Paginator.SearchRooms

paginator = client.get_paginator('search_rooms')

paginate(**kwargs)

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

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 rooms. The supported filter keys are RoomName and ProfileName.

  • (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 rooms. The supported sort keys are RoomName and ProfileName.

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

{
    'Rooms': [
        {
            'RoomArn': 'string',
            'RoomName': 'string',
            'Description': 'string',
            'ProviderCalendarId': 'string',
            'ProfileArn': 'string',
            'ProfileName': 'string'
        },
    ],
    'TotalCount': 123
}

Response Structure

• (dict) –

  • Rooms (list) –

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

    • (dict) –

      The data of a room.

      • RoomArn (string) –

        The ARN of a room.

      • RoomName (string) –

        The name of a room.

      • Description (string) –

        The description of a room.

      • ProviderCalendarId (string) –

        The provider calendar ARN of a room.

      • ProfileArn (string) –

        The profile ARN of a room.

      • ProfileName (string) –

        The profile name of a room.

  • TotalCount (integer) –

    The total number of rooms returned.