AlexaForBusiness / Client / search_rooms

search_rooms#

AlexaForBusiness.Client.search_rooms(**kwargs)#

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

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 = client.search_rooms(
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    SortCriteria=[
        {
            'Key': 'string',
            'Value': 'ASC'|'DESC'
        },
    ]
)
Parameters:

  • 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 includes only 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.

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

Return type:

dict

Returns:

Response Syntax

{
    'Rooms': [
        {
            'RoomArn': 'string',
            'RoomName': 'string',
            'Description': 'string',
            'ProviderCalendarId': 'string',
            'ProfileArn': 'string',
            'ProfileName': 'string'
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

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

    • TotalCount (integer) –

      The total number of rooms returned.