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

Class: Aws::ConfigService::Types::Evaluation

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

{
  compliance_resource_type: "StringWithCharLimit256", # required
  compliance_resource_id: "BaseResourceId", # required
  compliance_type: "COMPLIANT", # required, accepts COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA
  annotation: "StringWithCharLimit256",
  ordering_timestamp: Time.now, # required
}

Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.

Instance Attribute Summary collapse

Instance Attribute Details

#annotationString

Supplementary information about how the evaluation determined the compliance.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1375

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  include Aws::Structure
end

#compliance_resource_idString

The ID of the AWS resource that was evaluated.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1375

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  include Aws::Structure
end

#compliance_resource_typeString

The type of AWS resource that was evaluated.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1375

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  include Aws::Structure
end

#compliance_typeString

Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

Returns:

  • (String)


1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1375

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  include Aws::Structure
end

#ordering_timestampTime

The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

Returns:

  • (Time)


1375
1376
1377
1378
1379
1380
1381
1382
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 1375

class Evaluation < Struct.new(
  :compliance_resource_type,
  :compliance_resource_id,
  :compliance_type,
  :annotation,
  :ordering_timestamp)
  include Aws::Structure
end