feat(client-qbusiness): Adds S3 path option to pass group member list…

… for PutGroup API.
aws · Nov 8, 2024 · a0824b3 · a0824b3
1 parent 0c470f6
commit a0824b3
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 3 deletions.
diff --git a/clients/client-qbusiness/src/commands/CreateApplicationCommand.ts b/clients/client-qbusiness/src/commands/CreateApplicationCommand.ts
@@ -37,7 +37,16 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
  *             <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are
  *                 also available in Amazon Q Business Lite. For information on what's included in
  *                 Amazon Q Business Lite and what's included in Amazon Q Business Pro, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers">Amazon Q Business tiers</a>. You must use the Amazon Q Business console to assign
- *                 subscription tiers to users.</p>
+ *                 subscription tiers to users.
+ *             </p>
+ *             <p>
+ *                 A Amazon Q Apps service linked role will be created if it's absent in the
+ *                 Amazon Web Services account when the QAppsConfiguration is enabled in the request.
+ *                 For more information, see
+ *                 <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html">
+ *                     Using service-linked roles for Q Apps
+ *                 </a>
+ *             </p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-qbusiness/src/commands/PutGroupCommand.ts b/clients/client-qbusiness/src/commands/PutGroupCommand.ts
@@ -60,7 +60,12 @@ export interface PutGroupCommandOutput extends PutGroupResponse, __MetadataBeare
  *         type: "INDEX" || "DATASOURCE",
  *       },
  *     ],
+ *     s3PathForGroupMembers: { // S3
+ *       bucket: "STRING_VALUE", // required
+ *       key: "STRING_VALUE", // required
+ *     },
  *   },
+ *   roleArn: "STRING_VALUE",
  * };
  * const command = new PutGroupCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-qbusiness/src/commands/UpdateApplicationCommand.ts b/clients/client-qbusiness/src/commands/UpdateApplicationCommand.ts
@@ -29,6 +29,15 @@ export interface UpdateApplicationCommandOutput extends UpdateApplicationRespons
 
 /**
  * <p>Updates an existing Amazon Q Business application.</p>
+ *          <note>
+ *             <p>
+ *                 A Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account
+ *                 when the QAppsConfiguration is enabled in the request.
+ *                 For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html">
+ *                     Using service-linked roles for Q Apps
+ *                 </a>
+ *             </p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-qbusiness/src/models/models_0.ts b/clients/client-qbusiness/src/models/models_0.ts
@@ -6949,6 +6949,13 @@ export interface GroupMembers {
    * @public
    */
   memberUsers?: MemberUser[];
+
+  /**
+   * <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
+   *             bucket.</p>
+   * @public
+   */
+  s3PathForGroupMembers?: S3;
 }
 
 /**
@@ -6998,6 +7005,14 @@ export interface PutGroupRequest {
    * @public
    */
   groupMembers: GroupMembers | undefined;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains
+   *             your list of users that belong to a group.The Amazon Resource Name (ARN) of an IAM role that
+   *             has access to the S3 file that contains your list of users that belong to a group.</p>
+   * @public
+   */
+  roleArn?: string;
 }
 
 /**

diff --git a/clients/client-qbusiness/src/protocols/Aws_restJson1.ts b/clients/client-qbusiness/src/protocols/Aws_restJson1.ts
@@ -1191,6 +1191,7 @@ export const se_PutGroupCommand = async (
       dataSourceId: [],
       groupMembers: (_) => _json(_),
       groupName: [],
+      roleArn: [],
       type: [],
     })
   );

diff --git a/codegen/sdk-codegen/aws-models/qbusiness.json b/codegen/sdk-codegen/aws-models/qbusiness.json
@@ -1946,7 +1946,7 @@
           "kms:DescribeKey",
           "kms:CreateGrant"
         ],
-        "smithy.api#documentation": "<p>Creates an Amazon Q Business application.</p>\n         <note>\n            <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are\n                also available in Amazon Q Business Lite. For information on what's included in\n                Amazon Q Business Lite and what's included in Amazon Q Business Pro, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers\">Amazon Q Business tiers</a>. You must use the Amazon Q Business console to assign\n                subscription tiers to users.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Creates an Amazon Q Business application.</p>\n         <note>\n            <p>There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are\n                also available in Amazon Q Business Lite. For information on what's included in\n                Amazon Q Business Lite and what's included in Amazon Q Business Pro, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers\">Amazon Q Business tiers</a>. You must use the Amazon Q Business console to assign\n                subscription tiers to users.\n            </p>\n            <p>\n                A Amazon Q Apps service linked role will be created if it's absent in the \n                Amazon Web Services account when the QAppsConfiguration is enabled in the request. \n                For more information, see \n                <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html\">\n                    Using service-linked roles for Q Apps\n                </a>\n            </p>\n         </note>",
         "smithy.api#http": {
           "uri": "/applications",
           "method": "POST"
@@ -6407,6 +6407,9 @@
           "traits": {
             "smithy.api#documentation": "<p>A list of users that belong to a group. For example, a list of interns all belong to\n            the \"Interns\" group.</p>"
           }
+        },
+        "s3PathForGroupMembers": {
+          "target": "com.amazonaws.qbusiness#S3"
         }
       },
       "traits": {
@@ -9265,6 +9268,12 @@
           "traits": {
             "smithy.api#required": {}
           }
+        },
+        "roleArn": {
+          "target": "com.amazonaws.qbusiness#RoleArn",
+          "traits": {
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains \n            your list of users that belong to a group.The Amazon Resource Name (ARN) of an IAM role that \n            has access to the S3 file that contains your list of users that belong to a group.</p>"
+          }
         }
       },
       "traits": {
@@ -10629,7 +10638,7 @@
           "qbusiness:ListTagsForResource",
           "iam:PassRole"
         ],
-        "smithy.api#documentation": "<p>Updates an existing Amazon Q Business application.</p>",
+        "smithy.api#documentation": "<p>Updates an existing Amazon Q Business application.</p>\n         <note>\n            <p>\n                A Amazon Q Apps service-linked role will be created if it's absent in the Amazon Web Services account\n                when the QAppsConfiguration is enabled in the request.\n                For more information, see <a href=\"https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html\">\n                    Using service-linked roles for Q Apps\n                </a>\n            </p>\n         </note>",
         "smithy.api#http": {
           "uri": "/applications/{applicationId}",
           "method": "PUT"