GetAgentConfiguration
Note
For use by AWS Ground Station Agent and shouldn't be called directly.
Gets the latest configuration information for a registered agent.
Request Syntax
GET /agent/agentId/configuration HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- agentId
-
UUID of agent to get configuration information for.
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 does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"agentId": "string",
"taskingDocument": "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 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}$ - taskingDocument
-
Tasking document for agent.
Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
