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

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 queues in an Amazon Connect instance, with optional filtering.

This operation returns paginated results.

Synopsis

data SearchQueues = SearchQueues' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- searchCriteria :: Maybe QueueSearchCriteria
- searchFilter :: Maybe QueueSearchFilter
- instanceId :: Text
}
newSearchQueues :: Text -> SearchQueues
searchQueues_maxResults :: Lens' SearchQueues (Maybe Natural)
searchQueues_nextToken :: Lens' SearchQueues (Maybe Text)
searchQueues_searchCriteria :: Lens' SearchQueues (Maybe QueueSearchCriteria)
searchQueues_searchFilter :: Lens' SearchQueues (Maybe QueueSearchFilter)
searchQueues_instanceId :: Lens' SearchQueues Text
data SearchQueuesResponse = SearchQueuesResponse' {
- approximateTotalCount :: Maybe Integer
- nextToken :: Maybe Text
- queues :: Maybe [Queue]
- httpStatus :: Int
}
newSearchQueuesResponse :: Int -> SearchQueuesResponse
searchQueuesResponse_approximateTotalCount :: Lens' SearchQueuesResponse (Maybe Integer)
searchQueuesResponse_nextToken :: Lens' SearchQueuesResponse (Maybe Text)
searchQueuesResponse_queues :: Lens' SearchQueuesResponse (Maybe [Queue])
searchQueuesResponse_httpStatus :: Lens' SearchQueuesResponse Int

Creating a Request

data SearchQueues Source #

See: newSearchQueues smart constructor.

Constructors

SearchQueues'

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 QueueSearchCriteria
The search criteria to be used to return queues.
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 QueueSearchFilter
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 SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods toJSON :: SearchQueues -> Value # toEncoding :: SearchQueues -> Encoding # toJSONList :: [SearchQueues] -> Value # toEncodingList :: [SearchQueues] -> Encoding #
ToHeaders SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods toHeaders :: SearchQueues -> [Header] #
ToPath SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods toPath :: SearchQueues -> ByteString #
ToQuery SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods toQuery :: SearchQueues -> QueryString #
AWSPager SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods page :: SearchQueues -> AWSResponse SearchQueues -> Maybe SearchQueues #
AWSRequest SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Associated Types type AWSResponse SearchQueues # Methods request :: (Service -> Service) -> SearchQueues -> Request SearchQueues # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SearchQueues -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SearchQueues))) #
Generic SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Associated Types type Rep SearchQueues :: Type -> Type # Methods from :: SearchQueues -> Rep SearchQueues x # to :: Rep SearchQueues x -> SearchQueues #
Read SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods readsPrec :: Int -> ReadS SearchQueues # readList :: ReadS [SearchQueues] # readPrec :: ReadPrec SearchQueues # readListPrec :: ReadPrec [SearchQueues] #
Show SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods showsPrec :: Int -> SearchQueues -> ShowS # show :: SearchQueues -> String # showList :: [SearchQueues] -> ShowS #
NFData SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods rnf :: SearchQueues -> () #
Eq SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods (==) :: SearchQueues -> SearchQueues -> Bool # (/=) :: SearchQueues -> SearchQueues -> Bool #
Hashable SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods hashWithSalt :: Int -> SearchQueues -> Int # hash :: SearchQueues -> Int #
type AWSResponse SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues type AWSResponse SearchQueues = SearchQueuesResponse
type Rep SearchQueues Source #
Instance details Defined in Amazonka.Connect.SearchQueues type Rep SearchQueues = D1 ('MetaData "SearchQueues" "Amazonka.Connect.SearchQueues" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchQueues'" '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 QueueSearchCriteria)) :: (S1 ('MetaSel ('Just "searchFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueueSearchFilter)) :: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSearchQueues Source #

Arguments

:: Text	`SearchQueues`
-> SearchQueues

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

SearchQueues, searchQueues_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:SearchQueues', searchQueues_searchCriteria - The search criteria to be used to return queues.

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:SearchQueues', searchQueues_searchFilter - Filters to be applied to search results.

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

Request Lenses

searchQueues_maxResults :: Lens' SearchQueues (Maybe Natural) Source #

The maximum number of results to return per page.

searchQueues_nextToken :: Lens' SearchQueues (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.

searchQueues_searchCriteria :: Lens' SearchQueues (Maybe QueueSearchCriteria) Source #

The search criteria to be used to return queues.

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.

searchQueues_searchFilter :: Lens' SearchQueues (Maybe QueueSearchFilter) Source #

Filters to be applied to search results.

searchQueues_instanceId :: Lens' SearchQueues Text Source #

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

Destructuring the Response

data SearchQueuesResponse Source #

See: newSearchQueuesResponse smart constructor.

Constructors

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

Instances

Instances details

Generic SearchQueuesResponse Source #
Instance details Defined in Amazonka.Connect.SearchQueues Associated Types type Rep SearchQueuesResponse :: Type -> Type # Methods from :: SearchQueuesResponse -> Rep SearchQueuesResponse x # to :: Rep SearchQueuesResponse x -> SearchQueuesResponse #
Read SearchQueuesResponse Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods readsPrec :: Int -> ReadS SearchQueuesResponse # readList :: ReadS [SearchQueuesResponse] # readPrec :: ReadPrec SearchQueuesResponse # readListPrec :: ReadPrec [SearchQueuesResponse] #
Show SearchQueuesResponse Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods showsPrec :: Int -> SearchQueuesResponse -> ShowS # show :: SearchQueuesResponse -> String # showList :: [SearchQueuesResponse] -> ShowS #
NFData SearchQueuesResponse Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods rnf :: SearchQueuesResponse -> () #
Eq SearchQueuesResponse Source #
Instance details Defined in Amazonka.Connect.SearchQueues Methods (==) :: SearchQueuesResponse -> SearchQueuesResponse -> Bool # (/=) :: SearchQueuesResponse -> SearchQueuesResponse -> Bool #
type Rep SearchQueuesResponse Source #
Instance details Defined in Amazonka.Connect.SearchQueues type Rep SearchQueuesResponse = D1 ('MetaData "SearchQueuesResponse" "Amazonka.Connect.SearchQueues" "amazonka-connect-2.0-IAACrecRcUS5AABe9BOFyN" 'False) (C1 ('MetaCons "SearchQueuesResponse'" '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 "queues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Queue])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchQueuesResponse Source #

Arguments

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

Create a value of SearchQueuesResponse 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:SearchQueuesResponse', searchQueuesResponse_approximateTotalCount - The total number of queues which matched your search query.

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

SearchQueuesResponse, searchQueuesResponse_queues - Information about the queues.

$sel:httpStatus:SearchQueuesResponse', searchQueuesResponse_httpStatus - The response's http status code.

Response Lenses

searchQueuesResponse_approximateTotalCount :: Lens' SearchQueuesResponse (Maybe Integer) Source #

The total number of queues which matched your search query.

searchQueuesResponse_nextToken :: Lens' SearchQueuesResponse (Maybe Text) Source #

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

searchQueuesResponse_queues :: Lens' SearchQueuesResponse (Maybe [Queue]) Source #

Information about the queues.

searchQueuesResponse_httpStatus :: Lens' SearchQueuesResponse Int Source #

The response's http status code.