Struct aws_sdk_config::client::fluent_builders::DescribeComplianceByConfigRule

pub struct DescribeComplianceByConfigRule { /* private fields */ }

Fluent builder constructing a request to DescribeComplianceByConfigRule.

Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.

If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

• Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

• The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.

• The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Implementations

impl DescribeComplianceByConfigRule

pub async fn send(
    self
) -> Result<DescribeComplianceByConfigRuleOutput, SdkError<DescribeComplianceByConfigRuleError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeComplianceByConfigRulePaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn config_rule_names(self, input: impl Into<String>) -> Self

Appends an item to ConfigRuleNames.

To override the contents of this collection use set_config_rule_names.

Specify one or more Config rule names to filter the results by rule.

pub fn set_config_rule_names(self, input: Option<Vec<String>>) -> Self

Specify one or more Config rule names to filter the results by rule.

pub fn compliance_types(self, input: ComplianceType) -> Self

Appends an item to ComplianceTypes.

To override the contents of this collection use set_compliance_types.

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

pub fn set_compliance_types(self, input: Option<Vec<ComplianceType>>) -> Self

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

pub fn next_token(self, input: impl Into<String>) -> Self

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

pub fn set_next_token(self, input: Option<String>) -> Self

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Trait Implementations

impl Clone for DescribeComplianceByConfigRule

fn clone(&self) -> DescribeComplianceByConfigRule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeComplianceByConfigRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.