GroundStation / Client / update_agent_status

update_agent_status#

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

Request Syntax

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

  • agentId (string) –

    [REQUIRED]

    UUID of agent to update.

  • aggregateStatus (dict) –

    [REQUIRED]

    Aggregate status for agent.

    • signatureMap (dict) –

      Sparse map of failure signatures.

      • (string) –

        • (boolean) –

    • status (string) – [REQUIRED]

      Aggregate status.

  • componentStatuses (list) –

    [REQUIRED]

    List of component statuses for agent.

    • (dict) –

      Data on the status of agent components.

      • bytesReceived (integer) –

        Bytes received by the component.

      • bytesSent (integer) –

        Bytes sent by the component.

      • capabilityArn (string) – [REQUIRED]

        Capability ARN of the component.

      • componentType (string) – [REQUIRED]

        The Component type.

      • dataflowId (string) – [REQUIRED]

        Dataflow UUID associated with the component.

      • packetsDropped (integer) –

        Packets dropped by component.

      • status (string) – [REQUIRED]

        Component status.

  • taskId (string) –

    [REQUIRED]

    GUID of agent task.

Return type:

dict

Returns:

Response Syntax

{
    'agentId': 'string'
}

Response Structure

  • (dict) –

    • agentId (string) –

      UUID of updated agent.

Exceptions