@aws-sdk/client-qapps 3.701.0 → 3.705.0

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

@@ -85,8 +85,8 @@ declare const UpdateQAppPermissionsCommand_base: {
  *  <p>The requested resource could not be found.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The requested operation could not be completed because too many
- *       requests were sent at once. Wait a bit and try again later.</p>
+ *  <p>The requested operation could not be completed because too many requests were sent at
+ *       once. Wait a bit and try again later.</p>
  *
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -98,6 +98,79 @@ declare const UpdateQAppPermissionsCommand_base: {
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
  * @public
+ * @example Grant permissions for the app
+ * ```javascript
+ * //
+ * const input = {
+ *   "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
+ *   "grantPermissions": [
+ *     {
+ *       "action": "read",
+ *       "principal": "user2@example.com"
+ *     }
+ *   ],
+ *   "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2"
+ * };
+ * const command = new UpdateQAppPermissionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
+ *   "permissions": [
+ *     {
+ *       "action": "write",
+ *       "principal": {
+ *         "email": "user1@example.com",
+ *         "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
+ *       }
+ *     },
+ *     {
+ *       "action": "read",
+ *       "principal": {
+ *         "email": "user2@example.com",
+ *         "userId": "c81133d0-10d1-70eb-aaa3-d427ea6fc0f3"
+ *       }
+ *     }
+ *   ],
+ *   "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example Revoke permissions for the app
+ * ```javascript
+ * //
+ * const input = {
+ *   "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
+ *   "instanceId": "01793661-ad73-4c7d-8eaa-1c95a10151c2",
+ *   "revokePermissions": [
+ *     {
+ *       "action": "read",
+ *       "principal": "user2@example.com"
+ *     }
+ *   ]
+ * };
+ * const command = new UpdateQAppPermissionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "appId": "fe0acf86-49e5-4def-a0c2-40ce0cafee14",
+ *   "permissions": [
+ *     {
+ *       "action": "write",
+ *       "principal": {
+ *         "email": "user1@example.com",
+ *         "userId": "f8f15330-b091-708b-d46e-adb0d914b699"
+ *       }
+ *     }
+ *   ],
+ *   "resourceArn": "arn:aws:qapps:us-west-2:111111111111:application/01793661-ad73-4c7d-8eaa-1c95a10151c2/qapp/fe0acf86-49e5-4def-a0c2-40ce0cafee14"
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
  */
 export declare class UpdateQAppPermissionsCommand extends UpdateQAppPermissionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -27,11 +27,11 @@ declare const UpdateQAppSessionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates the session for a given Q App <code>sessionId</code>. This is only
- *       valid when at least one card of the session is in the <code>WAITING</code> state.
- *       Data for each <code>WAITING</code> card can be provided as input. If inputs
- *       are not provided, the call will be accepted but session will not move forward.
- *       Inputs for cards that are not in the <code>WAITING</code> status will be ignored.</p>
+ * <p>Updates the session for a given Q App <code>sessionId</code>. This is only valid when at
+ *       least one card of the session is in the <code>WAITING</code> state. Data for each
+ *         <code>WAITING</code> card can be provided as input. If inputs are not provided, the call
+ *       will be accepted but session will not move forward. Inputs for cards that are not in the
+ *         <code>WAITING</code> status will be ignored.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -77,12 +77,12 @@ declare const UpdateQAppSessionCommand_base: {
  *  <p>The requested resource could not be found.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  <p>The requested operation could not be completed because
- *       it would exceed the service's quota or limit.</p>
+ *  <p>The requested operation could not be completed because it would exceed the service's quota
+ *       or limit.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The requested operation could not be completed because too many
- *       requests were sent at once. Wait a bit and try again later.</p>
+ *  <p>The requested operation could not be completed because too many requests were sent at
+ *       once. Wait a bit and try again later.</p>
  *
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The client is not authenticated or authorized to perform the requested operation.</p>

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

@@ -27,7 +27,8 @@ declare const UpdateQAppSessionMetadataCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Updates the configuration metadata of a session for a given Q App <code>sessionId</code>.</p>
+ * <p>Updates the configuration metadata of a session for a given Q App
+ *       <code>sessionId</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -75,12 +76,12 @@ declare const UpdateQAppSessionMetadataCommand_base: {
  *  <p>The requested resource could not be found.</p>
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
- *  <p>The requested operation could not be completed because
- *       it would exceed the service's quota or limit.</p>
+ *  <p>The requested operation could not be completed because it would exceed the service's quota
+ *       or limit.</p>
  *
  * @throws {@link ThrottlingException} (client fault)
- *  <p>The requested operation could not be completed because too many
- *       requests were sent at once. Wait a bit and try again later.</p>
+ *  <p>The requested operation could not be completed because too many requests were sent at
+ *       once. Wait a bit and try again later.</p>
  *
  * @throws {@link UnauthorizedException} (client fault)
  *  <p>The client is not authenticated or authorized to perform the requested operation.</p>
@@ -92,6 +93,36 @@ declare const UpdateQAppSessionMetadataCommand_base: {
  * <p>Base exception class for all service exceptions from QApps service.</p>
  *
  * @public
+ * @example Updates an existing session metadata for an Amazon Q App
+ * ```javascript
+ * //
+ * const input = {
+ *   "instanceId": "0b95c9c4-89cc-4aa8-9aae-aa91cbec699f",
+ *   "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
+ *   "sessionName": "Trip itinerary collection session",
+ *   "sharingConfiguration": {
+ *     "acceptResponses": true,
+ *     "enabled": true,
+ *     "revealCards": false
+ *   }
+ * };
+ * const command = new UpdateQAppSessionMetadataCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "sessionArn": "arn:aws:qapps:us-west-2:0123456789012:application/cbea8329-41c0-4566-a112-19250921a220/qapp/387ccac9-4717-489f-841f-729b7d7de355/session/56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
+ *   "sessionId": "56ae47c3-10bc-4c2c-8b27-9b9fe23b3edb",
+ *   "sessionName": "Trip itinerary collection session",
+ *   "sharingConfiguration": {
+ *     "acceptResponses": true,
+ *     "enabled": true,
+ *     "revealCards": false
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class UpdateQAppSessionMetadataCommand extends UpdateQAppSessionMetadataCommand_base {
     /** @internal type navigation helper, not in runtime. */

package/dist-types/index.d.ts

@@ -1,18 +1,17 @@
 /**
- * <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience
- *       users to create lightweight, purpose-built AI apps to fulfill specific tasks from
- *       within their web experience. For example, users can create a Q App that exclusively
- *       generates marketing-related content to improve your marketing team's productivity or a
- *       Q App for writing customer emails and creating promotional content using a certain
- *       style of voice, tone, and branding. For more information on the capabilities, see
- *       <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html#q-apps-actions">Amazon Q Apps capabilities</a> in the <i>Amazon Q Business User Guide</i>.
- *       </p>
- *          <p>For an overview of the Amazon Q App APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Operations_QApps.html">Overview of
- *       Amazon Q Apps API operations</a>.</p>
- *          <p>For information about the IAM access control permissions you need to
- *       use the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
- *         IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in the
- *       <i>Amazon Q Business User Guide</i>.</p>
+ * <p>The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create
+ *       lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience.
+ *       For example, users can create a Q App that exclusively generates marketing-related content to
+ *       improve your marketing team's productivity or a Q App for writing customer emails and
+ *       creating promotional content using a certain style of voice, tone, and branding. For more
+ *       information on the capabilities, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html#q-apps-actions">Amazon Q Apps capabilities</a> in the <i>Amazon Q Business User
+ *         Guide</i>. </p>
+ *          <p>For an overview of the Amazon Q App APIs, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Operations_QApps.html">Overview of Amazon Q Apps API
+ *         operations</a>.</p>
+ *          <p>For information about the IAM access control permissions you need to use
+ *       the Amazon Q Apps API, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html">
+ *         IAM role for the Amazon Q Business web experience including Amazon Q Apps</a> in
+ *       the <i>Amazon Q Business User Guide</i>.</p>
  *
  * @packageDocumentation
  */