- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetResourceEvaluationSummaryCommand
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.
To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ConfigServiceClient, GetResourceEvaluationSummaryCommand } from "@aws-sdk/client-config-service"; // ES Modules import
// const { ConfigServiceClient, GetResourceEvaluationSummaryCommand } = require("@aws-sdk/client-config-service"); // CommonJS import
const client = new ConfigServiceClient(config);
const input = { // GetResourceEvaluationSummaryRequest
ResourceEvaluationId: "STRING_VALUE", // required
};
const command = new GetResourceEvaluationSummaryCommand(input);
const response = await client.send(command);
// { // GetResourceEvaluationSummaryResponse
// ResourceEvaluationId: "STRING_VALUE",
// EvaluationMode: "DETECTIVE" || "PROACTIVE",
// EvaluationStatus: { // EvaluationStatus
// Status: "IN_PROGRESS" || "FAILED" || "SUCCEEDED", // required
// FailureReason: "STRING_VALUE",
// },
// EvaluationStartTimestamp: new Date("TIMESTAMP"),
// Compliance: "COMPLIANT" || "NON_COMPLIANT" || "NOT_APPLICABLE" || "INSUFFICIENT_DATA",
// EvaluationContext: { // EvaluationContext
// EvaluationContextIdentifier: "STRING_VALUE",
// },
// ResourceDetails: { // ResourceDetails
// ResourceId: "STRING_VALUE", // required
// ResourceType: "STRING_VALUE", // required
// ResourceConfiguration: "STRING_VALUE", // required
// ResourceConfigurationSchemaType: "CFN_RESOURCE_SCHEMA",
// },
// };
GetResourceEvaluationSummaryCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ResourceEvaluationId Required | string | undefined | The unique |
GetResourceEvaluationSummaryCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Compliance | ComplianceType | undefined | The compliance status of the resource evaluation summary. |
EvaluationContext | EvaluationContext | undefined | Returns an |
EvaluationMode | EvaluationMode | undefined | Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive. |
EvaluationStartTimestamp | Date | undefined | The start timestamp when Config rule starts evaluating compliance for the provided resource details. |
EvaluationStatus | EvaluationStatus | undefined | Returns an |
ResourceDetails | ResourceDetails | undefined | Returns a |
ResourceEvaluationId | string | undefined | The unique |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ResourceNotFoundException | client | You have specified a resource that does not exist. |
ConfigServiceServiceException | Base exception class for all service exceptions from ConfigService service. |