@aws-sdk/client-controlcatalog 3.782.0 → 3.786.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.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ResourceNotFoundException = exports.ControlScope = exports.ControlBehavior = exports.ValidationException = exports.ThrottlingException = exports.InternalServerException = exports.AccessDeniedException = void 0;
3
+ 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";
@@ -75,6 +75,12 @@ exports.ControlScope = {
75
75
  GLOBAL: "GLOBAL",
76
76
  REGIONAL: "REGIONAL",
77
77
  };
78
+ exports.ControlSeverity = {
79
+ CRITICAL: "CRITICAL",
80
+ HIGH: "HIGH",
81
+ LOW: "LOW",
82
+ MEDIUM: "MEDIUM",
83
+ };
78
84
  class ResourceNotFoundException extends ControlCatalogServiceException_1.ControlCatalogServiceException {
79
85
  name = "ResourceNotFoundException";
80
86
  $fault = "client";
@@ -93,11 +93,13 @@ const de_GetControlCommand = async (output, context) => {
93
93
  const doc = (0, smithy_client_1.take)(data, {
94
94
  Arn: smithy_client_1.expectString,
95
95
  Behavior: smithy_client_1.expectString,
96
+ CreateTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
96
97
  Description: smithy_client_1.expectString,
97
98
  Implementation: smithy_client_1._json,
98
99
  Name: smithy_client_1.expectString,
99
100
  Parameters: smithy_client_1._json,
100
101
  RegionConfiguration: smithy_client_1._json,
102
+ Severity: smithy_client_1.expectString,
101
103
  });
102
104
  Object.assign(contents, doc);
103
105
  return contents;
@@ -128,7 +130,7 @@ const de_ListControlsCommand = async (output, context) => {
128
130
  });
129
131
  const data = (0, smithy_client_1.expectNonNull)((0, smithy_client_1.expectObject)(await (0, core_1.parseJsonBody)(output.body, context)), "body");
130
132
  const doc = (0, smithy_client_1.take)(data, {
131
- Controls: smithy_client_1._json,
133
+ Controls: (_) => de_Controls(_, context),
132
134
  NextToken: smithy_client_1.expectString,
133
135
  });
134
136
  Object.assign(contents, doc);
@@ -283,6 +285,25 @@ const de_CommonControlSummaryList = (output, context) => {
283
285
  });
284
286
  return retVal;
285
287
  };
