list_antennas async ¶

async def list_antennas(
    self,
    ground_station_id: "capo_groundstation.types.ground_station_name.GroundStationName",
    *,
    config_overrides: Optional[AsyncGroundStationClientConfig] = None,
    max_results: Optional[
        "capo_groundstation.types.pagination_max_results.PaginationMaxResults"
    ] = None,
    next_token: Optional[
        "capo_groundstation.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_groundstation.types.list_antennas_response.ListAntennasResponse":
    """<p>Returns a list of antennas at a specified ground station.</p>

    Args:
        ground_station_id: <p>ID of a ground station.</p>
        max_results: <p>Maximum number of antennas returned.</p>
        next_token: <p>Next token returned in the request of a previous <code>ListAntennas</code> call. Used to get the next page of results.</p>

    Raises:
        capo_groundstation.errors.dependency_exception.DependencyException: <p>Dependency encountered an error.</p>
        capo_groundstation.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_groundstation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_groundstation.types.list_antennas_request.ListAntennasRequest]",
    ) -> AsyncOperationResponse[
        "capo_groundstation.types.list_antennas_response.ListAntennasResponse"
    ]:
        import capo_groundstation._operations.ground_station.list_antennas

        (
            output,
            http_response,
        ) = await capo_groundstation._operations.ground_station.list_antennas.async_list_antennas(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAntennas")
    )
    input_: capo_groundstation.types.list_antennas_request.ListAntennasRequest = {
        "ground_station_id": ground_station_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output