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

UpdateEphemeris

Updates an existing ephemeris

Request Syntax


PUT /ephemeris/ephemerisId HTTP/1.1
Content-type: application/json

{
   "enabled": boolean,
   "name": "string",
   "priority": number
}

URI Request Parameters

The request uses the following URI parameters.

ephemerisId

The AWS Ground Station ephemeris ID.

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.

enabled

Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.

Type: Boolean

Required: Yes

name

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

Type: String

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

Pattern: ^[ a-zA-Z0-9_:-]{1,256}$

Required: No

priority

Customer-provided priority score to establish the order in which overlapping ephemerides should be used.

The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.

Priority must be 1 or greater

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 99999.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ephemerisId": "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.

ephemerisId

The AWS Ground Station ephemeris ID.

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