Connect / Client / describe_agent_status



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

Describes an agent status.

See also: AWS API Documentation

Request Syntax

response = client.describe_agent_status(
  • InstanceId (string) –


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

  • AgentStatusId (string) –


    The identifier for the agent status.

Return type:



Response Syntax

    'AgentStatus': {
        'AgentStatusARN': 'string',
        'AgentStatusId': 'string',
        'Name': 'string',
        'Description': 'string',
        'Type': 'ROUTABLE'|'CUSTOM'|'OFFLINE',
        'DisplayOrder': 123,
        'State': 'ENABLED'|'DISABLED',
        'Tags': {
            'string': 'string'
        'LastModifiedTime': datetime(2015, 1, 1),
        'LastModifiedRegion': 'string'

Response Structure

  • (dict) –

    • AgentStatus (dict) –

      The agent status.

      • AgentStatusARN (string) –

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

      • AgentStatusId (string) –

        The identifier of the agent status.

      • Name (string) –

        The name of the agent status.

      • Description (string) –

        The description of the agent status.

      • Type (string) –

        The type of agent status.

      • DisplayOrder (integer) –

        The display order of the agent status.

      • State (string) –

        The state of the agent status.

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

        • (string) –

          • (string) –

      • LastModifiedTime (datetime) –

        The timestamp when this resource was last modified.

      • LastModifiedRegion (string) –

        The Amazon Web Services Region where this resource was last modified.


  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException