/

POST

Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Evaluations": [],
    "ResultToken": "string",
    "TestMode": true
}'

Response Example

200 - Example 1

{
  "FailedEvaluations": []
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

<p/>

Evaluations

array[object (Evaluation) {5}]

optional

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.

>= 0 items<= 100 items

ComplianceResourceType

string

required

The type of Amazon Web Services resource that was evaluated.

>= 1 characters<= 256 characters

ComplianceResourceId

string

required

The ID of the Amazon Web Services resource that was evaluated.

>= 1 characters<= 768 characters

ComplianceType

enum<string>

required

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

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

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

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

Annotation

string

optional

Supplementary information about how the evaluation determined the compliance.

>= 1 characters<= 256 characters

OrderingTimestamp

string <date-time>

required

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

ResultToken

string

required

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

TestMode

boolean

optional

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.

Examples

Responses

🟢200Success

application/json

Body

<p/>

FailedEvaluations

array[object (Evaluation) {5}]

optional

Requests that failed because of a client or server error.

>= 0 items<= 100 items

ComplianceResourceType

string

required

The type of Amazon Web Services resource that was evaluated.

>= 1 characters<= 256 characters

ComplianceResourceId

string

required

The ID of the Amazon Web Services resource that was evaluated.

>= 1 characters<= 768 characters

ComplianceType

enum<string>

required

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

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

Allowed values:

COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA

Annotation

string

optional

Supplementary information about how the evaluation determined the compliance.

>= 1 characters<= 256 characters

OrderingTimestamp

string <date-time>

required

🟠480InvalidParameterValueException

🟠481InvalidResultTokenException

🟠482NoSuchConfigRuleException

Modified at 2023-08-15 05:59:06