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

RegisterAgent

Note

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

Registers a new agent with AWS Ground Station.

Request Syntax


POST /agent HTTP/1.1
Content-type: application/json

{
   "agentDetails": { 
      "agentCpuCores": [ number ],
      "agentVersion": "string",
      "componentVersions": [ 
         { 
            "componentType": "string",
            "versions": [ "string" ]
         }
      ],
      "instanceId": "string",
      "instanceType": "string",
      "reservedCpuCores": [ number ]
   },
   "discoveryData": { 
      "capabilityArns": [ "string" ],
      "privateIpAddresses": [ "string" ],
      "publicIpAddresses": [ "string" ]
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

agentDetails

Detailed information about the agent being registered.

Type: AgentDetails object

Required: Yes

discoveryData

Data for associating an agent with the capabilities it is managing.

Type: DiscoveryData object

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 registered 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