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.AlexaBusiness.SearchRooms

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data SearchRooms = SearchRooms' {
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortCriteria :: Maybe [Sort]
}
newSearchRooms :: SearchRooms
searchRooms_filters :: Lens' SearchRooms (Maybe [Filter])
searchRooms_maxResults :: Lens' SearchRooms (Maybe Natural)
searchRooms_nextToken :: Lens' SearchRooms (Maybe Text)
searchRooms_sortCriteria :: Lens' SearchRooms (Maybe [Sort])
data SearchRoomsResponse = SearchRoomsResponse' {
- nextToken :: Maybe Text
- rooms :: Maybe [RoomData]
- totalCount :: Maybe Int
- httpStatus :: Int
}
newSearchRoomsResponse :: Int -> SearchRoomsResponse
searchRoomsResponse_nextToken :: Lens' SearchRoomsResponse (Maybe Text)
searchRoomsResponse_rooms :: Lens' SearchRoomsResponse (Maybe [RoomData])
searchRoomsResponse_totalCount :: Lens' SearchRoomsResponse (Maybe Int)
searchRoomsResponse_httpStatus :: Lens' SearchRoomsResponse Int

Creating a Request

data SearchRooms Source #

See: newSearchRooms smart constructor.

Constructors

SearchRooms'

Fields

filters :: Maybe [Filter]
The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
maxResults :: Maybe Natural
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.
nextToken :: Maybe Text
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.
sortCriteria :: Maybe [Sort]
The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

Instances

Instances details

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

newSearchRooms :: SearchRooms Source #

Create a value of SearchRooms 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:filters:SearchRooms', searchRooms_filters - The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.

$sel:maxResults:SearchRooms', searchRooms_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.

SearchRooms, searchRooms_nextToken - 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.

$sel:sortCriteria:SearchRooms', searchRooms_sortCriteria - The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.

Request Lenses

searchRooms_filters :: Lens' SearchRooms (Maybe [Filter]) Source #

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

searchRooms_maxResults :: 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.

searchRooms_nextToken :: 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.

searchRooms_sortCriteria :: Lens' SearchRooms (Maybe [Sort]) Source #

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

Destructuring the Response

data SearchRoomsResponse Source #

See: newSearchRoomsResponse smart constructor.

Constructors

SearchRoomsResponse'
Fields nextToken :: Maybe Text The token returned to indicate that there is more data available. rooms :: Maybe [RoomData] The rooms that meet the specified set of filter criteria, in sort order. totalCount :: Maybe Int The total number of rooms returned. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newSearchRoomsResponse Source #

Arguments

:: Int	`$sel:httpStatus:SearchRoomsResponse'`
-> SearchRoomsResponse

Create a value of SearchRoomsResponse 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:

SearchRooms, searchRoomsResponse_nextToken - The token returned to indicate that there is more data available.

$sel:rooms:SearchRoomsResponse', searchRoomsResponse_rooms - The rooms that meet the specified set of filter criteria, in sort order.

$sel:totalCount:SearchRoomsResponse', searchRoomsResponse_totalCount - The total number of rooms returned.

$sel:httpStatus:SearchRoomsResponse', searchRoomsResponse_httpStatus - The response's http status code.

Response Lenses

searchRoomsResponse_nextToken :: Lens' SearchRoomsResponse (Maybe Text) Source #

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

searchRoomsResponse_rooms :: Lens' SearchRoomsResponse (Maybe [RoomData]) Source #

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

searchRoomsResponse_totalCount :: Lens' SearchRoomsResponse (Maybe Int) Source #

The total number of rooms returned.

searchRoomsResponse_httpStatus :: Lens' SearchRoomsResponse Int Source #

The response's http status code.