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.Chime.ListRooms

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the room details for the specified Amazon Chime Enterprise account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.

Synopsis

data ListRooms = ListRooms' {
- maxResults :: Maybe Natural
- memberId :: Maybe Text
- nextToken :: Maybe Text
- accountId :: Text
}
newListRooms :: Text -> ListRooms
listRooms_maxResults :: Lens' ListRooms (Maybe Natural)
listRooms_memberId :: Lens' ListRooms (Maybe Text)
listRooms_nextToken :: Lens' ListRooms (Maybe Text)
listRooms_accountId :: Lens' ListRooms Text
data ListRoomsResponse = ListRoomsResponse' {
- nextToken :: Maybe Text
- rooms :: Maybe [Room]
- httpStatus :: Int
}
newListRoomsResponse :: Int -> ListRoomsResponse
listRoomsResponse_nextToken :: Lens' ListRoomsResponse (Maybe Text)
listRoomsResponse_rooms :: Lens' ListRoomsResponse (Maybe [Room])
listRoomsResponse_httpStatus :: Lens' ListRoomsResponse Int

Creating a Request

data ListRooms Source #

See: newListRooms smart constructor.

Constructors

ListRooms'
Fields maxResults :: Maybe Natural The maximum number of results to return in a single call. memberId :: Maybe Text The member ID (user ID or bot ID). nextToken :: Maybe Text The token to use to retrieve the next page of results. accountId :: Text The Amazon Chime account ID.

Instances

Instances details

ToHeaders ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms Methods toHeaders :: ListRooms -> [Header] #
ToPath ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms Methods toPath :: ListRooms -> ByteString #
ToQuery ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms Methods toQuery :: ListRooms -> QueryString #
AWSRequest ListRooms Source #
Instance details Defined in Amazonka.Chime.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.Chime.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.Chime.ListRooms Methods readsPrec :: Int -> ReadS ListRooms # readList :: ReadS [ListRooms] # readPrec :: ReadPrec ListRooms # readListPrec :: ReadPrec [ListRooms] #
Show ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms Methods showsPrec :: Int -> ListRooms -> ShowS # show :: ListRooms -> String # showList :: [ListRooms] -> ShowS #
NFData ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms Methods rnf :: ListRooms -> () #
Eq ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms Methods (==) :: ListRooms -> ListRooms -> Bool # (/=) :: ListRooms -> ListRooms -> Bool #
Hashable ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms Methods hashWithSalt :: Int -> ListRooms -> Int # hash :: ListRooms -> Int #
type AWSResponse ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms type AWSResponse ListRooms = ListRoomsResponse
type Rep ListRooms Source #
Instance details Defined in Amazonka.Chime.ListRooms type Rep ListRooms = D1 ('MetaData "ListRooms" "Amazonka.Chime.ListRooms" "amazonka-chime-2.0-AQIuSSkHccQ9VXokPBc5Nb" 'False) (C1 ('MetaCons "ListRooms'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "memberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListRooms Source #

Arguments

:: Text	`ListRooms`
-> ListRooms

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:maxResults:ListRooms', listRooms_maxResults - The maximum number of results to return in a single call.

ListRooms, listRooms_memberId - The member ID (user ID or bot ID).

ListRooms, listRooms_nextToken - The token to use to retrieve the next page of results.

ListRooms, listRooms_accountId - The Amazon Chime account ID.

Request Lenses

listRooms_maxResults :: Lens' ListRooms (Maybe Natural) Source #

The maximum number of results to return in a single call.

listRooms_memberId :: Lens' ListRooms (Maybe Text) Source #

The member ID (user ID or bot ID).

listRooms_nextToken :: Lens' ListRooms (Maybe Text) Source #

The token to use to retrieve the next page of results.

listRooms_accountId :: Lens' ListRooms Text Source #

The Amazon Chime account ID.

Destructuring the Response

data ListRoomsResponse Source #

See: newListRoomsResponse smart constructor.

Constructors

ListRoomsResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. rooms :: Maybe [Room] The room details. httpStatus :: Int The response's http status code.

Instances

Instances details

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

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 - The token to use to retrieve the next page of results.

$sel:rooms:ListRoomsResponse', listRoomsResponse_rooms - The room details.

$sel:httpStatus:ListRoomsResponse', listRoomsResponse_httpStatus - The response's http status code.

Response Lenses

listRoomsResponse_nextToken :: Lens' ListRoomsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results.

listRoomsResponse_rooms :: Lens' ListRoomsResponse (Maybe [Room]) Source #

The room details.

listRoomsResponse_httpStatus :: Lens' ListRoomsResponse Int Source #

The response's http status code.