antennas

Creates, updates, deletes, gets or lists an antennas resource.

Overview

Name	antennas
Type	Resource
Id	aws.groundstation.antennas

Fields

The following fields are returned by SELECT queries:

list_antennas

Name	Datatype	Description
antenna_name	string	Name of the antenna. (pattern: <code>[ a-zA-Z0-9-._:=]{4,256}</code>)
ground_station_name	string	Name of the ground station the antenna is associated with. (pattern: <code>[ a-zA-Z0-9-._:=]{4,97}</code>)
region	string	Region of the antenna. (pattern: <code>[\w-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_antennas	select	ground_station_id, region	maxResults, nextToken	Returns a list of antennas at 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
ground_station_id	string	ID of a ground station.
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of antennas returned.
nextToken	string	Next token returned in the request of a previous ListAntennas call. Used to get the next page of results.

SELECT examples

list_antennas

Returns a list of antennas at a specified ground station.

SELECT
antenna_name,
ground_station_name,
region
FROM aws.groundstation.antennas
WHERE ground_station_id = '{{ ground_station_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;