Struct aws_sdk_config::client::fluent_builders::DescribeComplianceByResource

pub struct DescribeComplianceByResource { /* private fields */ }

Fluent builder constructing a request to DescribeComplianceByResource.

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

A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

• 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 that 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 DescribeComplianceByResource

pub async fn send(
    self
) -> Result<DescribeComplianceByResourceOutput, SdkError<DescribeComplianceByResourceError>>

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) -> DescribeComplianceByResourcePaginator

Create a paginator for this request

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

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

The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

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

The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

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

The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

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

The ID of the Amazon Web Services resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

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, NON_COMPLIANT, and INSUFFICIENT_DATA.

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

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

pub fn limit(self, input: i32) -> Self

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.

pub fn set_limit(self, input: Option<i32>) -> Self

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.

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 DescribeComplianceByResource

fn clone(&self) -> DescribeComplianceByResource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeComplianceByResource

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

Formats the value using the given formatter.