configservice_describe_config_rules: Returns details about your AWS Config rules

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

Returns details about your AWS Config rules.

Usage

1
configservice_describe_config_rules(ConfigRuleNames, NextToken)

Arguments

ConfigRuleNames

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

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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
list(
  ConfigRules = list(
    list(
      ConfigRuleName = "string",
      ConfigRuleArn = "string",
      ConfigRuleId = "string",
      Description = "string",
      Scope = list(
        ComplianceResourceTypes = list(
          "string"
        ),
        TagKey = "string",
        TagValue = "string",
        ComplianceResourceId = "string"
      ),
      Source = list(
        Owner = "CUSTOM_LAMBDA"|"AWS",
        SourceIdentifier = "string",
        SourceDetails = list(
          list(
            EventSource = "aws.config",
            MessageType = "ConfigurationItemChangeNotification"|"ConfigurationSnapshotDeliveryCompleted"|"ScheduledNotification"|"OversizedConfigurationItemChangeNotification",
            MaximumExecutionFrequency = "One_Hour"|"Three_Hours"|"Six_Hours"|"Twelve_Hours"|"TwentyFour_Hours"
          )
        )
      ),
      InputParameters = "string",
      MaximumExecutionFrequency = "One_Hour"|"Three_Hours"|"Six_Hours"|"Twelve_Hours"|"TwentyFour_Hours",
      ConfigRuleState = "ACTIVE"|"DELETING"|"DELETING_RESULTS"|"EVALUATING",
      CreatedBy = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
6
svc$describe_config_rules(
  ConfigRuleNames = list(
    "string"
  ),
  NextToken = "string"
)

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