@aws-sdk/client-controlcatalog 3.826.0 → 3.830.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -28
- package/dist-cjs/ControlCatalog.js +2 -0
- package/dist-cjs/commands/ListControlMappingsCommand.js +26 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +15 -1
- package/dist-cjs/pagination/ListControlMappingsPaginator.js +7 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +45 -2
- package/dist-es/ControlCatalog.js +2 -0
- package/dist-es/commands/ListControlMappingsCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +14 -0
- package/dist-es/pagination/ListControlMappingsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +42 -1
- package/dist-types/ControlCatalog.d.ts +9 -28
- package/dist-types/ControlCatalogClient.d.ts +4 -30
- package/dist-types/commands/GetControlCommand.d.ts +7 -2
- package/dist-types/commands/ListCommonControlsCommand.d.ts +1 -4
- package/dist-types/commands/ListControlMappingsCommand.d.ts +111 -0
- package/dist-types/commands/ListControlsCommand.d.ts +17 -1
- package/dist-types/commands/ListDomainsCommand.d.ts +1 -1
- package/dist-types/commands/ListObjectivesCommand.d.ts +1 -3
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +7 -7
- package/dist-types/index.d.ts +1 -28
- package/dist-types/models/models_0.d.ts +223 -132
- package/dist-types/pagination/ListControlMappingsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/ControlCatalog.d.ts +18 -0
- package/dist-types/ts3.4/ControlCatalogClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/ListControlMappingsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +7 -7
- package/dist-types/ts3.4/models/models_0.d.ts +70 -0
- package/dist-types/ts3.4/pagination/ListControlMappingsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +4 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +4 -2
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -6,34 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript ControlCatalog Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>Welcome to the Amazon Web Services Control Catalog API
|
|
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>
|
|
37
10
|
|
|
38
11
|
## Installing
|
|
39
12
|
|
|
@@ -245,6 +218,14 @@ ListCommonControls
|
|
|
245
218
|
|
|
246
219
|
[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/)
|
|
247
220
|
|
|
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
|
+
|
|
248
229
|
</details>
|
|
249
230
|
<details>
|
|
250
231
|
<summary>
|
|
@@ -4,6 +4,7 @@ exports.ControlCatalog = void 0;
|
|
|
4
4
|
const smithy_client_1 = require("@smithy/smithy-client");
|
|
5
5
|
const GetControlCommand_1 = require("./commands/GetControlCommand");
|
|
6
6
|
const ListCommonControlsCommand_1 = require("./commands/ListCommonControlsCommand");
|
|
7
|
+
const ListControlMappingsCommand_1 = require("./commands/ListControlMappingsCommand");
|
|
7
8
|
const ListControlsCommand_1 = require("./commands/ListControlsCommand");
|
|
8
9
|
const ListDomainsCommand_1 = require("./commands/ListDomainsCommand");
|
|
9
10
|
const ListObjectivesCommand_1 = require("./commands/ListObjectivesCommand");
|
|
@@ -11,6 +12,7 @@ const ControlCatalogClient_1 = require("./ControlCatalogClient");
|
|
|
11
12
|
const commands = {
|
|
12
13
|
GetControlCommand: GetControlCommand_1.GetControlCommand,
|
|
13
14
|
ListCommonControlsCommand: ListCommonControlsCommand_1.ListCommonControlsCommand,
|
|
15
|
+
ListControlMappingsCommand: ListControlMappingsCommand_1.ListControlMappingsCommand,
|
|
14
16
|
ListControlsCommand: ListControlsCommand_1.ListControlsCommand,
|
|
15
17
|
ListDomainsCommand: ListDomainsCommand_1.ListDomainsCommand,
|
|
16
18
|
ListObjectivesCommand: ListObjectivesCommand_1.ListObjectivesCommand,
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ListControlMappingsCommand = exports.$Command = void 0;
|
|
4
|
+
const middleware_endpoint_1 = require("@smithy/middleware-endpoint");
|
|
5
|
+
const middleware_serde_1 = require("@smithy/middleware-serde");
|
|
6
|
+
const smithy_client_1 = require("@smithy/smithy-client");
|
|
7
|
+
Object.defineProperty(exports, "$Command", { enumerable: true, get: function () { return smithy_client_1.Command; } });
|
|
8
|
+
const EndpointParameters_1 = require("../endpoint/EndpointParameters");
|
|
9
|
+
const Aws_restJson1_1 = require("../protocols/Aws_restJson1");
|
|
10
|
+
class ListControlMappingsCommand extends smithy_client_1.Command
|
|
11
|
+
.classBuilder()
|
|
12
|
+
.ep(EndpointParameters_1.commonParams)
|
|
13
|
+
.m(function (Command, cs, config, o) {
|
|
14
|
+
return [
|
|
15
|
+
(0, middleware_serde_1.getSerdePlugin)(config, this.serialize, this.deserialize),
|
|
16
|
+
(0, middleware_endpoint_1.getEndpointPlugin)(config, Command.getEndpointParameterInstructions()),
|
|
17
|
+
];
|
|
18
|
+
})
|
|
19
|
+
.s("ControlCatalog", "ListControlMappings", {})
|
|
20
|
+
.n("ControlCatalogClient", "ListControlMappingsCommand")
|
|
21
|
+
.f(void 0, void 0)
|
|
22
|
+
.ser(Aws_restJson1_1.se_ListControlMappingsCommand)
|
|
23
|
+
.de(Aws_restJson1_1.de_ListControlMappingsCommand)
|
|
24
|
+
.build() {
|
|
25
|
+
}
|
|
26
|
+
exports.ListControlMappingsCommand = ListControlMappingsCommand;
|
|
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
const tslib_1 = require("tslib");
|
|
4
4
|
tslib_1.__exportStar(require("./GetControlCommand"), exports);
|
|
5
5
|
tslib_1.__exportStar(require("./ListCommonControlsCommand"), exports);
|
|
6
|
+
tslib_1.__exportStar(require("./ListControlMappingsCommand"), exports);
|
|
6
7
|
tslib_1.__exportStar(require("./ListControlsCommand"), exports);
|
|
7
8
|
tslib_1.__exportStar(require("./ListDomainsCommand"), exports);
|
|
8
9
|
tslib_1.__exportStar(require("./ListObjectivesCommand"), exports);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.ResourceNotFoundException = exports.ControlSeverity = exports.ControlScope = exports.ControlBehavior = exports.ValidationException = exports.ThrottlingException = exports.InternalServerException = exports.AccessDeniedException = void 0;
|
|
3
|
+
exports.Mapping = exports.MappingType = exports.ResourceNotFoundException = exports.ControlSeverity = exports.ControlScope = exports.ControlBehavior = exports.ValidationException = exports.ThrottlingException = exports.InternalServerException = exports.AccessDeniedException = void 0;
|
|
4
4
|
const ControlCatalogServiceException_1 = require("./ControlCatalogServiceException");
|
|
5
5
|
class AccessDeniedException extends ControlCatalogServiceException_1.ControlCatalogServiceException {
|
|
6
6
|
name = "AccessDeniedException";
|
|
@@ -96,3 +96,17 @@ class ResourceNotFoundException extends ControlCatalogServiceException_1.Control
|
|
|
96
96
|
}
|
|
97
97
|
}
|
|
98
98
|
exports.ResourceNotFoundException = ResourceNotFoundException;
|
|
99
|
+
exports.MappingType = {
|
|
100
|
+
COMMON_CONTROL: "COMMON_CONTROL",
|
|
101
|
+
FRAMEWORK: "FRAMEWORK",
|
|
102
|
+
};
|
|
103
|
+
var Mapping;
|
|
104
|
+
(function (Mapping) {
|
|
105
|
+
Mapping.visit = (value, visitor) => {
|
|
106
|
+
if (value.Framework !== undefined)
|
|
107
|
+
return visitor.Framework(value.Framework);
|
|
108
|
+
if (value.CommonControl !== undefined)
|
|
109
|
+
return visitor.CommonControl(value.CommonControl);
|
|
110
|
+
return visitor._(value.$unknown[0], value.$unknown[1]);
|
|
111
|
+
};
|
|
112
|
+
})(Mapping || (exports.Mapping = Mapping = {}));
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.paginateListControlMappings = void 0;
|
|
4
|
+
const core_1 = require("@smithy/core");
|
|
5
|
+
const ListControlMappingsCommand_1 = require("../commands/ListControlMappingsCommand");
|
|
6
|
+
const ControlCatalogClient_1 = require("../ControlCatalogClient");
|
|
7
|
+
exports.paginateListControlMappings = (0, core_1.createPaginator)(ControlCatalogClient_1.ControlCatalogClient, ListControlMappingsCommand_1.ListControlMappingsCommand, "NextToken", "NextToken", "MaxResults");
|
|
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
const tslib_1 = require("tslib");
|
|
4
4
|
tslib_1.__exportStar(require("./Interfaces"), exports);
|
|
5
5
|
tslib_1.__exportStar(require("./ListCommonControlsPaginator"), exports);
|
|
6
|
+
tslib_1.__exportStar(require("./ListControlMappingsPaginator"), exports);
|
|
6
7
|
tslib_1.__exportStar(require("./ListControlsPaginator"), exports);
|
|
7
8
|
tslib_1.__exportStar(require("./ListDomainsPaginator"), exports);
|
|
8
9
|
tslib_1.__exportStar(require("./ListObjectivesPaginator"), exports);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.de_ListObjectivesCommand = exports.de_ListDomainsCommand = exports.de_ListControlsCommand = exports.de_ListCommonControlsCommand = exports.de_GetControlCommand = exports.se_ListObjectivesCommand = exports.se_ListDomainsCommand = exports.se_ListControlsCommand = exports.se_ListCommonControlsCommand = exports.se_GetControlCommand = void 0;
|
|
3
|
+
exports.de_ListObjectivesCommand = exports.de_ListDomainsCommand = exports.de_ListControlsCommand = exports.de_ListControlMappingsCommand = exports.de_ListCommonControlsCommand = exports.de_GetControlCommand = exports.se_ListObjectivesCommand = exports.se_ListDomainsCommand = exports.se_ListControlsCommand = exports.se_ListControlMappingsCommand = exports.se_ListCommonControlsCommand = exports.se_GetControlCommand = void 0;
|
|
4
4
|
const core_1 = require("@aws-sdk/core");
|
|
5
5
|
const core_2 = require("@smithy/core");
|
|
6
6
|
const smithy_client_1 = require("@smithy/smithy-client");
|
|
@@ -38,15 +38,38 @@ const se_ListCommonControlsCommand = async (input, context) => {
|
|
|
38
38
|
return b.build();
|
|
39
39
|
};
|
|
40
40
|
exports.se_ListCommonControlsCommand = se_ListCommonControlsCommand;
|
|
41
|
+
const se_ListControlMappingsCommand = async (input, context) => {
|
|
42
|
+
const b = (0, core_2.requestBuilder)(input, context);
|
|
43
|
+
const headers = {
|
|
44
|
+
"content-type": "application/json",
|
|
45
|
+
};
|
|
46
|
+
b.bp("/list-control-mappings");
|
|
47
|
+
const query = (0, smithy_client_1.map)({
|
|
48
|
+
[_nT]: [, input[_NT]],
|
|
49
|
+
[_mR]: [() => input.MaxResults !== void 0, () => input[_MR].toString()],
|
|
50
|
+
});
|
|
51
|
+
let body;
|
|
52
|
+
body = JSON.stringify((0, smithy_client_1.take)(input, {
|
|
53
|
+
Filter: (_) => (0, smithy_client_1._json)(_),
|
|
54
|
+
}));
|
|
55
|
+
b.m("POST").h(headers).q(query).b(body);
|
|
56
|
+
return b.build();
|
|
57
|
+
};
|
|
58
|
+
exports.se_ListControlMappingsCommand = se_ListControlMappingsCommand;
|
|
41
59
|
const se_ListControlsCommand = async (input, context) => {
|
|
42
60
|
const b = (0, core_2.requestBuilder)(input, context);
|
|
43
|
-
const headers = {
|
|
61
|
+
const headers = {
|
|
62
|
+
"content-type": "application/json",
|
|
63
|
+
};
|
|
44
64
|
b.bp("/list-controls");
|
|
45
65
|
const query = (0, smithy_client_1.map)({
|
|
46
66
|
[_nT]: [, input[_NT]],
|
|
47
67
|
[_mR]: [() => input.MaxResults !== void 0, () => input[_MR].toString()],
|
|
48
68
|
});
|
|
49
69
|
let body;
|
|
70
|
+
body = JSON.stringify((0, smithy_client_1.take)(input, {
|
|
71
|
+
Filter: (_) => (0, smithy_client_1._json)(_),
|
|
72
|
+
}));
|
|
50
73
|
b.m("POST").h(headers).q(query).b(body);
|
|
51
74
|
return b.build();
|
|
52
75
|
};
|
|
@@ -91,10 +114,12 @@ const de_GetControlCommand = async (output, context) => {
|
|
|
91
114
|
});
|
|
92
115
|
const data = (0, smithy_client_1.expectNonNull)((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context)), "body");
|
|
93
116
|
const doc = (0, smithy_client_1.take)(data, {
|
|
117
|
+
Aliases: smithy_client_1._json,
|
|
94
118
|
Arn: smithy_client_1.expectString,
|
|
95
119
|
Behavior: smithy_client_1.expectString,
|
|
96
120
|
CreateTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
97
121
|
Description: smithy_client_1.expectString,
|
|
122
|
+
GovernedResources: smithy_client_1._json,
|
|
98
123
|
Implementation: smithy_client_1._json,
|
|
99
124
|
Name: smithy_client_1.expectString,
|
|
100
125
|
Parameters: smithy_client_1._json,
|
|
@@ -121,6 +146,22 @@ const de_ListCommonControlsCommand = async (output, context) => {
|
|
|
121
146
|
return contents;
|
|
122
147
|
};
|
|
123
148
|
exports.de_ListCommonControlsCommand = de_ListCommonControlsCommand;
|
|
149
|
+
const de_ListControlMappingsCommand = async (output, context) => {
|
|
150
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
151
|
+
return de_CommandError(output, context);
|
|
152
|
+
}
|
|
153
|
+
const contents = (0, smithy_client_1.map)({
|
|
154
|
+
$metadata: deserializeMetadata(output),
|
|
155
|
+
});
|
|
156
|
+
const data = (0, smithy_client_1.expectNonNull)((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context)), "body");
|
|
157
|
+
const doc = (0, smithy_client_1.take)(data, {
|
|
158
|
+
ControlMappings: smithy_client_1._json,
|
|
159
|
+
NextToken: smithy_client_1.expectString,
|
|
160
|
+
});
|
|
161
|
+
Object.assign(contents, doc);
|
|
162
|
+
return contents;
|
|
163
|
+
};
|
|
164
|
+
exports.de_ListControlMappingsCommand = de_ListControlMappingsCommand;
|
|
124
165
|
const de_ListControlsCommand = async (output, context) => {
|
|
125
166
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
126
167
|
return de_CommandError(output, context);
|
|
@@ -295,10 +336,12 @@ const de_Controls = (output, context) => {
|
|
|
295
336
|
};
|
|
296
337
|
const de_ControlSummary = (output, context) => {
|
|
297
338
|
return (0, smithy_client_1.take)(output, {
|
|
339
|
+
Aliases: smithy_client_1._json,
|
|
298
340
|
Arn: smithy_client_1.expectString,
|
|
299
341
|
Behavior: smithy_client_1.expectString,
|
|
300
342
|
CreateTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
|
|
301
343
|
Description: smithy_client_1.expectString,
|
|
344
|
+
GovernedResources: smithy_client_1._json,
|
|
302
345
|
Implementation: smithy_client_1._json,
|
|
303
346
|
Name: smithy_client_1.expectString,
|
|
304
347
|
Severity: smithy_client_1.expectString,
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { createAggregatedClient } from "@smithy/smithy-client";
|
|
2
2
|
import { GetControlCommand } from "./commands/GetControlCommand";
|
|
3
3
|
import { ListCommonControlsCommand, } from "./commands/ListCommonControlsCommand";
|
|
4
|
+
import { ListControlMappingsCommand, } from "./commands/ListControlMappingsCommand";
|
|
4
5
|
import { ListControlsCommand, } from "./commands/ListControlsCommand";
|
|
5
6
|
import { ListDomainsCommand } from "./commands/ListDomainsCommand";
|
|
6
7
|
import { ListObjectivesCommand, } from "./commands/ListObjectivesCommand";
|
|
@@ -8,6 +9,7 @@ import { ControlCatalogClient } from "./ControlCatalogClient";
|
|
|
8
9
|
const commands = {
|
|
9
10
|
GetControlCommand,
|
|
10
11
|
ListCommonControlsCommand,
|
|
12
|
+
ListControlMappingsCommand,
|
|
11
13
|
ListControlsCommand,
|
|
12
14
|
ListDomainsCommand,
|
|
13
15
|
ListObjectivesCommand,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { getSerdePlugin } from "@smithy/middleware-serde";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { commonParams } from "../endpoint/EndpointParameters";
|
|
5
|
+
import { de_ListControlMappingsCommand, se_ListControlMappingsCommand } from "../protocols/Aws_restJson1";
|
|
6
|
+
export { $Command };
|
|
7
|
+
export class ListControlMappingsCommand extends $Command
|
|
8
|
+
.classBuilder()
|
|
9
|
+
.ep(commonParams)
|
|
10
|
+
.m(function (Command, cs, config, o) {
|
|
11
|
+
return [
|
|
12
|
+
getSerdePlugin(config, this.serialize, this.deserialize),
|
|
13
|
+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
|
|
14
|
+
];
|
|
15
|
+
})
|
|
16
|
+
.s("ControlCatalog", "ListControlMappings", {})
|
|
17
|
+
.n("ControlCatalogClient", "ListControlMappingsCommand")
|
|
18
|
+
.f(void 0, void 0)
|
|
19
|
+
.ser(se_ListControlMappingsCommand)
|
|
20
|
+
.de(de_ListControlMappingsCommand)
|
|
21
|
+
.build() {
|
|
22
|
+
}
|
|
@@ -88,3 +88,17 @@ export class ResourceNotFoundException extends __BaseException {
|
|
|
88
88
|
this.Message = opts.Message;
|
|
89
89
|
}
|
|
90
90
|
}
|
|
91
|
+
export const MappingType = {
|
|
92
|
+
COMMON_CONTROL: "COMMON_CONTROL",
|
|
93
|
+
FRAMEWORK: "FRAMEWORK",
|
|
94
|
+
};
|
|
95
|
+
export var Mapping;
|
|
96
|
+
(function (Mapping) {
|
|
97
|
+
Mapping.visit = (value, visitor) => {
|
|
98
|
+
if (value.Framework !== undefined)
|
|
99
|
+
return visitor.Framework(value.Framework);
|
|
100
|
+
if (value.CommonControl !== undefined)
|
|
101
|
+
return visitor.CommonControl(value.CommonControl);
|
|
102
|
+
return visitor._(value.$unknown[0], value.$unknown[1]);
|
|
103
|
+
};
|
|
104
|
+
})(Mapping || (Mapping = {}));
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { createPaginator } from "@smithy/core";
|
|
2
|
+
import { ListControlMappingsCommand, } from "../commands/ListControlMappingsCommand";
|
|
3
|
+
import { ControlCatalogClient } from "../ControlCatalogClient";
|
|
4
|
+
export const paginateListControlMappings = createPaginator(ControlCatalogClient, ListControlMappingsCommand, "NextToken", "NextToken", "MaxResults");
|
|
@@ -33,15 +33,37 @@ export const se_ListCommonControlsCommand = async (input, context) => {
|
|
|
33
33
|
b.m("POST").h(headers).q(query).b(body);
|
|
34
34
|
return b.build();
|
|
35
35
|
};
|
|
36
|
+
export const se_ListControlMappingsCommand = async (input, context) => {
|
|
37
|
+
const b = rb(input, context);
|
|
38
|
+
const headers = {
|
|
39
|
+
"content-type": "application/json",
|
|
40
|
+
};
|
|
41
|
+
b.bp("/list-control-mappings");
|
|
42
|
+
const query = map({
|
|
43
|
+
[_nT]: [, input[_NT]],
|
|
44
|
+
[_mR]: [() => input.MaxResults !== void 0, () => input[_MR].toString()],
|
|
45
|
+
});
|
|
46
|
+
let body;
|
|
47
|
+
body = JSON.stringify(take(input, {
|
|
48
|
+
Filter: (_) => _json(_),
|
|
49
|
+
}));
|
|
50
|
+
b.m("POST").h(headers).q(query).b(body);
|
|
51
|
+
return b.build();
|
|
52
|
+
};
|
|
36
53
|
export const se_ListControlsCommand = async (input, context) => {
|
|
37
54
|
const b = rb(input, context);
|
|
38
|
-
const headers = {
|
|
55
|
+
const headers = {
|
|
56
|
+
"content-type": "application/json",
|
|
57
|
+
};
|
|
39
58
|
b.bp("/list-controls");
|
|
40
59
|
const query = map({
|
|
41
60
|
[_nT]: [, input[_NT]],
|
|
42
61
|
[_mR]: [() => input.MaxResults !== void 0, () => input[_MR].toString()],
|
|
43
62
|
});
|
|
44
63
|
let body;
|
|
64
|
+
body = JSON.stringify(take(input, {
|
|
65
|
+
Filter: (_) => _json(_),
|
|
66
|
+
}));
|
|
45
67
|
b.m("POST").h(headers).q(query).b(body);
|
|
46
68
|
return b.build();
|
|
47
69
|
};
|
|
@@ -83,10 +105,12 @@ export const de_GetControlCommand = async (output, context) => {
|
|
|
83
105
|
});
|
|
84
106
|
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
85
107
|
const doc = take(data, {
|
|
108
|
+
Aliases: _json,
|
|
86
109
|
Arn: __expectString,
|
|
87
110
|
Behavior: __expectString,
|
|
88
111
|
CreateTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
89
112
|
Description: __expectString,
|
|
113
|
+
GovernedResources: _json,
|
|
90
114
|
Implementation: _json,
|
|
91
115
|
Name: __expectString,
|
|
92
116
|
Parameters: _json,
|
|
@@ -111,6 +135,21 @@ export const de_ListCommonControlsCommand = async (output, context) => {
|
|
|
111
135
|
Object.assign(contents, doc);
|
|
112
136
|
return contents;
|
|
113
137
|
};
|
|
138
|
+
export const de_ListControlMappingsCommand = async (output, context) => {
|
|
139
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
140
|
+
return de_CommandError(output, context);
|
|
141
|
+
}
|
|
142
|
+
const contents = map({
|
|
143
|
+
$metadata: deserializeMetadata(output),
|
|
144
|
+
});
|
|
145
|
+
const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
|
|
146
|
+
const doc = take(data, {
|
|
147
|
+
ControlMappings: _json,
|
|
148
|
+
NextToken: __expectString,
|
|
149
|
+
});
|
|
150
|
+
Object.assign(contents, doc);
|
|
151
|
+
return contents;
|
|
152
|
+
};
|
|
114
153
|
export const de_ListControlsCommand = async (output, context) => {
|
|
115
154
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
116
155
|
return de_CommandError(output, context);
|
|
@@ -282,10 +321,12 @@ const de_Controls = (output, context) => {
|
|
|
282
321
|
};
|
|
283
322
|
const de_ControlSummary = (output, context) => {
|
|
284
323
|
return take(output, {
|
|
324
|
+
Aliases: _json,
|
|
285
325
|
Arn: __expectString,
|
|
286
326
|
Behavior: __expectString,
|
|
287
327
|
CreateTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
288
328
|
Description: __expectString,
|
|
329
|
+
GovernedResources: _json,
|
|
289
330
|
Implementation: _json,
|
|
290
331
|
Name: __expectString,
|
|
291
332
|
Severity: __expectString,
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
2
2
|
import { GetControlCommandInput, GetControlCommandOutput } from "./commands/GetControlCommand";
|
|
3
3
|
import { ListCommonControlsCommandInput, ListCommonControlsCommandOutput } from "./commands/ListCommonControlsCommand";
|
|
4
|
+
import { ListControlMappingsCommandInput, ListControlMappingsCommandOutput } from "./commands/ListControlMappingsCommand";
|
|
4
5
|
import { ListControlsCommandInput, ListControlsCommandOutput } from "./commands/ListControlsCommand";
|
|
5
6
|
import { ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
|
|
6
7
|
import { ListObjectivesCommandInput, ListObjectivesCommandOutput } from "./commands/ListObjectivesCommand";
|
|
@@ -19,6 +20,13 @@ export interface ControlCatalog {
|
|
|
19
20
|
listCommonControls(args: ListCommonControlsCommandInput, options?: __HttpHandlerOptions): Promise<ListCommonControlsCommandOutput>;
|
|
20
21
|
listCommonControls(args: ListCommonControlsCommandInput, cb: (err: any, data?: ListCommonControlsCommandOutput) => void): void;
|
|
21
22
|
listCommonControls(args: ListCommonControlsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCommonControlsCommandOutput) => void): void;
|
|
23
|
+
/**
|
|
24
|
+
* @see {@link ListControlMappingsCommand}
|
|
25
|
+
*/
|
|
26
|
+
listControlMappings(): Promise<ListControlMappingsCommandOutput>;
|
|
27
|
+
listControlMappings(args: ListControlMappingsCommandInput, options?: __HttpHandlerOptions): Promise<ListControlMappingsCommandOutput>;
|
|
28
|
+
listControlMappings(args: ListControlMappingsCommandInput, cb: (err: any, data?: ListControlMappingsCommandOutput) => void): void;
|
|
29
|
+
listControlMappings(args: ListControlMappingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListControlMappingsCommandOutput) => void): void;
|
|
22
30
|
/**
|
|
23
31
|
* @see {@link ListControlsCommand}
|
|
24
32
|
*/
|
|
@@ -42,34 +50,7 @@ export interface ControlCatalog {
|
|
|
42
50
|
listObjectives(args: ListObjectivesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListObjectivesCommandOutput) => void): void;
|
|
43
51
|
}
|
|
44
52
|
/**
|
|
45
|
-
* <p>Welcome to the Amazon Web Services Control Catalog API
|
|
46
|
-
* developers who need detailed information about how to programmatically identify and filter
|
|
47
|
-
* the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
|
|
48
|
-
* descriptions, syntax, and usage examples for each of the actions and data types that are
|
|
49
|
-
* supported by Amazon Web Services Control Catalog. </p>
|
|
50
|
-
* <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
|
|
51
|
-
* <ul>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>
|
|
54
|
-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
|
|
55
|
-
* alphabetical list of all Control Catalog API operations.</p>
|
|
56
|
-
* </li>
|
|
57
|
-
* <li>
|
|
58
|
-
* <p>
|
|
59
|
-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
|
|
60
|
-
* alphabetical list of all Control Catalog data types.</p>
|
|
61
|
-
* </li>
|
|
62
|
-
* <li>
|
|
63
|
-
* <p>
|
|
64
|
-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
|
|
65
|
-
* parameters</a>: Parameters that all operations can use.</p>
|
|
66
|
-
* </li>
|
|
67
|
-
* <li>
|
|
68
|
-
* <p>
|
|
69
|
-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
|
|
70
|
-
* Client and server errors that all operations can return.</p>
|
|
71
|
-
* </li>
|
|
72
|
-
* </ul>
|
|
53
|
+
* <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>
|
|
73
54
|
* @public
|
|
74
55
|
*/
|
|
75
56
|
export declare class ControlCatalog extends ControlCatalogClient implements ControlCatalog {
|
|
@@ -9,6 +9,7 @@ import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalc
|
|
|
9
9
|
import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
|
|
10
10
|
import { GetControlCommandInput, GetControlCommandOutput } from "./commands/GetControlCommand";
|
|
11
11
|
import { ListCommonControlsCommandInput, ListCommonControlsCommandOutput } from "./commands/ListCommonControlsCommand";
|
|
12
|
+
import { ListControlMappingsCommandInput, ListControlMappingsCommandOutput } from "./commands/ListControlMappingsCommand";
|
|
12
13
|
import { ListControlsCommandInput, ListControlsCommandOutput } from "./commands/ListControlsCommand";
|
|
13
14
|
import { ListDomainsCommandInput, ListDomainsCommandOutput } from "./commands/ListDomainsCommand";
|
|
14
15
|
import { ListObjectivesCommandInput, ListObjectivesCommandOutput } from "./commands/ListObjectivesCommand";
|
|
@@ -18,11 +19,11 @@ export { __Client };
|
|
|
18
19
|
/**
|
|
19
20
|
* @public
|
|
20
21
|
*/
|
|
21
|
-
export type ServiceInputTypes = GetControlCommandInput | ListCommonControlsCommandInput | ListControlsCommandInput | ListDomainsCommandInput | ListObjectivesCommandInput;
|
|
22
|
+
export type ServiceInputTypes = GetControlCommandInput | ListCommonControlsCommandInput | ListControlMappingsCommandInput | ListControlsCommandInput | ListDomainsCommandInput | ListObjectivesCommandInput;
|
|
22
23
|
/**
|
|
23
24
|
* @public
|
|
24
25
|
*/
|
|
25
|
-
export type ServiceOutputTypes = GetControlCommandOutput | ListCommonControlsCommandOutput | ListControlsCommandOutput | ListDomainsCommandOutput | ListObjectivesCommandOutput;
|
|
26
|
+
export type ServiceOutputTypes = GetControlCommandOutput | ListCommonControlsCommandOutput | ListControlMappingsCommandOutput | ListControlsCommandOutput | ListDomainsCommandOutput | ListObjectivesCommandOutput;
|
|
26
27
|
/**
|
|
27
28
|
* @public
|
|
28
29
|
*/
|
|
@@ -174,34 +175,7 @@ export type ControlCatalogClientResolvedConfigType = __SmithyResolvedConfigurati
|
|
|
174
175
|
export interface ControlCatalogClientResolvedConfig extends ControlCatalogClientResolvedConfigType {
|
|
175
176
|
}
|
|
176
177
|
/**
|
|
177
|
-
* <p>Welcome to the Amazon Web Services Control Catalog API
|
|
178
|
-
* developers who need detailed information about how to programmatically identify and filter
|
|
179
|
-
* the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides
|
|
180
|
-
* descriptions, syntax, and usage examples for each of the actions and data types that are
|
|
181
|
-
* supported by Amazon Web Services Control Catalog. </p>
|
|
182
|
-
* <p>Use the following links to get started with the Amazon Web Services Control Catalog API:</p>
|
|
183
|
-
* <ul>
|
|
184
|
-
* <li>
|
|
185
|
-
* <p>
|
|
186
|
-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Operations.html">Actions</a>: An
|
|
187
|
-
* alphabetical list of all Control Catalog API operations.</p>
|
|
188
|
-
* </li>
|
|
189
|
-
* <li>
|
|
190
|
-
* <p>
|
|
191
|
-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/API_Types.html">Data types</a>: An
|
|
192
|
-
* alphabetical list of all Control Catalog data types.</p>
|
|
193
|
-
* </li>
|
|
194
|
-
* <li>
|
|
195
|
-
* <p>
|
|
196
|
-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonParameters.html">Common
|
|
197
|
-
* parameters</a>: Parameters that all operations can use.</p>
|
|
198
|
-
* </li>
|
|
199
|
-
* <li>
|
|
200
|
-
* <p>
|
|
201
|
-
* <a href="https://docs.aws.amazon.com/controlcatalog/latest/APIReference/CommonErrors.html">Common errors</a>:
|
|
202
|
-
* Client and server errors that all operations can return.</p>
|
|
203
|
-
* </li>
|
|
204
|
-
* </ul>
|
|
178
|
+
* <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>
|
|
205
179
|
* @public
|
|
206
180
|
*/
|
|
207
181
|
export declare class ControlCatalogClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ControlCatalogClientResolvedConfig> {
|
|
@@ -27,8 +27,7 @@ declare const GetControlCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <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>
|
|
31
|
-
* <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>
|
|
30
|
+
* <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>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -42,6 +41,9 @@ declare const GetControlCommand_base: {
|
|
|
42
41
|
* const response = await client.send(command);
|
|
43
42
|
* // { // GetControlResponse
|
|
44
43
|
* // Arn: "STRING_VALUE", // required
|
|
44
|
+
* // Aliases: [ // ControlAliases
|
|
45
|
+
* // "STRING_VALUE",
|
|
46
|
+
* // ],
|
|
45
47
|
* // Name: "STRING_VALUE", // required
|
|
46
48
|
* // Description: "STRING_VALUE", // required
|
|
47
49
|
* // Behavior: "PREVENTIVE" || "PROACTIVE" || "DETECTIVE", // required
|
|
@@ -62,6 +64,9 @@ declare const GetControlCommand_base: {
|
|
|
62
64
|
* // },
|
|
63
65
|
* // ],
|
|
64
66
|
* // CreateTime: new Date("TIMESTAMP"),
|
|
67
|
+
* // GovernedResources: [ // GovernedResources
|
|
68
|
+
* // "STRING_VALUE",
|
|
69
|
+
* // ],
|
|
65
70
|
* // };
|
|
66
71
|
*
|
|
67
72
|
* ```
|
|
@@ -27,10 +27,7 @@ declare const ListCommonControlsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a paginated list of common controls from the Amazon Web Services Control
|
|
31
|
-
* Catalog.</p>
|
|
32
|
-
* <p>You can apply an optional filter to see common controls that have a specific objective. If
|
|
33
|
-
* you don’t provide a filter, the operation returns all common controls. </p>
|
|
30
|
+
* <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>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|