AWS Firewall Manager
Firewall Management (API Version 2018-01-01)

ListComplianceStatus

Returns an array of PolicyComplianceStatus objects in the response. 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 AWS Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus 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 more PolicyComplianceStatus objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

Type: String

Length Constraints: Minimum length of 1.

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 for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

Type: String

Length Constraints: Minimum length of 1.

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: