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

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.

Lists agent statuses.

This operation returns paginated results.

Synopsis

data ListAgentStatuses = ListAgentStatuses' {
- agentStatusTypes :: Maybe [AgentStatusType]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- instanceId :: Text
}
newListAgentStatuses :: Text -> ListAgentStatuses
listAgentStatuses_agentStatusTypes :: Lens' ListAgentStatuses (Maybe [AgentStatusType])
listAgentStatuses_maxResults :: Lens' ListAgentStatuses (Maybe Natural)
listAgentStatuses_nextToken :: Lens' ListAgentStatuses (Maybe Text)
listAgentStatuses_instanceId :: Lens' ListAgentStatuses Text
data ListAgentStatusesResponse = ListAgentStatusesResponse' {
- agentStatusSummaryList :: Maybe [AgentStatusSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAgentStatusesResponse :: Int -> ListAgentStatusesResponse
listAgentStatusesResponse_agentStatusSummaryList :: Lens' ListAgentStatusesResponse (Maybe [AgentStatusSummary])
listAgentStatusesResponse_nextToken :: Lens' ListAgentStatusesResponse (Maybe Text)
listAgentStatusesResponse_httpStatus :: Lens' ListAgentStatusesResponse Int

Creating a Request

data ListAgentStatuses Source #

See: newListAgentStatuses smart constructor.

Constructors

ListAgentStatuses'

Fields

agentStatusTypes :: Maybe [AgentStatusType]
Available agent status types.
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.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Instances

Instances details

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

newListAgentStatuses Source #

Arguments

:: Text	`ListAgentStatuses`
-> ListAgentStatuses

Create a value of ListAgentStatuses 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:agentStatusTypes:ListAgentStatuses', listAgentStatuses_agentStatusTypes - Available agent status types.

$sel:maxResults:ListAgentStatuses', listAgentStatuses_maxResults - The maximum number of results to return per page.

ListAgentStatuses, listAgentStatuses_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.

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

Request Lenses

listAgentStatuses_agentStatusTypes :: Lens' ListAgentStatuses (Maybe [AgentStatusType]) Source #

Available agent status types.

listAgentStatuses_maxResults :: Lens' ListAgentStatuses (Maybe Natural) Source #

The maximum number of results to return per page.

listAgentStatuses_nextToken :: Lens' ListAgentStatuses (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.

listAgentStatuses_instanceId :: Lens' ListAgentStatuses Text Source #

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

Destructuring the Response

data ListAgentStatusesResponse Source #

See: newListAgentStatusesResponse smart constructor.

Constructors

ListAgentStatusesResponse'
Fields agentStatusSummaryList :: Maybe [AgentStatusSummary] A summary of agent statuses. nextToken :: Maybe Text If there are additional results, this is the token for the next set of results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListAgentStatusesResponse Source #

Arguments

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

Create a value of ListAgentStatusesResponse 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:agentStatusSummaryList:ListAgentStatusesResponse', listAgentStatusesResponse_agentStatusSummaryList - A summary of agent statuses.

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

$sel:httpStatus:ListAgentStatusesResponse', listAgentStatusesResponse_httpStatus - The response's http status code.

Response Lenses

listAgentStatusesResponse_agentStatusSummaryList :: Lens' ListAgentStatusesResponse (Maybe [AgentStatusSummary]) Source #

A summary of agent statuses.

listAgentStatusesResponse_nextToken :: Lens' ListAgentStatusesResponse (Maybe Text) Source #

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

listAgentStatusesResponse_httpStatus :: Lens' ListAgentStatusesResponse Int Source #

The response's http status code.