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

Class: Aws::ConfigService::Types::PutEvaluationsRequest

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

{
  evaluations: [
    {
      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
    },
  ],
  result_token: "String", # required
  test_mode: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#evaluationsArray<Types::Evaluation>

The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.

Returns:



2042
2043
2044
2045
2046
2047
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2042

class PutEvaluationsRequest < Struct.new(
  :evaluations,
  :result_token,
  :test_mode)
  include Aws::Structure
end

#result_tokenString

An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation

Returns:

  • (String)


2042
2043
2044
2045
2046
2047
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2042

class PutEvaluationsRequest < Struct.new(
  :evaluations,
  :result_token,
  :test_mode)
  include Aws::Structure
end

#test_modeBoolean

Use this parameter to specify a test run for PutEvaluations. You can verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config.

When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

Returns:

  • (Boolean)


2042
2043
2044
2045
2046
2047
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 2042

class PutEvaluationsRequest < Struct.new(
  :evaluations,
  :result_token,
  :test_mode)
  include Aws::Structure
end