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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides information about the queues for the specified Amazon Connect instance.

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data ListQueues Source #

See: newListQueues smart constructor.

Constructors

ListQueues'

Fields

maxResults :: Maybe Natural
The maximum number of results to return per page. The default MaxResult size is 100.
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.
queueTypes :: Maybe [QueueType]
The type of queue.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

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

newListQueues Source #

Arguments

:: Text	`ListQueues`
-> ListQueues

Create a value of ListQueues 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:ListQueues', listQueues_maxResults - The maximum number of results to return per page. The default MaxResult size is 100.

ListQueues, listQueues_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:queueTypes:ListQueues', listQueues_queueTypes - The type of queue.

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

Request Lenses

listQueues_maxResults :: Lens' ListQueues (Maybe Natural) Source #

The maximum number of results to return per page. The default MaxResult size is 100.

listQueues_nextToken :: Lens' ListQueues (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.

listQueues_queueTypes :: Lens' ListQueues (Maybe [QueueType]) Source #

The type of queue.

listQueues_instanceId :: Lens' ListQueues Text Source #

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

Destructuring the Response

data ListQueuesResponse Source #

See: newListQueuesResponse smart constructor.

Constructors

ListQueuesResponse'
Fields nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. queueSummaryList :: Maybe [QueueSummary] Information about the queues. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListQueuesResponse Source #

Arguments

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

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

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

$sel:queueSummaryList:ListQueuesResponse', listQueuesResponse_queueSummaryList - Information about the queues.

$sel:httpStatus:ListQueuesResponse', listQueuesResponse_httpStatus - The response's http status code.

Response Lenses

listQueuesResponse_nextToken :: Lens' ListQueuesResponse (Maybe Text) Source #

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

listQueuesResponse_queueSummaryList :: Lens' ListQueuesResponse (Maybe [QueueSummary]) Source #

Information about the queues.

listQueuesResponse_httpStatus :: Lens' ListQueuesResponse Int Source #

The response's http status code.