@aws-sdk/client-qbusiness 3.738.0 → 3.741.0

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

@@ -0,0 +1,113 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { CreateSubscriptionRequest, CreateSubscriptionResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link CreateSubscriptionCommand}.
+ */
+export interface CreateSubscriptionCommandInput extends CreateSubscriptionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link CreateSubscriptionCommand}.
+ */
+export interface CreateSubscriptionCommandOutput extends CreateSubscriptionResponse, __MetadataBearer {
+}
+declare const CreateSubscriptionCommand_base: {
+    new (input: CreateSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSubscriptionCommandInput, CreateSubscriptionCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: CreateSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateSubscriptionCommandInput, CreateSubscriptionCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Subscribes an IAM Identity Center user or a group to a pricing tier for an
+ *             Amazon Q Business application.</p>
+ *          <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and
+ *                 <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user.
+ *             For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business
+ *             pricing</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, CreateSubscriptionCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, CreateSubscriptionCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // CreateSubscriptionRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   principal: { // SubscriptionPrincipal Union: only one key present
+ *     user: "STRING_VALUE",
+ *     group: "STRING_VALUE",
+ *   },
+ *   type: "Q_LITE" || "Q_BUSINESS", // required
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new CreateSubscriptionCommand(input);
+ * const response = await client.send(command);
+ * // { // CreateSubscriptionResponse
+ * //   subscriptionId: "STRING_VALUE",
+ * //   subscriptionArn: "STRING_VALUE",
+ * //   currentSubscription: { // SubscriptionDetails
+ * //     type: "Q_LITE" || "Q_BUSINESS",
+ * //   },
+ * //   nextSubscription: {
+ * //     type: "Q_LITE" || "Q_BUSINESS",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param CreateSubscriptionCommandInput - {@link CreateSubscriptionCommandInput}
+ * @returns {@link CreateSubscriptionCommandOutput}
+ * @see {@link CreateSubscriptionCommandInput} for command's `input` shape.
+ * @see {@link CreateSubscriptionCommandOutput} for command's `response` shape.
+ * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You don't have access to perform this action. Make sure you have the required
+ *             permission policies and user accounts and try again.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>You are trying to perform an action that conflicts with the current status of your
+ *             resource. Fix any inconsistencies with your resources and try again.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
+ *             some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
+ *             provided the correct resource and try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling. Reduce the number of requests and try
+ *             again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
+ *             correct input and try again.</p>
+ *
+ * @throws {@link QBusinessServiceException}
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
+ *
+ * @public
+ */
+export declare class CreateSubscriptionCommand extends CreateSubscriptionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: CreateSubscriptionRequest;
+            output: CreateSubscriptionResponse;
+        };
+        sdk: {
+            input: CreateSubscriptionCommandInput;
+            output: CreateSubscriptionCommandOutput;
+        };
+    };
+}

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

