AWS Config
  1. Root
AWS Config
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ResourceDetails": {
        "ResourceId": "string",
        "ResourceType": "string",
        "ResourceConfiguration": "string",
        "ResourceConfigurationSchemaType": "CFN_RESOURCE_SCHEMA"
    },
    "EvaluationContext": {
        "EvaluationContextIdentifier": "string"
    },
    "EvaluationMode": "DETECTIVE",
    "EvaluationTimeout": 0,
    "ClientToken": "string"
}'
Response Response Example
200 - Example 1
{
  "ResourceEvaluationId": "string"
}

Request

Header Params
X-Amz-Target
string 
required
Body Params application/json
ResourceDetails
object 
required
Returns a ResourceDetails object.
ResourceId
string 
required
A unique resource ID for an evaluation.
>= 1 characters<= 768 characters
ResourceType
string 
required
The type of resource being evaluated.
>= 1 characters<= 256 characters
ResourceConfiguration
string 
required
The resource definition to be evaluated as per the resource configuration schema type.
>= 1 characters<= 51200 characters
ResourceConfigurationSchemaType
enum<string> 
optional
The schema type of the resource configuration.
Allowed value:
CFN_RESOURCE_SCHEMA
EvaluationContext
object 
optional
Returns an EvaluationContext object.
EvaluationContextIdentifier
string 
optional
A unique EvaluationContextIdentifier ID for an EvaluationContext.
>= 1 characters<= 128 characters
EvaluationMode
enum<string> 
required
The mode of an evaluation. The valid values for this API are DETECTIVE and PROACTIVE.
Allowed values:
DETECTIVEPROACTIVE
EvaluationTimeout
integer 
optional
The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.
>= 0<= 3600
ClientToken
string 
optional
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.
>= 64 characters<= 256 characters
Examples

Responses

🟢200Success
application/json
Body
ResourceEvaluationId
string 
optional
A unique ResourceEvaluationId that is associated with a single execution.
>= 1 characters<= 128 characters
🟠480InvalidParameterValueException
🟠481IdempotentParameterMismatch
Modified at 2023-08-15 05:59:05
Previous
/
Next
/
Built with