DescribeOrganizationConfigRules
Returns a list of organization AWS 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 AWS Config rule names. It is only applicable, when you request all the organization AWS Config rules.
For accounts within an organization
If you deploy an organizational rule or conformance pack in an organization
administrator account, and then establish a delegated administrator and deploy an
organizational rule or conformance pack in the delegated administrator account, you
won't be able to see the organizational rule or conformance pack in the organization
administrator account from the delegated administrator account or see the organizational
rule or conformance pack in the delegated administrator account from organization
administrator account. The DescribeOrganizationConfigRules and
DescribeOrganizationConformancePacks APIs can only see and interact with
the organization-related resource that were deployed from within the account calling
those APIs.
Request Syntax
{
"Limit": number,
"NextToken": "string",
"OrganizationConfigRuleNames": [ "string" ]
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Limit
-
The maximum number of organization AWS Config rules returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextToken
-
The
nextTokenstring returned on a previous page that you use to get the next page of results in a paginated response.Type: String
Required: No
- OrganizationConfigRuleNames
-
The names of organization AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your organization AWS Config rules.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
Response Syntax
{
"NextToken": "string",
"OrganizationConfigRules": [
{
"ExcludedAccounts": [ "string" ],
"LastUpdateTime": number,
"OrganizationConfigRuleArn": "string",
"OrganizationConfigRuleName": "string",
"OrganizationCustomPolicyRuleMetadata": {
"DebugLogDeliveryAccounts": [ "string" ],
"Description": "string",
"InputParameters": "string",
"MaximumExecutionFrequency": "string",
"OrganizationConfigRuleTriggerTypes": [ "string" ],
"PolicyRuntime": "string",
"ResourceIdScope": "string",
"ResourceTypesScope": [ "string" ],
"TagKeyScope": "string",
"TagValueScope": "string"
},
"OrganizationCustomRuleMetadata": {
"Description": "string",
"InputParameters": "string",
"LambdaFunctionArn": "string",
"MaximumExecutionFrequency": "string",
"OrganizationConfigRuleTriggerTypes": [ "string" ],
"ResourceIdScope": "string",
"ResourceTypesScope": [ "string" ],
"TagKeyScope": "string",
"TagValueScope": "string"
},
"OrganizationManagedRuleMetadata": {
"Description": "string",
"InputParameters": "string",
"MaximumExecutionFrequency": "string",
"ResourceIdScope": "string",
"ResourceTypesScope": [ "string" ],
"RuleIdentifier": "string",
"TagKeyScope": "string",
"TagValueScope": "string"
}
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
The
nextTokenstring returned on a previous page that you use to get the next page of results in a paginated response.Type: String
- OrganizationConfigRules
-
Returns a list of
OrganizationConfigRuleobjects.Type: Array of OrganizationConfigRule objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidLimitException
-
The specified limit is outside the allowable range.
HTTP Status Code: 400
- InvalidNextTokenException
-
The specified next token is not valid. Specify the
nextTokenstring that was returned in the previous response to get the next page of results.HTTP Status Code: 400
- NoSuchOrganizationConfigRuleException
-
The AWS Config rule in the request is not valid. Verify that the rule is an organization AWS Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
HTTP Status Code: 400
- OrganizationAccessDeniedException
-
For
PutConfigurationAggregatorAPI, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccessAPI -
The configuration aggregator cannot be updated because your AWS Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current AWS Organization.
-
The configuration aggregator is associated with a previous AWS Organization and AWS Config cannot aggregate data with current AWS Organization. Delete this aggregator and create a new one with the current AWS Organization.
-
You are not a registered delegated administrator for AWS Config with permissions to call
ListDelegatedAdministratorsAPI. Ensure that the management account registers delagated administrator for AWS Config service principal name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRuleandOrganizationConformancePackAPIs, AWS Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account.HTTP Status Code: 400
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
