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

get-aggregate-config-rule-compliance-summary¶

Description¶

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

Note

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Synopsis¶

  get-aggregate-config-rule-compliance-summary
--configuration-aggregator-name <value>
[--filters <value>]
[--group-by-key <value>]
[--limit <value>]
[--next-token <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¶

--configuration-aggregator-name (string)

The name of the configuration aggregator.

--filters (structure)

Filters the results based on the ConfigRuleComplianceSummaryFilters object.

AccountId -> (string)

The 12-digit account ID of the source account.

AwsRegion -> (string)

The source region where the data is aggregated.

Shorthand Syntax:

AccountId=string,AwsRegion=string

JSON Syntax:

{
  "AccountId": "string",
  "AwsRegion": "string"
}

--group-by-key (string)

Groups the result based on ACCOUNT_ID or AWS_REGION.

Possible values:

ACCOUNT_ID

AWS_REGION

--limit (integer)

The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

--next-token (string)

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

Output¶

GroupByKey -> (string)

Groups the result based on ACCOUNT_ID or AWS_REGION.

AggregateComplianceCounts -> (list)

Returns a list of AggregateComplianceCounts object.

(structure)

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

GroupName -> (string)

The 12-digit account ID or region based on the GroupByKey value.

ComplianceSummary -> (structure)

The number of compliant and noncompliant Config rules.

CompliantResourceCount -> (structure)

The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

CappedCount -> (integer)

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

CapExceeded -> (boolean)

Indicates whether the maximum count is reached.

NonCompliantResourceCount -> (structure)

The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

CappedCount -> (integer)

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

CapExceeded -> (boolean)

Indicates whether the maximum count is reached.

ComplianceSummaryTimestamp -> (timestamp)

The time that Config created the compliance summary.

NextToken -> (string)