list_ephemerides ¶

def list_ephemerides(
    self,
    start_time: datetime.datetime,
    end_time: datetime.datetime,
    *,
    config_overrides: Optional[GroundStationClientConfig] = None,
    satellite_id: Optional["capo_groundstation.types.uuid.Uuid"] = None,
    ephemeris_type: Optional[
        "capo_groundstation.types.ephemeris_type.EphemerisType"
    ] = None,
    status_list: Optional[
        "capo_groundstation.types.ephemeris_status_list.EphemerisStatusList"
    ] = 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_ephemerides_response.ListEphemeridesResponse":
    """<p>List your existing ephemerides.</p>

    Args:
        satellite_id: <p>The AWS Ground Station satellite ID to list ephemeris for.</p>
        ephemeris_type: <p>Filter ephemerides by type. If not specified, all ephemeris types will be returned.</p>
        start_time: <p>The start time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.</p>
        end_time: <p>The end time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.</p>
        status_list: <p>The list of ephemeris status to return.</p>
        max_results: <p>Maximum number of ephemerides to return.</p>
        next_token: <p>Pagination token.</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_ephemerides_request.ListEphemeridesRequest]",
    ) -> OperationResponse[
        "capo_groundstation.types.list_ephemerides_response.ListEphemeridesResponse"
    ]:
        import capo_groundstation._operations.ground_station.list_ephemerides

        output, http_response = (
            capo_groundstation._operations.ground_station.list_ephemerides.list_ephemerides(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEphemerides")
    )
    input_: capo_groundstation.types.list_ephemerides_request.ListEphemeridesRequest = {
        "start_time": start_time,
        "end_time": end_time,
    }
    if satellite_id is not None:
        input_["satellite_id"] = satellite_id
    if ephemeris_type is not None:
        input_["ephemeris_type"] = ephemeris_type
    if status_list is not None:
        input_["status_list"] = status_list
    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