[ aws . configservice ]

describe-organization-config-rules

Description

Returns a list of organization config rules.

Note

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.

Only a master account can call this API.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-organization-config-rules
[--organization-config-rule-names <value>]
[--limit <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--organization-config-rule-names (list)

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

(string)

Syntax:

"string" "string" ...

--limit (integer)

The maximum number of organization config rules returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

--next-token (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

OrganizationConfigRules -> (list)

Returns a list of OrganizationConfigRule objects.

(structure)

An organization config rule that has information about config rules that AWS Config creates in member accounts.

OrganizationConfigRuleName -> (string)

The name that you assign to organization config rule.

OrganizationConfigRuleArn -> (string)

Amazon Resource Name (ARN) of organization config rule.

OrganizationManagedRuleMetadata -> (structure)

An OrganizationManagedRuleMetadata object.

Description -> (string)

The description that you provide for organization config rule.

RuleIdentifier -> (string)

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS Managed Config Rules .

InputParameters -> (string)

A string, in JSON format, that is passed to organization config rule Lambda function.

MaximumExecutionFrequency -> (string)

The maximum frequency with which AWS Config runs evaluations for a rule. You are using an AWS managed rule that is triggered at a periodic frequency.

Note

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

ResourceTypesScope -> (list)

The type of the AWS resource that was evaluated.

(string)

ResourceIdScope -> (string)

The ID of the AWS resource that was evaluated.

TagKeyScope -> (string)

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

TagValueScope -> (string)

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

OrganizationCustomRuleMetadata -> (structure)

An OrganizationCustomRuleMetadata object.

Description -> (string)

The description that you provide for organization config rule.

LambdaFunctionArn -> (string)

The lambda function ARN.

OrganizationConfigRuleTriggerTypes -> (list)

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:

• ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.

• OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

• ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency .

(string)

InputParameters -> (string)

A string, in JSON format, that is passed to organization config rule Lambda function.

MaximumExecutionFrequency -> (string)

The maximum frequency with which AWS Config runs evaluations for a rule. Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .

Note

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

ResourceTypesScope -> (list)

The type of the AWS resource that was evaluated.

(string)

ResourceIdScope -> (string)

The ID of the AWS resource that was evaluated.

TagKeyScope -> (string)

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

TagValueScope -> (string)

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

ExcludedAccounts -> (list)

A comma-separated list of accounts excluded from organization config rule.

(string)

LastUpdateTime -> (timestamp)

The timestamp of the last update.

NextToken -> (string)

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