aws_sdk_databrew/client/
describe_ruleset.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 [`DescribeRuleset`](crate::operation::describe_ruleset::builders::DescribeRulesetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::describe_ruleset::builders::DescribeRulesetFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::describe_ruleset::builders::DescribeRulesetFluentBuilder::set_name):<br>required: **true**<br><p>The name of the ruleset to be described.</p><br>
7    /// - On success, responds with [`DescribeRulesetOutput`](crate::operation::describe_ruleset::DescribeRulesetOutput) with field(s):
8    ///   - [`name(String)`](crate::operation::describe_ruleset::DescribeRulesetOutput::name): <p>The name of the ruleset.</p>
9    ///   - [`description(Option<String>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::description): <p>The description of the ruleset.</p>
10    ///   - [`target_arn(Option<String>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::target_arn): <p>The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.</p>
11    ///   - [`rules(Option<Vec::<Rule>>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::rules): <p>A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.</p>
12    ///   - [`create_date(Option<DateTime>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::create_date): <p>The date and time that the ruleset was created.</p>
13    ///   - [`created_by(Option<String>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::created_by): <p>The Amazon Resource Name (ARN) of the user who created the ruleset.</p>
14    ///   - [`last_modified_by(Option<String>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::last_modified_by): <p>The Amazon Resource Name (ARN) of the user who last modified the ruleset.</p>
15    ///   - [`last_modified_date(Option<DateTime>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::last_modified_date): <p>The modification date and time of the ruleset.</p>
16    ///   - [`resource_arn(Option<String>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::resource_arn): <p>The Amazon Resource Name (ARN) for the ruleset.</p>
17    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_ruleset::DescribeRulesetOutput::tags): <p>Metadata tags that have been applied to the ruleset.</p>
18    /// - On failure, responds with [`SdkError<DescribeRulesetError>`](crate::operation::describe_ruleset::DescribeRulesetError)
19    pub fn describe_ruleset(&self) -> crate::operation::describe_ruleset::builders::DescribeRulesetFluentBuilder {
20        crate::operation::describe_ruleset::builders::DescribeRulesetFluentBuilder::new(self.handle.clone())
21    }
22}