@aws-sdk/client-quicksight 3.699.0 → 3.705.0

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

@@ -1,7 +1,597 @@
 import { ResourceStatus } from "./models_0";
-import { AssignmentStatus, DataSourceParameters, ServiceType, SslProperties, TopicIR, TopicTemplate, VisualRole, VpcConnectionProperties } from "./models_2";
-import { DataSourceCredentials, Group, RefreshSchedule, ResourcePermission, Role, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, ValidationStrategy, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
-import { FailedKeyRegistrationEntry, PersonalizationMode, PurchaseMode, RegisteredCustomerManagedKey, User, UserRole } from "./models_4";
+import { AssignmentStatus, BrandDefinition, BrandDetail, Capabilities, ColumnGroup, ColumnLevelPermissionRule, DataSourceParameters, ServiceType, SslProperties, TopicIR, TopicTemplate, VisualRole, VpcConnectionProperties } from "./models_2";
+import { _Parameters, DashboardPublishOptions, DashboardSourceEntity, DashboardsQAStatus, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, FieldFolder, Group, LinkSharingConfiguration, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicDetails, TopicRefreshSchedule, ValidationStrategy, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
+import { FailedKeyRegistrationEntry, PersonalizationMode, PurchaseMode, QSearchStatus, RegisteredCustomerManagedKey, User, UserRole } from "./models_4";
+/**
+ * @public
+ */
+export interface UpdateBrandResponse {
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The details of the brand.</p>
+     * @public
+     */
+    BrandDetail?: BrandDetail | undefined;
+    /**
+     * <p>The definition of the brand.</p>
+     * @public
+     */
+    BrandDefinition?: BrandDefinition | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateBrandAssignmentRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that owns the brand assignment.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the brand.</p>
+     * @public
+     */
+    BrandArn: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateBrandAssignmentResponse {
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the brand.</p>
+     * @public
+     */
+    BrandArn?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateBrandPublishedVersionRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that owns the brand.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID of the Amazon QuickSight brand.</p>
+     * @public
+     */
+    BrandId: string | undefined;
+    /**
+     * <p>The ID of the published version.</p>
+     * @public
+     */
+    VersionId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateBrandPublishedVersionResponse {
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The ID of the published version.</p>
+     * @public
+     */
+    VersionId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateCustomPermissionsRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The name of the custom permissions profile that you want to update.</p>
+     * @public
+     */
+    CustomPermissionsName: string | undefined;
+    /**
+     * <p>A set of actions to include in the custom permissions profile.</p>
+     * @public
+     */
+    Capabilities?: Capabilities | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateCustomPermissionsResponse {
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the custom permissions profile.</p>
+     * @public
+     */
+    Arn?: string | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the dashboard that you're
+     *             updating.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID for the dashboard.</p>
+     * @public
+     */
+    DashboardId: string | undefined;
+    /**
+     * <p>The display name of the dashboard.</p>
+     * @public
+     */
+    Name: string | undefined;
+    /**
+     * <p>The entity that you are using as a source when you update the dashboard. In
+     *             <code>SourceEntity</code>, you specify the type of object you're using as source. You
+     *             can only update a dashboard from a template, so you use a <code>SourceTemplate</code>
+     *             entity. If you need to update a dashboard from an analysis, first convert the analysis
+     *             to a template by using the <code>
+     *                <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a>
+     *             </code> API operation. For
+     *             <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source
+     *             template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any
+     *             Amazon QuickSight-supported Amazon Web Services Region. </p>
+     *          <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to
+     *             list the replacement datasets for the placeholders listed in the original. The schema in
+     *             each dataset must match its placeholder. </p>
+     * @public
+     */
+    SourceEntity?: DashboardSourceEntity | undefined;
+    /**
+     * <p>A structure that contains the parameters of the dashboard. These are parameter
+     *             overrides for a dashboard. A dashboard can have any type of parameters, and some
+     *             parameters might accept multiple values.</p>
+     * @public
+     */
+    Parameters?: _Parameters | undefined;
+    /**
+     * <p>A description for the first version of the dashboard being created.</p>
+     * @public
+     */
+    VersionDescription?: string | undefined;
+    /**
+     * <p>Options for publishing the dashboard when you create it:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This
+     *                     status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is
+     *                     set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the
+     *                     published dashboard, which can be used for ad hoc (one-time) filtering. This
+     *                     option is <code>ENABLED</code> by default. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This
+     *                     status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual
+     *                     option to export data to .CSV format isn't enabled when this is set to
+     *                     <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>VisibilityState</code> for <code>SheetControlsOption</code> - This
+     *                     visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>.
+     *                     This option is <code>COLLAPSED</code> by default. </p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    DashboardPublishOptions?: DashboardPublishOptions | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If
+     *             you add a value for this field, it overrides the value that was originally associated
+     *             with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the
+     *             dashboard.</p>
+     * @public
+     */
+    ThemeArn?: string | undefined;
+    /**
+     * <p>The definition of a dashboard.</p>
+     *          <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
+     * @public
+     */
+    Definition?: DashboardVersionDefinition | undefined;
+    /**
+     * <p>The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.</p>
+     * @public
+     */
+    ValidationStrategy?: ValidationStrategy | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the resource.</p>
+     * @public
+     */
+    Arn?: string | undefined;
+    /**
+     * <p>The ARN of the dashboard, including the version number.</p>
+     * @public
+     */
+    VersionArn?: string | undefined;
+    /**
+     * <p>The ID for the dashboard.</p>
+     * @public
+     */
+    DashboardId?: string | undefined;
+    /**
+     * <p>The creation status of the request.</p>
+     * @public
+     */
+    CreationStatus?: ResourceStatus | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardLinksRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID for the dashboard.</p>
+     * @public
+     */
+    DashboardId: string | undefined;
+    /**
+     * <p> list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
+     * @public
+     */
+    LinkEntities: string[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardLinksResponse {
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
+     * @public
+     */
+    DashboardArn?: string | undefined;
+    /**
+     * <p>A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.</p>
+     * @public
+     */
+    LinkEntities?: string[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardPermissionsRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're
+     *             updating.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID for the dashboard.</p>
+     * @public
+     */
+    DashboardId: string | undefined;
+    /**
+     * <p>The permissions that you want to grant on this resource.</p>
+     * @public
+     */
+    GrantPermissions?: ResourcePermission[] | undefined;
+    /**
+     * <p>The permissions that you want to revoke from this resource.</p>
+     * @public
+     */
+    RevokePermissions?: ResourcePermission[] | undefined;
+    /**
+     * <p>Grants link permissions to all users in a defined namespace.</p>
+     * @public
+     */
+    GrantLinkPermissions?: ResourcePermission[] | undefined;
+    /**
+     * <p>Revokes link permissions from all users in a defined namespace.</p>
+     * @public
+     */
+    RevokeLinkPermissions?: ResourcePermission[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardPermissionsResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
+     * @public
+     */
+    DashboardArn?: string | undefined;
+    /**
+     * <p>The ID for the dashboard.</p>
+     * @public
+     */
+    DashboardId?: string | undefined;
+    /**
+     * <p>Information about the permissions on the dashboard.</p>
+     * @public
+     */
+    Permissions?: ResourcePermission[] | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+    /**
+     * <p>Updates the permissions of a shared link to an Amazon QuickSight dashboard.</p>
+     * @public
+     */
+    LinkSharingConfiguration?: LinkSharingConfiguration | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardPublishedVersionRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the dashboard that you're
+     *             updating.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID for the dashboard.</p>
+     * @public
+     */
+    DashboardId: string | undefined;
+    /**
+     * <p>The version number of the dashboard.</p>
+     * @public
+     */
+    VersionNumber: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardPublishedVersionResponse {
+    /**
+     * <p>The ID for the dashboard.</p>
+     * @public
+     */
+    DashboardId?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
+     * @public
+     */
+    DashboardArn?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardsQAConfigurationRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the dashboard QA configuration that you want to update.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The status of dashboards QA configuration that you want to update.</p>
+     * @public
+     */
+    DashboardsQAStatus: DashboardsQAStatus | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDashboardsQAConfigurationResponse {
+    /**
+     * <p>A value that indicates whether the dashboard QA configuration is enabled or not.</p>
+     * @public
+     */
+    DashboardsQAStatus?: DashboardsQAStatus | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDataSetRequest {
+    /**
+     * <p>The Amazon Web Services account ID.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each
+     * 			Amazon Web Services account.</p>
+     * @public
+     */
+    DataSetId: string | undefined;
+    /**
+     * <p>The display name for the dataset.</p>
+     * @public
+     */
+    Name: string | undefined;
+    /**
+     * <p>Declares the physical tables that are available in the underlying data sources.</p>
+     * @public
+     */
+    PhysicalTableMap: Record<string, PhysicalTable> | undefined;
+    /**
+     * <p>Configures the combination and transformation of the data from the physical tables.</p>
+     * @public
+     */
+    LogicalTableMap?: Record<string, LogicalTable> | undefined;
+    /**
+     * <p>Indicates whether you want to import the data into SPICE.</p>
+     * @public
+     */
+    ImportMode: DataSetImportMode | undefined;
+    /**
+     * <p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>
+     * @public
+     */
+    ColumnGroups?: ColumnGroup[] | undefined;
+    /**
+     * <p>The folder that contains fields and nested subfolders for your dataset.</p>
+     * @public
+     */
+    FieldFolders?: Record<string, FieldFolder> | undefined;
+    /**
+     * <p>The row-level security configuration for the data you want to create.</p>
+     * @public
+     */
+    RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined;
+    /**
+     * <p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.</p>
+     * @public
+     */
+    RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration | undefined;
+    /**
+     * <p>A set of one or more definitions of a <code>
+     *                <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a>
+     *             </code>.</p>
+     * @public
+     */
+    ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined;
+    /**
+     * <p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>
+     * @public
+     */
+    DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined;
+    /**
+     * <p>The parameter declarations of the dataset.</p>
+     * @public
+     */
+    DatasetParameters?: DatasetParameter[] | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDataSetResponse {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the dataset.</p>
+     * @public
+     */
+    Arn?: string | undefined;
+    /**
+     * <p>The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
+     * @public
+     */
+    DataSetId?: string | undefined;
+    /**
+     * <p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import
+     * 			mode is SPICE.</p>
+     * @public
+     */
+    IngestionArn?: string | undefined;
+    /**
+     * <p>The ID of the ingestion, which is triggered as a result of dataset creation if the import
+     * 			mode is SPICE.</p>
+     * @public
+     */
+    IngestionId?: string | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDataSetPermissionsRequest {
+    /**
+     * <p>The Amazon Web Services account ID.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The ID for the dataset whose permissions you want to update. This ID is unique per
+     * 			Amazon Web Services Region for each Amazon Web Services account.</p>
+     * @public
+     */
+    DataSetId: string | undefined;
+    /**
+     * <p>The resource permissions that you want to grant to the dataset.</p>
+     * @public
+     */
+    GrantPermissions?: ResourcePermission[] | undefined;
+    /**
+     * <p>The resource permissions that you want to revoke from the dataset.</p>
+     * @public
+     */
+    RevokePermissions?: ResourcePermission[] | undefined;
+}
 /**
  * @public
  */
@@ -151,6 +741,41 @@ export interface UpdateDataSourcePermissionsResponse {
      */
     Status?: number | undefined;
 }
+/**
+ * @public
+ */
+export interface UpdateDefaultQBusinessApplicationRequest {
+    /**
+     * <p>The ID of the Amazon QuickSight account that is connected to the Amazon Q Business application that you want to update.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The Amazon QuickSight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.</p>
+     * @public
+     */
+    Namespace?: string | undefined;
+    /**
+     * <p>The ID of the Amazon Q Business application that you want to update.</p>
+     * @public
+     */
+    ApplicationId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateDefaultQBusinessApplicationResponse {
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+}
 /**
  * @public
  */
@@ -615,6 +1240,41 @@ export interface UpdateQPersonalizationConfigurationResponse {
      */
     Status?: number | undefined;
 }
+/**
+ * @public
+ */
+export interface UpdateQuickSightQSearchConfigurationRequest {
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the Amazon QuickSight Q Search configuration that you want to update.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The status of the Amazon QuickSight Q Search configuration that the user wants to update.</p>
+     * @public
+     */
+    QSearchStatus: QSearchStatus | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateQuickSightQSearchConfigurationResponse {
+    /**
+     * <p>The status of the Amazon QuickSight Q Search configuration.</p>
+     * @public
+     */
+    QSearchStatus?: QSearchStatus | undefined;
+    /**
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     * @public
+     */
+    RequestId?: string | undefined;
+    /**
+     * <p>The HTTP status of the request.</p>
+     * @public
+     */
+    Status?: number | undefined;
+}
 /**
  * @public
  */
@@ -1692,6 +2352,14 @@ export interface ListTopicReviewedAnswersResponse {
      */
     RequestId?: string | undefined;
 }
+/**
+ * @internal
+ */
+export declare const UpdateDashboardRequestFilterSensitiveLog: (obj: UpdateDashboardRequest) => any;
+/**
+ * @internal
+ */
+export declare const UpdateDataSetRequestFilterSensitiveLog: (obj: UpdateDataSetRequest) => any;
 /**
  * @internal
  */