:doc:`GroundStation <../../groundstation>` / Client / update_agent_status

*******************
update_agent_status
*******************



.. py:method:: GroundStation.Client.update_agent_status(**kwargs)

  

  

  .. note::

    

    For use by AWS Ground Station Agent and shouldn't be called directly.

    

   

  Update the status of the agent.

  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateAgentStatus>`_  


  **Request Syntax**
  ::

    response = client.update_agent_status(
        agentId='string',
        taskId='string',
        aggregateStatus={
            'status': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
            'signatureMap': {
                'string': True|False
            }
        },
        componentStatuses=[
            {
                'componentType': 'string',
                'capabilityArn': 'string',
                'status': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
                'bytesSent': 123,
                'bytesReceived': 123,
                'packetsDropped': 123,
                'dataflowId': 'string'
            },
        ]
    )
    
  :type agentId: string
  :param agentId: **[REQUIRED]** 

    UUID of agent to update.

    

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

    GUID of agent task.

    

  
  :type aggregateStatus: dict
  :param aggregateStatus: **[REQUIRED]** 

    Aggregate status for agent.

    

  
    - **status** *(string) --* **[REQUIRED]** 

      Aggregate status.

      

    
    - **signatureMap** *(dict) --* 

      Sparse map of failure signatures.

      

    
      - *(string) --* 

      
        - *(boolean) --* 

        
  

  
  :type componentStatuses: list
  :param componentStatuses: **[REQUIRED]** 

    List of component statuses for agent.

    

  
    - *(dict) --* 

      Data on the status of agent components.

      

    
      - **componentType** *(string) --* **[REQUIRED]** 

        The Component type.

        

      
      - **capabilityArn** *(string) --* **[REQUIRED]** 

        Capability ARN of the component.

        

      
      - **status** *(string) --* **[REQUIRED]** 

        Component status.

        

      
      - **bytesSent** *(integer) --* 

        Bytes sent by the component.

        

      
      - **bytesReceived** *(integer) --* 

        Bytes received by the component.

        

      
      - **packetsDropped** *(integer) --* 

        Packets dropped by component.

        

      
      - **dataflowId** *(string) --* **[REQUIRED]** 

        Dataflow UUID associated with the component.

        

      
    

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

    
    ::

      {
          'agentId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **agentId** *(string) --* 

        UUID of updated agent.

        
  
  **Exceptions**
  
  *   :py:class:`GroundStation.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`GroundStation.Client.exceptions.DependencyException`

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

  