288
+ const de_Controls = (output, context) => {
289
+ const retVal = (output || [])
290
+ .filter((e) => e != null)
291
+ .map((entry) => {
292
+ return de_ControlSummary(entry, context);
293
+ });
294
+ return retVal;
295
+ };
296
+ const de_ControlSummary = (output, context) => {
297
+ return (0, smithy_client_1.take)(output, {
298
+ Arn: smithy_client_1.expectString,
299
+ Behavior: smithy_client_1.expectString,
300
+ CreateTime: (_) => (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(_))),
301
+ Description: smithy_client_1.expectString,
302
+ Implementation: smithy_client_1._json,
303
+ Name: smithy_client_1.expectString,
304
+ Severity: smithy_client_1.expectString,
305
+ });
306
+ };
286
307
  const de_DomainSummary = (output, context) => {
287
308
  return (0, smithy_client_1.take)(output, {
288
309
  Arn: smithy_client_1.expectString,
@@ -68,6 +68,12 @@ export const ControlScope = {
68
68
  GLOBAL: "GLOBAL",
69
69
  REGIONAL: "REGIONAL",
70
70
  };
71
+ export const ControlSeverity = {
72
+ CRITICAL: "CRITICAL",
73
+ HIGH: "HIGH",
74
+ LOW: "LOW",
75
+ MEDIUM: "MEDIUM",
76
+ };
71
77
  export class ResourceNotFoundException extends __BaseException {
72
78
  name = "ResourceNotFoundException";
73
79
  $fault = "client";
@@ -85,11 +85,13 @@ export const de_GetControlCommand = async (output, context) => {
85
85
  const doc = take(data, {
86
86
  Arn: __expectString,
87
87
  Behavior: __expectString,
88
+ CreateTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
88
89
  Description: __expectString,
89
90
  Implementation: _json,
90
91
  Name: __expectString,
91
92
  Parameters: _json,
92
93
  RegionConfiguration: _json,
94
+ Severity: __expectString,
93
95
  });
94
96
  Object.assign(contents, doc);
95
97
  return contents;
@@ -118,7 +120,7 @@ export const de_ListControlsCommand = async (output, context) => {
118
120
  });
119
121
  const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
120
122
  const doc = take(data, {
121
- Controls: _json,
123
+ Controls: (_) => de_Controls(_, context),
122
124
  NextToken: __expectString,
123
125
  });
124
126
  Object.assign(contents, doc);
@@ -270,6 +272,25 @@ const de_CommonControlSummaryList = (output, context) => {
270
272
  });
271
273
  return retVal;
272
274
  };
275
+ const de_Controls = (output, context) => {
276
+ const retVal = (output || [])
277
+ .filter((e) => e != null)
278
+ .map((entry) => {
279
+ return de_ControlSummary(entry, context);
280
+ });
281
+ return retVal;
282
+ };
283
+ const de_ControlSummary = (output, context) => {
284
+ return take(output, {
285
+ Arn: __expectString,
286
+ Behavior: __expectString,
287
+ CreateTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
288
+ Description: __expectString,
289
+ Implementation: _json,
290
+ Name: __expectString,
291
+ Severity: __expectString,
292
+ });
293
+ };
273
294
  const de_DomainSummary = (output, context) => {
274
295
  return take(output, {
275
296
  Arn: __expectString,
@@ -45,6 +45,7 @@ declare const GetControlCommand_base: {
45
45
  * // Name: "STRING_VALUE", // required
46
46
  * // Description: "STRING_VALUE", // required
47
47
  * // Behavior: "PREVENTIVE" || "PROACTIVE" || "DETECTIVE", // required
48
+ * // Severity: "LOW" || "MEDIUM" || "HIGH" || "CRITICAL",
48
49
  * // RegionConfiguration: { // RegionConfiguration
49
50
  * // Scope: "GLOBAL" || "REGIONAL", // required
50
51
  * // DeployableRegions: [ // DeployableRegions
@@ -53,12 +54,14 @@ declare const GetControlCommand_base: {
53
54
  * // },
54
55
  * // Implementation: { // ImplementationDetails
55
56
  * // Type: "STRING_VALUE", // required
57
+ * // Identifier: "STRING_VALUE",
56
58
  * // },
57
59
  * // Parameters: [ // ControlParameters
58
60
  * // { // ControlParameter
59
61
  * // Name: "STRING_VALUE", // required
60
62
  * // },
61
63
  * // ],
64
+ * // CreateTime: new Date("TIMESTAMP"),
62
65
  * // };
63
66
  *
64
67
  * ```
@@ -46,6 +46,13 @@ declare const ListControlsCommand_base: {
46
46
  * // Arn: "STRING_VALUE", // required
47
47
  * // Name: "STRING_VALUE", // required
48
48
  * // Description: "STRING_VALUE", // required
49
+ * // Behavior: "PREVENTIVE" || "PROACTIVE" || "DETECTIVE",
50
+ * // Severity: "LOW" || "MEDIUM" || "HIGH" || "CRITICAL",
51
+ * // Implementation: { // ImplementationSummary
52
+ * // Type: "STRING_VALUE", // required
53
+ * // Identifier: "STRING_VALUE",
54
+ * // },
55
+ * // CreateTime: new Date("TIMESTAMP"),
49
56
  * // },
50
57
  * // ],
51
58
  * // NextToken: "STRING_VALUE",
@@ -265,6 +265,11 @@ export interface ImplementationDetails {
265
265
  * @public
266
266
  */
267
267
  Type: string | undefined;
268
+ /**
269
+ * <p>A service-specific identifier for the control, assigned by the service that implemented the control. For example, this identifier could be an Amazon Web Services Config Rule ID or a Security Hub Control ID.</p>
270
+ * @public
271
+ */
272
+ Identifier?: string | undefined;
268
273
  }
269
274
  /**
270
275
  * <p>Five types of control parameters are supported.</p>
@@ -371,6 +376,20 @@ export interface RegionConfiguration {
371
376
  */
372
377
  DeployableRegions?: string[] | undefined;
373
378
  }
379
+ /**
380
+ * @public
381
+ * @enum
382
+ */
383
+ export declare const ControlSeverity: {
384
+ readonly CRITICAL: "CRITICAL";
385
+ readonly HIGH: "HIGH";
386
+ readonly LOW: "LOW";
387
+ readonly MEDIUM: "MEDIUM";
388
+ };
389
+ /**
390
+ * @public
391
+ */
392
+ export type ControlSeverity = (typeof ControlSeverity)[keyof typeof ControlSeverity];
374
393
  /**
375
394
  * @public
376
395
  */
@@ -396,6 +415,11 @@ export interface GetControlResponse {
396
415
  * @public
397
416
  */
398
417
  Behavior: ControlBehavior | undefined;
418
+ /**
419
+ * <p>An enumerated type, with the following possible values:</p>
420
+ * @public
421
+ */
422
+ Severity?: ControlSeverity | undefined;
399
423
  /**
400
424
  * <p>Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control currently is available for deployment. For more information about scope, see <a href="https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/global-services.html">Global services</a>.</p>
401
425
  * <p>If you are applying controls through an Amazon Web Services Control Tower landing zone environment, remember that the values returned in the <code>RegionConfiguration</code> API operation are not related to the governed Regions in your landing zone. For example, if you are governing Regions <code>A</code>,<code>B</code>,and <code>C</code> while the control is available in Regions <code>A</code>, <code>B</code>, C<code>,</code> and <code>D</code>, you'd see a response with <code>DeployableRegions</code> of <code>A</code>, <code>B</code>, <code>C</code>, and <code>D</code> for a control with <code>REGIONAL</code> scope, even though you may not intend to deploy the control in Region <code>D</code>, because you do not govern it through your landing zone.</p>
@@ -413,6 +437,11 @@ export interface GetControlResponse {
413
437
  * @public
414
438
  */
415
439
  Parameters?: ControlParameter[] | undefined;
440
+ /**
441
+ * <p>A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.</p>
442
+ * @public
443
+ */
444
+ CreateTime?: Date | undefined;
416
445
  }
417
446
  /**
418
447
  * <p>The requested resource does not exist.</p>
@@ -442,6 +471,22 @@ export interface ListControlsRequest {
442
471
  */
443
472
  MaxResults?: number | undefined;
444
473
  }
474
+ /**
475
+ * <p>A summary of how the control is implemented, including the Amazon Web Services service that enforces the control and its service-specific identifier. For example, the value of this field could indicate that the control is implemented as an Amazon Web Services Config Rule or an Amazon Web Services Security Hub control.</p>
476
+ * @public
477
+ */
478
+ export interface ImplementationSummary {
479
+ /**
480
+ * <p>A string that represents the Amazon Web Services service that implements this control. For example, a value of <code>AWS::Config::ConfigRule</code> indicates that the control is implemented by Amazon Web Services Config, and <code>AWS::SecurityHub::SecurityControl</code> indicates implementation by Amazon Web Services Security Hub.</p>
481
+ * @public
482
+ */
483
+ Type: string | undefined;
484
+ /**
485
+ * <p>The identifier originally assigned by the Amazon Web Services service that implements the control. For example, <code>CODEPIPELINE_DEPLOYMENT_COUNT_CHECK</code>.</p>
486
+ * @public
487
+ */
488
+ Identifier?: string | undefined;
489
+ }
445
490
  /**
446
491
  * <p>Overview of information about a control.</p>
447
492
  * @public
@@ -462,6 +507,26 @@ export interface ControlSummary {
462
507
  * @public
463
508
  */
464
509
  Description: string | undefined;
510
+ /**
511
+ * <p>An enumerated type, with the following possible values:</p>
512
+ * @public
513
+ */
514
+ Behavior?: ControlBehavior | undefined;
515
+ /**
516
+ * <p>An enumerated type, with the following possible values:</p>
517
+ * @public
518
+ */
519
+ Severity?: ControlSeverity | undefined;
520
+ /**
521
+ * <p>An object of type <code>ImplementationSummary</code> that describes how the control is implemented.</p>
522
+ * @public
523
+ */
524
+ Implementation?: ImplementationSummary | undefined;
525
+ /**
526
+ * <p>A timestamp that notes the time when the control was released (start of its life) as a governance capability in Amazon Web Services.</p>
527
+ * @public
528
+ */
529
+ CreateTime?: Date | undefined;
465
530
  }
466
531
  /**
467
532
  * @public
@@ -80,6 +80,7 @@ export interface GetControlRequest {
80
80
  }
81
81
  export interface ImplementationDetails {
82
82
  Type: string | undefined;
83
+ Identifier?: string | undefined;
83
84
  }
84
85
  export interface ControlParameter {
85
86
  Name: string | undefined;
@@ -93,14 +94,24 @@ export interface RegionConfiguration {
93
94
  Scope: ControlScope | undefined;
94
95
  DeployableRegions?: string[] | undefined;
95
96
  }
97
+ export declare const ControlSeverity: {
98
+ readonly CRITICAL: "CRITICAL";
99
+ readonly HIGH: "HIGH";
100
+ readonly LOW: "LOW";
101
+ readonly MEDIUM: "MEDIUM";
102
+ };
103
+ export type ControlSeverity =
104
+ (typeof ControlSeverity)[keyof typeof ControlSeverity];
96
105
  export interface GetControlResponse {
97
106
  Arn: string | undefined;
98
107
  Name: string | undefined;
99
108
  Description: string | undefined;
100
109
  Behavior: ControlBehavior | undefined;
110
+ Severity?: ControlSeverity | undefined;
101
111
  RegionConfiguration: RegionConfiguration | undefined;
102
112
  Implementation?: ImplementationDetails | undefined;
103
113
  Parameters?: ControlParameter[] | undefined;
114
+ CreateTime?: Date | undefined;
104
115
  }
105
116
  export declare class ResourceNotFoundException extends __BaseException {
106
117
  readonly name: "ResourceNotFoundException";
@@ -114,10 +125,18 @@ export interface ListControlsRequest {
114
125
  NextToken?: string | undefined;
115
126
  MaxResults?: number | undefined;
116
127
  }
128
+ export interface ImplementationSummary {
129
+ Type: string | undefined;
130
+ Identifier?: string | undefined;
131
+ }
117
132
  export interface ControlSummary {
118
133
  Arn: string | undefined;
119
134
  Name: string | undefined;
120
135
  Description: string | undefined;
136
+ Behavior?: ControlBehavior | undefined;
137
+ Severity?: ControlSeverity | undefined;
138
+ Implementation?: ImplementationSummary | undefined;
139
+ CreateTime?: Date | undefined;
121
140
  }
122
141
  export interface ListControlsResponse {
123
142
  Controls: ControlSummary[] | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-controlcatalog",
3
3
  "description": "AWS SDK for JavaScript Controlcatalog Client for Node.js, Browser and React Native",
4
- "version": "3.782.0",
4
+ "version": "3.786.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",