Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateAgentStatus

Note

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

Update the status of the agent.

Request Syntax


PUT /agent/agentId HTTP/1.1
Content-type: application/json

{
   "aggregateStatus": { 
      "signatureMap": { 
         "string" : boolean 
      },
      "status": "string"
   },
   "componentStatuses": [ 
      { 
         "bytesReceived": number,
         "bytesSent": number,
         "capabilityArn": "string",
         "componentType": "string",
         "dataflowId": "string",
         "packetsDropped": number,
         "status": "string"
      }
   ],
   "taskId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

agentId

UUID of agent to update.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

aggregateStatus

Aggregate status for agent.

Type: AggregateStatus object

Required: Yes

componentStatuses

List of component statuses for agent.

Type: Array of ComponentStatusData objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: Yes

taskId

GUID of agent task.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "agentId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

agentId

UUID of updated agent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Errors

For information about the errors that are common to all actions, see Common Errors.

DependencyException

Dependency encountered an error.

HTTP Status Code: 531

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 431

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 434