Skip to content

Commit 125f9f6

Browse files
author
awstools
committed
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.
1 parent ada2099 commit 125f9f6

15 files changed

+582
-256
lines changed

‎clients/client-controlcatalog/README.md

Lines changed: 9 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,7 @@
66

77
AWS SDK for JavaScript ControlCatalog Client for Node.js, Browser and React Native.
88

9-
<p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
10-
developers who need detailed information about how to programmatically identify and filter
11-
the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
12-
descriptions, syntax, and usage examples for each of the actions and data types that are
13-
supported by Amazon Web Services Control Catalog. </p>
14-
<p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
15-
<ul>
16-
<li>
17-
<p>
18-
<a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
19-
alphabetical list of all Control Catalog API operations.</p>
20-
</li>
21-
<li>
22-
<p>
23-
<a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
24-
alphabetical list of all Control Catalog data types.</p>
25-
</li>
26-
<li>
27-
<p>
28-
<a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
29-
parameters</a>: Parameters that all operations can use.</p>
30-
</li>
31-
<li>
32-
<p>
33-
<a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
34-
Client and server errors that all operations can return.</p>
35-
</li>
36-
</ul>
9+
<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>
3710

3811
## Installing
3912

@@ -245,6 +218,14 @@ ListCommonControls
245218

246219
[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/)
247220

221+
</details>
222+
<details>
223+
<summary>
224+
ListControlMappings
225+
</summary>
226+
227+
[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/)
228+
248229
</details>
249230
<details>
250231
<summary>

