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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-configservice/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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The 12-digit account ID of the source account.

Returns:

  • (String)


4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 4088

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_regionString

The source region from where the data is aggregated.

Returns:

  • (String)


4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 4088

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_typeString

The resource compliance status.

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

Returns:

  • (String)


4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 4088

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_nameString

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

Returns:

  • (String)


4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 4088

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_nameString

The name of the configuration aggregator.

Returns:

  • (String)


4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 4088

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

#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, Config uses the default.

Returns:

  • (Integer)


4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 4088

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


4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 4088

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