Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . fms ]

list-compliance-status

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-compliance-status
--policy-id <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--policy-id (string)

The ID of the AWS Firewall Manager policy that you want the details for.

--next-token (string)

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 list-compliance-status requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

--max-results (integer)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

PolicyComplianceStatusList -> (list)

An array of PolicyComplianceStatus objects.

(structure)

Indicates whether the account is compliant with the specified policy. An account is considered non-compliant if it includes resources that are not protected by the policy.

PolicyOwner -> (string)

The AWS account that created the AWS Firewall Manager policy.

PolicyId -> (string)

The ID of the AWS Firewall Manager policy.

PolicyName -> (string)

The friendly name of the AWS Firewall Manager policy.

MemberAccount -> (string)

The member account ID.

EvaluationResults -> (list)

An array of EvaluationResult objects.

(structure)

Describes the compliance status for the account. An account is considered non-compliant if it includes resources that are not protected by the specified policy.

ComplianceStatus -> (string)

Describes an AWS account's compliance with the AWS Firewall Manager policy.

ViolatorCount -> (long)

Number of resources that are non-compliant with the specified policy. A resource is considered non-compliant if it is not associated with the specified policy.

EvaluationLimitExceeded -> (boolean)

Indicates that over 100 resources are non-compliant with the AWS Firewall Manager policy.

LastUpdated -> (timestamp)

Time stamp of the last update to the EvaluationResult objects.

NextToken -> (string)

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 list-compliance-status request, and specify the NextToken value from the response in the NextToken value in the next request.