import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GenerateEmbedUrlForRegisteredUserWithIdentityRequest, GenerateEmbedUrlForRegisteredUserWithIdentityResponse } from "../models/models_4"; import type { 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; new (input: GenerateEmbedUrlForRegisteredUserWithIdentityCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Generates an embed URL that you can use to embed an Amazon Quick Sight experience in * your website. This action can be used for any type of user that is registered in an * Amazon Quick Sight account that uses IAM Identity Center for authentication. This API * requires identity-enhanced IAM Role sessions for the authenticated * user that the API call is being made for.

*

This API uses trusted identity * propagation 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 trusted Identity Propagation enabled for Amazon Quick Sight with the scope * value set to quicksight:read. Before you use this action, make sure that * you have configured the relevant Amazon Quick Sight resource and permissions.

* @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 * // import type { QuickSightClientConfig } from "@aws-sdk/client-quicksight"; * const config = {}; // type is QuickSightClientConfig * 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 * }, * Bookmarks: { // BookmarksConfigurations * Enabled: true || false, // required * }, * SharedView: { // SharedViewConfigurations * Enabled: true || false, // required * }, * AmazonQInQuickSight: { // AmazonQInQuickSightDashboardConfigurations * ExecutiveSummary: { // ExecutiveSummaryConfigurations * Enabled: true || false, // required * }, * }, * Schedules: { // SchedulesConfigurations * Enabled: true || false, // required * }, * RecentSnapshots: { // RecentSnapshotsConfigurations * Enabled: true || false, // required * }, * ThresholdAlerts: { // ThresholdAlertsConfigurations * Enabled: true || false, // required * }, * }, * }, * QuickSightConsole: { // RegisteredUserQuickSightConsoleEmbeddingConfiguration * InitialPath: "STRING_VALUE", * FeatureConfigurations: { // RegisteredUserConsoleFeatureConfigurations * StatePersistence: { * Enabled: true || false, // required * }, * SharedView: { * Enabled: true || false, // required * }, * AmazonQInQuickSight: { // AmazonQInQuickSightConsoleConfigurations * DataQnA: { // DataQnAConfigurations * Enabled: true || false, // required * }, * GenerativeAuthoring: { // GenerativeAuthoringConfigurations * Enabled: true || false, // required * }, * ExecutiveSummary: { * Enabled: true || false, // required * }, * DataStories: { // DataStoriesConfigurations * Enabled: true || false, // required * }, * }, * Schedules: { * Enabled: true || false, // required * }, * RecentSnapshots: { * Enabled: true || false, // required * }, * ThresholdAlerts: { * 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", * }, * QuickChat: {}, * }, * 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) *

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 Quick Sight service, that your policies have the * correct permissions, and that you are using the correct credentials.

* * @throws {@link InternalFailureException} (server fault) *

An internal failure occurred.

* * @throws {@link InvalidParameterValueException} (client fault) *

One or more parameters has a value that isn't valid.

* * @throws {@link QuickSightUserNotFoundException} (client fault) *

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 * DeleteUser, DescribeUser, and so on.

* * @throws {@link ResourceNotFoundException} (client fault) *

One or more resources can't be found.

* * @throws {@link SessionLifetimeInMinutesInvalidException} (client fault) *

The number of minutes specified for the lifetime of a session isn't valid. The session * lifetime must be 15-600 minutes.

* * @throws {@link ThrottlingException} (client fault) *

Access is throttled.

* * @throws {@link UnsupportedPricingPlanException} (client fault) *

This error indicates that you are calling an embedding operation in Amazon Quick Sight * without the required pricing plan on your Amazon Web Services account. Before you can use embedding * for anonymous users, a Quick Suite administrator needs to add capacity pricing to Quick Sight. You * can do this on the Manage Quick Suite page.

*

After capacity pricing is added, you can use the * * GetDashboardEmbedUrl * API operation with the * --identity-type ANONYMOUS option.

* * @throws {@link UnsupportedUserEditionException} (client fault) *

This error indicates that you are calling an operation on an Amazon Quick Suite * subscription where the edition doesn't include support for that operation. Amazon * Quick Suite currently has Standard Edition and Enterprise Edition. Not every operation and * capability is available in every edition.

* * @throws {@link QuickSightServiceException} *

Base exception class for all service exceptions from QuickSight service.

* * * @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; }; }; }