ListComplianceStatus
Returns an array of PolicyComplianceStatus
objects. Use
PolicyComplianceStatus
to get a summary of which member accounts are protected
by the specified policy.
Request Syntax
{
"MaxResults": number
,
"NextToken": "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.
- MaxResults
-
Specifies the number of
PolicyComplianceStatus
objects that you want Firewall Manager to return for this request. If you have morePolicyComplianceStatus
objects than the number that you specify forMaxResults
, the response includes aNextToken
value that you can use to get another batch ofPolicyComplianceStatus
objects.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If you specify a value for
MaxResults
and you have morePolicyComplianceStatus
objects than the number that you specify forMaxResults
, AWS Firewall Manager returns aNextToken
value in the response that allows you to list another group ofPolicyComplianceStatus
objects. For the second and subsequentListComplianceStatus
requests, specify the value ofNextToken
from the previous response to get information about another batch ofPolicyComplianceStatus
objects.Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Required: No
- PolicyId
-
The ID of the AWS Firewall Manager policy that you want the details for.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-z0-9A-Z-]{36}$
Required: Yes
Response Syntax
{
"NextToken": "string",
"PolicyComplianceStatusList": [
{
"EvaluationResults": [
{
"ComplianceStatus": "string",
"EvaluationLimitExceeded": boolean,
"ViolatorCount": number
}
],
"IssueInfoMap": {
"string" : "string"
},
"LastUpdated": number,
"MemberAccount": "string",
"PolicyId": "string",
"PolicyName": "string",
"PolicyOwner": "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
-
If you have more
PolicyComplianceStatus
objects than the number that you specified forMaxResults
in the request, the response includes aNextToken
value. To list morePolicyComplianceStatus
objects, submit anotherListComplianceStatus
request, and specify theNextToken
value from the response in theNextToken
value in the next request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
- PolicyComplianceStatusList
-
An array of
PolicyComplianceStatus
objects.Type: Array of PolicyComplianceStatus objects
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
- 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 AWS SDKs, see the following: