GroundStation / Client / list_ground_stations

list_ground_stations¶

GroundStation.Client.list_ground_stations(**kwargs)¶

Returns a list of ground stations.

Request Syntax

response = client.list_ground_stations(
    satelliteId='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

satelliteId (string) – Satellite ID to retrieve on-boarded ground stations.
maxResults (integer) – Maximum number of ground stations returned.
nextToken (string) – Next token that can be supplied in the next call to get the next page of ground stations.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'groundStationList': [
        {
            'groundStationId': 'string',
            'groundStationName': 'string',
            'region': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  Next token that can be supplied in the next call to get the next page of ground stations.
- groundStationList (list) –
  
  List of ground stations.
  - (dict) –
    
    Information about the ground station data.
    - groundStationId (string) –
      
      UUID of a ground station.
    - groundStationName (string) –
      
      Name of a ground station.
    - region (string) –
      
      Ground station Region.

Exceptions

GroundStation.Client.exceptions.InvalidParameterException
GroundStation.Client.exceptions.DependencyException
GroundStation.Client.exceptions.ResourceNotFoundException