@aws-sdk/client-service-catalog 3.348.0 → 3.349.0

package/dist-cjs/protocols/Aws_json1_1.js

@@ -4302,6 +4302,7 @@ const de_DescribeProvisioningArtifactOutput = (output, context) => {
     return (0, smithy_client_1.take)(output, {
         Info: smithy_client_1._json,
         ProvisioningArtifactDetail: (_) => de_ProvisioningArtifactDetail(_, context),
+        ProvisioningArtifactParameters: smithy_client_1._json,
         Status: smithy_client_1.expectString,
     });
 };

package/dist-es/protocols/Aws_json1_1.js

@@ -4116,6 +4116,7 @@ const de_DescribeProvisioningArtifactOutput = (output, context) => {
     return take(output, {
         Info: _json,
         ProvisioningArtifactDetail: (_) => de_ProvisioningArtifactDetail(_, context),
+        ProvisioningArtifactParameters: _json,
         Status: __expectString,
     });
 };

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

@@ -37,6 +37,7 @@ export interface DescribeProvisioningArtifactCommandOutput extends DescribeProvi
  *   ProvisioningArtifactName: "STRING_VALUE",
  *   ProductName: "STRING_VALUE",
  *   Verbose: true || false,
+ *   IncludeProvisioningArtifactParameters: true || false,
  * };
  * const command = new DescribeProvisioningArtifactCommand(input);
  * const response = await client.send(command);
@@ -55,6 +56,26 @@ export interface DescribeProvisioningArtifactCommandOutput extends DescribeProvi
  * //     "<keys>": "STRING_VALUE",
  * //   },
  * //   Status: "AVAILABLE" || "CREATING" || "FAILED",
