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

*******************
create_agent_status
*******************



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

  

  Creates an agent status for the specified Amazon Connect instance.

  

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


  **Request Syntax**
  ::

    response = client.create_agent_status(
        InstanceId='string',
        Name='string',
        Description='string',
        State='ENABLED'|'DISABLED',
        DisplayOrder=123,
        Tags={
            'string': '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 Name: string
  :param Name: **[REQUIRED]** 

    The name of the status.

    

  
  :type Description: string
  :param Description: 

    The description of the status.

    

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

    The state of the status.

    

  
  :type DisplayOrder: integer
  :param DisplayOrder: 

    The display order of the status.

    

  
  :type Tags: dict
  :param Tags: 

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

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'AgentStatusARN': 'string',
          'AgentStatusId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AgentStatusARN** *(string) --* 

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

        
      

      - **AgentStatusId** *(string) --* 

        The identifier of the agent status.

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

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

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

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

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

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

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

  