AWS Config
API Reference (API Version 2014-11-12)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeOrganizationConfigRuleStatuses

Provides organization config rule deployment status for an organization.

Note

The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

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.

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 OrganizationConfigRuleStatuses 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 nextToken string 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 config rules for which you want status details. If you do not specify any names, AWS Config returns details for all your organization AWS Confg 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", "OrganizationConfigRuleStatuses": [ { "ErrorCode": "string", "ErrorMessage": "string", "LastUpdateTime": number, "OrganizationConfigRuleName": "string", "OrganizationRuleStatus": "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 nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Type: String

OrganizationConfigRuleStatuses

A list of OrganizationConfigRuleStatus objects.

Type: Array of OrganizationConfigRuleStatus 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 invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

HTTP Status Code: 400

NoSuchOrganizationConfigRuleException

You specified one or more organization config rules that do not exist.

HTTP Status Code: 400

OrganizationAccessDeniedException

For PutConfigAggregator API, no permission to call EnableAWSServiceAccess API.

For all OrganizationConfigRule APIs, AWS Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master 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: