@aws-sdk/client-quicksight 3.303.0 → 3.309.0

package/dist-types/models/models_3.d.ts

@@ -1,8 +1,539 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { AccountCustomization, ActiveIAMPolicyAssignment, ResourceStatus } from "./models_0";
-import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, Tag } from "./models_1";
-import { _Parameters, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSetImportMode, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, DataSourceSearchFilter, DataSourceSummary, FieldFolder, FolderSearchFilter, FolderSummary, Group, GroupMember, IdentityType, Ingestion, LinkSharingConfiguration, LogicalTable, MemberIdArnPair, NamespaceInfoV2, PhysicalTable, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ThemeType, User, UserRole, VpcConnectionProperties } from "./models_2";
+import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardVisualId, FilterOperator, Tag } from "./models_1";
+import { _Parameters, DashboardPublishOptions, DashboardSearchFilter, DashboardSourceEntity, DashboardSummary, DashboardVersionDefinition, DashboardVersionSummary, DataSetImportMode, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSetUsageConfiguration, DataSource, DataSourceCredentials, DataSourceParameters, DataSourceSearchFilter, DataSourceSummary, EmbeddingIdentityType, FieldFolder, FolderFilterAttribute, FolderType, Group, GroupMember, IdentityType, Ingestion, LinkSharingConfiguration, LogicalTable, NamespaceInfoV2, PhysicalTable, RefreshSchedule, ResourcePermission, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SslProperties, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ThemeType, User, UserRole, VpcConnectionProperties } from "./models_2";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+/**
+ * @public
+ * <p>An object that consists of a member Amazon Resource Name (ARN) and a member ID.</p>
+ */
+export interface MemberIdArnPair {
+    /**
+     * <p>The ID of the member.</p>
+     */
+    MemberId?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the member.</p>
+     */
+    MemberArn?: string;
+}
+/**
+ * @public
+ * <p>A filter to use to search an Amazon QuickSight folder.</p>
+ */
+export interface FolderSearchFilter {
+    /**
+     * <p>The comparison operator that you want to use as a filter, for example  <code>"Operator": "StringEquals"</code>. Valid values are  <code>"StringEquals"</code>  and  <code>"StringLike"</code>.</p>
+     *          <p>If you set the operator value to <code>"StringEquals"</code>, you need to provide an ownership related filter in the <code>"NAME"</code> field and the arn of the user or group whose folders you want to search in the <code>"Value"</code> field. For example,  <code>"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"</code>.</p>
+     *          <p>If you set the value to <code>"StringLike"</code>, you need to provide the name of the folders you are searching for. For example, <code>"Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"</code>. The <code>"StringLike"</code> operator only supports the <code>NAME</code> value <code>FOLDER_NAME</code>.</p>
+     */
+    Operator?: FilterOperator | string;
+    /**
+     * <p>The name of a value that you want to use in the filter. For example, <code>"Name": "QUICKSIGHT_OWNER"</code>.</p>
+     *          <p>Valid values are defined as follows:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>DIRECT_QUICKSIGHT_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>FOLDER_NAME</code>: Any folders whose names have a substring match to this value will be returned.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>PARENT_FOLDER_ARN</code>: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned. </p>
+     *             </li>
+     *          </ul>
+     */
+    Name?: FolderFilterAttribute | string;
+    /**
+     * <p>The value of the named item (in this example, <code>PARENT_FOLDER_ARN</code>), that you want to use as a filter. For example, <code>"Value": "arn:aws:quicksight:us-east-1:1:folder/folderId"</code>.</p>
+     */
+    Value?: string;
+}
+/**
+ * @public
+ * <p>A summary of information about an existing Amazon QuickSight folder. </p>
+ */
+export interface FolderSummary {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the folder.</p>
+     */
+    Arn?: string;
+    /**
+     * <p>The ID of the folder.</p>
+     */
+    FolderId?: string;
+    /**
+     * <p>The display name of the folder.</p>
+     */
+    Name?: string;
+    /**
+     * <p>The type of folder.</p>
+     */
+    FolderType?: FolderType | string;
+    /**
+     * <p>The time that the folder was created.</p>
+     */
+    CreatedTime?: Date;
+    /**
+     * <p>The time that the folder was last updated.</p>
+     */
+    LastUpdatedTime?: Date;
+}
+/**
+ * @public
+ * <p>The key-value pair used for the row-level security tags feature.</p>
+ */
+export interface SessionTag {
+    /**
+     * <p>The key for the tag.</p>
+     */
+    Key: string | undefined;
+    /**
+     * <p>The value that you want to assign the tag.</p>
+     */
+    Value: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GenerateEmbedUrlForAnonymousUserRequest {
+    /**
+     * <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</p>
+     */
+    SessionLifetimeInMinutes?: number;
+    /**
+     * <p>The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to <code>default</code>.</p>
+     */
+    Namespace: string | undefined;
+    /**
+     * <p>The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the <code>DataSet$RowLevelPermissionTagConfiguration</code> parameter so that session tags can be used to provide row-level security.</p>
+     *          <p>These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon QuickSight User Guide</i>.</p>
+     */
+    SessionTags?: SessionTag[];
+    /**
+     * <p>The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user
+     *             is authorized to access during the lifetime of the session. If you choose
+     *                 <code>Dashboard</code> embedding experience, pass the list of dashboard ARNs in the
+     *             account that you want the user to be able to view. Currently, you can pass up to 25
+     *             dashboard ARNs in each API call.</p>
+     */
+    AuthorizedResourceArns: string[] | undefined;
+    /**
+     * <p>The configuration of the experience that you are embedding.</p>
+     */
+    ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined;
+    /**
+     * <p>The domains that you want to add to the allow list for access to the generated URL that
+     *             is then embedded. This optional parameter overrides the static domains that are
+     *             configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
+     *             allows only the domains that you include in this parameter. You can list up to three
+     *             domains or subdomains in each API call.</p>
+     *          <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
+     *             For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
+     *             <code>https://sapp.amazon.com</code>.</p>
+     */
+    AllowedDomains?: string[];
+}
+/**
+ * @public
+ */
+export interface GenerateEmbedUrlForAnonymousUserResponse {
+    /**
+     * <p>The embed URL for the dashboard.</p>
+     */
+    EmbedUrl: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     */
+    Status: number | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.</p>
+     */
+    AnonymousUserArn: string | undefined;
+}
+/**
+ * @public
+ * <p>The number of minutes specified for the lifetime of a session isn't valid. The session
+ * 			lifetime must be 15-600 minutes.</p>
+ */
+export declare class SessionLifetimeInMinutesInvalidException extends __BaseException {
+    readonly name: "SessionLifetimeInMinutesInvalidException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * <p>The Amazon Web Services request ID for this request.</p>
+     */
+    RequestId?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<SessionLifetimeInMinutesInvalidException, __BaseException>);
+}
+/**
+ * @public
+ * <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>
+ */
+export declare class UnsupportedPricingPlanException extends __BaseException {
+    readonly name: "UnsupportedPricingPlanException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * <p>The Amazon Web Services request ID for this request.</p>
+     */
+    RequestId?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<UnsupportedPricingPlanException, __BaseException>);
+}
+/**
+ * @public
+ * <p>The state perssitence configuration of an embedded dashboard.</p>
+ */
+export interface StatePersistenceConfigurations {
+    /**
+     * <p>Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.</p>
+     */
+    Enabled: boolean | undefined;
+}
+/**
+ * @public
+ * <p>The feature configuration for an embedded dashboard.</p>
+ */
+export interface RegisteredUserDashboardFeatureConfigurations {
+    /**
+     * <p>The state persistence settings of an embedded dashboard.</p>
+     */
+    StatePersistence?: StatePersistenceConfigurations;
+}
+/**
+ * @public
+ * <p>Information about the dashboard you want to embed.</p>
+ */
+export interface RegisteredUserDashboardEmbeddingConfiguration {
+    /**
+     * <p>The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.</p>
+     *          <p>If the user does not have permission to view this dashboard, they see a permissions error message.</p>
+     */
+    InitialDashboardId: string | undefined;
+    /**
+     * <p>The feature configurations of an embbedded Amazon QuickSight dashboard.</p>
+     */
+    FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations;
+}
+/**
+ * @public
+ * <p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>
+ */
+export interface RegisteredUserDashboardVisualEmbeddingConfiguration {
+    /**
+     * <p>The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.</p>
+     *          <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>
+     */
+    InitialDashboardVisualId: DashboardVisualId | undefined;
+}
+/**
+ * @public
+ * <p>Information about the Q search bar embedding experience.</p>
+ */
+export interface RegisteredUserQSearchBarEmbeddingConfiguration {
+    /**
+     * <p>The ID of the Q topic that you want to make the starting topic in the Q search bar.
+     *       You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening
+     *       a topic. The ID is in the URL for the topic that you open.</p>
+     *          <p>If you don't specify an initial topic, a list of all shared topics is shown in the Q bar
+     *       for your readers. When you select an initial topic, you can specify whether or not readers
+     *       are allowed to select other topics from the available ones in the list.</p>
+     */
+    InitialTopicId?: string;
+}
+/**
+ * @public
+ * <p>The feature configurations of an embedded Amazon QuickSight console.</p>
+ */
+export interface RegisteredUserConsoleFeatureConfigurations {
+    /**
+     * <p>The state persistence configurations of an embedded Amazon QuickSight console.</p>
+     */
+    StatePersistence?: StatePersistenceConfigurations;
+}
+/**
+ * @public
+ * <p>Information about the Amazon QuickSight console that you want to embed.</p>
+ */
+export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration {
+    /**
+     * <p>The initial URL path for the Amazon QuickSight console. <code>InitialPath</code> is required.</p>
+     *          <p>The entry point URL is constrained to the following paths:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>/start</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>/start/analyses</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>/start/dashboards</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>/start/favorites</code>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>/dashboards/DashboardId</code>. <i>DashboardId</i> is the actual ID key from the Amazon QuickSight console URL of the dashboard.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>/analyses/AnalysisId</code>. <i>AnalysisId</i> is the actual ID key from the Amazon QuickSight console URL of the analysis.</p>
+     *             </li>
+     *          </ul>
+     */
+    InitialPath?: string;
+    /**
+     * <p>The embedding configuration of an embedded Amazon QuickSight console.</p>
+     */
+    FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations;
+}
+/**
+ * @public
+ * <p>The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.</p>
+ *          <note>
+ *             <p>Exactly one of the experience configurations is required. You can choose
+ *                     <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more
+ *                 than one experience configuration.</p>
+ *          </note>
+ */
+export interface RegisteredUserEmbeddingExperienceConfiguration {
+    /**
+     * <p>The configuration details for providing a dashboard embedding experience.</p>
+     */
+    Dashboard?: RegisteredUserDashboardEmbeddingConfiguration;
+    /**
+     * <p>The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a> in the <i>Amazon QuickSight User
+     *             Guide</i>.</p>
+     *          <p>Use <code>
+     *                <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html">GenerateEmbedUrlForRegisteredUser</a>
+     *             </code>
+     *             where
+     *             you want to provide an authoring portal that allows users to create data sources,
+     *             datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console
+     *             needs to belong to the author or admin security cohort. If you want to restrict permissions
+     *             to some of these features, add a custom permissions profile to the user with the
+     *             <code>
+     *                <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html">UpdateUser</a>
+     *             </code> API operation. Use the <code>
+     *                <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html">RegisterUser</a>
+     *             </code> API operation to add a new user with a custom permission profile attached. For more
+     *             information, see the following sections in the <i>Amazon QuickSight User
+     *             Guide</i>:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html">Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users</a>
+     *                </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <a href="https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html">Customizing Access to the Amazon QuickSight Console</a>
+     *                </p>
+     *             </li>
+     *          </ul>
+     *          <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href="https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html">Amazon QuickSight Developer Portal</a>.</p>
+     */
+    QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration;
+    /**
+     * <p>The configuration details for embedding the Q search bar.</p>
+     *          <p>For more information about embedding the Q search bar, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html">Embedding Overview</a> in
+     *             the <i>Amazon QuickSight User Guide</i>.</p>
+     */
+    QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration;
+    /**
+     * <p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>
+     */
+    DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration;
+}
+/**
+ * @public
+ */
+export interface GenerateEmbedUrlForRegisteredUserRequest {
+    /**
+     * <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</p>
+     */
+    SessionLifetimeInMinutes?: number;
+    /**
+     * <p>The Amazon Resource Name for the registered user.</p>
+     */
+    UserArn: string | undefined;
+    /**
+     * <p>The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.</p>
+     */
+    ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined;
+    /**
+     * <p>The domains that you want to add to the allow list for access to the generated URL that
+     *           is then embedded. This optional parameter overrides the static domains that are
+     *           configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it
+     *           allows only the domains that you include in this parameter. You can list up to three
+     *           domains or subdomains in each API call.</p>
+     *          <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>.
+     *             For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under
+     *             <code>https://sapp.amazon.com</code>.</p>
+     */
+    AllowedDomains?: string[];
+}
+/**
+ * @public
+ */
+export interface GenerateEmbedUrlForRegisteredUserResponse {
+    /**
+     * <p>The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.</p>
+     */
+    EmbedUrl: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     */
+    Status: number | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId: string | undefined;
+}
+/**
+ * @public
+ * <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>
+ */
+export declare class QuickSightUserNotFoundException extends __BaseException {
+    readonly name: "QuickSightUserNotFoundException";
+    readonly $fault: "client";
+    Message?: string;
+    /**
+     * <p>The Amazon Web Services request ID for this request.</p>
+     */
+    RequestId?: string;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<QuickSightUserNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface GetDashboardEmbedUrlRequest {
+    /**
+     * <p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID for the dashboard, also added to the Identity and Access Management (IAM)
+     *             policy.</p>
+     */
+    DashboardId: string | undefined;
+    /**
+     * <p>The authentication method that the user uses to sign in.</p>
+     */
+    IdentityType: EmbeddingIdentityType | string | undefined;
+    /**
+     * <p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>
+     */
+    SessionLifetimeInMinutes?: number;
+    /**
+     * <p>Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables
+     * 			the undo/redo button.</p>
+     */
+    UndoRedoDisabled?: boolean;
+    /**
+     * <p>Remove the reset button on the embedded dashboard. The default is FALSE, which enables the
+     * 			reset button.</p>
+     */
+    ResetDisabled?: boolean;
+    /**
+     * <p>Adds persistence of state for the user session in an embedded dashboard. Persistence
+     *             applies to the sheet and the parameter settings. These are control settings that the
+     *             dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is
+     *             set to <code>TRUE</code>, the settings are the same when the subscriber reopens the same
+     *             dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is
+     *             set to FALSE, the state of the user session is not persisted. The default is
+     *                 <code>FALSE</code>.</p>
+     */
+    StatePersistenceEnabled?: boolean;
+    /**
+     * <p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type.
+     * 			You can use this for any Amazon QuickSight users in your account (readers, authors, or
+     * 			admins) authenticated as one of the following:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Active Directory (AD) users or group members</p>
+     *             </li>
+     *             <li>
+     *                <p>Invited nonfederated users</p>
+     *             </li>
+     *             <li>
+     *                <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using
+     * 					SAML, OpenID Connect, or IAM federation.</p>
+     *             </li>
+     *          </ul>
+     *          <p>Omit this parameter for users in the third group – IAM users and IAM
+     *             role-based sessions.</p>
+     */
+    UserArn?: string;
+    /**
+     * <p>The Amazon QuickSight namespace that contains the dashboard IDs in this request.
+     *     	   If you're not using a custom namespace, set <code>Namespace = default</code>.</p>
+     */
+    Namespace?: string;
+    /**
+     * <p>A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the <code>IdentityType</code> parameter must be set to <code>ANONYMOUS</code> because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>", the session can access all three dashboards.</p>
+     */
+    AdditionalDashboardIds?: string[];
+}
 /**
  * @public
  * <p>Output returned from the <code>GetDashboardEmbedUrl</code> operation.</p>
@@ -749,6 +1280,36 @@ export interface ListNamespacesResponse {
      */
     Status?: number;
 }
