@aws-sdk/client-quicksight 3.696.0 → 3.705.0

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

@@ -0,0 +1,162 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GenerateEmbedUrlForRegisteredUserWithIdentityRequest, GenerateEmbedUrlForRegisteredUserWithIdentityResponse } from "../models/models_4";
+import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GenerateEmbedUrlForRegisteredUserWithIdentityCommand}.
+ */
+export interface GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput extends GenerateEmbedUrlForRegisteredUserWithIdentityRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GenerateEmbedUrlForRegisteredUserWithIdentityCommand}.
+ */
+export interface GenerateEmbedUrlForRegisteredUserWithIdentityCommandOutput extends GenerateEmbedUrlForRegisteredUserWithIdentityResponse, __MetadataBearer {
+}
+declare const GenerateEmbedUrlForRegisteredUserWithIdentityCommand_base: {
+    new (input: GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput, GenerateEmbedUrlForRegisteredUserWithIdentityCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput, GenerateEmbedUrlForRegisteredUserWithIdentityCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user that is registered in an Amazon QuickSight account that uses IAM Identity Center for authentication. This API requires <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-overview.html#types-identity-enhanced-iam-role-sessions">identity-enhanced IAM Role sessions</a> for the authenticated user that the API call is being made for.</p>
+ *          <p>This API uses <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation.html">trusted identity propagation</a> to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/trustedidentitypropagation-using-customermanagedapps-specify-trusted-apps.html">trusted Identity Propagation enabled for Amazon QuickSight</a> with the scope value set to <code>quicksight:read</code>. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QuickSightClient, GenerateEmbedUrlForRegisteredUserWithIdentityCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
+ * // const { QuickSightClient, GenerateEmbedUrlForRegisteredUserWithIdentityCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
+ * const client = new QuickSightClient(config);
+ * const input = { // GenerateEmbedUrlForRegisteredUserWithIdentityRequest
+ *   AwsAccountId: "STRING_VALUE", // required
+ *   SessionLifetimeInMinutes: Number("long"),
+ *   ExperienceConfiguration: { // RegisteredUserEmbeddingExperienceConfiguration
+ *     Dashboard: { // RegisteredUserDashboardEmbeddingConfiguration
+ *       InitialDashboardId: "STRING_VALUE", // required
+ *       FeatureConfigurations: { // RegisteredUserDashboardFeatureConfigurations
+ *         StatePersistence: { // StatePersistenceConfigurations
+ *           Enabled: true || false, // required
+ *         },
+ *         SharedView: { // SharedViewConfigurations
+ *           Enabled: true || false, // required
+ *         },
+ *         Bookmarks: { // BookmarksConfigurations
+ *           Enabled: true || false, // required
+ *         },
+ *       },
+ *     },
+ *     QuickSightConsole: { // RegisteredUserQuickSightConsoleEmbeddingConfiguration
+ *       InitialPath: "STRING_VALUE",
+ *       FeatureConfigurations: { // RegisteredUserConsoleFeatureConfigurations
+ *         StatePersistence: {
+ *           Enabled: true || false, // required
+ *         },
+ *         SharedView: {
+ *           Enabled: true || false, // required
+ *         },
+ *       },
+ *     },
+ *     QSearchBar: { // RegisteredUserQSearchBarEmbeddingConfiguration
+ *       InitialTopicId: "STRING_VALUE",
+ *     },
+ *     DashboardVisual: { // RegisteredUserDashboardVisualEmbeddingConfiguration
+ *       InitialDashboardVisualId: { // DashboardVisualId
+ *         DashboardId: "STRING_VALUE", // required
+ *         SheetId: "STRING_VALUE", // required
+ *         VisualId: "STRING_VALUE", // required
+ *       },
+ *     },
+ *     GenerativeQnA: { // RegisteredUserGenerativeQnAEmbeddingConfiguration
+ *       InitialTopicId: "STRING_VALUE",
+ *     },
+ *   },
+ *   AllowedDomains: [ // StringList
+ *     "STRING_VALUE",
+ *   ],
+ * };
+ * const command = new GenerateEmbedUrlForRegisteredUserWithIdentityCommand(input);
+ * const response = await client.send(command);
+ * // { // GenerateEmbedUrlForRegisteredUserWithIdentityResponse
+ * //   EmbedUrl: "STRING_VALUE", // required
+ * //   Status: Number("int"), // required
+ * //   RequestId: "STRING_VALUE", // required
+ * // };
+ *
+ * ```
+ *
+ * @param GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput - {@link GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput}
+ * @returns {@link GenerateEmbedUrlForRegisteredUserWithIdentityCommandOutput}
+ * @see {@link GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput} for command's `input` shape.
+ * @see {@link GenerateEmbedUrlForRegisteredUserWithIdentityCommandOutput} for command's `response` shape.
+ * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have access to this item. The provided credentials couldn't be
+ * 			validated. You might not be authorized to carry out the request. Make sure that your
+ * 			account is authorized to use the Amazon QuickSight service, that your policies have the
+ * 			correct permissions, and that you are using the correct credentials.</p>
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>An internal failure occurred.</p>
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  <p>One or more parameters has a value that isn't valid.</p>
+ *
+ * @throws {@link QuickSightUserNotFoundException} (client fault)
+ *  <p>The user with the provided name isn't found. This error can happen in any operation
+ * 			that requires finding a user based on a provided user name, such as
+ * 				<code>DeleteUser</code>, <code>DescribeUser</code>, and so on.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more resources can't be found.</p>
+ *
+ * @throws {@link SessionLifetimeInMinutesInvalidException} (client fault)
+ *  <p>The number of minutes specified for the lifetime of a session isn't valid. The session
+ * 			lifetime must be 15-600 minutes.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Access is throttled.</p>
+ *
+ * @throws {@link UnsupportedPricingPlanException} (client fault)
+ *  <p>This error indicates that you are calling an embedding operation in Amazon QuickSight
+ * 			without the required pricing plan on your Amazon Web Services account. Before you can use embedding
+ * 			for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You
+ * 		    can do this on the <b>Manage Amazon QuickSight</b> page. </p>
+ *          <p>After capacity pricing is added, you can use the
+ *             <code>
+ *                <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html">GetDashboardEmbedUrl</a>
+ *             </code> API operation with the
+ *             <code>--identity-type ANONYMOUS</code> option.</p>
+ *
+ * @throws {@link UnsupportedUserEditionException} (client fault)
+ *  <p>This error indicates that you are calling an operation on an Amazon QuickSight
+ * 			subscription where the edition doesn't include support for that operation. Amazon
+ * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
+ * 			capability is available in every edition.</p>
+ *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
+ *
+ * @public
+ */
+export declare class GenerateEmbedUrlForRegisteredUserWithIdentityCommand extends GenerateEmbedUrlForRegisteredUserWithIdentityCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GenerateEmbedUrlForRegisteredUserWithIdentityRequest;
+            output: GenerateEmbedUrlForRegisteredUserWithIdentityResponse;
+        };
+        sdk: {
+            input: GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput;
+            output: GenerateEmbedUrlForRegisteredUserWithIdentityCommandOutput;
+        };
+    };
+}

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

@@ -45,7 +45,7 @@ declare const ListIdentityPropagationConfigsCommand_base: {
  * // { // ListIdentityPropagationConfigsResponse
  * //   Services: [ // AuthorizedTargetsByServices
  * //     { // AuthorizedTargetsByService
- * //       Service: "REDSHIFT",
+ * //       Service: "REDSHIFT" || "QBUSINESS",
  * //       AuthorizedTargets: [ // AuthorizedTargetsList
  * //         "STRING_VALUE",
  * //       ],

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

@@ -53,6 +53,8 @@ declare const ListNamespacesCommand_base: {
  * //         Type: "PERMISSION_DENIED" || "INTERNAL_SERVICE_ERROR",
  * //         Message: "STRING_VALUE",
  * //       },
+ * //       IamIdentityCenterApplicationArn: "STRING_VALUE",
+ * //       IamIdentityCenterInstanceArn: "STRING_VALUE",
  * //     },
  * //   ],
  * //   NextToken: "STRING_VALUE",

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

@@ -1,6 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { ListTopicReviewedAnswersRequest, ListTopicReviewedAnswersResponse } from "../models/models_4";
+import { ListTopicReviewedAnswersRequest } from "../models/models_4";
+import { ListTopicReviewedAnswersResponse } from "../models/models_5";
 import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
 /**
  * @public

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

@@ -0,0 +1,139 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { PredictQAResultsRequest, PredictQAResultsResponse } from "../models/models_4";
+import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PredictQAResultsCommand}.
+ */
+export interface PredictQAResultsCommandInput extends PredictQAResultsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PredictQAResultsCommand}.
+ */
+export interface PredictQAResultsCommandOutput extends PredictQAResultsResponse, __MetadataBearer {
+}
+declare const PredictQAResultsCommand_base: {
+    new (input: PredictQAResultsCommandInput): import("@smithy/smithy-client").CommandImpl<PredictQAResultsCommandInput, PredictQAResultsCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PredictQAResultsCommandInput): import("@smithy/smithy-client").CommandImpl<PredictQAResultsCommandInput, PredictQAResultsCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Predicts existing visuals or generates new visuals to answer a given query.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QuickSightClient, PredictQAResultsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
+ * // const { QuickSightClient, PredictQAResultsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
+ * const client = new QuickSightClient(config);
+ * const input = { // PredictQAResultsRequest
+ *   AwsAccountId: "STRING_VALUE", // required
+ *   QueryText: "STRING_VALUE", // required
+ *   IncludeQuickSightQIndex: "INCLUDE" || "EXCLUDE",
+ *   IncludeGeneratedAnswer: "INCLUDE" || "EXCLUDE",
+ *   MaxTopicsToConsider: Number("int"),
+ * };
+ * const command = new PredictQAResultsCommand(input);
+ * const response = await client.send(command);
+ * // { // PredictQAResultsResponse
+ * //   PrimaryResult: { // QAResult
+ * //     ResultType: "DASHBOARD_VISUAL" || "GENERATED_ANSWER" || "NO_ANSWER",
+ * //     DashboardVisual: { // DashboardVisualResult
+ * //       DashboardId: "STRING_VALUE",
+ * //       DashboardName: "STRING_VALUE",
+ * //       SheetId: "STRING_VALUE",
+ * //       SheetName: "STRING_VALUE",
+ * //       VisualId: "STRING_VALUE",
+ * //       VisualTitle: "STRING_VALUE",
+ * //       VisualSubtitle: "STRING_VALUE",
+ * //       DashboardUrl: "STRING_VALUE",
+ * //     },
+ * //     GeneratedAnswer: { // GeneratedAnswerResult
+ * //       QuestionText: "STRING_VALUE",
+ * //       AnswerStatus: "ANSWER_GENERATED" || "ANSWER_RETRIEVED" || "ANSWER_DOWNGRADE",
+ * //       TopicId: "STRING_VALUE",
+ * //       TopicName: "STRING_VALUE",
+ * //       Restatement: "STRING_VALUE",
+ * //       QuestionId: "STRING_VALUE",
+ * //       AnswerId: "STRING_VALUE",
+ * //       QuestionUrl: "STRING_VALUE",
+ * //     },
+ * //   },
+ * //   AdditionalResults: [ // QAResults
+ * //     {
+ * //       ResultType: "DASHBOARD_VISUAL" || "GENERATED_ANSWER" || "NO_ANSWER",
+ * //       DashboardVisual: {
+ * //         DashboardId: "STRING_VALUE",
+ * //         DashboardName: "STRING_VALUE",
+ * //         SheetId: "STRING_VALUE",
+ * //         SheetName: "STRING_VALUE",
+ * //         VisualId: "STRING_VALUE",
+ * //         VisualTitle: "STRING_VALUE",
+ * //         VisualSubtitle: "STRING_VALUE",
+ * //         DashboardUrl: "STRING_VALUE",
+ * //       },
+ * //       GeneratedAnswer: {
+ * //         QuestionText: "STRING_VALUE",
+ * //         AnswerStatus: "ANSWER_GENERATED" || "ANSWER_RETRIEVED" || "ANSWER_DOWNGRADE",
+ * //         TopicId: "STRING_VALUE",
+ * //         TopicName: "STRING_VALUE",
+ * //         Restatement: "STRING_VALUE",
+ * //         QuestionId: "STRING_VALUE",
+ * //         AnswerId: "STRING_VALUE",
+ * //         QuestionUrl: "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   RequestId: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * // };
+ *
+ * ```
+ *
+ * @param PredictQAResultsCommandInput - {@link PredictQAResultsCommandInput}
+ * @returns {@link PredictQAResultsCommandOutput}
+ * @see {@link PredictQAResultsCommandInput} for command's `input` shape.
+ * @see {@link PredictQAResultsCommandOutput} for command's `response` shape.
+ * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have access to this item. The provided credentials couldn't be
+ * 			validated. You might not be authorized to carry out the request. Make sure that your
+ * 			account is authorized to use the Amazon QuickSight service, that your policies have the
+ * 			correct permissions, and that you are using the correct credentials.</p>
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>An internal failure occurred.</p>
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  <p>One or more parameters has a value that isn't valid.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Access is throttled.</p>
+ *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
+ *
+ * @public
+ */
+export declare class PredictQAResultsCommand extends PredictQAResultsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PredictQAResultsRequest;
+            output: PredictQAResultsResponse;
+        };
+        sdk: {
+            input: PredictQAResultsCommandInput;
+            output: PredictQAResultsCommandOutput;
+        };
+    };
+}

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

