create_ephemeris ¶

def create_ephemeris(
    self,
    name: "capo_groundstation.types.safe_name.SafeName",
    *,
    config_overrides: Optional[GroundStationClientConfig] = None,
    satellite_id: Optional["capo_groundstation.types.uuid.Uuid"] = None,
    enabled: Optional[bool] = None,
    priority: Optional[
        "capo_groundstation.types.customer_ephemeris_priority.CustomerEphemerisPriority"
    ] = None,
    expiration_time: Optional[datetime.datetime] = None,
    kms_key_arn: Optional["capo_groundstation.types.key_arn.KeyArn"] = None,
    ephemeris: Optional[
        "capo_groundstation.types.ephemeris_data.EphemerisData"
    ] = None,
    tags: Optional["capo_groundstation.types.tags_map.TagsMap"] = None,
) -> "capo_groundstation.types.ephemeris_id_response.EphemerisIdResponse":
    """<p>Create an ephemeris with your specified <a>EphemerisData</a>.</p>

    Args:
        satellite_id: <p>The satellite ID that associates this ephemeris with a satellite in AWS Ground Station.</p>
        enabled: <p>Set to <code>true</code> to enable the ephemeris after validation. Set to <code>false</code> to keep it disabled.</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>
        expiration_time: <p>An overall expiration time for the ephemeris in UTC, after which it will become <code>EXPIRED</code>.</p>
        name: <p>A name that you can use to identify the ephemeris.</p>
        kms_key_arn: <p>The ARN of the KMS key to use for encrypting the ephemeris.</p>
        ephemeris: <p>Ephemeris data.</p>
        tags: <p>Tags assigned to an ephemeris.</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.create_ephemeris_request.CreateEphemerisRequest]",
    ) -> OperationResponse[
        "capo_groundstation.types.ephemeris_id_response.EphemerisIdResponse"
    ]:
        import capo_groundstation._operations.ground_station.create_ephemeris

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateEphemeris")
    )
    input_: capo_groundstation.types.create_ephemeris_request.CreateEphemerisRequest = {
        "name": name
    }
    if satellite_id is not None:
        input_["satellite_id"] = satellite_id
    if enabled is not None:
        input_["enabled"] = enabled
    if priority is not None:
        input_["priority"] = priority
    if expiration_time is not None:
        input_["expiration_time"] = expiration_time
    if kms_key_arn is not None:
        input_["kms_key_arn"] = kms_key_arn
    if ephemeris is not None:
        input_["ephemeris"] = ephemeris
    if tags is not None:
        input_["tags"] = tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output