libZSservicesZSamazonka-connectZSamazonka-connect
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Connect.ListAgentStatuses

Description

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

Lists agent statuses.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAgentStatuses Source #

See: newListAgentStatuses smart constructor.

Constructors

ListAgentStatuses' 

Fields

Instances

Instances details
Eq ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Read ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Show ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Generic ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Associated Types

type Rep ListAgentStatuses :: Type -> Type #

NFData ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Methods

rnf :: ListAgentStatuses -> () #

Hashable ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

AWSPager ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

AWSRequest ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Associated Types

type AWSResponse ListAgentStatuses #

ToHeaders ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

ToPath ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

ToQuery ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

type Rep ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

type Rep ListAgentStatuses = D1 ('MetaData "ListAgentStatuses" "Amazonka.Connect.ListAgentStatuses" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListAgentStatuses'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "agentStatusTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AgentStatusType])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListAgentStatuses Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

newListAgentStatuses Source #

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:nextToken: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.

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

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

Request Lenses

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_maxResults :: Lens' ListAgentStatuses (Maybe Natural) Source #

The maximum number of results to return per page.

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

Instances

Instances details
Eq ListAgentStatusesResponse Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Read ListAgentStatusesResponse Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Show ListAgentStatusesResponse Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Generic ListAgentStatusesResponse Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

Associated Types

type Rep ListAgentStatusesResponse :: Type -> Type #

NFData ListAgentStatusesResponse Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

type Rep ListAgentStatusesResponse Source # 
Instance details

Defined in Amazonka.Connect.ListAgentStatuses

type Rep ListAgentStatusesResponse = D1 ('MetaData "ListAgentStatusesResponse" "Amazonka.Connect.ListAgentStatuses" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "ListAgentStatusesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "agentStatusSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AgentStatusSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAgentStatusesResponse Source #

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:nextToken:ListAgentStatuses', listAgentStatusesResponse_nextToken - If there are additional results, this is the token for the next set of results.

$sel:agentStatusSummaryList:ListAgentStatusesResponse', listAgentStatusesResponse_agentStatusSummaryList - A summary of agent statuses.

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

Response Lenses

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

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