@@ -0,0 +1,111 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { SearchTopicsRequest, SearchTopicsResponse } from "../models/models_4";
+import { QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../QuickSightClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link SearchTopicsCommand}.
+ */
+export interface SearchTopicsCommandInput extends SearchTopicsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link SearchTopicsCommand}.
+ */
+export interface SearchTopicsCommandOutput extends SearchTopicsResponse, __MetadataBearer {
+}
+declare const SearchTopicsCommand_base: {
+    new (input: SearchTopicsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchTopicsCommandInput, SearchTopicsCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: SearchTopicsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchTopicsCommandInput, SearchTopicsCommandOutput, QuickSightClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Searches for any Q topic that exists in an Amazon QuickSight account.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { QuickSightClient, SearchTopicsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
+ * // const { QuickSightClient, SearchTopicsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
+ * const client = new QuickSightClient(config);
+ * const input = { // SearchTopicsRequest
+ *   AwsAccountId: "STRING_VALUE", // required
+ *   Filters: [ // TopicSearchFilterList // required
+ *     { // TopicSearchFilter
+ *       Operator: "StringEquals" || "StringLike", // required
+ *       Name: "QUICKSIGHT_USER" || "QUICKSIGHT_VIEWER_OR_OWNER" || "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" || "QUICKSIGHT_OWNER" || "DIRECT_QUICKSIGHT_OWNER" || "DIRECT_QUICKSIGHT_SOLE_OWNER" || "TOPIC_NAME", // required
+ *       Value: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   NextToken: "STRING_VALUE",
+ *   MaxResults: Number("int"),
+ * };
+ * const command = new SearchTopicsCommand(input);
+ * const response = await client.send(command);
+ * // { // SearchTopicsResponse
+ * //   TopicSummaryList: [ // TopicSummaries
+ * //     { // TopicSummary
+ * //       Arn: "STRING_VALUE",
+ * //       TopicId: "STRING_VALUE",
+ * //       Name: "STRING_VALUE",
+ * //       UserExperienceVersion: "LEGACY" || "NEW_READER_EXPERIENCE",
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * //   Status: Number("int"),
+ * //   RequestId: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param SearchTopicsCommandInput - {@link SearchTopicsCommandInput}
+ * @returns {@link SearchTopicsCommandOutput}
+ * @see {@link SearchTopicsCommandInput} for command's `input` shape.
+ * @see {@link SearchTopicsCommandOutput} for command's `response` shape.
+ * @see {@link QuickSightClientResolvedConfig | config} for QuickSightClient's `config` shape.
+ *
+ * @throws {@link InternalFailureException} (server fault)
+ *  <p>An internal failure occurred.</p>
+ *
+ * @throws {@link InvalidNextTokenException} (client fault)
+ *  <p>The <code>NextToken</code> value isn't valid.</p>
+ *
+ * @throws {@link InvalidParameterValueException} (client fault)
+ *  <p>One or more parameters has a value that isn't valid.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>One or more resources can't be found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>Access is throttled.</p>
+ *
+ * @throws {@link UnsupportedUserEditionException} (client fault)
+ *  <p>This error indicates that you are calling an operation on an Amazon QuickSight
+ * 			subscription where the edition doesn't include support for that operation. Amazon
+ * 			Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and
+ * 			capability is available in every edition.</p>
+ *
+ * @throws {@link QuickSightServiceException}
+ * <p>Base exception class for all service exceptions from QuickSight service.</p>
+ *
+ * @public
+ */
+export declare class SearchTopicsCommand extends SearchTopicsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: SearchTopicsRequest;
+            output: SearchTopicsResponse;
+        };
+        sdk: {
+            input: SearchTopicsCommandInput;
+            output: SearchTopicsCommandOutput;
+        };
+    };
+}