aws_sdk_frauddetector/client/

get_event_prediction_metadata.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetEventPredictionMetadata`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`event_id(impl Into<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::event_id) / [`set_event_id(Option<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::set_event_id):<br>required: **true**<br><p>The event ID.</p><br>
    ///   - [`event_type_name(impl Into<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::event_type_name) / [`set_event_type_name(Option<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::set_event_type_name):<br>required: **true**<br><p>The event type associated with the detector specified for the prediction.</p><br>
    ///   - [`detector_id(impl Into<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::detector_id) / [`set_detector_id(Option<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::set_detector_id):<br>required: **true**<br><p>The detector ID.</p><br>
    ///   - [`detector_version_id(impl Into<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::detector_version_id) / [`set_detector_version_id(Option<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::set_detector_version_id):<br>required: **true**<br><p>The detector version ID.</p><br>
    ///   - [`prediction_timestamp(impl Into<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::prediction_timestamp) / [`set_prediction_timestamp(Option<String>)`](crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::set_prediction_timestamp):<br>required: **true**<br><p>The timestamp that defines when the prediction was generated. The timestamp must be specified using ISO 8601 standard in UTC.</p> <p>We recommend calling <a href="https://docs.aws.amazon.com/frauddetector/latest/api/API_ListEventPredictions.html">ListEventPredictions</a> first, and using the <code>predictionTimestamp</code> value in the response to provide an accurate prediction timestamp value.</p><br>
    /// - On success, responds with [`GetEventPredictionMetadataOutput`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput) with field(s):
    ///   - [`event_id(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::event_id): <p>The event ID.</p>
    ///   - [`event_type_name(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::event_type_name): <p>The event type associated with the detector specified for this prediction.</p>
    ///   - [`entity_id(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::entity_id): <p>The entity ID.</p>
    ///   - [`entity_type(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::entity_type): <p>The entity type.</p>
    ///   - [`event_timestamp(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::event_timestamp): <p>The timestamp for when the prediction was generated for the associated event ID.</p>
    ///   - [`detector_id(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::detector_id): <p>The detector ID.</p>
    ///   - [`detector_version_id(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::detector_version_id): <p>The detector version ID.</p>
    ///   - [`detector_version_status(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::detector_version_status): <p>The status of the detector version.</p>
    ///   - [`event_variables(Option<Vec::<EventVariableSummary>>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::event_variables): <p>A list of event variables that influenced the prediction scores.</p>
    ///   - [`rules(Option<Vec::<EvaluatedRule>>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::rules): <p>List of rules associated with the detector version that were used for evaluating variable values.</p>
    ///   - [`rule_execution_mode(Option<RuleExecutionMode>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::rule_execution_mode): <p>The execution mode of the rule used for evaluating variable values.</p>
    ///   - [`outcomes(Option<Vec::<String>>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::outcomes): <p>The outcomes of the matched rule, based on the rule execution mode.</p>
    ///   - [`evaluated_model_versions(Option<Vec::<EvaluatedModelVersion>>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::evaluated_model_versions): <p>Model versions that were evaluated for generating predictions.</p>
    ///   - [`evaluated_external_models(Option<Vec::<EvaluatedExternalModel>>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::evaluated_external_models): <p>External (Amazon SageMaker) models that were evaluated for generating predictions.</p>
    ///   - [`prediction_timestamp(Option<String>)`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataOutput::prediction_timestamp): <p>The timestamp that defines when the prediction was generated.</p>
    /// - On failure, responds with [`SdkError<GetEventPredictionMetadataError>`](crate::operation::get_event_prediction_metadata::GetEventPredictionMetadataError)
    pub fn get_event_prediction_metadata(
        &self,
    ) -> crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder {
        crate::operation::get_event_prediction_metadata::builders::GetEventPredictionMetadataFluentBuilder::new(self.handle.clone())
    }
}