AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

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

See also: AWS API Documentation

Synopsis

  get-compliance-detail
--policy-id <value>
--member-account <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 Amazon Web Services account that owns the resources that you want to get the details for.

--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. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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 Amazon Web Services account that created the Firewall Manager policy.

PolicyId -> (string)

The ID of the Firewall Manager policy.

MemberAccount -> (string)

The Amazon Web Services account ID.

Violators -> (list)

An array of resources that aren't protected by the 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 Amazon Web Services Resource Types Reference . For example: AWS::ElasticLoadBalancingV2::LoadBalancer , AWS::CloudFront::Distribution , or AWS::NetworkFirewall::FirewallPolicy .

Metadata -> (map)

Metadata about the resource that doesn't comply with the policy scope.

key -> (string)

value -> (string)

EvaluationLimitExceeded -> (boolean)

Indicates if over 100 resources are noncompliant with the 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 WAF or Config, and the error message received that indicates the problem with the service.

key -> (string)

value -> (string)