@aws-sdk/client-controlcatalog 3.826.0 → 3.828.0

package/dist-types/commands/ListControlMappingsCommand.d.ts

@@ -0,0 +1,111 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ControlCatalogClient";
+import { ListControlMappingsRequest, ListControlMappingsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListControlMappingsCommand}.
+ */
+export interface ListControlMappingsCommandInput extends ListControlMappingsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListControlMappingsCommand}.
+ */
+export interface ListControlMappingsCommandOutput extends ListControlMappingsResponse, __MetadataBearer {
+}
+declare const ListControlMappingsCommand_base: {
+    new (input: ListControlMappingsCommandInput): import("@smithy/smithy-client").CommandImpl<ListControlMappingsCommandInput, ListControlMappingsCommandOutput, ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [ListControlMappingsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListControlMappingsCommandInput, ListControlMappingsCommandOutput, ControlCatalogClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ControlCatalogClient, ListControlMappingsCommand } from "@aws-sdk/client-controlcatalog"; // ES Modules import
+ * // const { ControlCatalogClient, ListControlMappingsCommand } = require("@aws-sdk/client-controlcatalog"); // CommonJS import
+ * const client = new ControlCatalogClient(config);
+ * const input = { // ListControlMappingsRequest
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ *   Filter: { // ControlMappingFilter
+ *     ControlArns: [ // ControlArnFilterList
+ *       "STRING_VALUE",
+ *     ],
+ *     CommonControlArns: [ // CommonControlArnFilterList
+ *       "STRING_VALUE",
+ *     ],
+ *     MappingTypes: [ // MappingTypeFilterList
+ *       "FRAMEWORK" || "COMMON_CONTROL",
+ *     ],
+ *   },
+ * };
+ * const command = new ListControlMappingsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListControlMappingsResponse
+ * //   ControlMappings: [ // ControlMappings // required
+ * //     { // ControlMapping
+ * //       ControlArn: "STRING_VALUE", // required
+ * //       MappingType: "FRAMEWORK" || "COMMON_CONTROL", // required
+ * //       Mapping: { // Mapping Union: only one key present
+ * //         Framework: { // FrameworkMappingDetails
+ * //           Name: "STRING_VALUE", // required
+ * //           Item: "STRING_VALUE", // required
+ * //         },
+ * //         CommonControl: { // CommonControlMappingDetails
+ * //           CommonControlArn: "STRING_VALUE", // required
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListControlMappingsCommandInput - {@link ListControlMappingsCommandInput}
+ * @returns {@link ListControlMappingsCommandOutput}
+ * @see {@link ListControlMappingsCommandInput} for command's `input` shape.
+ * @see {@link ListControlMappingsCommandOutput} 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 declare class ListControlMappingsCommand extends ListControlMappingsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListControlMappingsRequest;
+            output: ListControlMappingsResponse;
+        };
+        sdk: {
+            input: ListControlMappingsCommandInput;
+            output: ListControlMappingsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListControlsCommand.d.ts

@@ -27,7 +27,7 @@ declare const ListControlsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <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>
+ * <p>Returns a paginated list of all available controls in the 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
@@ -37,6 +37,16 @@ declare const ListControlsCommand_base: {
  * const input = { // ListControlsRequest
  *   NextToken: "STRING_VALUE",
  *   MaxResults: Number("int"),
+ *   Filter: { // ControlFilter
+ *     Implementations: { // ImplementationFilter
+ *       Types: [ // ImplementationTypeFilterList
+ *         "STRING_VALUE",
+ *       ],
+ *       Identifiers: [ // ImplementationIdentifierFilterList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
  * };
  * const command = new ListControlsCommand(input);
  * const response = await client.send(command);
@@ -44,6 +54,9 @@ declare const ListControlsCommand_base: {
  * //   Controls: [ // Controls // required
  * //     { // ControlSummary
  * //       Arn: "STRING_VALUE", // required
+ * //       Aliases: [ // ControlAliases
+ * //         "STRING_VALUE",
+ * //       ],
  * //       Name: "STRING_VALUE", // required
  * //       Description: "STRING_VALUE", // required
  * //       Behavior: "PREVENTIVE" || "PROACTIVE" || "DETECTIVE",
@@ -53,6 +66,9 @@ declare const ListControlsCommand_base: {
  * //         Identifier: "STRING_VALUE",
  * //       },
  * //       CreateTime: new Date("TIMESTAMP"),
+ * //       GovernedResources: [ // GovernedResources
+ * //         "STRING_VALUE",
+ * //       ],
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

package/dist-types/commands/ListDomainsCommand.d.ts

@@ -27,7 +27,7 @@ declare const ListDomainsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a paginated list of domains from the Amazon Web Services Control Catalog.</p>
+ * <p>Returns a paginated list of domains from the Control Catalog.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListObjectivesCommand.d.ts

@@ -27,9 +27,7 @@ declare const ListObjectivesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a paginated list of objectives from the Amazon Web Services Control Catalog.</p>
- *          <p>You can apply an optional filter to see the objectives that belong to a specific domain.
- *       If you don’t provide a filter, the operation returns all objectives. </p>
+ * <p>Returns a paginated list of objectives from the Control Catalog.</p> <p>You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./GetControlCommand";
 export * from "./ListCommonControlsCommand";
+export * from "./ListControlMappingsCommand";
 export * from "./ListControlsCommand";
 export * from "./ListDomainsCommand";
 export * from "./ListObjectivesCommand";

package/dist-types/index.d.ts

@@ -1,32 +1,5 @@
 /**
- * <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>
  *
  * @packageDocumentation
  */