AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . groundstation ]

describe-ephemeris

Description

Retrieve information about an existing ephemeris.

See also: AWS API Documentation

Synopsis

  describe-ephemeris
--ephemeris-id <value>
[--cli-input-json <value>]
[--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>]

Options

--ephemeris-id (string)

The AWS Ground Station ephemeris ID.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

ephemerisId -> (string)

The AWS Ground Station ephemeris ID.

satelliteId -> (string)

The AWS Ground Station satellite ID associated with ephemeris.

status -> (string)

The status of the ephemeris.

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.

creationTime -> (timestamp)

The time the ephemeris was uploaded in UTC.

enabled -> (boolean)

Whether or not the ephemeris is enabled.

name -> (string)

A name that you can use to identify the ephemeris.

tags -> (map)

Tags assigned to an ephemeris.

key -> (string)

value -> (string)

suppliedData -> (tagged union structure)

Supplied 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)

Description of ephemeris.

sourceS3Object -> (structure)

Source Amazon S3 object used for the ephemeris.

bucket -> (string)

An Amazon S3 Bucket name.

key -> (string)

An Amazon S3 key for the ephemeris.

version -> (string)

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

ephemerisData -> (string)

Supplied ephemeris data.

oem -> (structure)

Description of ephemeris.

sourceS3Object -> (structure)

Source Amazon S3 object used for the ephemeris.

bucket -> (string)

An Amazon S3 Bucket name.

key -> (string)

An Amazon S3 key for the ephemeris.

version -> (string)

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

ephemerisData -> (string)

Supplied ephemeris data.

azEl -> (structure)

Description of ephemeris.

sourceS3Object -> (structure)

Source Amazon S3 object used for the ephemeris.

bucket -> (string)

An Amazon S3 Bucket name.

key -> (string)

An Amazon S3 key for the ephemeris.

version -> (string)

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

ephemerisData -> (string)

Supplied ephemeris data.

invalidReason -> (string)

Reason that an ephemeris failed validation. Appears only when the status is INVALID .

errorReasons -> (list)

Detailed error information for ephemerides with INVALID status.

Provides specific error codes and messages to help diagnose validation failures.

(structure)

Detailed error information for ephemeris validation failures.

Provides an error code and descriptive message to help diagnose and resolve validation issues.

errorCode -> (string)

The error code identifying the type of validation failure.

See the Troubleshooting Invalid Ephemerides guide for error code details.

errorMessage -> (string)

A human-readable message describing the validation failure.

Provides specific details about what failed and may include suggestions for remediation.