Skip to main content

aws_sdk_glue/client/
start_data_quality_rule_recommendation_run.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 [`StartDataQualityRuleRecommendationRun`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`data_source(DataSource)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::data_source) / [`set_data_source(Option<DataSource>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_data_source):<br>required: **true**<br><p>The data source (Glue table) associated with this run.</p><br>
7    ///   - [`role(impl Into<String>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::role) / [`set_role(Option<String>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_role):<br>required: **true**<br><p>The IAM role that Glue assumes to access resources for the run.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/glue/latest/dg/data-quality-authorization.html">Configure IAM permissions for Glue Data Quality</a>.</p><br>
8    ///   - [`number_of_workers(i32)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::number_of_workers) / [`set_number_of_workers(Option<i32>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_number_of_workers):<br>required: **false**<br><p>The number of <code>G.1X</code> workers to be used in the run. The default is 5.</p><br>
9    ///   - [`timeout(i32)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::timeout) / [`set_timeout(Option<i32>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_timeout):<br>required: **false**<br><p>The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p><br>
10    ///   - [`created_ruleset_name(impl Into<String>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::created_ruleset_name) / [`set_created_ruleset_name(Option<String>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_created_ruleset_name):<br>required: **false**<br><p>A name for the ruleset.</p><br>
11    ///   - [`data_quality_security_configuration(impl Into<String>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::data_quality_security_configuration) / [`set_data_quality_security_configuration(Option<String>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_data_quality_security_configuration):<br>required: **false**<br><p>The name of the security configuration created with the data quality encryption option.</p><br>
12    ///   - [`client_token(impl Into<String>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_client_token):<br>required: **false**<br><p>Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource.</p><br>
13    ///   - [`additional_run_options(DataQualityRuleRecommendationRunAdditionalRunOptions)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::additional_run_options) / [`set_additional_run_options(Option<DataQualityRuleRecommendationRunAdditionalRunOptions>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_additional_run_options):<br>required: **false**<br><p>Additional run options you can specify for a recommendation run.</p><br>
14    ///   - [`recommendation_mode(RecommendationMode)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::recommendation_mode) / [`set_recommendation_mode(Option<RecommendationMode>)`](crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::set_recommendation_mode):<br>required: **false**<br><p>The mode that Glue Data Quality uses to recommend rules.</p> <p>The default is <code>BASIC</code>.</p><br>
15    /// - On success, responds with [`StartDataQualityRuleRecommendationRunOutput`](crate::operation::start_data_quality_rule_recommendation_run::StartDataQualityRuleRecommendationRunOutput) with field(s):
16    ///   - [`run_id(Option<String>)`](crate::operation::start_data_quality_rule_recommendation_run::StartDataQualityRuleRecommendationRunOutput::run_id): <p>The unique run identifier associated with this run.</p>
17    /// - On failure, responds with [`SdkError<StartDataQualityRuleRecommendationRunError>`](crate::operation::start_data_quality_rule_recommendation_run::StartDataQualityRuleRecommendationRunError)
18    pub fn start_data_quality_rule_recommendation_run(
19        &self,
20    ) -> crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder {
21        crate::operation::start_data_quality_rule_recommendation_run::builders::StartDataQualityRuleRecommendationRunFluentBuilder::new(
22            self.handle.clone(),
23        )
24    }
25}