GroundStation / Client / update_ephemeris

update_ephemeris#

GroundStation.Client.update_ephemeris(**kwargs)#

Updates an existing ephemeris

See also: AWS API Documentation

Request Syntax

response = client.update_ephemeris(
    enabled=True|False,
    ephemerisId='string',
    name='string',
    priority=123
)
Parameters:
  • enabled (boolean) –

    [REQUIRED]

    Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.

  • ephemerisId (string) –

    [REQUIRED]

    The AWS Ground Station ephemeris ID.

  • 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

Return type:

dict

Returns:

Response Syntax

{
    'ephemerisId': 'string'
}

Response Structure

  • (dict) –

    • ephemerisId (string) –

      The AWS Ground Station ephemeris ID.

Exceptions

  • GroundStation.Client.exceptions.InvalidParameterException

  • GroundStation.Client.exceptions.DependencyException

  • GroundStation.Client.exceptions.ResourceNotFoundException