ephemeris

Creates, updates, deletes, gets or lists an ephemeris resource.

Overview

Name	ephemeris
Type	Resource
Id	aws.groundstation.ephemeris

Fields

The following fields are returned by SELECT queries:

describe_ephemeris

Name	Datatype	Description
name	string	A name that you can use to identify the ephemeris. (pattern: <code>[ a-zA-Z0-9_:-]{1,256}</code>)
creation_time	string (date-time)	The time the ephemeris was uploaded in UTC.
enabled	boolean	Whether or not the ephemeris is enabled.
ephemeris_id	string	The AWS Ground Station ephemeris ID. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
error_reasons	array	Detailed error information for ephemerides with INVALID status. Provides specific error codes and messages to help diagnose validation failures.
invalid_reason	string	Reason that an ephemeris failed validation. Appears only when the status is INVALID. (METADATA_INVALID, TIME_RANGE_INVALID, TRAJECTORY_INVALID, KMS_KEY_INVALID, VALIDATION_ERROR)
priority	integer	A priority score that determines which ephemeris to use when multiple ephemerides overlap. Higher numbers take precedence. The default is 1. Must be 1 or greater.
satellite_id	string	The AWS Ground Station satellite ID associated with ephemeris. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
status	string	The status of the ephemeris. (VALIDATING, INVALID, ERROR, ENABLED, DISABLED, EXPIRED)
supplied_data	object	Supplied ephemeris data.
tags	object	Tags assigned to an ephemeris.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_ephemeris	select	ephemeris_id, region		Retrieve information about an existing ephemeris.
create_ephemeris	insert	region, name		Create an ephemeris with your specified EphemerisData.
update_ephemeris	update	ephemeris_id, region, enabled		Update an existing ephemeris.
delete_ephemeris	delete	ephemeris_id, region		Delete an ephemeris.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ephemeris_id	string	The AWS Ground Station ephemeris ID.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_ephemeris

Retrieve information about an existing ephemeris.

SELECT
name,
creation_time,
enabled,
ephemeris_id,
error_reasons,
invalid_reason,
priority,
satellite_id,
status,
supplied_data,
tags
FROM aws.groundstation.ephemeris
WHERE ephemeris_id = '{{ ephemeris_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_ephemeris

Create an ephemeris with your specified EphemerisData.

INSERT INTO aws.groundstation.ephemeris (
satelliteId,
enabled,
priority,
expirationTime,
name,
kmsKeyArn,
ephemeris,
tags,
region
)
SELECT 
'{{ satelliteId }}',
{{ enabled }},
{{ priority }},
'{{ expirationTime }}',
'{{ name }}' /* required */,
'{{ kmsKeyArn }}',
'{{ ephemeris }}',
'{{ tags }}',
'{{ region }}'
RETURNING
ephemeris_id
;

Manifest

# Description fields are for documentation purposes
- name: ephemeris
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ephemeris resource.
  - name: satelliteId
    value: "{{ satelliteId }}"
  - name: enabled
    value: {{ enabled }}
  - name: priority
    value: {{ priority }}
  - name: expirationTime
    value: "{{ expirationTime }}"
  - name: name
    value: "{{ name }}"
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"
  - name: ephemeris
    description: |
      Ephemeris data.
    value:
      tle:
        s3Object:
          bucket: "{{ bucket }}"
          key: "{{ key }}"
          version: "{{ version }}"
        tleData:
          - tleLine1: "{{ tleLine1 }}"
            tleLine2: "{{ tleLine2 }}"
            validTimeRange:
              startTime: "{{ startTime }}"
              endTime: "{{ endTime }}"
      oem:
        s3Object:
          bucket: "{{ bucket }}"
          key: "{{ key }}"
          version: "{{ version }}"
        oemData: "{{ oemData }}"
      azEl:
        groundStation: "{{ groundStation }}"
        data:
          s3Object:
            bucket: "{{ bucket }}"
            key: "{{ key }}"
            version: "{{ version }}"
          azElData:
            angleUnit: "{{ angleUnit }}"
            azElSegmentList:
              - referenceEpoch: "{{ referenceEpoch }}"
                validTimeRange:
                  startTime: "{{ startTime }}"
                  endTime: "{{ endTime }}"
                azElList: "{{ azElList }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_ephemeris

Update an existing ephemeris.

UPDATE aws.groundstation.ephemeris
SET 
enabled = {{ enabled }},
name = '{{ name }}',
priority = {{ priority }}
WHERE 
ephemeris_id = '{{ ephemeris_id }}' --required
AND region = '{{ region }}' --required
AND enabled = {{ enabled }} --required
RETURNING
ephemeris_id;

DELETE examples

delete_ephemeris

Delete an ephemeris.

DELETE FROM aws.groundstation.ephemeris
WHERE ephemeris_id = '{{ ephemeris_id }}' --required
AND region = '{{ region }}' --required
;