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

CreateEphemeris

Creates an Ephemeris with the specified EphemerisData.

Request Syntax


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

{
   "enabled": boolean,
   "ephemeris": { ... },
   "expirationTime": number,
   "kmsKeyArn": "string",
   "name": "string",
   "priority": number,
   "satelliteId": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

enabled

Whether to set the ephemeris status to ENABLED after validation.

Setting this to false will set the ephemeris status to DISABLED after validation.

Type: Boolean

Required: No

ephemeris

Ephemeris data.

Type: EphemerisData object

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

Required: No

expirationTime

An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.

Type: Timestamp

Required: No

kmsKeyArn

The ARN of a KMS key used to encrypt the ephemeris in Ground Station.

Type: String

Required: No

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: Yes

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 1. Maximum value of 99999.

Required: No

satelliteId

AWS Ground Station satellite ID for this 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}$

Required: Yes

tags

Tags assigned to an ephemeris.

Type: String to string map

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