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

Class: Aws::ConfigService::Types::GetComplianceDetailsByConfigRuleRequest

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 GetComplianceDetailsByConfigRuleRequest data as a hash:

{
  config_rule_name: "StringWithCharLimit64", # required
  compliance_types: ["COMPLIANT"], # accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  limit: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#compliance_typesArray<String>

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

Returns:

  • (Array<String>)


1513
1514
1515
1516
1517
1518
1519
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1513

class GetComplianceDetailsByConfigRuleRequest < Struct.new(
  :config_rule_name,
  :compliance_types,
  :limit,
  :next_token)
  include Aws::Structure
end

#config_rule_nameString

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

Returns:

  • (String)


1513
1514
1515
1516
1517
1518
1519
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1513

class GetComplianceDetailsByConfigRuleRequest < Struct.new(
  :config_rule_name,
  :compliance_types,
  :limit,
  :next_token)
  include Aws::Structure
end

#limitInteger

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

Returns:

  • (Integer)


1513
1514
1515
1516
1517
1518
1519
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1513

class GetComplianceDetailsByConfigRuleRequest < Struct.new(
  :config_rule_name,
  :compliance_types,
  :limit,
  :next_token)
  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)


1513
1514
1515
1516
1517
1518
1519
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1513

class GetComplianceDetailsByConfigRuleRequest < Struct.new(
  :config_rule_name,
  :compliance_types,
  :limit,
  :next_token)
  include Aws::Structure
end