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

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::GetAggregateComplianceDetailsByConfigRuleRequest

Includes:

Structure

Defined in:

lib/aws-sdk-configservice/types.rb

Overview

Note:

When making an API call, you may pass GetAggregateComplianceDetailsByConfigRuleRequest data as a 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",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The 12-digit account ID of the source account.

• #aws_region ⇒ String

  The source region from where the data is aggregated.

• #compliance_type ⇒ String

  The resource compliance status.

• #config_rule_name ⇒ String

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

• #configuration_aggregator_name ⇒ String

  The name of the configuration aggregator.

• #limit ⇒ Integer

  The maximum number of evaluation results returned on each page.

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

Instance Attribute Details

#account_id ⇒ String

The 12-digit account ID of the source account.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4078

class GetAggregateComplianceDetailsByConfigRuleRequest < Struct.new(
  :configuration_aggregator_name,
  :config_rule_name,
  :account_id,
  :aws_region,
  :compliance_type,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#aws_region ⇒ String

The source region from where the data is aggregated.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4078

class GetAggregateComplianceDetailsByConfigRuleRequest < Struct.new(
  :configuration_aggregator_name,
  :config_rule_name,
  :account_id,
  :aws_region,
  :compliance_type,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#compliance_type ⇒ String

The resource compliance status.

<note markdown=“1”> 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.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4078

class GetAggregateComplianceDetailsByConfigRuleRequest < Struct.new(
  :configuration_aggregator_name,
  :config_rule_name,
  :account_id,
  :aws_region,
  :compliance_type,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#config_rule_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4078

class GetAggregateComplianceDetailsByConfigRuleRequest < Struct.new(
  :configuration_aggregator_name,
  :config_rule_name,
  :account_id,
  :aws_region,
  :compliance_type,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_aggregator_name ⇒ String

The name of the configuration aggregator.

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4078

class GetAggregateComplianceDetailsByConfigRuleRequest < Struct.new(
  :configuration_aggregator_name,
  :config_rule_name,
  :account_id,
  :aws_region,
  :compliance_type,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

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)

# File 'lib/aws-sdk-configservice/types.rb', line 4078

class GetAggregateComplianceDetailsByConfigRuleRequest < Struct.new(
  :configuration_aggregator_name,
  :config_rule_name,
  :account_id,
  :aws_region,
  :compliance_type,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-configservice/types.rb', line 4078

class GetAggregateComplianceDetailsByConfigRuleRequest < Struct.new(
  :configuration_aggregator_name,
  :config_rule_name,
  :account_id,
  :aws_region,
  :compliance_type,
  :limit,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end