@@ -28,7 +28,7 @@ declare const DeleteDataAccessorCommand_base: {
 };
 /**
  * <p>Deletes a specified data accessor. This operation permanently removes the data accessor
- *         and its associated AWS IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked</p>
+ *         and its associated IAM Identity Center application. Any access granted to the ISV through this data accessor will be revoked.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -27,7 +27,7 @@ declare const DisassociatePermissionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Removes a permission policy from a Q Business application, revoking the cross-account access that was
+ * <p>Removes a permission policy from a Amazon Q Business application, revoking the cross-account access that was
  *         previously granted to an ISV. This operation deletes the specified policy statement from the application's permission policy.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -30,7 +30,7 @@ declare const GetDataAccessorCommand_base: {
 /**
  * <p>Retrieves information about a specified data accessor. This operation returns details about the
  *         data accessor, including its display name, unique identifier, Amazon Resource Name (ARN), the associated
- *         Q Business application and AWS IAM Identity Center application, the IAM role for the ISV, the
+ *         Amazon Q Business application and IAM Identity Center application, the IAM role for the ISV, the
  *         action configurations, and the timestamps for when the data accessor was created and last updated.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -27,7 +27,7 @@ declare const GetPolicyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Retrieves the current permission policy for a Q Business application. The policy is
+ * <p>Retrieves the current permission policy for a Amazon Q Business application. The policy is
  *         returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -27,7 +27,7 @@ declare const ListDataAccessorsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Lists the data accessors for a Q Business application. This operation returns a paginated
+ * <p>Lists the data accessors for a Amazon Q Business application. This operation returns a paginated
  *         list of data accessor summaries, including the friendly name, unique identifier, ARN,
  *         associated IAM role, and creation/update timestamps for each data accessor.</p>
  * @example

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

@@ -0,0 +1,113 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { ListSubscriptionsRequest, ListSubscriptionsResponse } from "../models/models_0";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListSubscriptionsCommand}.
+ */
+export interface ListSubscriptionsCommandInput extends ListSubscriptionsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListSubscriptionsCommand}.
+ */
+export interface ListSubscriptionsCommandOutput extends ListSubscriptionsResponse, __MetadataBearer {
+}
+declare const ListSubscriptionsCommand_base: {
+    new (input: ListSubscriptionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: ListSubscriptionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListSubscriptionsCommandInput, ListSubscriptionsCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p> Lists all subscriptions created in an Amazon Q Business application. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, ListSubscriptionsCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, ListSubscriptionsCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // ListSubscriptionsRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListSubscriptionsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListSubscriptionsResponse
+ * //   nextToken: "STRING_VALUE",
+ * //   subscriptions: [ // Subscriptions
+ * //     { // Subscription
+ * //       subscriptionId: "STRING_VALUE",
+ * //       subscriptionArn: "STRING_VALUE",
+ * //       principal: { // SubscriptionPrincipal Union: only one key present
+ * //         user: "STRING_VALUE",
+ * //         group: "STRING_VALUE",
+ * //       },
+ * //       currentSubscription: { // SubscriptionDetails
+ * //         type: "Q_LITE" || "Q_BUSINESS",
+ * //       },
+ * //       nextSubscription: {
+ * //         type: "Q_LITE" || "Q_BUSINESS",
+ * //       },
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param ListSubscriptionsCommandInput - {@link ListSubscriptionsCommandInput}
+ * @returns {@link ListSubscriptionsCommandOutput}
+ * @see {@link ListSubscriptionsCommandInput} for command's `input` shape.
+ * @see {@link ListSubscriptionsCommandOutput} for command's `response` shape.
+ * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You don't have access to perform this action. Make sure you have the required
+ *             permission policies and user accounts and try again.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>You are trying to perform an action that conflicts with the current status of your
+ *             resource. Fix any inconsistencies with your resources and try again.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
+ *             some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
+ *             provided the correct resource and try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling. Reduce the number of requests and try
+ *             again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
+ *             correct input and try again.</p>
+ *
+ * @throws {@link QBusinessServiceException}
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
+ *
+ * @public
+ */
+export declare class ListSubscriptionsCommand extends ListSubscriptionsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListSubscriptionsRequest;
+            output: ListSubscriptionsResponse;
+        };
+        sdk: {
+            input: ListSubscriptionsCommandInput;
+            output: ListSubscriptionsCommandOutput;
+        };
+    };
+}

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

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { PutGroupRequest, PutGroupResponse } from "../models/models_0";
+import { PutGroupRequest, PutGroupResponse } from "../models/models_1";
 import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
 /**
  * @public
@@ -34,6 +34,10 @@ declare const PutGroupCommand_base: {
  *             include their own list of users or people who work in these teams. Only users who work
  *             in research and engineering, and therefore belong in the intellectual property group,
  *             can see top-secret company documents in their Amazon Q Business chat results.</p>
+ *          <p>There are two options for creating groups, either passing group members inline or using an S3 file via the
+ *             S3PathForGroupMembers field. For inline groups, there is a limit of 1000 members per group and for provided S3 files
+ *             there is a limit of 100 thousand members. When creating a group using an S3 file, you provide both
+ *             an S3 file and a <code>RoleArn</code> for Amazon Q Buisness to access the file.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -1,7 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { SearchRelevantContentResponse } from "../models/models_0";
-import { SearchRelevantContentRequest } from "../models/models_1";
+import { SearchRelevantContentRequest, SearchRelevantContentResponse } from "../models/models_1";
 import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
 /**
  * @public
@@ -28,8 +27,8 @@ declare const SearchRelevantContentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Searches for relevant content in a Q Business application based on a query. This operation takes a
- *         search query text, the Q Business application identifier, and optional filters
+ * <p>Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a
+ *         search query text, the Amazon Q Business application identifier, and optional filters
  *         (such as content source and maximum results) as input. It returns a list of
  *         relevant content items, where each item includes the content text, the unique document identifier,
  *         the document title, the document URI, any relevant document attributes, and score attributes

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

@@ -1,7 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { StartDataSourceSyncJobRequest } from "../models/models_0";
-import { StartDataSourceSyncJobResponse } from "../models/models_1";
+import { StartDataSourceSyncJobRequest, StartDataSourceSyncJobResponse } from "../models/models_1";
 import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
 /**
  * @public

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

@@ -0,0 +1,106 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { UpdateSubscriptionRequest, UpdateSubscriptionResponse } from "../models/models_1";
+import { QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QBusinessClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateSubscriptionCommand}.
+ */
+export interface UpdateSubscriptionCommandInput extends UpdateSubscriptionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateSubscriptionCommand}.
+ */
+export interface UpdateSubscriptionCommandOutput extends UpdateSubscriptionResponse, __MetadataBearer {
+}
+declare const UpdateSubscriptionCommand_base: {
+    new (input: UpdateSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSubscriptionCommandInput, UpdateSubscriptionCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: UpdateSubscriptionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateSubscriptionCommandInput, UpdateSubscriptionCommandOutput, QBusinessClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Updates the pricing tier for an Amazon Q Business subscription. Upgrades are instant.
+ *             Downgrades apply at the start of the next month. Subscription tier determines feature
+ *             access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business
+ *             pricing</a>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QBusinessClient, UpdateSubscriptionCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
+ * // const { QBusinessClient, UpdateSubscriptionCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
+ * const client = new QBusinessClient(config);
+ * const input = { // UpdateSubscriptionRequest
+ *   applicationId: "STRING_VALUE", // required
+ *   subscriptionId: "STRING_VALUE", // required
+ *   type: "Q_LITE" || "Q_BUSINESS", // required
+ * };
+ * const command = new UpdateSubscriptionCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateSubscriptionResponse
+ * //   subscriptionArn: "STRING_VALUE",
+ * //   currentSubscription: { // SubscriptionDetails
+ * //     type: "Q_LITE" || "Q_BUSINESS",
+ * //   },
+ * //   nextSubscription: {
+ * //     type: "Q_LITE" || "Q_BUSINESS",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateSubscriptionCommandInput - {@link UpdateSubscriptionCommandInput}
+ * @returns {@link UpdateSubscriptionCommandOutput}
+ * @see {@link UpdateSubscriptionCommandInput} for command's `input` shape.
+ * @see {@link UpdateSubscriptionCommandOutput} for command's `response` shape.
+ * @see {@link QBusinessClientResolvedConfig | config} for QBusinessClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p> You don't have access to perform this action. Make sure you have the required
+ *             permission policies and user accounts and try again.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>You are trying to perform an action that conflicts with the current status of your
+ *             resource. Fix any inconsistencies with your resources and try again.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
+ *             some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The application or plugin resource you want to use doesn’t exist. Make sure you have
+ *             provided the correct resource and try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to throttling. Reduce the number of requests and try
+ *             again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
+ *             correct input and try again.</p>
+ *
+ * @throws {@link QBusinessServiceException}
+ * <p>Base exception class for all service exceptions from QBusiness service.</p>
+ *
+ * @public
+ */
+export declare class UpdateSubscriptionCommand extends UpdateSubscriptionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateSubscriptionRequest;
+            output: UpdateSubscriptionResponse;
+        };
+        sdk: {
+            input: UpdateSubscriptionCommandInput;
+            output: UpdateSubscriptionCommandOutput;
+        };
+    };
+}

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

