-
Notifications
You must be signed in to change notification settings - Fork 587
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(client-controlcatalog): AWS Control Tower provides two new publi…
…c APIs controlcatalog:ListControls and controlcatalog:GetControl under controlcatalog service namespace, which enable customers to programmatically retrieve control metadata of available controls.
- Loading branch information
awstools
committed
Aug 1, 2024
1 parent
2f7a965
commit c897818
Showing
11 changed files
with
947 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
clients/client-controlcatalog/src/commands/GetControlCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // smithy-typescript generated code | ||
| import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
| import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
| import { Command as $Command } from "@smithy/smithy-client"; | ||
| import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
|
||
| import { ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlCatalogClient"; | ||
| import { commonParams } from "../endpoint/EndpointParameters"; | ||
| import { GetControlRequest, GetControlResponse } from "../models/models_0"; | ||
| import { de_GetControlCommand, se_GetControlCommand } from "../protocols/Aws_restJson1"; | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| export type { __MetadataBearer }; | ||
| export { $Command }; | ||
| /** | ||
| * @public | ||
| * | ||
| * The input for {@link GetControlCommand}. | ||
| */ | ||
| export interface GetControlCommandInput extends GetControlRequest {} | ||
| /** | ||
| * @public | ||
| * | ||
| * The output of {@link GetControlCommand}. | ||
| */ | ||
| export interface GetControlCommandOutput extends GetControlResponse, __MetadataBearer {} | ||
|
|
||
| /** | ||
| * <p>Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the <i>ControlArn</i> parameter, in ARN form. <code>GetControl</code> accepts <i>controltower</i> or <i>controlcatalog</i> control ARNs as input. Returns a <i>controlcatalog</i> ARN format.</p> | ||
| * <p>In the API response, controls that have the value <code>GLOBAL</code> in the <code>Scope</code> field do not show the <code>DeployableRegions</code> field, because it does not apply. Controls that have the value <code>REGIONAL</code> in the <code>Scope</code> field return a value for the <code>DeployableRegions</code> field, as shown in the example.</p> | ||
| * @example | ||
| * Use a bare-bones client and the command you need to make an API call. | ||
| * ```javascript | ||
| * import { ControlCatalogClient, GetControlCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import | ||
| * // const { ControlCatalogClient, GetControlCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import | ||
| * const client = new ControlCatalogClient(config); | ||
| * const input = { // GetControlRequest | ||
| * ControlArn: "STRING_VALUE", // required | ||
| * }; | ||
| * const command = new GetControlCommand(input); | ||
| * const response = await client.send(command); | ||
| * // { // GetControlResponse | ||
| * // Arn: "STRING_VALUE", // required | ||
| * // Name: "STRING_VALUE", // required | ||
| * // Description: "STRING_VALUE", // required | ||
| * // Behavior: "PREVENTIVE" || "PROACTIVE" || "DETECTIVE", // required | ||
| * // RegionConfiguration: { // RegionConfiguration | ||
| * // Scope: "GLOBAL" || "REGIONAL", // required | ||
| * // DeployableRegions: [ // DeployableRegions | ||
| * // "STRING_VALUE", | ||
| * // ], | ||
| * // }, | ||
| * // }; | ||
| * | ||
| * ``` | ||
| * | ||
| * @param GetControlCommandInput - {@link GetControlCommandInput} | ||
| * @returns {@link GetControlCommandOutput} | ||
| * @see {@link GetControlCommandInput} for command's `input` shape. | ||
| * @see {@link GetControlCommandOutput} for command's `response` shape. | ||
| * @see {@link ControlCatalogClientResolvedConfig | config} for ControlCatalogClient's `config` shape. | ||
| * | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * <p>You do not have sufficient access to perform this action.</p> | ||
| * | ||
| * @throws {@link InternalServerException} (server fault) | ||
| * <p>An internal service error occurred during the processing of your request. Try again later.</p> | ||
| * | ||
| * @throws {@link ResourceNotFoundException} (client fault) | ||
| * <p>The requested resource does not exist.</p> | ||
| * | ||
| * @throws {@link ThrottlingException} (client fault) | ||
| * <p>The request was denied due to request throttling.</p> | ||
| * | ||
| * @throws {@link ValidationException} (client fault) | ||
| * <p>The request has invalid or missing parameters.</p> | ||
| * | ||
| * @throws {@link ControlCatalogServiceException} | ||
| * <p>Base exception class for all service exceptions from ControlCatalog service.</p> | ||
| * | ||
| * @public | ||
| */ | ||
| export class GetControlCommand extends $Command | ||
| .classBuilder< | ||
| GetControlCommandInput, | ||
| GetControlCommandOutput, | ||
| ControlCatalogClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes | ||
| >() | ||
| .ep({ | ||
| ...commonParams, | ||
| }) | ||
| .m(function (this: any, Command: any, cs: any, config: ControlCatalogClientResolvedConfig, o: any) { | ||
| return [ | ||
| getSerdePlugin(config, this.serialize, this.deserialize), | ||
| getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
| ]; | ||
| }) | ||
| .s("ControlCatalog", "GetControl", {}) | ||
| .n("ControlCatalogClient", "GetControlCommand") | ||
| .f(void 0, void 0) | ||
| .ser(se_GetControlCommand) | ||
| .de(de_GetControlCommand) | ||
| .build() {} |
102 changes: 102 additions & 0 deletions
102
clients/client-controlcatalog/src/commands/ListControlsCommand.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| // smithy-typescript generated code | ||
| import { getEndpointPlugin } from "@smithy/middleware-endpoint"; | ||
| import { getSerdePlugin } from "@smithy/middleware-serde"; | ||
| import { Command as $Command } from "@smithy/smithy-client"; | ||
| import { MetadataBearer as __MetadataBearer } from "@smithy/types"; | ||
|
|
||
| import { ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlCatalogClient"; | ||
| import { commonParams } from "../endpoint/EndpointParameters"; | ||
| import { ListControlsRequest, ListControlsResponse } from "../models/models_0"; | ||
| import { de_ListControlsCommand, se_ListControlsCommand } from "../protocols/Aws_restJson1"; | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| export type { __MetadataBearer }; | ||
| export { $Command }; | ||
| /** | ||
| * @public | ||
| * | ||
| * The input for {@link ListControlsCommand}. | ||
| */ | ||
| export interface ListControlsCommandInput extends ListControlsRequest {} | ||
| /** | ||
| * @public | ||
| * | ||
| * The output of {@link ListControlsCommand}. | ||
| */ | ||
| export interface ListControlsCommandOutput extends ListControlsResponse, __MetadataBearer {} | ||
|
|
||
| /** | ||
| * <p>Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type <i>controlSummary</i>. The ARN is returned in the global <i>controlcatalog</i> format, as shown in the examples.</p> | ||
| * @example | ||
| * Use a bare-bones client and the command you need to make an API call. | ||
| * ```javascript | ||
| * import { ControlCatalogClient, ListControlsCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import | ||
| * // const { ControlCatalogClient, ListControlsCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import | ||
| * const client = new ControlCatalogClient(config); | ||
| * const input = { // ListControlsRequest | ||
| * NextToken: "STRING_VALUE", | ||
| * MaxResults: Number("int"), | ||
| * }; | ||
| * const command = new ListControlsCommand(input); | ||
| * const response = await client.send(command); | ||
| * // { // ListControlsResponse | ||
| * // Controls: [ // Controls // required | ||
| * // { // ControlSummary | ||
| * // Arn: "STRING_VALUE", // required | ||
| * // Name: "STRING_VALUE", // required | ||
| * // Description: "STRING_VALUE", // required | ||
| * // }, | ||
| * // ], | ||
| * // NextToken: "STRING_VALUE", | ||
| * // }; | ||
| * | ||
| * ``` | ||
| * | ||
| * @param ListControlsCommandInput - {@link ListControlsCommandInput} | ||
| * @returns {@link ListControlsCommandOutput} | ||
| * @see {@link ListControlsCommandInput} for command's `input` shape. | ||
| * @see {@link ListControlsCommandOutput} for command's `response` shape. | ||
| * @see {@link ControlCatalogClientResolvedConfig | config} for ControlCatalogClient's `config` shape. | ||
| * | ||
| * @throws {@link AccessDeniedException} (client fault) | ||
| * <p>You do not have sufficient access to perform this action.</p> | ||
| * | ||
| * @throws {@link InternalServerException} (server fault) | ||
| * <p>An internal service error occurred during the processing of your request. Try again later.</p> | ||
| * | ||
| * @throws {@link ThrottlingException} (client fault) | ||
| * <p>The request was denied due to request throttling.</p> | ||
| * | ||
| * @throws {@link ValidationException} (client fault) | ||
| * <p>The request has invalid or missing parameters.</p> | ||
| * | ||
| * @throws {@link ControlCatalogServiceException} | ||
| * <p>Base exception class for all service exceptions from ControlCatalog service.</p> | ||
| * | ||
| * @public | ||
| */ | ||
| export class ListControlsCommand extends $Command | ||
| .classBuilder< | ||
| ListControlsCommandInput, | ||
| ListControlsCommandOutput, | ||
| ControlCatalogClientResolvedConfig, | ||
| ServiceInputTypes, | ||
| ServiceOutputTypes | ||
| >() | ||
| .ep({ | ||
| ...commonParams, | ||
| }) | ||
| .m(function (this: any, Command: any, cs: any, config: ControlCatalogClientResolvedConfig, o: any) { | ||
| return [ | ||
| getSerdePlugin(config, this.serialize, this.deserialize), | ||
| getEndpointPlugin(config, Command.getEndpointParameterInstructions()), | ||
| ]; | ||
| }) | ||
| .s("ControlCatalog", "ListControls", {}) | ||
| .n("ControlCatalogClient", "ListControlsCommand") | ||
| .f(void 0, void 0) | ||
| .ser(se_ListControlsCommand) | ||
| .de(de_ListControlsCommand) | ||
| .build() {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,6 @@ | ||
| // smithy-typescript generated code | ||
| export * from "./GetControlCommand"; | ||
| export * from "./ListCommonControlsCommand"; | ||
| export * from "./ListControlsCommand"; | ||
| export * from "./ListDomainsCommand"; | ||
| export * from "./ListObjectivesCommand"; |
Oops, something went wrong.