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

Inherits:

Struct

• Object
• Struct
• Aws::ConfigService::Types::PutEvaluationsRequest

Includes:

Structure

Defined in:

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,
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #evaluations ⇒ Array<Types::Evaluation>

  The assessments that the AWS Lambda function performs.

• #result_token ⇒ String

  An encrypted token that associates an evaluation with an AWS Config rule.

• #test_mode ⇒ Boolean

  Use this parameter to specify a test run for ‘PutEvaluations`.

Instance Attribute Details

#evaluations ⇒ Array<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:

• (Array<Types::Evaluation>)

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

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

#result_token ⇒ String

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

Returns:

• (String)

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

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

#test_mode ⇒ Boolean

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.

<note markdown=“1”> When ‘TestMode` is `true`, `PutEvaluations` doesn’t require a valid value for the ‘ResultToken` parameter, but the value cannot be null.

</note>

Returns:

• (Boolean)

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

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