AWS API Changes

2022/11/09 - AWS Ground Station - 5 new2 updated api methods

Changes This release adds the preview of customer-provided ephemeris support for AWS Ground Station, allowing space vehicle owners to provide their own position and trajectory information for a satellite.

UpdateEphemeris (new)

Link ¶

Updates an existing ephemeris

See also: AWS API Documentation

Request Syntax

client.update_ephemeris(
    enabled=True|False,
    ephemerisId='string',
    name='string',
    priority=123
)

type enabled:

boolean

param enabled:

[REQUIRED]

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

type ephemerisId:

string

param ephemerisId:

[REQUIRED]

The AWS Ground Station ephemeris ID.

type name:

string

param name:

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

type priority:

integer

param priority:

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

rtype:

dict

returns:

Response Syntax

{
    'ephemerisId': 'string'
}

Response Structure

(dict) --
- ephemerisId (string) --
  
  The AWS Ground Station ephemeris ID.

DescribeEphemeris (new)

Link ¶

Describes an existing ephemeris.

See also: AWS API Documentation

Request Syntax

client.describe_ephemeris(
    ephemerisId='string'
)

type ephemerisId:

string

param ephemerisId:

[REQUIRED]

The AWS Ground Station ephemeris ID.

rtype:

dict

returns:

Response Syntax

