Skip to content

Commit

Permalink
feat(client-config-service): With this release, you can use AWS Confi…
Browse files Browse the repository at this point in the history 
…g to evaluate your resources for compliance with Config rules before they are created or updated. Using Config rules in proactive mode enables you to test and build compliant resource templates or check resource configurations at the time they are provisioned.
  • Loading branch information
awstools committed Nov 29, 2022
1 parent 1d1950f commit 384d079
Show file tree
Hide file tree
Showing 19 changed files with 2,764 additions and 716 deletions.
129 changes: 126 additions & 3 deletions clients/client-config-service/src/ConfigService.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,11 @@ import {
GetResourceConfigHistoryCommandInput,
GetResourceConfigHistoryCommandOutput,
} from "./commands/GetResourceConfigHistoryCommand";
import {
GetResourceEvaluationSummaryCommand,
GetResourceEvaluationSummaryCommandInput,
GetResourceEvaluationSummaryCommandOutput,
} from "./commands/GetResourceEvaluationSummaryCommand";
import {
GetStoredQueryCommand,
GetStoredQueryCommandInput,
Expand All @@ -321,6 +326,11 @@ import {
ListDiscoveredResourcesCommandInput,
ListDiscoveredResourcesCommandOutput,
} from "./commands/ListDiscoveredResourcesCommand";
import {
ListResourceEvaluationsCommand,
ListResourceEvaluationsCommandInput,
ListResourceEvaluationsCommandOutput,
} from "./commands/ListResourceEvaluationsCommand";
import {
ListStoredQueriesCommand,
ListStoredQueriesCommandInput,
Expand Down Expand Up @@ -431,6 +441,11 @@ import {
StartRemediationExecutionCommandInput,
StartRemediationExecutionCommandOutput,
} from "./commands/StartRemediationExecutionCommand";
import {
StartResourceEvaluationCommand,
StartResourceEvaluationCommandInput,
StartResourceEvaluationCommandOutput,
} from "./commands/StartResourceEvaluationCommand";
import {
StopConfigurationRecorderCommand,
StopConfigurationRecorderCommandInput,
Expand Down Expand Up @@ -1178,8 +1193,8 @@ export class ConfigService extends ConfigServiceClient {
}

/**
* <p>Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.
* Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.</p>
* <p>Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each
* conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.</p>
* <note>
* <p>The results can return an empty result page, but if you have a <code>nextToken</code>, the results are displayed on the next page.</p>
* </note>
Expand Down Expand Up @@ -2354,7 +2369,7 @@ export class ConfigService extends ConfigServiceClient {
/**
* <p>Returns the evaluation results for the specified Amazon Web Services resource.
* The results indicate which Config rules were used to evaluate
* the resource, when each rule was last used, and whether the resource
* the resource, when each rule was last invoked, and whether the resource
* complies with each rule.</p>
*/
public getComplianceDetailsByResource(
Expand Down Expand Up @@ -2796,6 +2811,40 @@ export class ConfigService extends ConfigServiceClient {
}
}

/**
* <p>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. </p>
*/
public getResourceEvaluationSummary(
args: GetResourceEvaluationSummaryCommandInput,
options?: __HttpHandlerOptions
): Promise<GetResourceEvaluationSummaryCommandOutput>;
public getResourceEvaluationSummary(
args: GetResourceEvaluationSummaryCommandInput,
cb: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void
): void;
public getResourceEvaluationSummary(
args: GetResourceEvaluationSummaryCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void
): void;
public getResourceEvaluationSummary(
args: GetResourceEvaluationSummaryCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void),
cb?: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void
): Promise<GetResourceEvaluationSummaryCommandOutput> | void {
const command = new GetResourceEvaluationSummaryCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}

/**
* <p>Returns the details of a specific stored query.</p>
*/
Expand Down Expand Up @@ -2949,6 +2998,38 @@ export class ConfigService extends ConfigServiceClient {
}
}

/**
* <p>Returns a list of proactive resource evaluations.</p>
*/
public listResourceEvaluations(
args: ListResourceEvaluationsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListResourceEvaluationsCommandOutput>;
public listResourceEvaluations(
args: ListResourceEvaluationsCommandInput,
cb: (err: any, data?: ListResourceEvaluationsCommandOutput) => void
): void;
public listResourceEvaluations(
args: ListResourceEvaluationsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListResourceEvaluationsCommandOutput) => void
): void;
public listResourceEvaluations(
args: ListResourceEvaluationsCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: ListResourceEvaluationsCommandOutput) => void),
cb?: (err: any, data?: ListResourceEvaluationsCommandOutput) => void
): Promise<ListResourceEvaluationsCommandOutput> | void {
const command = new ListResourceEvaluationsCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}

/**
* <p>Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100. </p>
*/
Expand Down Expand Up @@ -3540,6 +3621,9 @@ export class ConfigService extends ConfigServiceClient {
* <p>Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource.
* Remediation exceptions blocks auto-remediation until the exception is cleared.</p>
* </note>
* <note>
* <p>To place an exception on an Amazon Web Services resource, ensure remediation is set as manual remediation.</p>
* </note>
*/
public putRemediationExceptions(
args: PutRemediationExceptionsCommandInput,
Expand Down Expand Up @@ -3914,6 +3998,45 @@ export class ConfigService extends ConfigServiceClient {
}
}

/**
* <p>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.</p>
*
* <note>
* <p>Ensure you have the <code>cloudformation:DescribeType</code> role setup to validate the resource type schema.
* </p>
* </note>
*/
public startResourceEvaluation(
args: StartResourceEvaluationCommandInput,
options?: __HttpHandlerOptions
): Promise<StartResourceEvaluationCommandOutput>;
public startResourceEvaluation(
args: StartResourceEvaluationCommandInput,
cb: (err: any, data?: StartResourceEvaluationCommandOutput) => void
): void;
public startResourceEvaluation(
args: StartResourceEvaluationCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: StartResourceEvaluationCommandOutput) => void
): void;
public startResourceEvaluation(
args: StartResourceEvaluationCommandInput,
optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: StartResourceEvaluationCommandOutput) => void),
cb?: (err: any, data?: StartResourceEvaluationCommandOutput) => void
): Promise<StartResourceEvaluationCommandOutput> | void {
const command = new StartResourceEvaluationCommand(args);
if (typeof optionsOrCb === "function") {
this.send(command, optionsOrCb);
} else if (typeof cb === "function") {
if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
this.send(command, optionsOrCb || {}, cb);
} else {
return this.send(command, optionsOrCb);
}
}

