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-conformance-pack-compliance-summary

Description

Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.

Note

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-aggregate-conformance-pack-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>]

Options

--configuration-aggregator-name (string)

The name of the configuration aggregator.

--filters (structure)

Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.

AccountId -> (string)

The 12-digit Amazon Web Services account ID of the source account.

AwsRegion -> (string)

The source Amazon Web Services Region from 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 Amazon Web Services account ID or Amazon Web Services Region.

Possible values:

  • ACCOUNT_ID
  • AWS_REGION

--limit (integer)

The maximum number of results returned on each page. The default is maximum. 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.

See 'aws help' for descriptions of global parameters.

Output

AggregateConformancePackComplianceSummaries -> (list)

Returns a list of AggregateConformancePackComplianceSummary object.

(structure)

Provides a summary of compliance based on either account ID or region.

ComplianceSummary -> (structure)

Returns an AggregateConformancePackComplianceCount object.

CompliantConformancePackCount -> (integer)

Number of compliant conformance packs.

NonCompliantConformancePackCount -> (integer)

Number of noncompliant conformance packs.

GroupName -> (string)

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

GroupByKey -> (string)

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

NextToken -> (string)

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