AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#evaluationsArray<Types::Evaluation>

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

Returns:



6694
6695
6696
6697
6698
6699
6700
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6694

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

#result_tokenString

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

Returns:

  • (String)


6694
6695
6696
6697
6698
6699
6700
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6694

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

#test_modeBoolean

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

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

Returns:

  • (Boolean)


6694
6695
6696
6697
6698
6699
6700
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/types.rb', line 6694

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