| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IVSChat.ListRooms
Description
Gets summary information about all your rooms in the AWS region where
the API request is processed. Results are sorted in descending order of
updateTime.
Synopsis
- data ListRooms = ListRooms' {}
- newListRooms :: ListRooms
- listRooms_loggingConfigurationIdentifier :: Lens' ListRooms (Maybe Text)
- listRooms_maxResults :: Lens' ListRooms (Maybe Natural)
- listRooms_messageReviewHandlerUri :: Lens' ListRooms (Maybe Text)
- listRooms_name :: Lens' ListRooms (Maybe Text)
- listRooms_nextToken :: Lens' ListRooms (Maybe Text)
- data ListRoomsResponse = ListRoomsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- rooms :: [RoomSummary]
- newListRoomsResponse :: Int -> ListRoomsResponse
- listRoomsResponse_nextToken :: Lens' ListRoomsResponse (Maybe Text)
- listRoomsResponse_httpStatus :: Lens' ListRoomsResponse Int
- listRoomsResponse_rooms :: Lens' ListRoomsResponse [RoomSummary]
Creating a Request
See: newListRooms smart constructor.
Constructors
| ListRooms' | |
Fields
| |
Instances
newListRooms :: ListRooms Source #
Create a value of ListRooms with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loggingConfigurationIdentifier:ListRooms', listRooms_loggingConfigurationIdentifier - Logging-configuration identifier.
$sel:maxResults:ListRooms', listRooms_maxResults - Maximum number of rooms to return. Default: 50.
$sel:messageReviewHandlerUri:ListRooms', listRooms_messageReviewHandlerUri - Filters the list to match the specified message review handler URI.
ListRooms, listRooms_name - Filters the list to match the specified room name.
ListRooms, listRooms_nextToken - The first room to retrieve. This is used for pagination; see the
nextToken response field.
Request Lenses
listRooms_loggingConfigurationIdentifier :: Lens' ListRooms (Maybe Text) Source #
Logging-configuration identifier.
listRooms_maxResults :: Lens' ListRooms (Maybe Natural) Source #
Maximum number of rooms to return. Default: 50.
listRooms_messageReviewHandlerUri :: Lens' ListRooms (Maybe Text) Source #
Filters the list to match the specified message review handler URI.
listRooms_name :: Lens' ListRooms (Maybe Text) Source #
Filters the list to match the specified room name.
listRooms_nextToken :: Lens' ListRooms (Maybe Text) Source #
The first room to retrieve. This is used for pagination; see the
nextToken response field.
Destructuring the Response
data ListRoomsResponse Source #
See: newListRoomsResponse smart constructor.
Constructors
| ListRoomsResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> ListRoomsResponse |
Create a value of ListRoomsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListRooms, listRoomsResponse_nextToken - If there are more rooms than maxResults, use nextToken in the
request to get the next set.
$sel:httpStatus:ListRoomsResponse', listRoomsResponse_httpStatus - The response's http status code.
$sel:rooms:ListRoomsResponse', listRoomsResponse_rooms - List of the matching rooms (summary information only).
Response Lenses
listRoomsResponse_nextToken :: Lens' ListRoomsResponse (Maybe Text) Source #
If there are more rooms than maxResults, use nextToken in the
request to get the next set.
listRoomsResponse_httpStatus :: Lens' ListRoomsResponse Int Source #
The response's http status code.
listRoomsResponse_rooms :: Lens' ListRoomsResponse [RoomSummary] Source #
List of the matching rooms (summary information only).