feat(client-controlcatalog): Introduced ListControlMappings API that retrieves control mappings. Added control aliases and governed resources fields in GetControl and ListControls APIs. New filtering capability in ListControls API, with implementation identifiers and implementation types.

Author: awstools

clients/client-controlcatalog/README.md

@@ -6,34 +6,7 @@
 
 AWS SDK for JavaScript ControlCatalog Client for Node.js, Browser and React Native.
 
-<p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
-developers who need detailed information about how to programmatically identify and filter
-the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
-descriptions, syntax, and usage examples for each of the actions and data types that are
-supported by Amazon Web Services Control Catalog. </p>
-<p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
-<ul>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
-alphabetical list of all Control Catalog API operations.</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
-alphabetical list of all Control Catalog data types.</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
-parameters</a>: Parameters that all operations can use.</p>
-</li>
-<li>
-<p>
-<a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
-Client and server errors that all operations can return.</p>
-</li>
-</ul>
+<p>Welcome to the Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Control Catalog. </p> <p>Use the following links to get started with the Control Catalog API:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An alphabetical list of all Control Catalog API operations.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An alphabetical list of all Control Catalog data types.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common parameters</a>: Parameters that all operations can use.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>: Client and server errors that all operations can return.</p> </li> </ul>
 
 ## Installing
 
@@ -245,6 +218,14 @@ ListCommonControls
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controlcatalog/command/ListCommonControlsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controlcatalog/Interface/ListCommonControlsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controlcatalog/Interface/ListCommonControlsCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListControlMappings
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/controlcatalog/command/ListControlMappingsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controlcatalog/Interface/ListControlMappingsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-controlcatalog/Interface/ListControlMappingsCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-controlcatalog/src/ControlCatalog.ts

@@ -8,6 +8,11 @@ import {
   ListCommonControlsCommandInput,
   ListCommonControlsCommandOutput,
 } from "./commands/ListCommonControlsCommand";
