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

ListEphemerides

List existing ephemerides.

Request Syntax


POST /ephemerides?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "endTime": number,
   "satelliteId": "string",
   "startTime": number,
   "statusList": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

maxResults

Maximum number of ephemerides to return.

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

nextToken

Pagination token.

Length Constraints: Minimum length of 3. Maximum length of 1000.

Pattern: ^[A-Za-z0-9-/+_.=]+$

Request Body

The request accepts the following data in JSON format.

endTime

The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

Type: Timestamp

Required: Yes

satelliteId

The AWS Ground Station satellite ID to list ephemeris for.

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

startTime

The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

Type: Timestamp

Required: Yes

statusList

The list of ephemeris status to return.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 500 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ephemerides": [ 
      { 
         "creationTime": number,
         "enabled": boolean,
         "ephemerisId": "string",
         "name": "string",
         "priority": number,
         "sourceS3Object": { 
            "bucket": "string",
            "key": "string",
            "version": "string"
         },
         "status": "string"
      }
   ],
   "nextToken": "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.

ephemerides

List of ephemerides.

Type: Array of EphemerisItem objects

Array Members: Minimum number of 1 item. Maximum number of 500 items.

nextToken

Pagination token.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 1000.

Pattern: ^[A-Za-z0-9-/+_.=]+$

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