Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartResourceEvaluation

Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Amazon Config rules. You can also use it for evaluation purposes. Amazon Config recommends using an evaluation context. It runs an execution against the resource details with all of the Amazon Config rules in your account that match with the specified proactive mode and resource type.

Note

Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema.

You can find the Resource type schema in " Amazon public extensions" within the Amazon CloudFormation registry or with the following CLI commmand: aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE.

For more information, see Managing extensions through the Amazon CloudFormation registry and Amazon resource and property types reference in the Amazon CloudFormation User Guide.

Request Syntax


{
   "ClientToken": "string",
   "EvaluationContext": { 
      "EvaluationContextIdentifier": "string"
   },
   "EvaluationMode": "string",
   "EvaluationTimeout": number,
   "ResourceDetails": { 
      "ResourceConfiguration": "string",
      "ResourceConfigurationSchemaType": "string",
      "ResourceId": "string",
      "ResourceType": "string"
   }
}

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.

ClientToken

A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

Note

Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

Type: String

Length Constraints: Minimum length of 64. Maximum length of 256.

Required: No

EvaluationContext

Returns an EvaluationContext object.

Type: EvaluationContext object

Required: No

EvaluationMode

The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.

Type: String

Valid Values: DETECTIVE | PROACTIVE

Required: Yes

EvaluationTimeout

The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Amazon Config uses the default.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 3600.

Required: No

ResourceDetails

Returns a ResourceDetails object.

Type: ResourceDetails object

Required: Yes

Response Syntax


{
   "ResourceEvaluationId": "string"
}

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.

ResourceEvaluationId

A unique ResourceEvaluationId that is associated with a single execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Errors

For information about the errors that are common to all actions, see Common Errors.

IdempotentParameterMismatch

Using the same client token with one or more different parameters. Specify a new client token with the parameter changes and try again.

HTTP Status Code: 400

InvalidParameterValueException

One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.

HTTP Status Code: 400