@aws-sdk/client-quicksight 3.1030.0 → 3.1032.0

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

@@ -1,5 +1,215 @@
-import type { VisualRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
+import type { UserRole, VisualRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./enums";
 import type { TopicIR, TopicTemplate } from "./models_2";
+import type { User } from "./models_4";
+/**
+ * @public
+ */
+export interface UpdateTopicRefreshScheduleResponse {
+    /**
+     * <p>The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>
+     * @public
+     */
+    TopicId?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the topic.</p>
+     * @public
+     */
+    TopicArn?: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the dataset.</p>
+     * @public
+     */
+    DatasetArn?: 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 UpdateUserRequest {
+    /**
+     * <p>The Amazon Quick Sight user name that you want to update.</p>
+     * @public
+     */
+    UserName: string | undefined;
+    /**
+     * <p>The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the
+     * 			Amazon Web Services account that contains your Amazon Quick Sight account.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The namespace. Currently, you should set this to <code>default</code>.</p>
+     * @public
+     */
+    Namespace: string | undefined;
+    /**
+     * <p>The email address of the user that you want to update.</p>
+     * @public
+     */
+    Email: string | undefined;
+    /**
+     * <p>The Amazon Quick Sight role of the user. The role can be one of the
+     * 			following default security cohorts:</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>READER</code>: A user who has read-only access to dashboards.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and
+     * 					dashboards.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>ADMIN</code>: A user who is an author, who can also manage Amazon Quick Sight
+     * 					settings.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>READER_PRO</code>: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>AUTHOR_PRO</code>: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>ADMIN_PRO</code>: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.</p>
+     *             </li>
+     *          </ul>
+     *          <p>The name of the Quick Sight role is invisible to the user except for the console
+     * 	        screens dealing with permissions.</p>
+     * @public
+     */
+    Role: UserRole | undefined;
+    /**
+     * <p>(Enterprise edition only) The name of the custom permissions profile that you want to
+     *             assign to this user. Customized permissions allows you to control a user's access by
+     *             restricting access the following operations:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Create and update data sources</p>
+     *             </li>
+     *             <li>
+     *                <p>Create and update datasets</p>
+     *             </li>
+     *             <li>
+     *                <p>Create and update email reports</p>
+     *             </li>
+     *             <li>
+     *                <p>Subscribe to email reports</p>
+     *             </li>
+     *          </ul>
+     *          <p>A set of custom permissions includes any combination of these restrictions. Currently,
+     *             you need to create the profile names for custom permission sets by using the Quick Sight
+     *             console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of
+     *             permissions to a Quick Sight user. </p>
+     *          <p>Quick Sight custom permissions are applied through IAM policies. Therefore, they
+     *             override the permissions typically granted by assigning Quick Sight users to one of the
+     *             default security cohorts in Quick Sight (admin, author, reader).</p>
+     *          <p>This feature is available only to Quick Sight Enterprise edition subscriptions.</p>
+     * @public
+     */
+    CustomPermissionsName?: string | undefined;
+    /**
+     * <p>A flag that you use to indicate that you want to remove all custom permissions
+     *             from this user. Using this parameter resets the user to the state
+     *             it was in before a custom permissions profile was applied. This parameter defaults to
+     *             NULL and it doesn't accept any other value.</p>
+     * @public
+     */
+    UnapplyCustomPermissions?: boolean | undefined;
+    /**
+     * <p>The type of supported external login provider that provides identity to let a user federate into Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.</p>
+     *          <ul>
+     *             <li>
+     *                <p>
+     *                   <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p>
+     *             </li>
+     *             <li>
+     *                <p>
+     *                   <code>NONE</code>: This clears all the previously saved external login information for a user. Use the
+     *           <code>
+     *                      <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html">DescribeUser</a>
+     *                   </code>
+     *           API operation to check the external login information.</p>
+     *             </li>
+     *          </ul>
+     * @public
+     */
+    ExternalLoginFederationProviderType?: string | undefined;
+    /**
+     * <p>The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
+     *          into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should
+     *          only be used when <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>
+     * @public
+     */
+    CustomFederationProviderUrl?: string | undefined;
+    /**
+     * <p>The identity ID for a user in the external login provider.</p>
+     * @public
+     */
+    ExternalLoginId?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface UpdateUserResponse {
+    /**
+     * <p>The Amazon Quick Sight user.</p>
+     * @public
+     */
+    User?: User | 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 UpdateUserCustomPermissionRequest {
+    /**
+     * <p>The username of the user that you want to update custom permissions for.</p>
+     * @public
+     */
+    UserName: string | undefined;
+    /**
+     * <p>The ID of the Amazon Web Services account that contains the custom permission configuration that you want to update.</p>
+     * @public
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * <p>The namespace that the user belongs to.</p>
+     * @public
+     */
+    Namespace: string | undefined;
+    /**
+     * <p>The name of the custom permissions that you want to update.</p>
+     * @public
+     */
+    CustomPermissionsName: string | undefined;
+}
 /**
  * @public
  */

package/dist-types/schemas/schemas_0.d.ts

@@ -248,6 +248,7 @@ export declare var ContextualAccentPalette$: StaticStructureSchema;
 export declare var ContributionAnalysisDefault$: StaticStructureSchema;
 export declare var ContributionAnalysisFactor$: StaticStructureSchema;
 export declare var ContributionAnalysisTimeRanges$: StaticStructureSchema;
+export declare var ControlSortConfiguration$: StaticStructureSchema;
 export declare var Coordinate$: StaticStructureSchema;
 export declare var CreateAccountCustomizationRequest$: StaticStructureSchema;
 export declare var CreateAccountCustomizationResponse$: StaticStructureSchema;
@@ -320,6 +321,7 @@ export declare var CustomPermissions$: StaticStructureSchema;
 export declare var CustomSql$: StaticStructureSchema;
 export declare var CustomValuesConfiguration$: StaticStructureSchema;
 export declare var Dashboard$: StaticStructureSchema;
+export declare var DashboardCustomizationSummaryConfigurations$: StaticStructureSchema;
 export declare var DashboardCustomizationVisualOptions$: StaticStructureSchema;
 export declare var DashboardError$: StaticStructureSchema;
 export declare var DashboardPublishOptions$: StaticStructureSchema;
@@ -1123,6 +1125,7 @@ export declare var S3BucketConfiguration$: StaticStructureSchema;
 export declare var S3KnowledgeBaseParameters$: StaticStructureSchema;
 export declare var S3Parameters$: StaticStructureSchema;
 export declare var S3Source$: StaticStructureSchema;
+export declare var S3TablesParameters$: StaticStructureSchema;
 export declare var SaaSTable$: StaticStructureSchema;
 export declare var SameSheetTargetVisualConfiguration$: StaticStructureSchema;
 export declare var SankeyDiagramAggregatedFieldWells$: StaticStructureSchema;
@@ -1166,6 +1169,7 @@ export declare var SectionBasedLayoutPaperCanvasSizeOptions$: StaticStructureSch
 export declare var SectionLayoutConfiguration$: StaticStructureSchema;
 export declare var SectionPageBreakConfiguration$: StaticStructureSchema;
 export declare var SectionStyle$: StaticStructureSchema;
+export declare var SelectableValuesSort$: StaticStructureSchema;
 export declare var SelectedSheetsFilterScopeConfiguration$: StaticStructureSchema;
 export declare var SelfUpgradeConfiguration$: StaticStructureSchema;
 export declare var SelfUpgradeRequestDetail$: StaticStructureSchema;

package/dist-types/ts3.4/commands/DescribeRoleCustomPermissionCommand.d.ts

@@ -1,9 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import {
-  DescribeRoleCustomPermissionRequest,
-  DescribeRoleCustomPermissionResponse,
-} from "../models/models_3";
+import { DescribeRoleCustomPermissionRequest } from "../models/models_3";
+import { DescribeRoleCustomPermissionResponse } from "../models/models_4";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/DescribeSelfUpgradeConfigurationCommand.d.ts

@@ -3,7 +3,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import {
   DescribeSelfUpgradeConfigurationRequest,
   DescribeSelfUpgradeConfigurationResponse,
-} from "../models/models_3";
+} from "../models/models_4";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/UpdateTopicRefreshScheduleCommand.d.ts

@@ -1,9 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import {
-  UpdateTopicRefreshScheduleRequest,
-  UpdateTopicRefreshScheduleResponse,
-} from "../models/models_4";
+import { UpdateTopicRefreshScheduleRequest } from "../models/models_4";
+import { UpdateTopicRefreshScheduleResponse } from "../models/models_5";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts

@@ -1,6 +1,6 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { UpdateUserRequest, UpdateUserResponse } from "../models/models_4";
+import { UpdateUserRequest, UpdateUserResponse } from "../models/models_5";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/UpdateUserCustomPermissionCommand.d.ts

@@ -1,7 +1,9 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { UpdateUserCustomPermissionRequest } from "../models/models_4";
-import { UpdateUserCustomPermissionResponse } from "../models/models_5";
+import {
+  UpdateUserCustomPermissionRequest,
+  UpdateUserCustomPermissionResponse,
+} from "../models/models_5";
 import {
   QuickSightClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/models/enums.d.ts

@@ -410,6 +410,13 @@ export declare const SheetControlDateTimePickerType: {
 };
 export type SheetControlDateTimePickerType =
   (typeof SheetControlDateTimePickerType)[keyof typeof SheetControlDateTimePickerType];
+export declare const ControlSortDirection: {
+  readonly ASC: "ASC";
+  readonly DESC: "DESC";
+  readonly USER_DEFINED_ORDER: "USER_DEFINED_ORDER";
+};
+export type ControlSortDirection =
+  (typeof ControlSortDirection)[keyof typeof ControlSortDirection];
 export declare const SheetControlListType: {
   readonly MULTI_SELECT: "MULTI_SELECT";
   readonly SINGLE_SELECT: "SINGLE_SELECT";
@@ -1656,6 +1663,7 @@ export declare const DataSourceType: {
   readonly REDSHIFT: "REDSHIFT";
   readonly S3: "S3";
   readonly S3_KNOWLEDGE_BASE: "S3_KNOWLEDGE_BASE";
+  readonly S3_TABLES: "S3_TABLES";
   readonly SALESFORCE: "SALESFORCE";
   readonly SERVICENOW: "SERVICENOW";
   readonly SHAREPOINT: "SHAREPOINT";

package/dist-types/ts3.4/models/models_0.d.ts

@@ -14,6 +14,7 @@ import {
   ColumnRole,
   CommitMode,
   ConnectionAuthType,
+  ControlSortDirection,
   CrossDatasetTypes,
   DashboardBehavior,
   DataLabelContent,
@@ -733,6 +734,13 @@ export interface DefaultDateTimePickerControlOptions {
   DisplayOptions?: DateTimePickerControlDisplayOptions | undefined;
   CommitMode?: CommitMode | undefined;
 }
+export interface SelectableValuesSort {
+  Direction: ControlSortDirection | undefined;
+}
+export interface ControlSortConfiguration {
+  SelectableValuesSort?: SelectableValuesSort | undefined;
+  ControlColumnSort?: AggregationSortConfiguration | undefined;
+}
 export interface ListControlSelectAllOptions {
   Visibility?: Visibility | undefined;
 }
@@ -749,6 +757,7 @@ export interface DefaultFilterDropDownControlOptions {
   Type?: SheetControlListType | undefined;
   SelectableValues?: FilterSelectableValues | undefined;
   CommitMode?: CommitMode | undefined;
+  ControlSortConfigurations?: ControlSortConfiguration[] | undefined;
 }
 export interface ListControlSearchOptions {
   Visibility?: Visibility | undefined;
@@ -763,6 +772,7 @@ export interface DefaultFilterListControlOptions {
   DisplayOptions?: ListControlDisplayOptions | undefined;
   Type?: SheetControlListType | undefined;
   SelectableValues?: FilterSelectableValues | undefined;
+  ControlSortConfigurations?: ControlSortConfiguration[] | undefined;
 }
 export interface RelativeDateTimeControlDisplayOptions {
   TitleOptions?: LabelOptions | undefined;
@@ -1097,6 +1107,7 @@ export interface FilterDropDownControl {
   SelectableValues?: FilterSelectableValues | undefined;
   CascadingControlConfiguration?: CascadingControlConfiguration | undefined;
   CommitMode?: CommitMode | undefined;
+  ControlSortConfigurations?: ControlSortConfiguration[] | undefined;
 }
 export interface FilterListControl {
   FilterControlId: string | undefined;
@@ -1106,6 +1117,7 @@ export interface FilterListControl {
   Type?: SheetControlListType | undefined;
   SelectableValues?: FilterSelectableValues | undefined;
   CascadingControlConfiguration?: CascadingControlConfiguration | undefined;
+  ControlSortConfigurations?: ControlSortConfiguration[] | undefined;
 }
 export interface FilterRelativeDateTimeControl {
   FilterControlId: string | undefined;
@@ -1319,6 +1331,7 @@ export interface ParameterDropDownControl {
   SelectableValues?: ParameterSelectableValues | undefined;
   CascadingControlConfiguration?: CascadingControlConfiguration | undefined;
   CommitMode?: CommitMode | undefined;
+  ControlSortConfigurations?: ControlSortConfiguration[] | undefined;
 }
 export interface ParameterListControl {
   ParameterControlId: string | undefined;
@@ -1328,6 +1341,7 @@ export interface ParameterListControl {
   Type?: SheetControlListType | undefined;
   SelectableValues?: ParameterSelectableValues | undefined;
   CascadingControlConfiguration?: CascadingControlConfiguration | undefined;
+  ControlSortConfigurations?: ControlSortConfiguration[] | undefined;
 }
 export interface ParameterSliderControl {
   ParameterControlId: string | undefined;
@@ -1745,13 +1759,3 @@ export interface TooltipOptions {
 export interface DataPathType {
   PivotTableDataPathType?: PivotTableDataPathType | undefined;
 }
-export interface DataPathValue {
-  FieldId?: string | undefined;
-  FieldValue?: string | undefined;
-  DataPathType?: DataPathType | undefined;
-}
-export interface DataPathColor {
-  Element: DataPathValue | undefined;
-  Color: string | undefined;
-  TimeGranularity?: TimeGranularity | undefined;
-}

package/dist-types/ts3.4/models/models_1.d.ts

@@ -80,8 +80,7 @@ import {
   CustomActionSetParametersOperation,
   CustomActionURLOperation,
   DataLabelOptions,
-  DataPathColor,
-  DataPathValue,
+  DataPathType,
   DecalSettings,
   DimensionField,
   FieldSort,
@@ -99,6 +98,16 @@ import {
   VisualCustomAction,
   VisualInteractionOptions,
 } from "./models_0";
+export interface DataPathValue {
+  FieldId?: string | undefined;
+  FieldValue?: string | undefined;
+  DataPathType?: DataPathType | undefined;
+}
+export interface DataPathColor {
+  Element: DataPathValue | undefined;
+  Color: string | undefined;
+  TimeGranularity?: TimeGranularity | undefined;
+}
 export interface VisualPalette {
   ChartColor?: string | undefined;
   ColorMap?: DataPathColor[] | undefined;
@@ -1766,26 +1775,3 @@ export interface WaterfallChartSortConfiguration {
 export interface WaterfallChartOptions {
   TotalBarLabel?: string | undefined;
 }
-export interface WaterfallChartConfiguration {
-  FieldWells?: WaterfallChartFieldWells | undefined;
-  SortConfiguration?: WaterfallChartSortConfiguration | undefined;
-  WaterfallChartOptions?: WaterfallChartOptions | undefined;
-  CategoryAxisLabelOptions?: ChartAxisLabelOptions | undefined;
-  CategoryAxisDisplayOptions?: AxisDisplayOptions | undefined;
-  PrimaryYAxisLabelOptions?: ChartAxisLabelOptions | undefined;
-  PrimaryYAxisDisplayOptions?: AxisDisplayOptions | undefined;
-  Legend?: LegendOptions | undefined;
-  DataLabels?: DataLabelOptions | undefined;
-  VisualPalette?: VisualPalette | undefined;
-  ColorConfiguration?: WaterfallChartColorConfiguration | undefined;
-  Interactions?: VisualInteractionOptions | undefined;
-}
-export interface WaterfallVisual {
-  VisualId: string | undefined;
-  Title?: VisualTitleLabelOptions | undefined;
-  Subtitle?: VisualSubtitleLabelOptions | undefined;
-  ChartConfiguration?: WaterfallChartConfiguration | undefined;
-  Actions?: VisualCustomAction[] | undefined;
-  ColumnHierarchies?: ColumnHierarchy[] | undefined;
-  VisualContentAltText?: string | undefined;
-}