aws_sdk_config/client/
get_compliance_details_by_config_rule.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 [`GetComplianceDetailsByConfigRule`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`config_rule_name(impl Into<String>)`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::config_rule_name) / [`set_config_rule_name(Option<String>)`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::set_config_rule_name):<br>required: **true**<br><p>The name of the Config rule for which you want compliance information.</p><br>
8    ///   - [`compliance_types(ComplianceType)`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::compliance_types) / [`set_compliance_types(Option<Vec::<ComplianceType>>)`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::set_compliance_types):<br>required: **false**<br><p>Filters the results by compliance.</p> <p><code>INSUFFICIENT_DATA</code> is a valid <code>ComplianceType</code> that is returned when an Config rule cannot be evaluated. However, <code>INSUFFICIENT_DATA</code> cannot be used as a <code>ComplianceType</code> for filtering results.</p><br>
9    ///   - [`limit(i32)`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p><br>
11    /// - On success, responds with [`GetComplianceDetailsByConfigRuleOutput`](crate::operation::get_compliance_details_by_config_rule::GetComplianceDetailsByConfigRuleOutput) with field(s):
12    ///   - [`evaluation_results(Option<Vec::<EvaluationResult>>)`](crate::operation::get_compliance_details_by_config_rule::GetComplianceDetailsByConfigRuleOutput::evaluation_results): <p>Indicates whether the Amazon Web Services resource complies with the specified Config rule.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::get_compliance_details_by_config_rule::GetComplianceDetailsByConfigRuleOutput::next_token): <p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>
14    /// - On failure, responds with [`SdkError<GetComplianceDetailsByConfigRuleError>`](crate::operation::get_compliance_details_by_config_rule::GetComplianceDetailsByConfigRuleError)
15    pub fn get_compliance_details_by_config_rule(
16        &self,
17    ) -> crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder {
18        crate::operation::get_compliance_details_by_config_rule::builders::GetComplianceDetailsByConfigRuleFluentBuilder::new(self.handle.clone())
19    }
20}