AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ConfigService::Types::GetAggregateComplianceDetailsByConfigRuleRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetAggregateComplianceDetailsByConfigRuleRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  configuration_aggregator_name: "ConfigurationAggregatorName", # required
  config_rule_name: "ConfigRuleName", # required
  account_id: "AccountId", # required
  aws_region: "AwsRegion", # required
  compliance_type: "COMPLIANT", # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  limit: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The 12-digit account ID of the source account.

Returns:

  • (String)

    The 12-digit account ID of the source account.

#aws_regionString

The source region from where the data is aggregated.

Returns:

  • (String)

    The source region from where the data is aggregated.

#compliance_typeString

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

Possible values:

  • COMPLIANT
  • NON_COMPLIANT
  • NOT_APPLICABLE
  • INSUFFICIENT_DATA

Returns:

  • (String)

    The resource compliance status.

#config_rule_nameString

The name of the AWS Config rule for which you want compliance information.

Returns:

  • (String)

    The name of the AWS Config rule for which you want compliance information.

#configuration_aggregator_nameString

The name of the configuration aggregator.

Returns:

  • (String)

    The name of the configuration aggregator.

#limitInteger

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

Returns:

  • (Integer)

    The maximum number of evaluation results returned on each page.

#next_tokenString

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

Returns:

  • (String)

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