‎clients/client-controlcatalog/src/ControlCatalog.ts

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ import {
88
ListCommonControlsCommandInput,
99
ListCommonControlsCommandOutput,
1010
} from "./commands/ListCommonControlsCommand";
11+
import {
12+
ListControlMappingsCommand,
13+
ListControlMappingsCommandInput,
14+
ListControlMappingsCommandOutput,
15+
} from "./commands/ListControlMappingsCommand";
1116
import {
1217
ListControlsCommand,
1318
ListControlsCommandInput,
@@ -24,6 +29,7 @@ import { ControlCatalogClient, ControlCatalogClientConfig } from "./ControlCatal
2429
const commands = {
2530
GetControlCommand,
2631
ListCommonControlsCommand,
32+
ListControlMappingsCommand,
2733
ListControlsCommand,
2834
ListDomainsCommand,
2935
ListObjectivesCommand,
@@ -59,6 +65,24 @@ export interface ControlCatalog {
5965
cb: (err: any, data?: ListCommonControlsCommandOutput) => void
6066
): void;
6167

68+
/**
69+
* @see {@link ListControlMappingsCommand}
70+
*/
71+
listControlMappings(): Promise<ListControlMappingsCommandOutput>;
72+
listControlMappings(
73+
args: ListControlMappingsCommandInput,
74+
options?: __HttpHandlerOptions
75+
): Promise<ListControlMappingsCommandOutput>;
76+
listControlMappings(
77+
args: ListControlMappingsCommandInput,
78+
cb: (err: any, data?: ListControlMappingsCommandOutput) => void
79+
): void;
80+
listControlMappings(
81+
args: ListControlMappingsCommandInput,
82+
options: __HttpHandlerOptions,
83+
cb: (err: any, data?: ListControlMappingsCommandOutput) => void
84+
): void;
85+
6286
/**
6387
* @see {@link ListControlsCommand}
6488
*/
@@ -100,34 +124,7 @@ export interface ControlCatalog {
100124
}
101125

102126
/**
103-
* <p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
104-
* developers who need detailed information about how to programmatically identify and filter
105-
* the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
106-
* descriptions, syntax, and usage examples for each of the actions and data types that are
107-
* supported by Amazon Web Services Control Catalog. </p>
108-
* <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
109-
* <ul>
110-
* <li>
111-
* <p>
112-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
113-
* alphabetical list of all Control Catalog API operations.</p>
114-
* </li>
115-
* <li>
116-
* <p>
117-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
118-
* alphabetical list of all Control Catalog data types.</p>
119-
* </li>
120-
* <li>
121-
* <p>
122-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
123-
* parameters</a>: Parameters that all operations can use.</p>
124-
* </li>
125-
* <li>
126-
* <p>
127-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
128-
* Client and server errors that all operations can return.</p>
129-
* </li>
130-
* </ul>
127+
* <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>
131128
* @public
132129
*/
133130
export class ControlCatalog extends ControlCatalogClient implements ControlCatalog {}

‎clients/client-controlcatalog/src/ControlCatalogClient.ts

Lines changed: 7 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@ import {
5555
} from "./auth/httpAuthSchemeProvider";
5656
import { GetControlCommandInput, GetControlCommandOutput } from "./commands/GetControlCommand";
5757
import { ListCommonControlsCommandInput, ListCommonControlsCommandOutput } from "./commands/ListCommonControlsCommand";
58+
import {
59+
ListControlMappingsCommandInput,
60+
ListControlMappingsCommandOutput,
61+
} from "./commands/ListControlMappingsCommand";
5862
import { ListControlsCommandInput, ListControlsCommandOutput } from "./commands/ListControlsCommand";
5963
import { ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
6064
import { ListObjectivesCommandInput, ListObjectivesCommandOutput } from "./commands/ListObjectivesCommand";
@@ -75,6 +79,7 @@ export { __Client };
7579
export type ServiceInputTypes =
7680
| GetControlCommandInput
7781
| ListCommonControlsCommandInput
82+
| ListControlMappingsCommandInput
7883
| ListControlsCommandInput
7984
| ListDomainsCommandInput
8085
| ListObjectivesCommandInput;
@@ -85,6 +90,7 @@ export type ServiceInputTypes =
8590
export type ServiceOutputTypes =
8691
| GetControlCommandOutput
8792
| ListCommonControlsCommandOutput
93+
| ListControlMappingsCommandOutput
8894
| ListControlsCommandOutput
8995
| ListDomainsCommandOutput
9096
| ListObjectivesCommandOutput;
@@ -280,34 +286,7 @@ export type ControlCatalogClientResolvedConfigType = __SmithyResolvedConfigurati
280286
export interface ControlCatalogClientResolvedConfig extends ControlCatalogClientResolvedConfigType {}
281287

282288
/**
283-
* <p>Welcome to the Amazon Web Services Control Catalog API reference. This guide is for
284-
* developers who need detailed information about how to programmatically identify and filter
285-
* the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
286-
* descriptions, syntax, and usage examples for each of the actions and data types that are
287-
* supported by Amazon Web Services Control Catalog. </p>
288-
* <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
289-
* <ul>
290-
* <li>
291-
* <p>
292-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
293-
* alphabetical list of all Control Catalog API operations.</p>
294-
* </li>
295-
* <li>
296-
* <p>
297-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
298-
* alphabetical list of all Control Catalog data types.</p>
299-
* </li>
300-
* <li>
301-
* <p>
302-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
303-
* parameters</a>: Parameters that all operations can use.</p>
304-
* </li>
305-
* <li>
306-
* <p>
307-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
308-
* Client and server errors that all operations can return.</p>
309-
* </li>
310-
* </ul>
289+
* <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>
311290
* @public
312291
*/
313292
export class ControlCatalogClient extends __Client<

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface GetControlCommandInput extends GetControlRequest {}
2828
export interface GetControlCommandOutput extends GetControlResponse, __MetadataBearer {}
2929

3030
/**
31-
* <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>
32-
* <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>
31+
* <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>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript
@@ -43,6 +42,9 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
4342
* const response = await client.send(command);
4443
* // { // GetControlResponse
4544
* // Arn: "STRING_VALUE", // required
45+
* // Aliases: [ // ControlAliases
46+
* // "STRING_VALUE",
47+
* // ],
4648
* // Name: "STRING_VALUE", // required
4749
* // Description: "STRING_VALUE", // required
4850
* // Behavior: "PREVENTIVE" || "PROACTIVE" || "DETECTIVE", // required
@@ -63,6 +65,9 @@ export interface GetControlCommandOutput extends GetControlResponse, __MetadataB
6365
* // },
6466
* // ],
6567
* // CreateTime: new Date("TIMESTAMP"),
68+
* // GovernedResources: [ // GovernedResources
69+
* // "STRING_VALUE",
70+
* // ],
6671
* // };
6772
*
6873
* ```

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

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@ export interface ListCommonControlsCommandInput extends ListCommonControlsReques
2828
export interface ListCommonControlsCommandOutput extends ListCommonControlsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Returns a paginated list of common controls from the Amazon Web Services Control
32-
* Catalog.</p>
33-
* <p>You can apply an optional filter to see common controls that have a specific objective. If
34-
* you don’t provide a filter, the operation returns all common controls. </p>
31+
* <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>
3532
* @example
3633
* Use a bare-bones client and the command you need to make an API call.
3734
* ```javascript

0 commit comments

Comments
 (0)