ground_station_reservations

Creates, updates, deletes, gets or lists a ground_station_reservations resource.

Overview

Name	ground_station_reservations
Type	Resource
Id	aws.groundstation.ground_station_reservations

Fields

The following fields are returned by SELECT queries:

list_ground_station_reservations

Name	Datatype	Description
antenna_name	string	Name of an antenna. (pattern: <code>[ a-zA-Z0-9-._:=]{4,256}</code>)
end_time	string (date-time)	End time of a ground station reservation in UTC.
ground_station_id	string	ID of a ground station. (pattern: <code>[ a-zA-Z0-9-._:=]{4,97}</code>)
reservation_details	object	Details of a ground station reservation.
reservation_type	string	Type of a ground station reservation. (MAINTENANCE, CONTACT)
start_time	string (date-time)	Start time of a ground station reservation in UTC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_ground_station_reservations	select	ground_station_id, startTime, endTime, region	reservationTypes, maxResults, nextToken	Returns a list of reservations for a specified ground station.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endTime	string (date-time)	End time of the reservation window in UTC.
ground_station_id	string	ID of a ground station.
region	string	AWS region (default: us-east-1)
startTime	string (date-time)	Start time of the reservation window in UTC.
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.
reservationTypes	array	Types of reservations to filter by.

SELECT examples

list_ground_station_reservations

Returns a list of reservations for a specified ground station.

SELECT
antenna_name,
end_time,
ground_station_id,
reservation_details,
reservation_type,
start_time
FROM aws.groundstation.ground_station_reservations
WHERE ground_station_id = '{{ ground_station_id }}' -- required
AND startTime = '{{ startTime }}' -- required
AND endTime = '{{ endTime }}' -- required
AND region = '{{ region }}' -- required
AND reservationTypes = '{{ reservationTypes }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;