+ * //   ProvisioningArtifactParameters: [ // ProvisioningArtifactParameters
+ * //     { // ProvisioningArtifactParameter
+ * //       ParameterKey: "STRING_VALUE",
+ * //       DefaultValue: "STRING_VALUE",
+ * //       ParameterType: "STRING_VALUE",
+ * //       IsNoEcho: true || false,
+ * //       Description: "STRING_VALUE",
+ * //       ParameterConstraints: { // ParameterConstraints
+ * //         AllowedValues: [ // AllowedValues
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         AllowedPattern: "STRING_VALUE",
+ * //         ConstraintDescription: "STRING_VALUE",
+ * //         MaxLength: "STRING_VALUE",
+ * //         MinLength: "STRING_VALUE",
+ * //         MaxValue: "STRING_VALUE",
+ * //         MinValue: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
  * // };
  *
  * ```

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

@@ -237,27 +237,28 @@ export interface AssociatePrincipalWithPortfolioInput {
      */
     PortfolioId: string | undefined;
     /**
-     * <p>The ARN of the principal (user, role, or group). The supported value is a fully defined <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">
-     *                <code>IAM</code> ARN</a>
-     *          if the
-     *          <code>PrincipalType</code> is <code>IAM</code>. If the <code>PrincipalType</code> is <code>IAM_PATTERN</code>,
-     *          the supported value is an <code>IAM</code> ARN without an AccountID in the following format:</p>
+     * <p>The ARN of the principal (user, role, or group). If the <code>PrincipalType</code> is <code>IAM</code>, the supported value is a
+     *          fully defined
+     *          <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM Amazon Resource Name (ARN)</a>.
+     *          If the <code>PrincipalType</code> is <code>IAM_PATTERN</code>,
+     *          the supported value is an <code>IAM</code> ARN <i>without an AccountID</i> in the following format:</p>
      *          <p>
      *             <i>arn:partition:iam:::resource-type/resource-id</i>
      *          </p>
-     *          <p>The resource-id can be either of the following:</p>
+     *          <p>The ARN resource-id can be either:</p>
      *          <ul>
      *             <li>
-     *                <p>Fully formed, for example <i>arn:aws:iam:::role/resource-name</i> or
+     *                <p>A fully formed resource-id. For example, <i>arn:aws:iam:::role/resource-name</i> or
      *             <i>arn:aws:iam:::role/resource-path/resource-name</i>
      *                </p>
      *             </li>
      *             <li>
      *                <p>A wildcard ARN. The wildcard ARN accepts <code>IAM_PATTERN</code> values with a
-     *                "*" or "?" in the resource-id segment of the ARN, for example <i>arn:partition:service:::resource-type/resource-path/resource-name</i>.
+     *                "*" or "?" in the resource-id segment of the ARN. For example <i>arn:partition:service:::resource-type/resource-path/resource-name</i>.
      *                The new symbols are exclusive to the <b>resource-path</b> and <b>resource-name</b>
-     *                and cannot be used to replace the <b>resource-type</b> or other
+     *                and cannot replace the <b>resource-type</b> or other
      *             ARN values. </p>
+     *                <p>The ARN path and principal name allow unlimited wildcard characters.</p>
      *             </li>
      *          </ul>
      *          <p>Examples of an <b>acceptable</b> wildcard ARN:</p>
@@ -277,39 +278,25 @@ export interface AssociatePrincipalWithPortfolioInput {
      *          </ul>
      *          <p>You can associate multiple <code>IAM_PATTERN</code>s even if the account has no principal
      *          with that name. </p>
-     *          <note>
-     *             <ul>
-     *                <li>
-     *                   <p>The ARN path and principal name allow unlimited wildcard characters. </p>
-     *                </li>
-     *                <li>
-     *                   <p>The "?"  wildcard character matches zero or one of any character. This is similar to  ".?" in regular
-     *                   regex context.</p>
-     *                </li>
-     *                <li>
-     *                   <p>The "*" wildcard character matches any number of any characters. This is similar ".*"  in regular
-     *                   regex context.</p>
-     *                </li>
-     *                <li>
-     *                   <p>In the IAM Principal ARNs format (arn:partition:iam:::resource-type/resource-path/resource-name),
-     *                   valid <b>resource-type</b> values include user/, group/, or role/.  The "?" and "*"
-     *                   are allowed only after the <b>resource-type</b>, in the resource-id segment.
-     *                   You can use special characters anywhere within the <b>resource-id</b>.</p>
-     *                </li>
-     *                <li>
-     *                   <p>The "*" also matches the "/" character, allowing paths to be formed within the
-     *                   <b>resource-id</b>.
-     *                   For example, arn:aws:iam:::role/*\/ResourceName_? matches both arn:aws:iam:::role/pathA/pathB/ResourceName_1
+     *          <p>The "?" wildcard character matches zero or one of any character. This is similar to ".?" in regular
+     *                   regex context. The "*" wildcard character matches any number of any characters.
+     *                   This is similar to ".*" in regular regex context.</p>
+     *          <p>In the IAM Principal ARN format (<i>arn:partition:iam:::resource-type/resource-path/resource-name</i>),
+     *          valid resource-type values include <b>user/</b>, <b>group/</b>,
+     *             or <b>role/</b>.  The "?" and "*" characters
+     *                   are allowed only after the resource-type in the resource-id segment.
+     *                   You can use special characters anywhere within the resource-id. </p>
+     *          <p>The "*" character also matches the "/" character, allowing paths to be formed <i>within</i> the
+     *                   resource-id. For example, <i>arn:aws:iam:::role/<b>*</b>/ResourceName_?</i>
+     *                   matches both <i>arn:aws:iam:::role/pathA/pathB/ResourceName_1</i>
      *                   and
-     *                   arn:aws:iam:::role/pathA/ResourceName_1.</p>
-     *                </li>
-     *             </ul>
-     *          </note>
+     *                   <i>arn:aws:iam:::role/pathA/ResourceName_1</i>. </p>
      */
     PrincipalARN: string | undefined;
     /**
-     * <p>The principal type. The supported value is <code>IAM</code> if you use a fully defined ARN,
-     *          or <code>IAM_PATTERN</code> if you use an ARN with no <code>accountID</code>, with or without wildcard characters. </p>
+     * <p>The principal type. The supported value is <code>IAM</code> if you use a fully defined Amazon Resource Name
+     *          (ARN), or <code>IAM_PATTERN</code> if you use an ARN with no <code>accountID</code>,
+     *          with or without wildcard characters. </p>
      */
     PrincipalType: PrincipalType | string | undefined;
 }
@@ -3197,6 +3184,82 @@ export interface DescribeProvisioningArtifactInput {
      * <p>Indicates whether a verbose level of detail is enabled.</p>
      */
     Verbose?: boolean;
+    /**
+     * <p>Indicates if the API call response does or does not include additional details about the provisioning parameters. </p>
+     */
+    IncludeProvisioningArtifactParameters?: boolean;
+}
+/**
+ * @public
+ * <p>The constraints that the administrator has put on the parameter.</p>
+ */
+export interface ParameterConstraints {
+    /**
+     * <p>The values that the administrator has allowed for the parameter.</p>
+     */
+    AllowedValues?: string[];
+    /**
+     * <p>A regular expression that represents the patterns that allow for <code>String</code> types. The pattern must match the entire parameter value provided.</p>
+     */
+    AllowedPattern?: string;
+    /**
+     * <p>A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of <code>[A-Za-z0-9]+</code> displays the following error message when the user specifies an invalid value:</p>
+     *          <p>
+     *             <code>Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+</code>
+     *          </p>
+     *          <p>By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:</p>
+     *          <p>
+     *             <code>Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.</code>
+     *          </p>
+     */
+    ConstraintDescription?: string;
+    /**
+     * <p>An integer value that determines the largest number of characters you want to allow for <code>String</code> types. </p>
+     */
+    MaxLength?: string;
+    /**
+     * <p>An integer value that determines the smallest number of characters you want to allow for <code>String</code> types.</p>
+     */
+    MinLength?: string;
+    /**
+     * <p>A numeric value that determines the largest numeric value you want to allow for <code>Number</code> types.</p>
+     */
+    MaxValue?: string;
+    /**
+     * <p>A numeric value that determines the smallest numeric value you want to allow for <code>Number</code> types. </p>
+     */
+    MinValue?: string;
+}
+/**
+ * @public
+ * <p>Information about a parameter used to provision a product.</p>
+ */
+export interface ProvisioningArtifactParameter {
+    /**
+     * <p>The parameter key.</p>
+     */
+    ParameterKey?: string;
+    /**
+     * <p>The default value.</p>
+     */
+    DefaultValue?: string;
+    /**
+     * <p>The parameter type.</p>
+     */
+    ParameterType?: string;
+    /**
+     * <p>If this value is true, the value for this parameter is obfuscated from view when the
+     *          parameter is retrieved. This parameter is used to hide sensitive information.</p>
+     */
+    IsNoEcho?: boolean;
+    /**
+     * <p>The description of the parameter.</p>
+     */
+    Description?: string;
+    /**
+     * <p>Constraints that the administrator has put on a parameter.</p>
+     */
+    ParameterConstraints?: ParameterConstraints;
 }
 /**
  * @public
@@ -3214,6 +3277,10 @@ export interface DescribeProvisioningArtifactOutput {
      * <p>The status of the current request.</p>
      */
     Status?: Status | string;
+    /**
+     * <p>Information about the parameters used to provision the product.  </p>
+     */
+    ProvisioningArtifactParameters?: ProvisioningArtifactParameter[];
 }
 /**
  * @public
@@ -3308,78 +3375,6 @@ export interface ProvisioningArtifactOutput {
      */
     Description?: string;
 }
-/**
- * @public
- * <p>The constraints that the administrator has put on the parameter.</p>
- */
-export interface ParameterConstraints {
-    /**
-     * <p>The values that the administrator has allowed for the parameter.</p>
-     */
-    AllowedValues?: string[];
-    /**
-     * <p>A regular expression that represents the patterns that allow for <code>String</code> types. The pattern must match the entire parameter value provided.</p>
-     */
-    AllowedPattern?: string;
-    /**
-     * <p>A string that explains a constraint when the constraint is violated. For example, without a constraint description, a parameter that has an allowed pattern of <code>[A-Za-z0-9]+</code> displays the following error message when the user specifies an invalid value:</p>
-     *          <p>
-     *             <code>Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+</code>
-     *          </p>
-     *          <p>By adding a constraint description, such as must only contain letters (uppercase and lowercase) and numbers, you can display the following customized error message:</p>
-     *          <p>
-     *             <code>Malformed input-Parameter MyParameter must only contain uppercase and lowercase letters and numbers.</code>
-     *          </p>
-     */
-    ConstraintDescription?: string;
-    /**
-     * <p>An integer value that determines the largest number of characters you want to allow for <code>String</code> types. </p>
-     */
-    MaxLength?: string;
-    /**
-     * <p>An integer value that determines the smallest number of characters you want to allow for <code>String</code> types.</p>
-     */
-    MinLength?: string;
-    /**
-     * <p>A numeric value that determines the largest numeric value you want to allow for <code>Number</code> types.</p>
-     */
-    MaxValue?: string;
-    /**
-     * <p>A numeric value that determines the smallest numeric value you want to allow for <code>Number</code> types. </p>
-     */
-    MinValue?: string;
-}
-/**
- * @public
- * <p>Information about a parameter used to provision a product.</p>
- */
-export interface ProvisioningArtifactParameter {
-    /**
-     * <p>The parameter key.</p>
-     */
-    ParameterKey?: string;
-    /**
-     * <p>The default value.</p>
-     */
-    DefaultValue?: string;
-    /**
-     * <p>The parameter type.</p>
-     */
-    ParameterType?: string;
-    /**
-     * <p>If this value is true, the value for this parameter is obfuscated from view when the
-     *          parameter is retrieved. This parameter is used to hide sensitive information.</p>
-     */
-    IsNoEcho?: boolean;
-    /**
-     * <p>The description of the parameter.</p>
-     */
-    Description?: string;
-    /**
-     * <p>Constraints that the administrator has put on a parameter.</p>
-     */
-    ParameterConstraints?: ParameterConstraints;
-}
 /**
  * @public
  * <p>The user-defined preferences that will be applied during product provisioning, unless overridden by <code>ProvisioningPreferences</code> or <code>UpdateProvisioningPreferences</code>.</p>

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

@@ -783,11 +783,30 @@ export interface DescribeProvisioningArtifactInput {
   ProvisioningArtifactName?: string;
   ProductName?: string;
   Verbose?: boolean;
+  IncludeProvisioningArtifactParameters?: boolean;
+}
+export interface ParameterConstraints {
+  AllowedValues?: string[];
+  AllowedPattern?: string;
+  ConstraintDescription?: string;
+  MaxLength?: string;
+  MinLength?: string;
+  MaxValue?: string;
+  MinValue?: string;
+}
+export interface ProvisioningArtifactParameter {
+  ParameterKey?: string;
+  DefaultValue?: string;
+  ParameterType?: string;
+  IsNoEcho?: boolean;
+  Description?: string;
+  ParameterConstraints?: ParameterConstraints;
 }
 export interface DescribeProvisioningArtifactOutput {
   ProvisioningArtifactDetail?: ProvisioningArtifactDetail;
   Info?: Record<string, string>;
   Status?: Status | string;
+  ProvisioningArtifactParameters?: ProvisioningArtifactParameter[];
 }
 export interface DescribeProvisioningParametersInput {
   AcceptLanguage?: string;
@@ -806,23 +825,6 @@ export interface ProvisioningArtifactOutput {
   Key?: string;
   Description?: string;
 }
-export interface ParameterConstraints {
-  AllowedValues?: string[];
-  AllowedPattern?: string;
-  ConstraintDescription?: string;
-  MaxLength?: string;
-  MinLength?: string;
-  MaxValue?: string;
-  MinValue?: string;
-}
-export interface ProvisioningArtifactParameter {
-  ParameterKey?: string;
-  DefaultValue?: string;
-  ParameterType?: string;
-  IsNoEcho?: boolean;
-  Description?: string;
-  ParameterConstraints?: ParameterConstraints;
-}
 export interface ProvisioningArtifactPreferences {
   StackSetAccounts?: string[];
   StackSetRegions?: string[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-service-catalog",
   "description": "AWS SDK for JavaScript Service Catalog Client for Node.js, Browser and React Native",
-  "version": "3.348.0",
+  "version": "3.349.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",