Returns a list of ground stations.
Parameters:
-
satellite_id
(Optional[Uuid], default:
None
)
–
Satellite ID to retrieve on-boarded ground stations.
-
max_results
(Optional[PaginationMaxResults], default:
None
)
–
Maximum number of ground stations returned.
-
next_token
(Optional[PaginationToken], default:
None
)
–
Next token that can be supplied in the next call to get the next page of ground stations.
Raises:
Source code in docs_src/capo_groundstation/_services/ground_station.py
| def list_ground_stations(
self,
*,
config_overrides: Optional[GroundStationClientConfig] = None,
satellite_id: Optional["capo_groundstation.types.uuid.Uuid"] = 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_ground_stations_response.ListGroundStationsResponse":
"""<p>Returns a list of ground stations. </p>
Args:
satellite_id: <p>Satellite ID to retrieve on-boarded ground stations.</p>
max_results: <p>Maximum number of ground stations returned.</p>
next_token: <p>Next token that can be supplied in the next call to get the next page of ground stations.</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.resource_not_found_exception.ResourceNotFoundException: <p>Resource was not found.</p>
capo_groundstation.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_groundstation.types.list_ground_stations_request.ListGroundStationsRequest]",
) -> OperationResponse[
"capo_groundstation.types.list_ground_stations_response.ListGroundStationsResponse"
]:
import capo_groundstation._operations.ground_station.list_ground_stations
output, http_response = (
capo_groundstation._operations.ground_station.list_ground_stations.list_ground_stations(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListGroundStations")
)
input_: capo_groundstation.types.list_ground_stations_request.ListGroundStationsRequest = {}
if satellite_id is not None:
input_["satellite_id"] = satellite_id
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|