Returns details about your Config rules¶

Description¶

Returns details about your Config rules.

Usage¶

configservice_describe_config_rules(ConfigRuleNames, Filters, NextToken)

Arguments¶

ConfigRuleNames

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.
Filters

Returns a list of Detective or Proactive Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive Config rules, see Evaluation Mode in the Config Developer Guide.
NextToken

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

Value¶

A list with the following syntax:

list(
  ConfigRules = list(
    list(
      ConfigRuleName = "string",
      ConfigRuleArn = "string",
      ConfigRuleId = "string",
      Description = "string",
      Scope = list(
        ComplianceResourceTypes = list(
          "string"
        ),
        TagKey = "string",
        TagValue = "string",
        ComplianceResourceId = "string",
        ServicePrincipals = list(
          "string"
        )
      ),
      Source = list(
        Owner = "CUSTOM_LAMBDA"|"AWS"|"CUSTOM_POLICY",
        SourceIdentifier = "string",
        SourceDetails = list(
          list(
            EventSource = "aws.config",
            MessageType = "ConfigurationItemChangeNotification"|"ConfigurationSnapshotDeliveryCompleted"|"ScheduledNotification"|"OversizedConfigurationItemChangeNotification",
            MaximumExecutionFrequency = "One_Hour"|"Three_Hours"|"Six_Hours"|"Twelve_Hours"|"TwentyFour_Hours"
          )
        ),
        CustomPolicyDetails = list(
          PolicyRuntime = "string",
          PolicyText = "string",
          EnableDebugLogDelivery = TRUE|FALSE
        )
      ),
      InputParameters = "string",
      MaximumExecutionFrequency = "One_Hour"|"Three_Hours"|"Six_Hours"|"Twelve_Hours"|"TwentyFour_Hours",
      ConfigRuleState = "ACTIVE"|"DELETING"|"DELETING_RESULTS"|"EVALUATING",
      CreatedBy = "string",
      EvaluationModes = list(
        list(
          Mode = "DETECTIVE"|"PROACTIVE"
        )
      ),
      RuleEvaluationVisibility = "EXTERNAL"|"INTERNAL"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_config_rules(
  ConfigRuleNames = list(
    "string"
  ),
  Filters = list(
    EvaluationMode = "DETECTIVE"|"PROACTIVE",
    RuleEvaluationVisibility = "EXTERNAL"|"INTERNAL"
  ),
  NextToken = "string"
)