{
    'creationTime': datetime(2015, 1, 1),
    'enabled': True|False,
    'ephemerisId': 'string',
    'invalidReason': 'METADATA_INVALID'|'TIME_RANGE_INVALID'|'TRAJECTORY_INVALID'|'KMS_KEY_INVALID'|'VALIDATION_ERROR',
    'name': 'string',
    'priority': 123,
    'satelliteId': 'string',
    'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
    'suppliedData': {
        'oem': {
            'ephemerisData': 'string',
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        },
        'tle': {
            'ephemerisData': 'string',
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        }
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- creationTime (datetime) --
  
  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 (dict) --
  
  Supplied ephemeris data.
  Note
  
  This is a Tagged Union structure. Only one of the following top level keys will be set: oem, tle. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
```
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
```
  - oem (dict) --
    
    Description of ephemeris.
    - ephemerisData (string) --
      
      Supplied ephemeris data.
    - sourceS3Object (dict) --
      
      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 (dict) --
    
    Description of ephemeris.
    - ephemerisData (string) --
      
      Supplied ephemeris data.
    - sourceS3Object (dict) --
      
      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 (dict) --
  
  Tags assigned to an ephemeris.
  - (string) --
    - (string) --

ListEphemerides (new)

Link ¶

List existing ephemerides.

See also: AWS API Documentation

Request Syntax

client.list_ephemerides(
    endTime=datetime(2015, 1, 1),
    maxResults=123,
    nextToken='string',
    satelliteId='string',
    startTime=datetime(2015, 1, 1),
    statusList=[
        'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
    ]
)

type endTime:

datetime

param endTime:

[REQUIRED]

The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

type maxResults:

integer

param maxResults:

Maximum number of ephemerides to return.

type nextToken:

string

param nextToken:

Pagination token.

type satelliteId:

string

param satelliteId:

[REQUIRED]

The AWS Ground Station satellite ID to list ephemeris for.

type startTime:

datetime

param startTime:

[REQUIRED]

The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

type statusList:

list

param statusList:

The list of ephemeris status to return.

(string) --

rtype:

dict

returns:

Response Syntax

{
    'ephemerides': [
        {
            'creationTime': datetime(2015, 1, 1),
            'enabled': True|False,
            'ephemerisId': 'string',
            'name': 'string',
            'priority': 123,
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            },
            'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- ephemerides (list) --
  
  List of ephemerides.
  - (dict) --
    
    Ephemeris item.
    - creationTime (datetime) --
      
      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.
    - 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
    - sourceS3Object (dict) --
      
      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.
    - status (string) --
      
      The status of the ephemeris.
- nextToken (string) --
  
  Pagination token.

CreateEphemeris (new)

Link ¶

Creates an Ephemeris with the specified EphemerisData.

See also: AWS API Documentation

Request Syntax

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'
    }
)

type enabled:

boolean

param enabled:

Whether to set the ephemeris status to ENABLED after validation.

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

type ephemeris:

dict

param ephemeris:

Ephemeris data.

oem (dict) --

Ephemeris data in Orbit Ephemeris Message (OEM) format.
- 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.

type expirationTime:

datetime

param expirationTime:

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

type kmsKeyArn:

string

param kmsKeyArn:

The ARN of a KMS key used to encrypt the ephemeris in Ground Station.

type name:

string

param name:

[REQUIRED]

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

type priority:

integer

param priority:

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

type satelliteId:

string

param satelliteId:

[REQUIRED]

AWS Ground Station satellite ID for this ephemeris.

type tags:

dict

param tags:

Tags assigned to an ephemeris.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'ephemerisId': 'string'
}

Response Structure

(dict) --
- ephemerisId (string) --
  
  The AWS Ground Station ephemeris ID.

DeleteEphemeris (new)

Link ¶

Deletes an ephemeris

See also: AWS API Documentation

Request Syntax

client.delete_ephemeris(
    ephemerisId='string'
)

type ephemerisId:

string

param ephemerisId:

[REQUIRED]

The AWS Ground Station ephemeris ID.

rtype:

dict

returns:

Response Syntax

{
    'ephemerisId': 'string'
}

Response Structure

(dict) --
- ephemerisId (string) --
  
  The AWS Ground Station ephemeris ID.

GetSatellite (updated)

Link ¶
Changes (response)

{'currentEphemeris': {'ephemerisId': 'string',
                      'epoch': 'timestamp',
                      'name': 'string',
                      'source': 'CUSTOMER_PROVIDED | SPACE_TRACK'}}

Returns a satellite.

See also: AWS API Documentation

Request Syntax

client.get_satellite(
    satelliteId='string'
)

type satelliteId:

string

param satelliteId:

[REQUIRED]

UUID of a satellite.

rtype:

dict

returns:

Response Syntax

{
    'currentEphemeris': {
        'ephemerisId': 'string',
        'epoch': datetime(2015, 1, 1),
        'name': 'string',
        'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
    },
    'groundStations': [
        'string',
    ],
    'noradSatelliteID': 123,
    'satelliteArn': 'string',
    'satelliteId': 'string'
}

Response Structure

(dict) --
- currentEphemeris (dict) --
  
  The current ephemeris being used to compute the trajectory of the satellite.
  - ephemerisId (string) --
    
    UUID of a customer-provided ephemeris.
    
    This field is not populated for default ephemerides from Space Track.
  - epoch (datetime) --
    
    The epoch of a default, ephemeris from Space Track in UTC.
    
    This field is not populated for customer-provided ephemerides.
  - name (string) --
    
    A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
    
    A name is only returned for customer-provider ephemerides that have a name associated.
  - source (string) --
    
    The EphemerisSource that generated a given ephemeris.
- groundStations (list) --
  
  A list of ground stations to which the satellite is on-boarded.
  - (string) --
- noradSatelliteID (integer) --
  
  NORAD satellite ID number.
- satelliteArn (string) --
  
  ARN of a satellite.
- satelliteId (string) --
  
  UUID of a satellite.

ListSatellites (updated)

Link ¶
Changes (response)

{'satellites': {'currentEphemeris': {'ephemerisId': 'string',
                                     'epoch': 'timestamp',
                                     'name': 'string',
                                     'source': 'CUSTOMER_PROVIDED | '
                                               'SPACE_TRACK'}}}

Returns a list of satellites.

See also: AWS API Documentation

Request Syntax

client.list_satellites(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

Maximum number of satellites returned.

type nextToken:

string

param nextToken:

Next token that can be supplied in the next call to get the next page of satellites.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'satellites': [
        {
            'currentEphemeris': {
                'ephemerisId': 'string',
                'epoch': datetime(2015, 1, 1),
                'name': 'string',
                'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
            },
            'groundStations': [
                'string',
            ],
            'noradSatelliteID': 123,
            'satelliteArn': 'string',
            'satelliteId': 'string'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  Next token that can be supplied in the next call to get the next page of satellites.
- satellites (list) --
  
  List of satellites.
  - (dict) --
    
    Item in a list of satellites.
    - currentEphemeris (dict) --
      
      The current ephemeris being used to compute the trajectory of the satellite.
      - ephemerisId (string) --
        
        UUID of a customer-provided ephemeris.
        
        This field is not populated for default ephemerides from Space Track.
      - epoch (datetime) --
        
        The epoch of a default, ephemeris from Space Track in UTC.
        
        This field is not populated for customer-provided ephemerides.
      - name (string) --
        
        A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
        
        A name is only returned for customer-provider ephemerides that have a name associated.
      - source (string) --
        
        The EphemerisSource that generated a given ephemeris.
    - groundStations (list) --
      
      A list of ground stations to which the satellite is on-boarded.
      - (string) --
    - noradSatelliteID (integer) --
      
      NORAD satellite ID number.
    - satelliteArn (string) --
      
      ARN of a satellite.
    - satelliteId (string) --
      
      UUID of a satellite.