configservice_start_config_rules_evaluation: Runs an on-demand evaluation for the specified AWS Config...

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources. Use start_config_rules_evaluation when you want to test that a rule you updated is working as expected. start_config_rules_evaluation 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 AWS Config rules per request.

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

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

The start_config_rules_evaluation 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 start_config_rules_evaluation API.

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

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

Usage

1

Arguments

ConfigRuleNames

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

Value

An empty list.

Request syntax

1
2
3
4
5
svc$start_config_rules_evaluation(
  ConfigRuleNames = list(
    "string"
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.