Network.AWS.AlexaBusiness.SearchRooms

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

This operation returns paginated results.

Creating a Request

searchRooms :: SearchRooms

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 by MaxResults .
• srMaxResults - 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.

data SearchRooms

See: searchRooms smart constructor.

Instances

Eq SearchRooms

Methods

(==) :: SearchRooms -> SearchRooms -> Bool

(/=) :: SearchRooms -> SearchRooms -> Bool

Data SearchRooms

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchRooms -> c SearchRooms

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchRooms

toConstr :: SearchRooms -> Constr

dataTypeOf :: SearchRooms -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchRooms)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchRooms)

gmapT :: (forall b. Data b => b -> b) -> SearchRooms -> SearchRooms

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchRooms -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchRooms -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchRooms -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchRooms -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchRooms -> m SearchRooms

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchRooms -> m SearchRooms

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchRooms -> m SearchRooms

Read SearchRooms

Methods

readsPrec :: Int -> ReadS SearchRooms

readList :: ReadS [SearchRooms]

readPrec :: ReadPrec SearchRooms

readListPrec :: ReadPrec [SearchRooms]

Show SearchRooms

Methods

showsPrec :: Int -> SearchRooms -> ShowS

show :: SearchRooms -> String

showList :: [SearchRooms] -> ShowS

Generic SearchRooms

Associated Types

type Rep SearchRooms :: * -> *

Methods

from :: SearchRooms -> Rep SearchRooms x

to :: Rep SearchRooms x -> SearchRooms

Hashable SearchRooms

Methods

hashWithSalt :: Int -> SearchRooms -> Int

hash :: SearchRooms -> Int

ToJSON SearchRooms

Methods

toJSON :: SearchRooms -> Value

toEncoding :: SearchRooms -> Encoding

toJSONList :: [SearchRooms] -> Value

toEncodingList :: [SearchRooms] -> Encoding

NFData SearchRooms

Methods

rnf :: SearchRooms -> ()

AWSPager SearchRooms

Methods

page :: SearchRooms -> Rs SearchRooms -> Maybe SearchRooms

AWSRequest SearchRooms

Associated Types

type Rs SearchRooms :: *

Methods

request :: SearchRooms -> Request SearchRooms

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * SearchRooms -> ClientResponse -> m (Response SearchRooms)

ToHeaders SearchRooms

Methods

toHeaders :: SearchRooms -> [Header]

ToPath SearchRooms

Methods

toPath :: SearchRooms -> ByteString

ToQuery SearchRooms

Methods

toQuery :: SearchRooms -> QueryString

type Rep SearchRooms

type Rep SearchRooms = D1 * (MetaData "SearchRooms" "Network.AWS.AlexaBusiness.SearchRooms" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchRooms'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_srFilters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Filter]))) (S1 * (MetaSel (Just Symbol "_srSortCriteria") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Sort])))) ((:*:) * (S1 * (MetaSel (Just Symbol "_srNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_srMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs SearchRooms

type Rs SearchRooms = SearchRoomsResponse

Request Lenses

srFilters :: Lens' SearchRooms [Filter]

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

srSortCriteria :: Lens' SearchRooms [Sort]

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)

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)

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

searchRoomsResponse

Arguments

:: Int

srrsResponseStatus

-> SearchRoomsResponse

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

See: searchRoomsResponse smart constructor.

Instances

Eq SearchRoomsResponse

Methods

(==) :: SearchRoomsResponse -> SearchRoomsResponse -> Bool

(/=) :: SearchRoomsResponse -> SearchRoomsResponse -> Bool

Data SearchRoomsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SearchRoomsResponse -> c SearchRoomsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SearchRoomsResponse

toConstr :: SearchRoomsResponse -> Constr

dataTypeOf :: SearchRoomsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SearchRoomsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SearchRoomsResponse)

gmapT :: (forall b. Data b => b -> b) -> SearchRoomsResponse -> SearchRoomsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SearchRoomsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SearchRoomsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> SearchRoomsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> SearchRoomsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SearchRoomsResponse -> m SearchRoomsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchRoomsResponse -> m SearchRoomsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SearchRoomsResponse -> m SearchRoomsResponse

Read SearchRoomsResponse

Methods

readsPrec :: Int -> ReadS SearchRoomsResponse

readList :: ReadS [SearchRoomsResponse]

readPrec :: ReadPrec SearchRoomsResponse

readListPrec :: ReadPrec [SearchRoomsResponse]

Show SearchRoomsResponse

Methods

showsPrec :: Int -> SearchRoomsResponse -> ShowS

show :: SearchRoomsResponse -> String

showList :: [SearchRoomsResponse] -> ShowS

Generic SearchRoomsResponse

Associated Types

type Rep SearchRoomsResponse :: * -> *

Methods

from :: SearchRoomsResponse -> Rep SearchRoomsResponse x

to :: Rep SearchRoomsResponse x -> SearchRoomsResponse

NFData SearchRoomsResponse

Methods

rnf :: SearchRoomsResponse -> ()

type Rep SearchRoomsResponse

type Rep SearchRoomsResponse = D1 * (MetaData "SearchRoomsResponse" "Network.AWS.AlexaBusiness.SearchRooms" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchRoomsResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_srrsRooms") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [RoomData]))) (S1 * (MetaSel (Just Symbol "_srrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_srrsTotalCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_srrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

srrsRooms :: Lens' SearchRoomsResponse [RoomData]

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

srrsNextToken :: Lens' SearchRoomsResponse (Maybe Text)

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

srrsTotalCount :: Lens' SearchRoomsResponse (Maybe Int)

The total number of rooms returned.

srrsResponseStatus :: Lens' SearchRoomsResponse Int

• - | The response status code.