Skip to main content

aws_sdk_glue/client/
get_data_quality_result_v2.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetDataQualityResultV2`](crate::operation::get_data_quality_result_v2::builders::GetDataQualityResultV2FluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`result_id(impl Into<String>)`](crate::operation::get_data_quality_result_v2::builders::GetDataQualityResultV2FluentBuilder::result_id) / [`set_result_id(Option<String>)`](crate::operation::get_data_quality_result_v2::builders::GetDataQualityResultV2FluentBuilder::set_result_id):<br>required: **true**<br><p>A unique result ID for the data quality result.</p><br>
7    /// - On success, responds with [`GetDataQualityResultV2Output`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output) with field(s):
8    ///   - [`result_id(Option<String>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::result_id): <p>A unique result ID for the data quality result.</p>
9    ///   - [`data_source(Option<DataSource>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::data_source): <p>The table associated with the data quality result, if any.</p>
10    ///   - [`profile_id(Option<String>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::profile_id): <p>The Profile ID for the data quality result.</p>
11    ///   - [`dimensions(Option<HashMap::<String, String>>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::dimensions): <p>A map of platform-specific identifiers, such as cluster, application, workgroup, or project IDs, that identify where the data quality evaluation ran.</p>
12    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::tags): <p>A map of tags associated with the data quality result.</p>
13    ///   - [`execution_started_on(Option<DateTime>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::execution_started_on): <p>The date and time when this data quality run started.</p>
14    ///   - [`execution_completed_on(Option<DateTime>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::execution_completed_on): <p>The date and time when this data quality run completed.</p>
15    ///   - [`result_published_on(Option<DateTime>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::result_published_on): <p>The date and time when this data quality result was published.</p>
16    ///   - [`score(Option<f64>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::score): <p>An aggregate data quality score. Represents the ratio of rules that passed to the total number of rules.</p>
17    ///   - [`rule_results(Option<Vec::<DataQualityRuleResult>>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::rule_results): <p>A list of <code>DataQualityRuleResult</code> objects representing the results for each rule.</p>
18    ///   - [`analyzer_results(Option<Vec::<DataQualityAnalyzerResult>>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::analyzer_results): <p>A list of <code>DataQualityAnalyzerResult</code> objects representing the results for each analyzer.</p>
19    ///   - [`observations(Option<Vec::<DataQualityObservation>>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::observations): <p>A list of <code>DataQualityObservation</code> objects representing the anomaly detection observations generated after evaluating the rules and analyzers.</p>
20    ///   - [`evaluation_context(Option<String>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::evaluation_context): <p>The evaluation context for the data quality result. This value identifies a specific data quality result, or a series of related results, within a run.</p>
21    ///   - [`descriptors(Option<HashMap::<String, String>>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::descriptors): <p>A map of user-provided descriptors that add contextual metadata and configuration to the data quality result, such as database name, table name, team, or environment.</p>
22    ///   - [`aggregated_metrics(Option<DataQualityAggregatedMetrics>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::aggregated_metrics): <p>A summary of <code>DataQualityAggregatedMetrics</code> objects showing the total counts of processed rows and rules, including their pass/fail statistics based on row-level results.</p>
23    ///   - [`ruleset_name(Option<String>)`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Output::ruleset_name): <p>The name of the ruleset associated with the data quality result.</p>
24    /// - On failure, responds with [`SdkError<GetDataQualityResultV2Error>`](crate::operation::get_data_quality_result_v2::GetDataQualityResultV2Error)
25    pub fn get_data_quality_result_v2(&self) -> crate::operation::get_data_quality_result_v2::builders::GetDataQualityResultV2FluentBuilder {
26        crate::operation::get_data_quality_result_v2::builders::GetDataQualityResultV2FluentBuilder::new(self.handle.clone())
27    }
28}