Struct aws_sdk_config::client::fluent_builders::StartConfigRulesEvaluation

pub struct StartConfigRulesEvaluation<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to StartConfigRulesEvaluation.

Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.

You can specify up to 25 Config rules per request.

An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

1. You have a custom rule that evaluates your IAM resources every 24 hours.

2. You update your Lambda function to add additional conditions to your rule.

3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

4. Config invokes your Lambda function and evaluates your IAM resources.

5. Your custom rule will still run periodic evaluations every 24 hours.

Implementations

impl<C, M, R> StartConfigRulesEvaluation<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<StartConfigRulesEvaluationOutput, SdkError<StartConfigRulesEvaluationError>> where
    R::Policy: SmithyRetryPolicy<StartConfigRulesEvaluationInputOperationOutputAlias, StartConfigRulesEvaluationOutput, StartConfigRulesEvaluationError, StartConfigRulesEvaluationInputOperationRetryAlias>, 

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 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.

The list of names of Config rules that you want to run evaluations for.

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

The list of names of Config rules that you want to run evaluations for.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for StartConfigRulesEvaluation<C, M, R>

fn clone(&self) -> StartConfigRulesEvaluation<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for StartConfigRulesEvaluation<C, M, R>

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

Formats the value using the given formatter.