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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

Creating a Request

data ListRooms Source #

See: newListRooms smart constructor.

Constructors

ListRooms'

Fields

loggingConfigurationIdentifier :: Maybe Text
Logging-configuration identifier.
maxResults :: Maybe Natural
Maximum number of rooms to return. Default: 50.
messageReviewHandlerUri :: Maybe Text
Filters the list to match the specified message review handler URI.
name :: Maybe Text
Filters the list to match the specified room name.
nextToken :: Maybe Text
The first room to retrieve. This is used for pagination; see the nextToken response field.

Instances

Instances details

ToJSON ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods toJSON :: ListRooms -> Value # toEncoding :: ListRooms -> Encoding # toJSONList :: [ListRooms] -> Value # toEncodingList :: [ListRooms] -> Encoding #
ToHeaders ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods toHeaders :: ListRooms -> [Header] #
ToPath ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods toPath :: ListRooms -> ByteString #
ToQuery ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods toQuery :: ListRooms -> QueryString #
AWSRequest ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Associated Types type AWSResponse ListRooms # Methods request :: (Service -> Service) -> ListRooms -> Request ListRooms # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListRooms -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListRooms))) #
Generic ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Associated Types type Rep ListRooms :: Type -> Type # Methods from :: ListRooms -> Rep ListRooms x # to :: Rep ListRooms x -> ListRooms #
Read ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods readsPrec :: Int -> ReadS ListRooms # readList :: ReadS [ListRooms] # readPrec :: ReadPrec ListRooms # readListPrec :: ReadPrec [ListRooms] #
Show ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods showsPrec :: Int -> ListRooms -> ShowS # show :: ListRooms -> String # showList :: [ListRooms] -> ShowS #
NFData ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods rnf :: ListRooms -> () #
Eq ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods (==) :: ListRooms -> ListRooms -> Bool # (/=) :: ListRooms -> ListRooms -> Bool #
Hashable ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods hashWithSalt :: Int -> ListRooms -> Int # hash :: ListRooms -> Int #
type AWSResponse ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms type AWSResponse ListRooms = ListRoomsResponse
type Rep ListRooms Source #
Instance details Defined in Amazonka.IVSChat.ListRooms type Rep ListRooms = D1 ('MetaData "ListRooms" "Amazonka.IVSChat.ListRooms" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "ListRooms'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "loggingConfigurationIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "messageReviewHandlerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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 nextToken :: Maybe Text If there are more rooms than `maxResults`, use `nextToken` in the request to get the next set. httpStatus :: Int The response's http status code. rooms :: [RoomSummary] List of the matching rooms (summary information only).

Instances

Instances details

Generic ListRoomsResponse Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Associated Types type Rep ListRoomsResponse :: Type -> Type # Methods from :: ListRoomsResponse -> Rep ListRoomsResponse x # to :: Rep ListRoomsResponse x -> ListRoomsResponse #
Read ListRoomsResponse Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods readsPrec :: Int -> ReadS ListRoomsResponse # readList :: ReadS [ListRoomsResponse] # readPrec :: ReadPrec ListRoomsResponse # readListPrec :: ReadPrec [ListRoomsResponse] #
Show ListRoomsResponse Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods showsPrec :: Int -> ListRoomsResponse -> ShowS # show :: ListRoomsResponse -> String # showList :: [ListRoomsResponse] -> ShowS #
NFData ListRoomsResponse Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods rnf :: ListRoomsResponse -> () #
Eq ListRoomsResponse Source #
Instance details Defined in Amazonka.IVSChat.ListRooms Methods (==) :: ListRoomsResponse -> ListRoomsResponse -> Bool # (/=) :: ListRoomsResponse -> ListRoomsResponse -> Bool #
type Rep ListRoomsResponse Source #
Instance details Defined in Amazonka.IVSChat.ListRooms type Rep ListRoomsResponse = D1 ('MetaData "ListRoomsResponse" "Amazonka.IVSChat.ListRooms" "amazonka-ivschat-2.0-AB4QlCKEEGt4izEWjWKMb2" 'False) (C1 ('MetaCons "ListRoomsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "rooms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [RoomSummary]))))

newListRoomsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListRoomsResponse'`
-> 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).