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
/
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.
Request Request Example
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ResourceEvaluationId": "string"
}'
Response Response Example
200 - Example 1
{
  "ResourceEvaluationId": "string",
  "EvaluationMode": "DETECTIVE",
  "EvaluationStatus": {
    "Status": "IN_PROGRESS",
    "FailureReason": "string"
  },
  "EvaluationStartTimestamp": "string",
  "Compliance": "COMPLIANT",
  "EvaluationContext": {
    "EvaluationContextIdentifier": "string"
  },
  "ResourceDetails": {
    "ResourceId": "string",
    "ResourceType": "string",
    "ResourceConfiguration": "string",
    "ResourceConfigurationSchemaType": "CFN_RESOURCE_SCHEMA"
  }
}

Request

Header Params
X-Amz-Target
string 
required
Body Params application/json
ResourceEvaluationId
string 
required
The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.
>= 1 characters<= 128 characters
Examples

Responses

🟢200Success
application/json
Body
ResourceEvaluationId
string 
optional
The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.
>= 1 characters<= 128 characters
EvaluationMode
enum<string> 
optional
Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.
Allowed values:
DETECTIVEPROACTIVE
EvaluationStatus
object 
optional
Returns an EvaluationStatus object.
Status
enum<string> 
required
The status of an execution. The valid values are In_Progress, Succeeded or Failed.
Allowed values:
IN_PROGRESSFAILEDSUCCEEDED
FailureReason
string 
optional
An explanation for failed execution status.
>= 1 characters<= 1024 characters
EvaluationStartTimestamp
string <date-time>
optional
The start timestamp when Config rule starts evaluating compliance for the provided resource details.
Compliance
enum<string> 
optional
The compliance status of the resource evaluation summary.
Allowed values:
COMPLIANTNON_COMPLIANTNOT_APPLICABLEINSUFFICIENT_DATA
EvaluationContext
object 
optional
Returns an EvaluationContext object.
EvaluationContextIdentifier
string 
optional
A unique EvaluationContextIdentifier ID for an EvaluationContext.
>= 1 characters<= 128 characters
ResourceDetails
object 
optional
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
🟠480ResourceNotFoundException
Modified at over 1 year ago
Previous
/
Next
/
Built with