AWS Config
API Reference (API Version 2014-11-12)
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

GetOrganizationConfigRuleDetailedStatus

Returns detailed status for each member account within an organization for a given organization config rule.

Note

Only a master account can call this API.

Request Syntax

{ "Filters": { "AccountId": "string", "MemberAccountRuleStatus": "string" }, "Limit": number, "NextToken": "string", "OrganizationConfigRuleName": "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.

Filters

A StatusDetailFilters object.

Type: StatusDetailFilters object

Required: No

Limit

The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not 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

OrganizationConfigRuleName

The name of organization config rule for which you want status details for member accounts.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: .*\S.*

Required: Yes

Response Syntax

{ "NextToken": "string", "OrganizationConfigRuleDetailedStatus": [ { "AccountId": "string", "ConfigRuleName": "string", "ErrorCode": "string", "ErrorMessage": "string", "LastUpdateTime": number, "MemberAccountRuleStatus": "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

OrganizationConfigRuleDetailedStatus

A list of MemberAccountStatus objects.

Type: Array of MemberAccountStatus 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: