:doc:`Connect <../../connect>` / Client / describe_agent_status

*********************
describe_agent_status
*********************



.. py:method:: Connect.Client.describe_agent_status(**kwargs)

  

  Describes an agent status.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeAgentStatus>`_  


  **Request Syntax**
  ::

    response = client.describe_agent_status(
        InstanceId='string',
        AgentStatusId='string'
    )
    
  :type InstanceId: string
  :param InstanceId: **[REQUIRED]** 

    The identifier of the Amazon Connect instance. You can `find the instance ID <https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html>`__ in the Amazon Resource Name (ARN) of the instance.

    

  
  :type AgentStatusId: string
  :param AgentStatusId: **[REQUIRED]** 

    The identifier for the agent status.

    

  
  
  :rtype: dict
  :returns: 
    
    **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.

          
    
  
  **Exceptions**
  
  *   :py:class:`Connect.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Connect.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`Connect.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Connect.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Connect.Client.exceptions.InternalServiceException`

  