ListAgentStatuses

class Connect.Paginator.ListAgentStatuses

paginator = client.get_paginator('list_agent_statuses')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_agent_statuses().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    AgentStatusTypes=[
        'ROUTABLE'|'CUSTOM'|'OFFLINE',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

• InstanceId (string) --

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• AgentStatusTypes (list) --

  Available agent status types.

  • (string) --
• PaginationConfig (dict) --

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'AgentStatusSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE'
        },
    ]
}

Response Structure

• (dict) --

  • AgentStatusSummaryList (list) --

    A summary of agent statuses.

    • (dict) --

      Summary information for an agent status.

      • Id (string) --

        The identifier for an agent status.

      • Arn (string) --

        The Amazon Resource Name (ARN) for the agent status.

      • Name (string) --

        The name of the agent status.

      • Type (string) --

        The type of the agent status.