/**
* <p>Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.</p>
*/
Expand Down
18 changes: 18 additions & 0 deletions clients/client-config-service/src/ConfigServiceClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,10 @@ import {
GetResourceConfigHistoryCommandInput,
GetResourceConfigHistoryCommandOutput,
} from "./commands/GetResourceConfigHistoryCommand";
import {
GetResourceEvaluationSummaryCommandInput,
GetResourceEvaluationSummaryCommandOutput,
} from "./commands/GetResourceEvaluationSummaryCommand";
import { GetStoredQueryCommandInput, GetStoredQueryCommandOutput } from "./commands/GetStoredQueryCommand";
import {
ListAggregateDiscoveredResourcesCommandInput,
Expand All @@ -294,6 +298,10 @@ import {
ListDiscoveredResourcesCommandInput,
ListDiscoveredResourcesCommandOutput,
} from "./commands/ListDiscoveredResourcesCommand";
import {
ListResourceEvaluationsCommandInput,
ListResourceEvaluationsCommandOutput,
} from "./commands/ListResourceEvaluationsCommand";
import { ListStoredQueriesCommandInput, ListStoredQueriesCommandOutput } from "./commands/ListStoredQueriesCommand";
import {
ListTagsForResourceCommandInput,
Expand Down Expand Up @@ -361,6 +369,10 @@ import {
StartRemediationExecutionCommandInput,
StartRemediationExecutionCommandOutput,
} from "./commands/StartRemediationExecutionCommand";
import {
StartResourceEvaluationCommandInput,
StartResourceEvaluationCommandOutput,
} from "./commands/StartResourceEvaluationCommand";
import {
StopConfigurationRecorderCommandInput,
StopConfigurationRecorderCommandOutput,
Expand Down Expand Up @@ -436,10 +448,12 @@ export type ServiceInputTypes =
| GetOrganizationConformancePackDetailedStatusCommandInput
| GetOrganizationCustomRulePolicyCommandInput
| GetResourceConfigHistoryCommandInput
| GetResourceEvaluationSummaryCommandInput
| GetStoredQueryCommandInput
| ListAggregateDiscoveredResourcesCommandInput
| ListConformancePackComplianceScoresCommandInput
| ListDiscoveredResourcesCommandInput
| ListResourceEvaluationsCommandInput
| ListStoredQueriesCommandInput
| ListTagsForResourceCommandInput
| PutAggregationAuthorizationCommandInput
Expand All @@ -462,6 +476,7 @@ export type ServiceInputTypes =
| StartConfigRulesEvaluationCommandInput
| StartConfigurationRecorderCommandInput
| StartRemediationExecutionCommandInput
| StartResourceEvaluationCommandInput
| StopConfigurationRecorderCommandInput
| TagResourceCommandInput
| UntagResourceCommandInput;
Expand Down Expand Up @@ -527,10 +542,12 @@ export type ServiceOutputTypes =
| GetOrganizationConformancePackDetailedStatusCommandOutput
| GetOrganizationCustomRulePolicyCommandOutput
| GetResourceConfigHistoryCommandOutput
| GetResourceEvaluationSummaryCommandOutput
| GetStoredQueryCommandOutput
| ListAggregateDiscoveredResourcesCommandOutput
| ListConformancePackComplianceScoresCommandOutput
| ListDiscoveredResourcesCommandOutput
| ListResourceEvaluationsCommandOutput
| ListStoredQueriesCommandOutput
| ListTagsForResourceCommandOutput
| PutAggregationAuthorizationCommandOutput
Expand All @@ -553,6 +570,7 @@ export type ServiceOutputTypes =
| StartConfigRulesEvaluationCommandOutput
| StartConfigurationRecorderCommandOutput
| StartRemediationExecutionCommandOutput
| StartResourceEvaluationCommandOutput
| StopConfigurationRecorderCommandOutput
| TagResourceCommandOutput
| UntagResourceCommandOutput;
Expand Down
4 changes: 2 additions & 2 deletions ...lient-config-service/src/commands/DescribeAggregateComplianceByConformancePacksCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ export interface DescribeAggregateComplianceByConformancePacksCommandOutput
__MetadataBearer {}

/**
* <p>Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.
* Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.</p>
* <p>Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each
* conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.</p>
* <note>
* <p>The results can return an empty result page, but if you have a <code>nextToken</code>, the results are displayed on the next page.</p>
* </note>
Expand Down
2 changes: 1 addition & 1 deletion clients/client-config-service/src/commands/GetComplianceDetailsByResourceCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export interface GetComplianceDetailsByResourceCommandOutput
/**
* <p>Returns the evaluation results for the specified Amazon Web Services resource.
* The results indicate which Config rules were used to evaluate
* the resource, when each rule was last used, and whether the resource
* the resource, when each rule was last invoked, and whether the resource
* complies with each rule.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Loading

0 comments on commit 384d079

Please sign in to comment.