DescribeEphemeris - AWS Ground Station
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

DescribeEphemeris

Describes an existing ephemeris.

Request Syntax

GET /ephemeris/ephemerisId HTTP/1.1

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 does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "creationTime": number,
   "enabled": boolean,
   "ephemerisId": "string",
   "invalidReason": "string",
   "name": "string",
   "priority": number,
   "satelliteId": "string",
   "status": "string",
   "suppliedData": { ... },
   "tags": { 
      "string" : "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.

creationTime

The time the ephemeris was uploaded in UTC.

Type: Timestamp

enabled

Whether or not the ephemeris is enabled.

Type: Boolean

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}$

invalidReason

Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.

Type: String

Valid Values: METADATA_INVALID | TIME_RANGE_INVALID | TRAJECTORY_INVALID | KMS_KEY_INVALID | VALIDATION_ERROR

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}$

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.

satelliteId

The AWS Ground Station satellite ID associated with ephemeris.

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}$

status

The status of the ephemeris.

Type: String

Valid Values: VALIDATING | INVALID | ERROR | ENABLED | DISABLED | EXPIRED

suppliedData

Supplied ephemeris data.

Type: EphemerisTypeDescription object

Note: This object is a Union. Only one member of this object can be specified or returned.

tags

Tags assigned to an ephemeris.

Type: String to string map

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: