[ aws . fms ]

get-compliance-detail

Description

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 AWS 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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-compliance-detail
--policy-id <value>
--member-account <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--policy-id (string)

The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies .

--member-account (string)

The AWS account that owns the resources that you want to get the details for.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve the compliance information for an account

The following get-compliance-detail example retrieves compliance information for the specified policy and member account.

aws fms get-compliance-detail \
    --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --member-account 123456789012

Output:

{
    "PolicyComplianceDetail": {
    "EvaluationLimitExceeded": false,
    "IssueInfoMap": {},
    "MemberAccount": "123456789012",
    "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "PolicyOwner": "123456789012",
    "Violators": []
}

For more information, see Viewing Resource Compliance with a Policy in the AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide.

Output

PolicyComplianceDetail -> (structure)

Information about the resources and the policy that you specified in the GetComplianceDetail request.

PolicyOwner -> (string)

The AWS account that created the AWS Firewall Manager policy.

PolicyId -> (string)

The ID of the AWS Firewall Manager policy.

MemberAccount -> (string)

The AWS account ID.

Violators -> (list)

An array of resources that aren’t protected by the AWS WAF or Shield Advanced policy or that aren’t in compliance with the security group policy.

(structure)

Details of the resource that is not protected by the policy.

ResourceId -> (string)

The resource ID.

ViolationReason -> (string)

The reason that the resource is not protected by the policy.

ResourceType -> (string)

The resource type. This is in the format shown in the AWS Resource Types Reference . For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution .

EvaluationLimitExceeded -> (boolean)

Indicates if over 100 resources are noncompliant with the AWS Firewall Manager policy.

ExpiredAt -> (timestamp)

A timestamp that indicates when the returned information should be considered out of date.

IssueInfoMap -> (map)

Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be noncompliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.

key -> (string)

value -> (string)