@aws-sdk/client-controlcatalog 3.1055.0 → 3.1057.0

package/dist-cjs/index.js

@@ -214,6 +214,15 @@ const ControlBehavior = {
     PREVENTIVE: "PREVENTIVE",
     PROACTIVE: "PROACTIVE",
 };
+const ParameterRequirementSummary = {
+    NONE: "NONE",
+    OPTIONAL: "OPTIONAL",
+    REQUIRED: "REQUIRED",
+};
+const ControlParameterRequirement = {
+    OPTIONAL: "OPTIONAL",
+    REQUIRED: "REQUIRED",
+};
 const ControlScope = {
     GLOBAL: "GLOBAL",
     REGIONAL: "REGIONAL",
@@ -241,6 +250,7 @@ exports.ControlCatalogServiceException = ControlCatalogServiceException.ControlC
 exports.ControlBehavior = ControlBehavior;
 exports.ControlCatalog = ControlCatalog;
 exports.ControlCatalogClient = ControlCatalogClient;
+exports.ControlParameterRequirement = ControlParameterRequirement;
 exports.ControlRelationType = ControlRelationType;
 exports.ControlScope = ControlScope;
 exports.ControlSeverity = ControlSeverity;
@@ -251,6 +261,7 @@ exports.ListControlsCommand = ListControlsCommand;
 exports.ListDomainsCommand = ListDomainsCommand;
 exports.ListObjectivesCommand = ListObjectivesCommand;
 exports.MappingType = MappingType;
+exports.ParameterRequirementSummary = ParameterRequirementSummary;
 exports.paginateListCommonControls = paginateListCommonControls;
 exports.paginateListControlMappings = paginateListControlMappings;
 exports.paginateListControls = paginateListControls;

package/dist-cjs/schemas/schemas_0.js

@@ -40,6 +40,7 @@ const _Fr = "Framework";
 const _GC = "GetControl";
 const _GCR = "GetControlRequest";
 const _GCRe = "GetControlResponse";
+const _GP = "GovernedProviders";
 const _GR = "GovernedResources";
 const _I = "Implementations";
 const _ID = "ImplementationDetails";
@@ -81,6 +82,8 @@ const _OS = "ObjectiveSummary";
 const _OSL = "ObjectiveSummaryList";
 const _Ob = "Objective";
 const _P = "Parameters";
+const _PRS = "ParameterRequirementSummary";
+const _R = "Requirement";
 const _RC = "RegionConfiguration";
 const _RCMD = "RelatedControlMappingDetails";
 const _RCe = "RelatedControl";
@@ -170,8 +173,8 @@ exports.CommonControlSummary$ = [3, n0, _CCS,
 ];
 exports.ControlFilter$ = [3, n0, _CF,
     0,
-    [_I],
-    [() => exports.ImplementationFilter$]
+    [_I, _GP],
+    [() => exports.ImplementationFilter$, 64 | 0]
 ];
 exports.ControlMapping$ = [3, n0, _CM,
     0,
@@ -185,13 +188,13 @@ exports.ControlMappingFilter$ = [3, n0, _CMF,
 ];
 exports.ControlParameter$ = [3, n0, _CP,
     0,
-    [_N],
-    [0], 1
+    [_N, _R],
+    [0, 0], 1
 ];
 exports.ControlSummary$ = [3, n0, _CS,
     0,
-    [_A, _N, _D, _Al, _B, _S, _Im, _CT, _GR],
-    [0, 0, 0, 64 | 0, 0, 0, () => exports.ImplementationSummary$, 4, 64 | 0], 3
+    [_A, _N, _D, _Al, _B, _S, _PRS, _Im, _CT, _GR, _GP],
+    [0, 0, 0, 64 | 0, 0, 0, 0, () => exports.ImplementationSummary$, 4, 64 | 0, 64 | 0], 3
 ];
 exports.DomainResourceFilter$ = [3, n0, _DRF,
     0,
@@ -215,8 +218,8 @@ exports.GetControlRequest$ = [3, n0, _GCR,
 ];
 exports.GetControlResponse$ = [3, n0, _GCRe,
     0,
-    [_A, _N, _D, _B, _RC, _Al, _S, _Im, _P, _CT, _GR],
-    [0, 0, 0, 0, () => exports.RegionConfiguration$, 64 | 0, 0, () => exports.ImplementationDetails$, () => ControlParameters, 4, 64 | 0], 5
+    [_A, _N, _D, _B, _RC, _Al, _S, _Im, _PRS, _P, _CT, _GR, _GP],
+    [0, 0, 0, 0, () => exports.RegionConfiguration$, 64 | 0, 0, () => exports.ImplementationDetails$, 0, () => ControlParameters, 4, 64 | 0, 64 | 0], 5
 ];
 exports.ImplementationDetails$ = [3, n0, _ID,
     0,
@@ -330,6 +333,8 @@ var DomainResourceFilterList = [1, n0, _DRFL,
 var DomainSummaryList = [1, n0, _DSL,
     0, () => exports.DomainSummary$
 ];
+var GovernedProviderFilterList = 64 | 0;
+var GovernedProviders = 64 | 0;
 var GovernedResources = 64 | 0;
 var ImplementationIdentifierFilterList = 64 | 0;
 var ImplementationTypeFilterList = 64 | 0;

package/dist-es/models/enums.js

@@ -3,6 +3,15 @@ export const ControlBehavior = {
     PREVENTIVE: "PREVENTIVE",
     PROACTIVE: "PROACTIVE",
 };
+export const ParameterRequirementSummary = {
+    NONE: "NONE",
+    OPTIONAL: "OPTIONAL",
+    REQUIRED: "REQUIRED",
+};
+export const ControlParameterRequirement = {
+    OPTIONAL: "OPTIONAL",
+    REQUIRED: "REQUIRED",
+};
 export const ControlScope = {
     GLOBAL: "GLOBAL",
     REGIONAL: "REGIONAL",

package/dist-es/schemas/schemas_0.js

@@ -37,6 +37,7 @@ const _Fr = "Framework";
 const _GC = "GetControl";
 const _GCR = "GetControlRequest";
 const _GCRe = "GetControlResponse";
+const _GP = "GovernedProviders";
 const _GR = "GovernedResources";
 const _I = "Implementations";
 const _ID = "ImplementationDetails";
@@ -78,6 +79,8 @@ const _OS = "ObjectiveSummary";
 const _OSL = "ObjectiveSummaryList";
 const _Ob = "Objective";
 const _P = "Parameters";
+const _PRS = "ParameterRequirementSummary";
+const _R = "Requirement";
 const _RC = "RegionConfiguration";
 const _RCMD = "RelatedControlMappingDetails";
 const _RCe = "RelatedControl";
@@ -167,8 +170,8 @@ export var CommonControlSummary$ = [3, n0, _CCS,
 ];
 export var ControlFilter$ = [3, n0, _CF,
     0,
-    [_I],
-    [() => ImplementationFilter$]
+    [_I, _GP],
+    [() => ImplementationFilter$, 64 | 0]
 ];
 export var ControlMapping$ = [3, n0, _CM,
     0,
@@ -182,13 +185,13 @@ export var ControlMappingFilter$ = [3, n0, _CMF,
 ];
 export var ControlParameter$ = [3, n0, _CP,
     0,
-    [_N],
-    [0], 1
+    [_N, _R],
+    [0, 0], 1
 ];
 export var ControlSummary$ = [3, n0, _CS,
     0,
-    [_A, _N, _D, _Al, _B, _S, _Im, _CT, _GR],
-    [0, 0, 0, 64 | 0, 0, 0, () => ImplementationSummary$, 4, 64 | 0], 3
+    [_A, _N, _D, _Al, _B, _S, _PRS, _Im, _CT, _GR, _GP],
+    [0, 0, 0, 64 | 0, 0, 0, 0, () => ImplementationSummary$, 4, 64 | 0, 64 | 0], 3
 ];
 export var DomainResourceFilter$ = [3, n0, _DRF,
     0,
@@ -212,8 +215,8 @@ export var GetControlRequest$ = [3, n0, _GCR,
 ];
 export var GetControlResponse$ = [3, n0, _GCRe,
     0,
-    [_A, _N, _D, _B, _RC, _Al, _S, _Im, _P, _CT, _GR],
-    [0, 0, 0, 0, () => RegionConfiguration$, 64 | 0, 0, () => ImplementationDetails$, () => ControlParameters, 4, 64 | 0], 5
+    [_A, _N, _D, _B, _RC, _Al, _S, _Im, _PRS, _P, _CT, _GR, _GP],
+    [0, 0, 0, 0, () => RegionConfiguration$, 64 | 0, 0, () => ImplementationDetails$, 0, () => ControlParameters, 4, 64 | 0, 64 | 0], 5
 ];
 export var ImplementationDetails$ = [3, n0, _ID,
     0,
@@ -327,6 +330,8 @@ var DomainResourceFilterList = [1, n0, _DRFL,
 var DomainSummaryList = [1, n0, _DSL,
     0, () => DomainSummary$
 ];
+var GovernedProviderFilterList = 64 | 0;
+var GovernedProviders = 64 | 0;
 var GovernedResources = 64 | 0;
 var ImplementationIdentifierFilterList = 64 | 0;
 var ImplementationTypeFilterList = 64 | 0;

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

@@ -62,15 +62,20 @@ declare const GetControlCommand_base: {
  * //     Type: "STRING_VALUE", // required
  * //     Identifier: "STRING_VALUE",
  * //   },
+ * //   ParameterRequirementSummary: "REQUIRED" || "OPTIONAL" || "NONE",
  * //   Parameters: [ // ControlParameters
  * //     { // ControlParameter
  * //       Name: "STRING_VALUE", // required
+ * //       Requirement: "REQUIRED" || "OPTIONAL",
  * //     },
  * //   ],
  * //   CreateTime: new Date("TIMESTAMP"),
  * //   GovernedResources: [ // GovernedResources
  * //     "STRING_VALUE",
  * //   ],
+ * //   GovernedProviders: [ // GovernedProviders
+ * //     "STRING_VALUE",
+ * //   ],
  * // };
  *
  * ```

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

@@ -50,6 +50,9 @@ declare const ListControlsCommand_base: {
  *         "STRING_VALUE",
  *       ],
  *     },
+ *     GovernedProviders: [ // GovernedProviderFilterList
+ *       "STRING_VALUE",
+ *     ],
  *   },
  * };
  * const command = new ListControlsCommand(input);
@@ -65,6 +68,7 @@ declare const ListControlsCommand_base: {
  * //       Description: "STRING_VALUE", // required
  * //       Behavior: "PREVENTIVE" || "PROACTIVE" || "DETECTIVE",
  * //       Severity: "LOW" || "MEDIUM" || "HIGH" || "CRITICAL",
+ * //       ParameterRequirementSummary: "REQUIRED" || "OPTIONAL" || "NONE",
  * //       Implementation: { // ImplementationSummary
  * //         Type: "STRING_VALUE", // required
  * //         Identifier: "STRING_VALUE",
@@ -73,6 +77,9 @@ declare const ListControlsCommand_base: {
  * //       GovernedResources: [ // GovernedResources
  * //         "STRING_VALUE",
  * //       ],
+ * //       GovernedProviders: [ // GovernedProviders
+ * //         "STRING_VALUE",
+ * //       ],
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

package/dist-types/models/enums.d.ts

@@ -11,6 +11,31 @@ export declare const ControlBehavior: {
  * @public
  */
 export type ControlBehavior = (typeof ControlBehavior)[keyof typeof ControlBehavior];
+/**
+ * @public
+ * @enum
+ */
+export declare const ParameterRequirementSummary: {
+    readonly NONE: "NONE";
+    readonly OPTIONAL: "OPTIONAL";
+    readonly REQUIRED: "REQUIRED";
+};
+/**
+ * @public
+ */
+export type ParameterRequirementSummary = (typeof ParameterRequirementSummary)[keyof typeof ParameterRequirementSummary];
+/**
+ * @public
+ * @enum
+ */
+export declare const ControlParameterRequirement: {
+    readonly OPTIONAL: "OPTIONAL";
+    readonly REQUIRED: "REQUIRED";
+};
+/**
+ * @public
+ */
+export type ControlParameterRequirement = (typeof ControlParameterRequirement)[keyof typeof ControlParameterRequirement];
 /**
  * @public
  * @enum

package/dist-types/models/models_0.d.ts

@@ -1,4 +1,4 @@
-import type { ControlBehavior, ControlRelationType, ControlScope, ControlSeverity, MappingType } from "./enums";
+import type { ControlBehavior, ControlParameterRequirement, ControlRelationType, ControlScope, ControlSeverity, MappingType, ParameterRequirementSummary } from "./enums";
 /**
  * <p>A summary of the domain that a common control or an objective belongs to.</p>
  * @public
@@ -176,6 +176,11 @@ export interface ControlParameter {
      * @public
      */
     Name: string | undefined;
+    /**
+     * <p>Indicates whether the parameter is required or optional when you enable the control.</p>
+     * @public
+     */
+    Requirement?: ControlParameterRequirement | undefined;
 }
 /**
  * <p>Returns information about the control, including the scope of the control, if enabled, and the Regions in which the control 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> <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>
@@ -237,6 +242,11 @@ export interface GetControlResponse {
      * @public
      */
     Implementation?: ImplementationDetails | undefined;
+    /**
+     * <p>A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.</p>
+     * @public
+     */
+    ParameterRequirementSummary?: ParameterRequirementSummary | undefined;
     /**
      * <p>Returns an array of <code>ControlParameter</code> objects that specify the parameters a control supports. An empty list is returned for controls that don’t support parameters. </p>
      * @public
@@ -248,10 +258,15 @@ export interface GetControlResponse {
      */
     CreateTime?: Date | undefined;
     /**
-     * <p>A list of Amazon Web Services resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. The resources are represented as Amazon Web Services CloudFormation resource types. If <code>GovernedResources</code> cannot be represented by available CloudFormation resource types, it’s returned as an empty list.</p>
+     * <p>A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If <code>GovernedResources</code> cannot be represented by available resource types, it’s returned as an empty list.</p>
      * @public
      */
     GovernedResources?: string[] | undefined;
+    /**
+     * <p>A list of providers whose resources are governed by this control. For example, a value of <code>AWS</code> indicates that the control governs Amazon Web Services resources.</p>
+     * @public
+     */
+    GovernedProviders?: string[] | undefined;
 }
 /**
  * <p>A structure that defines filtering criteria for control implementations. You can use this filter to find controls that are implemented by specific Amazon Web Services services or with specific service identifiers.</p>
@@ -279,6 +294,11 @@ export interface ControlFilter {
      * @public
      */
     Implementations?: ImplementationFilter | undefined;
+    /**
+     * <p>A filter that narrows the results to controls that govern a specific provider's resources.</p>
+     * @public
+     */
+    GovernedProviders?: string[] | undefined;
 }
 /**
  * @public
@@ -351,6 +371,11 @@ export interface ControlSummary {
      * @public
      */
     Severity?: ControlSeverity | undefined;
+    /**
+     * <p>A summary that indicates whether the control requires parameters, accepts optional parameters, or does not support parameters. Use this field to determine whether you need to supply parameter values when you enable the control.</p>
+     * @public
+     */
+    ParameterRequirementSummary?: ParameterRequirementSummary | undefined;
     /**
      * <p>An object of type <code>ImplementationSummary</code> that describes how the control is implemented.</p>
      * @public
@@ -362,10 +387,15 @@ export interface ControlSummary {
      */
     CreateTime?: Date | undefined;
     /**
-     * <p>A list of Amazon Web Services resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. The resources are represented as Amazon Web Services CloudFormation resource types. If <code>GovernedResources</code> cannot be represented by available CloudFormation resource types, it’s returned as an empty list.</p>
+     * <p>A list of resource types that are governed by this control. This information helps you understand which controls can govern certain types of resources, and conversely, which resources are affected when the control is implemented. For Amazon Web Services controls, the resources are represented as CloudFormation resource types. For non-Amazon Web Services controls, the resources are represented in a provider-specific format. If <code>GovernedResources</code> cannot be represented by available resource types, it’s returned as an empty list.</p>
      * @public
      */
     GovernedResources?: string[] | undefined;
+    /**
+     * <p>A list of providers whose resources are governed by this control. For example, a value of <code>AWS</code> indicates that the control governs Amazon Web Services resources.</p>
+     * @public
+     */
+    GovernedProviders?: string[] | undefined;
 }
 /**
  * @public

package/dist-types/ts3.4/models/enums.d.ts

@@ -5,6 +5,19 @@ export declare const ControlBehavior: {
 };
 export type ControlBehavior =
   (typeof ControlBehavior)[keyof typeof ControlBehavior];
+export declare const ParameterRequirementSummary: {
+  readonly NONE: "NONE";
+  readonly OPTIONAL: "OPTIONAL";
+  readonly REQUIRED: "REQUIRED";
+};
+export type ParameterRequirementSummary =
+  (typeof ParameterRequirementSummary)[keyof typeof ParameterRequirementSummary];
+export declare const ControlParameterRequirement: {
+  readonly OPTIONAL: "OPTIONAL";
+  readonly REQUIRED: "REQUIRED";
+};
+export type ControlParameterRequirement =
+  (typeof ControlParameterRequirement)[keyof typeof ControlParameterRequirement];
 export declare const ControlScope: {
   readonly GLOBAL: "GLOBAL";
   readonly REGIONAL: "REGIONAL";

package/dist-types/ts3.4/models/models_0.d.ts

@@ -1,9 +1,11 @@
 import {
   ControlBehavior,
+  ControlParameterRequirement,
   ControlRelationType,
   ControlScope,
   ControlSeverity,
   MappingType,
+  ParameterRequirementSummary,
 } from "./enums";
 export interface AssociatedDomainSummary {
   Arn?: string | undefined;
@@ -49,6 +51,7 @@ export interface ImplementationDetails {
 }
 export interface ControlParameter {
   Name: string | undefined;
+  Requirement?: ControlParameterRequirement | undefined;
 }
 export interface RegionConfiguration {
   Scope: ControlScope | undefined;
@@ -63,9 +66,11 @@ export interface GetControlResponse {
   Severity?: ControlSeverity | undefined;
   RegionConfiguration: RegionConfiguration | undefined;
   Implementation?: ImplementationDetails | undefined;
+  ParameterRequirementSummary?: ParameterRequirementSummary | undefined;
   Parameters?: ControlParameter[] | undefined;
   CreateTime?: Date | undefined;
   GovernedResources?: string[] | undefined;
+  GovernedProviders?: string[] | undefined;
 }
 export interface ImplementationFilter {
   Types?: string[] | undefined;
@@ -73,6 +78,7 @@ export interface ImplementationFilter {
 }
 export interface ControlFilter {
   Implementations?: ImplementationFilter | undefined;
+  GovernedProviders?: string[] | undefined;
 }
 export interface ListControlsRequest {
   NextToken?: string | undefined;
@@ -90,9 +96,11 @@ export interface ControlSummary {
   Description: string | undefined;
   Behavior?: ControlBehavior | undefined;
   Severity?: ControlSeverity | undefined;
+  ParameterRequirementSummary?: ParameterRequirementSummary | undefined;
   Implementation?: ImplementationSummary | undefined;
   CreateTime?: Date | undefined;
   GovernedResources?: string[] | undefined;
+  GovernedProviders?: string[] | undefined;
 }
 export interface ListControlsResponse {
   Controls: ControlSummary[] | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-controlcatalog",
   "description": "AWS SDK for JavaScript Controlcatalog Client for Node.js, Browser and React Native",
-  "version": "3.1055.0",
+  "version": "3.1057.0",
   "scripts": {
     "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
     "build:cjs": "node ../../scripts/compilation/inline client-controlcatalog",
@@ -21,12 +21,12 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "^3.974.14",
-    "@aws-sdk/credential-provider-node": "^3.972.45",
+    "@aws-sdk/core": "^3.974.15",
+    "@aws-sdk/credential-provider-node": "^3.972.47",
     "@aws-sdk/types": "^3.973.9",
-    "@smithy/core": "^3.24.3",
-    "@smithy/fetch-http-handler": "^5.4.3",
-    "@smithy/node-http-handler": "^4.7.3",
+    "@smithy/core": "^3.24.5",
+    "@smithy/fetch-http-handler": "^5.4.5",
+    "@smithy/node-http-handler": "^4.7.5",
     "@smithy/types": "^4.14.2",
     "tslib": "^2.6.2"
   },