Skip to content

update_ephemeris async

update_ephemeris(
    ephemeris_id: Uuid,
    enabled: bool,
    *,
    config_overrides: Optional[AsyncGroundStationClientConfig] = None,
    name: Optional[SafeName] = None,
    priority: Optional[EphemerisPriority] = None,
) -> EphemerisIdResponse

Update an existing ephemeris.

Parameters:

  • ephemeris_id (Uuid) –

    The AWS Ground Station ephemeris ID.

  • enabled (bool) –

    Enable or disable the ephemeris. Changing this value doesn't require re-validation.

  • name (Optional[SafeName], default: None ) –

    A name that you can use to identify the ephemeris.

  • priority (Optional[EphemerisPriority], default: None ) –

    A priority score that determines which ephemeris to use when multiple ephemerides overlap.

    Higher numbers take precedence. The default is 1. Must be 1 or greater.

Raises:

Source code in docs_src/capo_groundstation/_services/async_ground_station.py
async def update_ephemeris(
    self,
    ephemeris_id: "capo_groundstation.types.uuid.Uuid",
    enabled: bool,
    *,
    config_overrides: Optional[AsyncGroundStationClientConfig] = None,
    name: Optional["capo_groundstation.types.safe_name.SafeName"] = None,
    priority: Optional[
        "capo_groundstation.types.ephemeris_priority.EphemerisPriority"
    ] = None,
) -> "capo_groundstation.types.ephemeris_id_response.EphemerisIdResponse":
    """<p>Update an existing ephemeris.</p>

    Args:
        ephemeris_id: <p>The AWS Ground Station ephemeris ID.</p>
        enabled: <p>Enable or disable the ephemeris. Changing this value doesn't require re-validation.</p>
        name: <p>A name that you can use to identify the ephemeris.</p>
        priority: <p>A priority score that determines which ephemeris to use when multiple ephemerides overlap.</p> <p>Higher numbers take precedence. The default is 1. Must be 1 or greater.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_groundstation.types.update_ephemeris_request.UpdateEphemerisRequest]",
    ) -> AsyncOperationResponse[
        "capo_groundstation.types.ephemeris_id_response.EphemerisIdResponse"
    ]:
        import capo_groundstation._operations.ground_station.update_ephemeris

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateEphemeris")
    )
    input_: capo_groundstation.types.update_ephemeris_request.UpdateEphemerisRequest = {
        "ephemeris_id": ephemeris_id,
        "enabled": enabled,
    }
    if name is not None:
        input_["name"] = name
    if priority is not None:
        input_["priority"] = priority

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