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 ]

describe-conformance-pack-compliance

Description

Returns compliance details for each rule in that conformance pack.

Note

You must provide exact rule names.

See also: AWS API Documentation

Synopsis

  describe-conformance-pack-compliance
--conformance-pack-name <value>
[--filters <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

--conformance-pack-name (string)

Name of the conformance pack.

--filters (structure)

A ConformancePackComplianceFilters object.

ConfigRuleNames -> (list)

Filters the results by Config rule names.

(string)

ComplianceType -> (string)

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT . INSUFFICIENT_DATA is not supported.

Shorthand Syntax:

ConfigRuleNames=string,string,ComplianceType=string

JSON Syntax:

{
  "ConfigRuleNames": ["string", ...],
  "ComplianceType": "COMPLIANT"|"NON_COMPLIANT"|"INSUFFICIENT_DATA"
}

--limit (integer)

The maximum number of Config rules within a conformance pack are returned on each page.

--next-token (string)

The nextToken string returned in a previous request that you use to request 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.

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

ConformancePackName -> (string)

Name of the conformance pack.

ConformancePackRuleComplianceList -> (list)

Returns a list of ConformancePackRuleCompliance objects.

(structure)

Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.

ConfigRuleName -> (string)

Name of the Config rule.

ComplianceType -> (string)

Compliance of the Config rule.

The allowed values are COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA .

Controls -> (list)

Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.

(string)

NextToken -> (string)

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