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.SearchProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data SearchProfiles = SearchProfiles' {
- filters :: Maybe [Filter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortCriteria :: Maybe [Sort]
}
newSearchProfiles :: SearchProfiles
searchProfiles_filters :: Lens' SearchProfiles (Maybe [Filter])
searchProfiles_maxResults :: Lens' SearchProfiles (Maybe Natural)
searchProfiles_nextToken :: Lens' SearchProfiles (Maybe Text)
searchProfiles_sortCriteria :: Lens' SearchProfiles (Maybe [Sort])
data SearchProfilesResponse = SearchProfilesResponse' {
- nextToken :: Maybe Text
- profiles :: Maybe [ProfileData]
- totalCount :: Maybe Int
- httpStatus :: Int
}
newSearchProfilesResponse :: Int -> SearchProfilesResponse
searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text)
searchProfilesResponse_profiles :: Lens' SearchProfilesResponse (Maybe [ProfileData])
searchProfilesResponse_totalCount :: Lens' SearchProfilesResponse (Maybe Int)
searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int

Creating a Request

data SearchProfiles Source #

See: newSearchProfiles smart constructor.

Constructors

SearchProfiles'

Fields

filters :: Maybe [Filter]
The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
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 room profiles. Supported sort keys are ProfileName and Address.

Instances

Instances details

ToJSON SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods toJSON :: SearchProfiles -> Value # toEncoding :: SearchProfiles -> Encoding # toJSONList :: [SearchProfiles] -> Value # toEncodingList :: [SearchProfiles] -> Encoding #
ToHeaders SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods toHeaders :: SearchProfiles -> [Header] #
ToPath SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods toPath :: SearchProfiles -> ByteString #
ToQuery SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods toQuery :: SearchProfiles -> QueryString #
AWSPager SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods page :: SearchProfiles -> AWSResponse SearchProfiles -> Maybe SearchProfiles #
AWSRequest SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Associated Types type AWSResponse SearchProfiles # Methods request :: (Service -> Service) -> SearchProfiles -> Request SearchProfiles # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchProfiles))) #
Generic SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Associated Types type Rep SearchProfiles :: Type -> Type # Methods from :: SearchProfiles -> Rep SearchProfiles x # to :: Rep SearchProfiles x -> SearchProfiles #
Read SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods readsPrec :: Int -> ReadS SearchProfiles # readList :: ReadS [SearchProfiles] # readPrec :: ReadPrec SearchProfiles # readListPrec :: ReadPrec [SearchProfiles] #
Show SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods showsPrec :: Int -> SearchProfiles -> ShowS # show :: SearchProfiles -> String # showList :: [SearchProfiles] -> ShowS #
NFData SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods rnf :: SearchProfiles -> () #
Eq SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods (==) :: SearchProfiles -> SearchProfiles -> Bool # (/=) :: SearchProfiles -> SearchProfiles -> Bool #
Hashable SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles Methods hashWithSalt :: Int -> SearchProfiles -> Int # hash :: SearchProfiles -> Int #
type AWSResponse SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles type AWSResponse SearchProfiles = SearchProfilesResponse
type Rep SearchProfiles Source #
Instance details Defined in Amazonka.AlexaBusiness.SearchProfiles type Rep SearchProfiles = D1 ('MetaData "SearchProfiles" "Amazonka.AlexaBusiness.SearchProfiles" "amazonka-alexa-business-2.0-BWvKfxFukoyBarGovAkdOS" 'False) (C1 ('MetaCons "SearchProfiles'" '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])))))

newSearchProfiles :: SearchProfiles Source #

Create a value of SearchProfiles 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:SearchProfiles', searchProfiles_filters - The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.

$sel:maxResults:SearchProfiles', searchProfiles_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.

SearchProfiles, searchProfiles_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:SearchProfiles', searchProfiles_sortCriteria - The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.

Request Lenses

searchProfiles_filters :: Lens' SearchProfiles (Maybe [Filter]) Source #

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

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

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

searchProfiles_sortCriteria :: Lens' SearchProfiles (Maybe [Sort]) Source #

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

Destructuring the Response

data SearchProfilesResponse Source #

See: newSearchProfilesResponse smart constructor.

Constructors

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

Instances

Instances details

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

newSearchProfilesResponse Source #

Arguments

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

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

SearchProfiles, searchProfilesResponse_nextToken - The token returned to indicate that there is more data available.

$sel:profiles:SearchProfilesResponse', searchProfilesResponse_profiles - The profiles that meet the specified set of filter criteria, in sort order.

$sel:totalCount:SearchProfilesResponse', searchProfilesResponse_totalCount - The total number of room profiles returned.

$sel:httpStatus:SearchProfilesResponse', searchProfilesResponse_httpStatus - The response's http status code.

Response Lenses

searchProfilesResponse_nextToken :: Lens' SearchProfilesResponse (Maybe Text) Source #

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

searchProfilesResponse_profiles :: Lens' SearchProfilesResponse (Maybe [ProfileData]) Source #

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

searchProfilesResponse_totalCount :: Lens' SearchProfilesResponse (Maybe Int) Source #

The total number of room profiles returned.

searchProfilesResponse_httpStatus :: Lens' SearchProfilesResponse Int Source #

The response's http status code.