@@ -1,6 +1,7 @@
 export * from "./AssociatePermissionCommand";
 export * from "./BatchDeleteDocumentCommand";
 export * from "./BatchPutDocumentCommand";
+export * from "./CancelSubscriptionCommand";
 export * from "./ChatCommand";
 export * from "./ChatSyncCommand";
 export * from "./CreateApplicationCommand";
@@ -9,6 +10,7 @@ export * from "./CreateDataSourceCommand";
 export * from "./CreateIndexCommand";
 export * from "./CreatePluginCommand";
 export * from "./CreateRetrieverCommand";
+export * from "./CreateSubscriptionCommand";
 export * from "./CreateUserCommand";
 export * from "./CreateWebExperienceCommand";
 export * from "./DeleteApplicationCommand";
@@ -50,6 +52,7 @@ export * from "./ListPluginTypeActionsCommand";
 export * from "./ListPluginTypeMetadataCommand";
 export * from "./ListPluginsCommand";
 export * from "./ListRetrieversCommand";
+export * from "./ListSubscriptionsCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListWebExperiencesCommand";
 export * from "./PutFeedbackCommand";
@@ -66,5 +69,6 @@ export * from "./UpdateDataSourceCommand";
 export * from "./UpdateIndexCommand";
 export * from "./UpdatePluginCommand";
 export * from "./UpdateRetrieverCommand";
+export * from "./UpdateSubscriptionCommand";
 export * from "./UpdateUserCommand";
 export * from "./UpdateWebExperienceCommand";