GroundStation / Client / create_ephemeris

create_ephemeris#

GroundStation.Client.create_ephemeris(**kwargs)#

Creates an Ephemeris with the specified EphemerisData.

See also: AWS API Documentation

Request Syntax

response = client.create_ephemeris(
    enabled=True|False,
    ephemeris={
        'oem': {
            'oemData': 'string',
            's3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        },
        'tle': {
            's3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            },
            'tleData': [
                {
                    'tleLine1': 'string',
                    'tleLine2': 'string',
                    'validTimeRange': {
                        'endTime': datetime(2015, 1, 1),
                        'startTime': datetime(2015, 1, 1)
                    }
                },
            ]
        }
    },
    expirationTime=datetime(2015, 1, 1),
    kmsKeyArn='string',
    name='string',
    priority=123,
    satelliteId='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • enabled (boolean) –

    Whether to set the ephemeris status to ENABLED after validation.

    Setting this to false will set the ephemeris status to DISABLED after validation.

  • ephemeris (dict) –

    Ephemeris data.

    Note

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

    • oem (dict) –

      Ephemeris data in Orbit Ephemeris Message (OEM) format.

      AWS Ground Station processes OEM Customer Provided 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.

      • oemData (string) –

        The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.

      • s3Object (dict) –

        Identifies the S3 object to be used as 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 (dict) –

      Two-line element set (TLE) ephemeris.

      • s3Object (dict) –

        Identifies the S3 object to be used as 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.

      • tleData (list) –

        The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.

        • (dict) –

          Two-line element set (TLE) data.

          • tleLine1 (string) – [REQUIRED]

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

          • tleLine2 (string) – [REQUIRED]

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

          • validTimeRange (dict) – [REQUIRED]

            The valid time range for the TLE. Gaps or overlap are not permitted.

            • endTime (datetime) – [REQUIRED]

              Time in UTC at which the time range ends.

            • startTime (datetime) – [REQUIRED]

              Time in UTC at which the time range starts.

  • expirationTime (datetime) – An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.

  • kmsKeyArn (string) – The ARN of a KMS key used to encrypt the ephemeris in Ground Station.

  • name (string) –

    [REQUIRED]

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

    [REQUIRED]

    AWS Ground Station satellite ID for this ephemeris.

  • tags (dict) –

    Tags assigned to an ephemeris.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ephemerisId': 'string'
}

Response Structure

  • (dict) –

    • ephemerisId (string) –

      The AWS Ground Station ephemeris ID.

Exceptions