Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Description

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

This operation returns paginated results.

Synopsis

# Creating a Request

Creates a value of SearchRooms with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• srFilters - The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
• srSortCriteria - The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
• srNextToken - 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 .
• srMaxResults - 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.

See: searchRooms smart constructor.

Instances

# Request Lenses

The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

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 .

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.

# Destructuring the Response

Arguments

 :: Int srrsResponseStatus -> SearchRoomsResponse

Creates a value of SearchRoomsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• srrsRooms - The rooms that meet the specified set of filter criteria, in sort order.
• srrsNextToken - The token returned to indicate that there is more data available.
• srrsTotalCount - The total number of rooms returned.
• srrsResponseStatus - -- | The response status code.

See: searchRoomsResponse smart constructor.

Instances

# Response Lenses

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

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

The total number of rooms returned.

• - | The response status code.