GroundStation / Client / list_antennas

list_antennas

GroundStation.Client.list_antennas(**kwargs)

Returns a list of antennas at a specified ground station.

See also: AWS API Documentation

Request Syntax

response = client.list_antennas(
    groundStationId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • groundStationId (string) –

    [REQUIRED]

    ID of a ground station.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'antennaList': [
        {
            'groundStationName': 'string',
            'antennaName': 'string',
            'region': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • antennaList (list) –

      List of antennas.

      • (dict) –

        An antenna at a ground station.

        • groundStationName (string) –

          Name of the ground station the antenna is associated with.

        • antennaName (string) –

          Name of the antenna.

        • region (string) –

          Region of the antenna.

    • nextToken (string) –

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

Exceptions