GroundStation / Client / list_ground_station_reservations

list_ground_station_reservations

GroundStation.Client.list_ground_station_reservations(**kwargs)

Returns a list of reservations for a specified ground station.

See also: AWS API Documentation

Request Syntax

response = client.list_ground_station_reservations(
    groundStationId='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    reservationTypes=[
        'MAINTENANCE'|'CONTACT',
    ],
    maxResults=123,
    nextToken='string'
)

Parameters:

• groundStationId (string) –

  [REQUIRED]

  ID of a ground station.

• startTime (datetime) –

  [REQUIRED]

  Start time of the reservation window in UTC.

• endTime (datetime) –

  [REQUIRED]

  End time of the reservation window in UTC.

• reservationTypes (list) –

  Types of reservations to filter by.

  • (string) –

• maxResults (integer) – Maximum number of ground station reservations returned.

• nextToken (string) – Next token returned in the request of a previous ListGroundStationReservations call. Used to get the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'reservationList': [
        {
            'reservationType': 'MAINTENANCE'|'CONTACT',
            'groundStationId': 'string',
            'antennaName': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'reservationDetails': {
                'maintenance': {
                    'maintenanceType': 'PLANNED'|'UNPLANNED'
                },
                'contact': {
                    'contactId': 'string'
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • reservationList (list) –

    List of ground station reservations.

    • (dict) –

      Item in a list of ground station reservations.

      • reservationType (string) –

        Type of a ground station reservation.

      • groundStationId (string) –

        ID of a ground station.

      • antennaName (string) –

        Name of an antenna.

      • startTime (datetime) –

        Start time of a ground station reservation in UTC.

      • endTime (datetime) –

        End time of a ground station reservation in UTC.

      • reservationDetails (dict) –

        Details of a ground station reservation.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: maintenance, contact. 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'}
        

        • maintenance (dict) –

          Details of a maintenance reservation.

          • maintenanceType (string) –

            Type of maintenance.

        • contact (dict) –

          Details of a contact reservation.

          • contactId (string) –

            UUID of a contact.

  • nextToken (string) –

    Next token to be used in a subsequent ListGroundStationReservations call to retrieve the next page of results.

Exceptions

• GroundStation.Client.exceptions.InvalidParameterException

• GroundStation.Client.exceptions.DependencyException