+/**
+ * @public
+ */
+export interface ListRefreshSchedulesRequest {
+    /**
+     * <p>The Amazon Web Services account ID.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID of the dataset.</p>
+     */
+    DataSetId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRefreshSchedulesResponse {
+    /**
+     * <p>The list of refresh schedules for the dataset.</p>
+     */
+    RefreshSchedules?: RefreshSchedule[];
+    /**
+     * <p>The HTTP status of the request.</p>
+     */
+    Status?: number;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId?: string;
+}
 /**
  * @public
  */
@@ -1240,6 +1801,36 @@ export interface ListUsersResponse {
      */
     Status?: number;
 }
+/**
+ * @public
+ */
+export interface PutDataSetRefreshPropertiesRequest {
+    /**
+     * <p>The Amazon Web Services account ID.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID of the dataset.</p>
+     */
+    DataSetId: string | undefined;
+    /**
+     * <p>The dataset refresh properties.</p>
+     */
+    DataSetRefreshProperties: DataSetRefreshProperties | undefined;
+}
+/**
+ * @public
+ */
+export interface PutDataSetRefreshPropertiesResponse {
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId?: string;
+    /**
+     * <p>The HTTP status of the request.</p>
+     */
+    Status?: number;
+}
 /**
  * @public
  */
@@ -2681,6 +3272,44 @@ export interface UpdatePublicSharingSettingsResponse {
      */
     Status?: number;
 }
+/**
+ * @public
+ */
+export interface UpdateRefreshScheduleRequest {
+    /**
+     * <p>The ID of the dataset.</p>
+     */
+    DataSetId: string | undefined;
+    /**
+     * <p>The Amazon Web Services account ID.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The refresh schedule.</p>
+     */
+    Schedule: RefreshSchedule | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateRefreshScheduleResponse {
+    /**
+     * <p>The HTTP status of the request.</p>
+     */
+    Status?: number;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId?: string;
+    /**
+     * <p>The ID of the refresh schedule.</p>
+     */
+    ScheduleId?: string;
+    /**
+     * <p>The Amazon Resource Name (ARN) for the refresh schedule.</p>
+     */
+    Arn?: string;
+}
 /**
  * @public
  */
@@ -3113,6 +3742,22 @@ export interface UpdateUserResponse {
      */
     Status?: number;
 }
+/**
+ * @internal
+ */
+export declare const SessionTagFilterSensitiveLog: (obj: SessionTag) => any;
+/**
+ * @internal
+ */
+export declare const GenerateEmbedUrlForAnonymousUserRequestFilterSensitiveLog: (obj: GenerateEmbedUrlForAnonymousUserRequest) => any;
+/**
+ * @internal
+ */
+export declare const GenerateEmbedUrlForAnonymousUserResponseFilterSensitiveLog: (obj: GenerateEmbedUrlForAnonymousUserResponse) => any;
+/**
+ * @internal
+ */
+export declare const GenerateEmbedUrlForRegisteredUserResponseFilterSensitiveLog: (obj: GenerateEmbedUrlForRegisteredUserResponse) => any;
 /**
  * @internal
  */