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.Connect.SearchRoutingProfiles

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This API is in preview release for Amazon Connect and is subject to change.

Searches routing profiles in an Amazon Connect instance, with optional filtering.

This operation returns paginated results.

Synopsis

Creating a Request

data SearchRoutingProfiles Source #

See: newSearchRoutingProfiles smart constructor.

Constructors

SearchRoutingProfiles'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page.
nextToken :: Maybe Text
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
searchCriteria :: Maybe RoutingProfileSearchCriteria
The search criteria to be used to return routing profiles.
The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.
searchFilter :: Maybe RoutingProfileSearchFilter
Filters to be applied to search results.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

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

newSearchRoutingProfiles Source #

Arguments

:: Text	`SearchRoutingProfiles`
-> SearchRoutingProfiles

Create a value of SearchRoutingProfiles 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:SearchRoutingProfiles', searchRoutingProfiles_maxResults - The maximum number of results to return per page.

SearchRoutingProfiles, searchRoutingProfiles_nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

$sel:searchCriteria:SearchRoutingProfiles', searchRoutingProfiles_searchCriteria - The search criteria to be used to return routing profiles.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

$sel:searchFilter:SearchRoutingProfiles', searchRoutingProfiles_searchFilter - Filters to be applied to search results.

SearchRoutingProfiles, searchRoutingProfiles_instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Request Lenses

searchRoutingProfiles_maxResults :: Lens' SearchRoutingProfiles (Maybe Natural) Source #

The maximum number of results to return per page.

searchRoutingProfiles_nextToken :: Lens' SearchRoutingProfiles (Maybe Text) Source #

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

searchRoutingProfiles_searchCriteria :: Lens' SearchRoutingProfiles (Maybe RoutingProfileSearchCriteria) Source #

The search criteria to be used to return routing profiles.

The name and description fields support "contains" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths outside of this range will throw invalid results.

searchRoutingProfiles_searchFilter :: Lens' SearchRoutingProfiles (Maybe RoutingProfileSearchFilter) Source #

Filters to be applied to search results.

searchRoutingProfiles_instanceId :: Lens' SearchRoutingProfiles Text Source #

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Destructuring the Response

data SearchRoutingProfilesResponse Source #

See: newSearchRoutingProfilesResponse smart constructor.

Constructors

SearchRoutingProfilesResponse'
Fields approximateTotalCount :: Maybe Integer The total number of routing profiles which matched your search query. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. routingProfiles :: Maybe [RoutingProfile] Information about the routing profiles. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic SearchRoutingProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchRoutingProfiles Associated Types type Rep SearchRoutingProfilesResponse :: Type -> Type # Methods from :: SearchRoutingProfilesResponse -> Rep SearchRoutingProfilesResponse x # to :: Rep SearchRoutingProfilesResponse x -> SearchRoutingProfilesResponse #
Read SearchRoutingProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchRoutingProfiles Methods readsPrec :: Int -> ReadS SearchRoutingProfilesResponse # readList :: ReadS [SearchRoutingProfilesResponse] # readPrec :: ReadPrec SearchRoutingProfilesResponse # readListPrec :: ReadPrec [SearchRoutingProfilesResponse] #
Show SearchRoutingProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchRoutingProfiles Methods showsPrec :: Int -> SearchRoutingProfilesResponse -> ShowS # show :: SearchRoutingProfilesResponse -> String # showList :: [SearchRoutingProfilesResponse] -> ShowS #
NFData SearchRoutingProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchRoutingProfiles Methods rnf :: SearchRoutingProfilesResponse -> () #
Eq SearchRoutingProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchRoutingProfiles Methods (==) :: SearchRoutingProfilesResponse -> SearchRoutingProfilesResponse -> Bool # (/=) :: SearchRoutingProfilesResponse -> SearchRoutingProfilesResponse -> Bool #
type Rep SearchRoutingProfilesResponse Source #
Instance details Defined in Amazonka.Connect.SearchRoutingProfiles type Rep SearchRoutingProfilesResponse = D1 ('MetaData "SearchRoutingProfilesResponse" "Amazonka.Connect.SearchRoutingProfiles" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchRoutingProfilesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "approximateTotalCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "routingProfiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RoutingProfile])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchRoutingProfilesResponse Source #

Arguments

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

Create a value of SearchRoutingProfilesResponse 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:approximateTotalCount:SearchRoutingProfilesResponse', searchRoutingProfilesResponse_approximateTotalCount - The total number of routing profiles which matched your search query.

SearchRoutingProfiles, searchRoutingProfilesResponse_nextToken - If there are additional results, this is the token for the next set of results.

SearchRoutingProfilesResponse, searchRoutingProfilesResponse_routingProfiles - Information about the routing profiles.

$sel:httpStatus:SearchRoutingProfilesResponse', searchRoutingProfilesResponse_httpStatus - The response's http status code.

Response Lenses

searchRoutingProfilesResponse_approximateTotalCount :: Lens' SearchRoutingProfilesResponse (Maybe Integer) Source #

The total number of routing profiles which matched your search query.

searchRoutingProfilesResponse_nextToken :: Lens' SearchRoutingProfilesResponse (Maybe Text) Source #

If there are additional results, this is the token for the next set of results.

searchRoutingProfilesResponse_routingProfiles :: Lens' SearchRoutingProfilesResponse (Maybe [RoutingProfile]) Source #

Information about the routing profiles.

searchRoutingProfilesResponse_httpStatus :: Lens' SearchRoutingProfilesResponse Int Source #

The response's http status code.