Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Searches rooms and lists the ones that meet a set of filter and sort criteria.
This operation returns paginated results.
- searchRooms :: SearchRooms
- data SearchRooms
- srFilters :: Lens' SearchRooms [Filter]
- srSortCriteria :: Lens' SearchRooms [Sort]
- srNextToken :: Lens' SearchRooms (Maybe Text)
- srMaxResults :: Lens' SearchRooms (Maybe Natural)
- searchRoomsResponse :: Int -> SearchRoomsResponse
- data SearchRoomsResponse
- srrsRooms :: Lens' SearchRoomsResponse [RoomData]
- srrsNextToken :: Lens' SearchRoomsResponse (Maybe Text)
- srrsTotalCount :: Lens' SearchRoomsResponse (Maybe Int)
- srrsResponseStatus :: Lens' SearchRoomsResponse Int
Creating a Request
searchRooms :: SearchRooms Source #
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 byMaxResults
.srMaxResults
- The maximum number of results to include in the response. If more results exist than the specifiedMaxResults
value, a token is included in the response so that the remaining results can be retrieved.
data SearchRooms Source #
See: searchRooms
smart constructor.
Request Lenses
srFilters :: Lens' SearchRooms [Filter] Source #
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
srSortCriteria :: Lens' SearchRooms [Sort] Source #
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
srNextToken :: Lens' SearchRooms (Maybe Text) Source #
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 :: Lens' SearchRooms (Maybe Natural) Source #
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
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.
data SearchRoomsResponse Source #
See: searchRoomsResponse
smart constructor.
Response Lenses
srrsRooms :: Lens' SearchRoomsResponse [RoomData] Source #
The rooms that meet the specified set of filter criteria, in sort order.
srrsNextToken :: Lens' SearchRoomsResponse (Maybe Text) Source #
The token returned to indicate that there is more data available.
srrsTotalCount :: Lens' SearchRoomsResponse (Maybe Int) Source #
The total number of rooms returned.
srrsResponseStatus :: Lens' SearchRoomsResponse Int Source #
- - | The response status code.