Network.AWS.AlexaBusiness.SearchProfiles

Searches room profiles and lists the ones that meet a set of filter criteria.

This operation returns paginated results.

Creating a Request

searchProfiles :: SearchProfiles

Creates a value of SearchProfiles with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• spFilters - The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
• spSortCriteria - The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
• spNextToken - 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 .
• spMaxResults - 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 SearchProfiles

See: searchProfiles smart constructor.

Instances

Eq SearchProfiles

Methods

(==) :: SearchProfiles -> SearchProfiles -> Bool

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

Data SearchProfiles

Methods

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

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

toConstr :: SearchProfiles -> Constr

dataTypeOf :: SearchProfiles -> DataType

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

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

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

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

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

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

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

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

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

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

Read SearchProfiles

Methods

readsPrec :: Int -> ReadS SearchProfiles

readList :: ReadS [SearchProfiles]

readPrec :: ReadPrec SearchProfiles

readListPrec :: ReadPrec [SearchProfiles]

Show SearchProfiles

Methods

showsPrec :: Int -> SearchProfiles -> ShowS

show :: SearchProfiles -> String

showList :: [SearchProfiles] -> ShowS

Generic SearchProfiles

Associated Types

type Rep SearchProfiles :: * -> *

Methods

from :: SearchProfiles -> Rep SearchProfiles x

to :: Rep SearchProfiles x -> SearchProfiles

Hashable SearchProfiles

Methods

hashWithSalt :: Int -> SearchProfiles -> Int

hash :: SearchProfiles -> Int

ToJSON SearchProfiles

Methods

toJSON :: SearchProfiles -> Value

toEncoding :: SearchProfiles -> Encoding

toJSONList :: [SearchProfiles] -> Value

toEncodingList :: [SearchProfiles] -> Encoding

NFData SearchProfiles

Methods

rnf :: SearchProfiles -> ()

AWSPager SearchProfiles

Methods

page :: SearchProfiles -> Rs SearchProfiles -> Maybe SearchProfiles

AWSRequest SearchProfiles

Associated Types

type Rs SearchProfiles :: *

Methods

request :: SearchProfiles -> Request SearchProfiles

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

ToHeaders SearchProfiles

Methods

toHeaders :: SearchProfiles -> [Header]

ToPath SearchProfiles

Methods

toPath :: SearchProfiles -> ByteString

ToQuery SearchProfiles

Methods

toQuery :: SearchProfiles -> QueryString

type Rep SearchProfiles

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

type Rs SearchProfiles

type Rs SearchProfiles = SearchProfilesResponse

Request Lenses

spFilters :: Lens' SearchProfiles [Filter]

The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

spSortCriteria :: Lens' SearchProfiles [Sort]

The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

spNextToken :: Lens' SearchProfiles (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 .

spMaxResults :: Lens' SearchProfiles (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

searchProfilesResponse

Arguments

:: Int

sprsResponseStatus

-> SearchProfilesResponse

Creates a value of SearchProfilesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• sprsProfiles - The profiles that meet the specified set of filter criteria, in sort order.
• sprsNextToken - The token returned to indicate that there is more data available.
• sprsTotalCount - The total number of room profiles returned.
• sprsResponseStatus - -- | The response status code.

data SearchProfilesResponse

See: searchProfilesResponse smart constructor.

Instances

Eq SearchProfilesResponse

Methods

(==) :: SearchProfilesResponse -> SearchProfilesResponse -> Bool

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

Data SearchProfilesResponse

Methods

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

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

toConstr :: SearchProfilesResponse -> Constr

dataTypeOf :: SearchProfilesResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read SearchProfilesResponse

Methods

readsPrec :: Int -> ReadS SearchProfilesResponse

readList :: ReadS [SearchProfilesResponse]

readPrec :: ReadPrec SearchProfilesResponse

readListPrec :: ReadPrec [SearchProfilesResponse]

Show SearchProfilesResponse

Methods

showsPrec :: Int -> SearchProfilesResponse -> ShowS

show :: SearchProfilesResponse -> String

showList :: [SearchProfilesResponse] -> ShowS

Generic SearchProfilesResponse

Associated Types

type Rep SearchProfilesResponse :: * -> *

Methods

from :: SearchProfilesResponse -> Rep SearchProfilesResponse x

to :: Rep SearchProfilesResponse x -> SearchProfilesResponse

NFData SearchProfilesResponse

Methods

rnf :: SearchProfilesResponse -> ()

type Rep SearchProfilesResponse

type Rep SearchProfilesResponse = D1 * (MetaData "SearchProfilesResponse" "Network.AWS.AlexaBusiness.SearchProfiles" "amazonka-alexa-business-1.6.0-DI5T43QkJWfD1hlGpmjsnd" False) (C1 * (MetaCons "SearchProfilesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_sprsProfiles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ProfileData]))) (S1 * (MetaSel (Just Symbol "_sprsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sprsTotalCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))) (S1 * (MetaSel (Just Symbol "_sprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

sprsProfiles :: Lens' SearchProfilesResponse [ProfileData]

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

sprsNextToken :: Lens' SearchProfilesResponse (Maybe Text)

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

sprsTotalCount :: Lens' SearchProfilesResponse (Maybe Int)

The total number of room profiles returned.

sprsResponseStatus :: Lens' SearchProfilesResponse Int

• - | The response status code.