AWS CLI Command Reference

[ aws . groundstation ]

create-ephemeris

Description

Create an ephemeris with your specified EphemerisData .

See also: AWS API Documentation

Synopsis

  create-ephemeris
[--satellite-id <value>]
[--enabled | --no-enabled]
[--priority <value>]
[--expiration-time <value>]
--name <value>
[--kms-key-arn <value>]
[--ephemeris <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--satellite-id (string)

The satellite ID that associates this ephemeris with a satellite in AWS Ground Station.

Constraints:

  • min: 36
  • max: 36
  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

--enabled | --no-enabled (boolean)

Set to true to enable the ephemeris after validation. Set to false to keep it disabled.

--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.

Constraints:

  • min: 1
  • max: 99999

--expiration-time (timestamp)

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

--name (string) [required]

A name that you can use to identify the ephemeris.

Constraints:

  • min: 1
  • max: 256
  • pattern: [ a-zA-Z0-9_:-]{1,256}

--kms-key-arn (string)

The ARN of the KMS key to use for encrypting the ephemeris.

--ephemeris (tagged union structure)

Ephemeris data.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tle, oem, azEl.

tle -> (structure)

Two-line element set (TLE) ephemeris.

For more detail about providing Two-line element sets to AWS Ground Station, see the TLE section of the AWS Ground Station user guide.

s3Object -> (structure)

The Amazon S3 object that contains the ephemeris data.

bucket -> (string)

An Amazon S3 Bucket name.

Constraints:

  • min: 3
  • max: 63
  • pattern: [a-z0-9.-]{3,63}

key -> (string)

An Amazon S3 key for the ephemeris.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [a-zA-Z0-9!*'\)\(./_-]{1,1024}

version -> (string)

For versioned Amazon S3 objects, the version to use for the ephemeris.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [\s\S]{1,1024}

tleData -> (list)

TLE data that you provide directly instead of using an Amazon S3 object.

Constraints:

  • min: 1
  • max: 500

(structure)

Two-line element set (TLE) data.

tleLine1 -> (string) [required]

First line of two-line element set (TLE) data.

Constraints:

  • min: 69
  • max: 69
  • pattern: 1 [ 0-9]{5}[A-Z] [ 0-9]{5}[ A-Z]{3} [ 0-9]{5}[.][ 0-9]{8} (?:(?:[ 0+-][.][ 0-9]{8})|(?: [ +-][.][ 0-9]{7})) [ +-][ 0-9]{5}[+-][ 0-9] [ +-][ 0-9]{5}[+-][ 0-9] [ 0-9] [ 0-9]{4}[ 0-9]

tleLine2 -> (string) [required]

Second line of two-line element set (TLE) data.

Constraints:

  • min: 69
  • max: 69
  • pattern: 2 [ 0-9]{5} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{7} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{3}[.][ 0-9]{4} [ 0-9]{2}[.][ 0-9]{13}[ 0-9]

validTimeRange -> (structure) [required]

The valid time range for the TLE. Time ranges must be continuous without gaps or overlaps.

startTime -> (timestamp) [required]

Unix epoch timestamp in UTC at which the time range starts.

endTime -> (timestamp) [required]

Unix epoch timestamp in UTC at which the time range ends.

oem -> (structure)

Ephemeris data in Orbit Ephemeris Message (OEM) format.

AWS Ground Station processes OEM ephemerides according to the CCSDS standard with some extra restrictions. OEM files should be in KVN format. For more detail about the OEM format that AWS Ground Station supports, see OEM ephemeris format in the AWS Ground Station user guide.

s3Object -> (structure)

The Amazon S3 object that contains the ephemeris data.

bucket -> (string)

An Amazon S3 Bucket name.

Constraints:

  • min: 3
  • max: 63
  • pattern: [a-z0-9.-]{3,63}

key -> (string)

An Amazon S3 key for the ephemeris.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [a-zA-Z0-9!*'\)\(./_-]{1,1024}

version -> (string)

For versioned Amazon S3 objects, the version to use for the ephemeris.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [\s\S]{1,1024}

oemData -> (string)

OEM data that you provide directly instead of using an Amazon S3 object.

Constraints:

  • min: 1
  • pattern: [\s\S]+

azEl -> (structure)

Azimuth elevation ephemeris data.

Use this ephemeris type to provide pointing angles directly, rather than satellite orbital elements. Use this when you need precise antenna pointing but have imprecise or unknown satellite trajectory information.

The azimuth elevation data specifies the antenna pointing direction at specific times relative to a ground station location. AWS Ground Station uses 4th order Lagrange interpolation to compute pointing angles between the provided data points.

AWS Ground Station automatically filters interpolated pointing angles, including only those that are above the site mask elevation of the specified ground station.

For more detail about providing azimuth elevation ephemerides to AWS Ground Station, see the azimuth elevation ephemeris section of the AWS Ground Station User Guide.

groundStation -> (string) [required]

The ground station name for which you’re providing azimuth elevation data.

This ephemeris is specific to this ground station and can’t be used at other locations.

Constraints:

  • min: 4
  • max: 500
  • pattern: [ a-zA-Z0-9-._:=]{4,256}

data -> (tagged union structure) [required]

Azimuth elevation segment data.

You can provide data inline in the request or through an Amazon S3 object reference.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: s3Object, azElData.

s3Object -> (structure)

The Amazon S3 object containing azimuth elevation segment data.

The Amazon S3 object must contain JSON-formatted azimuth elevation data matching the AzElSegments structure.

bucket -> (string)

An Amazon S3 Bucket name.

Constraints:

  • min: 3
  • max: 63
  • pattern: [a-z0-9.-]{3,63}

key -> (string)

An Amazon S3 key for the ephemeris.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [a-zA-Z0-9!*'\)\(./_-]{1,1024}

version -> (string)

For versioned Amazon S3 objects, the version to use for the ephemeris.

Constraints:

  • min: 1
  • max: 1024
  • pattern: [\s\S]{1,1024}

azElData -> (structure)

Azimuth elevation segment data provided directly in the request.

Use this option for smaller datasets or when Amazon S3 access is not available.

angleUnit -> (string) [required]

The unit of measure for azimuth and elevation angles. All angles in all segments must use the same unit.

Possible values:

  • DEGREE_ANGLE
  • RADIAN

azElSegmentList -> (list) [required]

List of azimuth elevation segments.

Must contain between 1 and 100 segments. Segments must be in chronological order with no overlaps.

Constraints:

  • min: 1
  • max: 100

(structure)

A time segment containing azimuth elevation pointing data.

Each segment defines a continuous time period with pointing angle data points. AWS Ground Station uses 4th order Lagrange interpolation between the provided points, so each segment must contain at least five data points.

referenceEpoch -> (timestamp) [required]

The reference time for this segment in ISO 8601 format in Coordinated Universal Time (UTC).

All time values within the segment’s AzElSegment$azElList are specified as offsets in atomic seconds from this reference epoch.

Example: 2024-01-15T12:00:00.000Z

validTimeRange -> (structure) [required]

The valid time range for this segment.

Specifies the start and end timestamps in ISO 8601 format in Coordinated Universal Time (UTC). The segment’s pointing data must cover this entire time range.

startTime -> (timestamp) [required]

Start time in ISO 8601 format in Coordinated Universal Time (UTC).

Example: 2026-11-15T10:28:48.000Z

endTime -> (timestamp) [required]

End time in ISO 8601 format in Coordinated Universal Time (UTC).

Example: 2024-01-15T12:00:00.000Z

azElList -> (list) [required]

List of time-tagged azimuth elevation data points.

Must contain at least five points to support 4th order Lagrange interpolation. Points must be in chronological order with no duplicates.

Constraints:

  • min: 5

(structure)

Time-tagged azimuth elevation pointing data.

Specifies the antenna pointing direction at a specific time offset from the segment’s reference epoch.

dt -> (double) [required]

Time offset in atomic seconds from the segment’s reference epoch.

All dt values within a segment must be in ascending order with no duplicates.

dt values may be:
  • negative
  • expressed as fractions of a second
  • expressed in scientific notation

az -> (double) [required]

Azimuth angle at the specified time.

Valid ranges by unit:

  • DEGREE_ANGLE : -180 to 360 degrees, measured clockwise from true north
  • RADIAN : -π to 2π radians, measured clockwise from true north

el -> (double) [required]

Elevation angle at the specified time.

Valid ranges by unit:

  • DEGREE_ANGLE : -90 to 90 degrees, where 0 is the horizon, 90 is zenith, and negative values are below the horizon
  • RADIAN : -π/2 to π/2 radians, where 0 is the horizon, π/2 is zenith, and negative values are below the horizon

JSON Syntax:

{
  "tle": {
    "s3Object": {
      "bucket": "string",
      "key": "string",
      "version": "string"
    },
    "tleData": [
      {
        "tleLine1": "string",
        "tleLine2": "string",
        "validTimeRange": {
          "startTime": timestamp,
          "endTime": timestamp
        }
      }
      ...
    ]
  },
  "oem": {
    "s3Object": {
      "bucket": "string",
      "key": "string",
      "version": "string"
    },
    "oemData": "string"
  },
  "azEl": {
    "groundStation": "string",
    "data": {
      "s3Object": {
        "bucket": "string",
        "key": "string",
        "version": "string"
      },
      "azElData": {
        "angleUnit": "DEGREE_ANGLE"|"RADIAN",
        "azElSegmentList": [
          {
            "referenceEpoch": timestamp,
            "validTimeRange": {
              "startTime": timestamp,
              "endTime": timestamp
            },
            "azElList": [
              {
                "dt": double,
                "az": double,
                "el": double
              }
              ...
            ]
          }
          ...
        ]
      }
    }
  }
}

--tags (map)

Tags assigned to an ephemeris.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ephemerisId -> (string)

The AWS Ground Station ephemeris ID.

Constraints:

  • min: 36
  • max: 36
  • pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
© Copyright 2025, Amazon Web Services. Created using Sphinx.