PutEvaluations
Used by an Amazon Lambda function to deliver evaluation results to Amazon Config. This operation is required in every Amazon Lambda function that is invoked by an Amazon Config rule.
Request Syntax
{
"Evaluations": [
{
"Annotation": "string
",
"ComplianceResourceId": "string
",
"ComplianceResourceType": "string
",
"ComplianceType": "string
",
"OrderingTimestamp": number
}
],
"ResultToken": "string
",
"TestMode": boolean
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Evaluations
-
The assessments that the Amazon Lambda function performs. Each evaluation identifies an Amazon resource and indicates whether it complies with the Amazon Config rule that invokes the Amazon Lambda function.
Type: Array of Evaluation objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
- ResultToken
-
An encrypted token that associates an evaluation with an Amazon Config rule. Identifies the rule and the event that triggered the evaluation.
Type: String
Required: Yes
- TestMode
-
Use this parameter to specify a test run for
PutEvaluations
. You can verify whether your Amazon Lambda function will deliver evaluation results to Amazon Config. No updates occur to your existing evaluations, and evaluation results are not sent to Amazon Config.Note
When
TestMode
istrue
,PutEvaluations
doesn't require a valid value for theResultToken
parameter, but the value cannot be null.Type: Boolean
Required: No
Response Syntax
{
"FailedEvaluations": [
{
"Annotation": "string",
"ComplianceResourceId": "string",
"ComplianceResourceType": "string",
"ComplianceType": "string",
"OrderingTimestamp": number
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- FailedEvaluations
-
Requests that failed because of a client or server error.
Type: Array of Evaluation objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValueException
-
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
HTTP Status Code: 400
- InvalidResultTokenException
-
The specified
ResultToken
is not valid.HTTP Status Code: 400
- NoSuchConfigRuleException
-
The Amazon Config rule in the request is not valid. Verify that the rule is an Amazon Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: