list_agent_statuses

list_agent_statuses(**kwargs)

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

Lists agent statuses.

See also: AWS API Documentation

Request Syntax

response = client.list_agent_statuses(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    AgentStatusTypes=[
        'ROUTABLE'|'CUSTOM'|'OFFLINE',
    ]
)

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.

• NextToken (string) -- 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.
• MaxResults (integer) -- The maximum number of results to return per page.
• AgentStatusTypes (list) --

  Available agent status types.

  • (string) --

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • NextToken (string) --

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

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

Exceptions

• Connect.Client.exceptions.InvalidRequestException
• Connect.Client.exceptions.InvalidParameterException
• Connect.Client.exceptions.ResourceNotFoundException
• Connect.Client.exceptions.ThrottlingException
• Connect.Client.exceptions.InternalServiceException