GetComplianceDetail
Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy.
-
Resources are considered noncompliant for Amazon WAF and Shield Advanced policies if the specified policy has not been applied to them.
-
Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible.
-
Resources are considered noncompliant for Amazon Network Firewall policies if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route table, and for modifications to a firewall policy that violate the Firewall Manager policy's rules.
-
Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall rule group is missing from the rule group associations for the VPC.
Request Syntax
{
"MemberAccount": "string
",
"PolicyId": "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.
- MemberAccount
-
The Amazon account that owns the resources that you want to get the details for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^[0-9]+$
Required: Yes
- PolicyId
-
The ID of the policy that you want to get the details for.
PolicyId
is returned byPutPolicy
and byListPolicies
.Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-z0-9A-Z-]{36}$
Required: Yes
Response Syntax
{
"PolicyComplianceDetail": {
"EvaluationLimitExceeded": boolean,
"ExpiredAt": number,
"IssueInfoMap": {
"string" : "string"
},
"MemberAccount": "string",
"PolicyId": "string",
"PolicyOwner": "string",
"Violators": [
{
"Metadata": {
"string" : "string"
},
"ResourceId": "string",
"ResourceType": "string",
"ViolationReason": "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.
- PolicyComplianceDetail
-
Information about the resources and the policy that you specified in the
GetComplianceDetail
request.Type: PolicyComplianceDetail object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 400
- InvalidInputException
-
The parameters of the request were invalid.
HTTP Status Code: 400
- InvalidOperationException
-
The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an
AssociateAdminAccount
request for an account ID that was already set as the Amazon Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Amazon Organizations before you can access it.HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: