GetOrganizationConfigRuleDetailedStatus
Returns detailed status for each member account within an organization for a given organization AWS Config rule.
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
StatusDetailFiltersobject.Type: StatusDetailFilters object
Required: No
- Limit
-
The maximum number of
OrganizationConfigRuleDetailedStatusreturned 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
nextTokenstring 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 your organization AWS Config rule for which you want status details for member accounts.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[A-Za-z0-9-_]+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
nextTokenstring 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
MemberAccountStatusobjects.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 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:
