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

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

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

creationTime -> (timestamp)

The time the ephemeris was uploaded in UTC.

enabled -> (boolean)

Whether or not the ephemeris is enabled.

ephemerisId -> (string)

The AWS Ground Station ephemeris ID.

invalidReason -> (string)

Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.

name -> (string)

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

priority -> (integer)

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

satelliteId -> (string)

The AWS Ground Station satellite ID associated with ephemeris.

status -> (string)

The status of the ephemeris.

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: oem, tle.

oem -> (structure)

Description of ephemeris.

ephemerisData -> (string)

Supplied ephemeris data.

sourceS3Object -> (structure)

Source 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 S3 objects, the version to use for the ephemeris.

tle -> (structure)

Description of ephemeris.

ephemerisData -> (string)

Supplied ephemeris data.

sourceS3Object -> (structure)

Source 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 S3 objects, the version to use for the ephemeris.

tags -> (map)

Tags assigned to an ephemeris.

key -> (string)

value -> (string)