+import {
+  ListControlMappingsCommand,
+  ListControlMappingsCommandInput,
+  ListControlMappingsCommandOutput,
+} from "./commands/ListControlMappingsCommand";
 import {
   ListControlsCommand,
   ListControlsCommandInput,
@@ -24,6 +29,7 @@ import { ControlCatalogClient, ControlCatalogClientConfig } from "./ControlCatal
 const commands = {
   GetControlCommand,
   ListCommonControlsCommand,
+  ListControlMappingsCommand,
   ListControlsCommand,
   ListDomainsCommand,
   ListObjectivesCommand,
@@ -59,6 +65,24 @@ export interface ControlCatalog {
     cb: (err: any, data?: ListCommonControlsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListControlMappingsCommand}
+   */
+  listControlMappings(): Promise<ListControlMappingsCommandOutput>;
+  listControlMappings(
+    args: ListControlMappingsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListControlMappingsCommandOutput>;
+  listControlMappings(
+    args: ListControlMappingsCommandInput,
+    cb: (err: any, data?: ListControlMappingsCommandOutput) => void
+  ): void;
+  listControlMappings(
+    args: ListControlMappingsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListControlMappingsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListControlsCommand}
    */
@@ -100,34 +124,7 @@ export interface ControlCatalog {
 }
 
 /**
- * <p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
- *       developers who need detailed information about how to programmatically identify and filter
- *       the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
- *       descriptions, syntax, and usage examples for each of the actions and data types that are
- *       supported by Amazon Web Services Control Catalog. </p>
- *          <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
- *           alphabetical list of all Control Catalog API operations.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
- *           alphabetical list of all Control Catalog data types.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
- *           parameters</a>: Parameters that all operations can use.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
- *           Client and server errors that all operations can return.</p>
- *             </li>
- *          </ul>
+ * <p>Welcome to the Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Control Catalog. </p> <p>Use the following links to get started with the Control Catalog API:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An alphabetical list of all Control Catalog API operations.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An alphabetical list of all Control Catalog data types.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common parameters</a>: Parameters that all operations can use.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>: Client and server errors that all operations can return.</p> </li> </ul>
  * @public
  */
 export class ControlCatalog extends ControlCatalogClient implements ControlCatalog {}

clients/client-controlcatalog/src/ControlCatalogClient.ts

@@ -55,6 +55,10 @@ import {
 } from "./auth/httpAuthSchemeProvider";
 import { GetControlCommandInput, GetControlCommandOutput } from "./commands/GetControlCommand";
 import { ListCommonControlsCommandInput, ListCommonControlsCommandOutput } from "./commands/ListCommonControlsCommand";
+import {
+  ListControlMappingsCommandInput,
+  ListControlMappingsCommandOutput,
+} from "./commands/ListControlMappingsCommand";
 import { ListControlsCommandInput, ListControlsCommandOutput } from "./commands/ListControlsCommand";
 import { ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
 import { ListObjectivesCommandInput, ListObjectivesCommandOutput } from "./commands/ListObjectivesCommand";
@@ -75,6 +79,7 @@ export { __Client };
 export type ServiceInputTypes =
   | GetControlCommandInput
   | ListCommonControlsCommandInput
+  | ListControlMappingsCommandInput
   | ListControlsCommandInput
   | ListDomainsCommandInput
   | ListObjectivesCommandInput;
@@ -85,6 +90,7 @@ export type ServiceInputTypes =
 export type ServiceOutputTypes =
   | GetControlCommandOutput
   | ListCommonControlsCommandOutput
+  | ListControlMappingsCommandOutput
   | ListControlsCommandOutput
   | ListDomainsCommandOutput
   | ListObjectivesCommandOutput;
@@ -280,34 +286,7 @@ export type ControlCatalogClientResolvedConfigType = __SmithyResolvedConfigurati
 export interface ControlCatalogClientResolvedConfig extends ControlCatalogClientResolvedConfigType {}
 
 /**
- * <p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
- *       developers who need detailed information about how to programmatically identify and filter
- *       the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
- *       descriptions, syntax, and usage examples for each of the actions and data types that are
- *       supported by Amazon Web Services Control Catalog. </p>
- *          <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
- *           alphabetical list of all Control Catalog API operations.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
- *           alphabetical list of all Control Catalog data types.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
- *           parameters</a>: Parameters that all operations can use.</p>
- *             </li>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
- *           Client and server errors that all operations can return.</p>
- *             </li>
- *          </ul>
+ * <p>Welcome to the Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Control Catalog. </p> <p>Use the following links to get started with the Control Catalog API:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An alphabetical list of all Control Catalog API operations.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An alphabetical list of all Control Catalog data types.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common parameters</a>: Parameters that all operations can use.</p> </li> <li> <p> <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>: Client and server errors that all operations can return.</p> </li> </ul>
  * @public
  */
 export class ControlCatalogClient extends __Client<

clients/client-controlcatalog/src/commands/GetControlCommand.ts

@@ -28,8 +28,7 @@ export interface GetControlCommandInput extends GetControlRequest {}
 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>
+ * <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
@@ -43,6 +42,9 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
  * const response = await client.send(command);
  * // { // GetControlResponse
  * //   Arn: "STRING_VALUE", // required
+ * //   Aliases: [ // ControlAliases
+ * //     "STRING_VALUE",
+ * //   ],
  * //   Name: "STRING_VALUE", // required
  * //   Description: "STRING_VALUE", // required
  * //   Behavior: "PREVENTIVE" || "PROACTIVE" || "DETECTIVE", // required
@@ -63,6 +65,9 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
  * //     },
  * //   ],
  * //   CreateTime: new Date("TIMESTAMP"),
+ * //   GovernedResources: [ // GovernedResources
+ * //     "STRING_VALUE",
+ * //   ],
  * // };
  *
  * ```

clients/client-controlcatalog/src/commands/ListCommonControlsCommand.ts

@@ -28,10 +28,7 @@ export interface ListCommonControlsCommandInput extends ListCommonControlsReques
 export interface ListCommonControlsCommandOutput extends ListCommonControlsResponse, __MetadataBearer {}
 
 /**
- * <p>Returns a paginated list of common controls from the Amazon Web Services Control
- *       Catalog.</p>
- *          <p>You can apply an optional filter to see common controls that have a specific objective. If
- *       you don’t provide a filter, the operation returns all common controls. </p>
+ * <p>Returns a paginated list of common controls from the Amazon Web Services Control Catalog.</p> <p>You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript