@aws-sdk/client-quicksight 3.507.0 → 3.510.0

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

@@ -1,8 +1,251 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { AccountCustomization, AccountInfo, AccountSettings, ActiveIAMPolicyAssignment, Analysis, AnalysisError, Entity, ResourceStatus, Sheet } from "./models_0";
-import { AnalysisDefinition, AnalysisSummary, FilterOperator } from "./models_1";
-import { _Parameters, AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSourceDescription, AssignmentStatus, AuthorizedTargetsByService, BookmarksConfigurations, CategoryFilterFunction, CategoryFilterType, CollectiveConstant, ColumnDataSubType, ColumnDataType, ColumnGroup, ColumnLevelPermissionRule, ConstantType, DashboardPublishOptions, DashboardVersionDefinition, DashboardVisualId, DataAggregation, DataSetConfiguration, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceParameters, DataSourceType, FieldFolder, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, LinkSharingConfiguration, LogicalTable, MemberType, NamespaceStatus, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SharingModel, SnapshotFile, SnapshotS3DestinationConfiguration, SslProperties, Tag, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, TopicCalculatedField, TopicColumn, TopicTimeGranularity, VpcConnectionProperties } from "./models_2";
+import { AnalysisDefinition, FilterOperator } from "./models_1";
+import { _Parameters, AnalysisSummary, AnonymousUserEmbeddingExperienceConfiguration, AnonymousUserSnapshotJobResult, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobError, AssetBundleExportJobStatus, AssetBundleExportJobSummary, AssetBundleExportJobValidationStrategy, AssetBundleExportJobWarning, AssetBundleImportFailureAction, AssetBundleImportJobError, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportJobStatus, AssetBundleImportJobSummary, AssetBundleImportSourceDescription, AssignmentStatus, AuthorizedTargetsByService, AuthorSpecifiedAggregation, BookmarksConfigurations, CategoryFilterFunction, CategoryFilterType, CellValueSynonym, CollectiveConstant, ColumnDataRole, ColumnDataSubType, ColumnDataType, ColumnGroup, ColumnLevelPermissionRule, ComparativeOrder, ConstantType, DashboardPublishOptions, DashboardVersionDefinition, DashboardVisualId, DataSetConfiguration, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceParameters, DataSourceType, DefaultAggregation, DefaultFormatting, FieldFolder, FolderType, Group, GroupMember, IdentityStore, IngestionStatus, LinkSharingConfiguration, LogicalTable, MemberType, NamespaceStatus, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, SemanticType, ServiceType, SharingModel, SnapshotFile, SnapshotS3DestinationConfiguration, SslProperties, Tag, TemplateAlias, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, VpcConnectionProperties } from "./models_2";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+/**
+ * @public
+ * @enum
+ */
+export declare const TopicTimeGranularity: {
+    readonly DAY: "DAY";
+    readonly HOUR: "HOUR";
+    readonly MINUTE: "MINUTE";
+    readonly MONTH: "MONTH";
+    readonly QUARTER: "QUARTER";
+    readonly SECOND: "SECOND";
+    readonly WEEK: "WEEK";
+    readonly YEAR: "YEAR";
+};
+/**
+ * @public
+ */
+export type TopicTimeGranularity = (typeof TopicTimeGranularity)[keyof typeof TopicTimeGranularity];
+/**
+ * @public
+ * <p>A structure that represents a calculated field.</p>
+ */
+export interface TopicCalculatedField {
+    /**
+     * @public
+     * <p>The calculated field name.</p>
+     */
+    CalculatedFieldName: string | undefined;
+    /**
+     * @public
+     * <p>The calculated field description.</p>
+     */
+    CalculatedFieldDescription?: string;
+    /**
+     * @public
+     * <p>The calculated field expression.</p>
+     */
+    Expression: string | undefined;
+    /**
+     * @public
+     * <p>The other names or aliases for the calculated field.</p>
+     */
+    CalculatedFieldSynonyms?: string[];
+    /**
+     * @public
+     * <p>A boolean value that indicates if a calculated field is included in the topic.</p>
+     */
+    IsIncludedInTopic?: boolean;
+    /**
+     * @public
+     * <p>A Boolean value that indicates if a calculated field is visible in the autocomplete.</p>
+     */
+    DisableIndexing?: boolean;
+    /**
+     * @public
+     * <p>The column data role for a calculated field. Valid values for this structure are <code>DIMENSION</code> and <code>MEASURE</code>.</p>
+     */
+    ColumnDataRole?: ColumnDataRole;
+    /**
+     * @public
+     * <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
+     */
+    TimeGranularity?: TopicTimeGranularity;
+    /**
+     * @public
+     * <p>The default formatting definition.</p>
+     */
+    DefaultFormatting?: DefaultFormatting;
+    /**
+     * @public
+     * <p>The default aggregation. Valid values for this structure are <code>SUM</code>,
+     *             <code>MAX</code>, <code>MIN</code>, <code>COUNT</code>,
+     *          <code>DISTINCT_COUNT</code>,
+     *          and <code>AVERAGE</code>.</p>
+     */
+    Aggregation?: DefaultAggregation;
+    /**
+     * @public
+     * <p>The order in which data is displayed for the calculated field when
+     *          it's used in a comparative context.</p>
+     */
+    ComparativeOrder?: ComparativeOrder;
+    /**
+     * @public
+     * <p>The semantic type.</p>
+     */
+    SemanticType?: SemanticType;
+    /**
+     * @public
+     * <p>The list of aggregation types that are allowed for the calculated field. Valid values
+     *          for this structure are <code>COUNT</code>, <code>DISTINCT_COUNT</code>, <code>MIN</code>,
+     *             <code>MAX</code>, <code>MEDIAN</code>, <code>SUM</code>, <code>AVERAGE</code>,
+     *             <code>STDEV</code>, <code>STDEVP</code>, <code>VAR</code>,
+     *          <code>VARP</code>, and <code>PERCENTILE</code>.</p>
+     */
+    AllowedAggregations?: AuthorSpecifiedAggregation[];
+    /**
+     * @public
+     * <p>The list of aggregation types that are not allowed for the calculated field. Valid
+     *          values for this structure are <code>COUNT</code>, <code>DISTINCT_COUNT</code>,
+     *             <code>MIN</code>, <code>MAX</code>, <code>MEDIAN</code>, <code>SUM</code>,
+     *             <code>AVERAGE</code>, <code>STDEV</code>, <code>STDEVP</code>, <code>VAR</code>,
+     *             <code>VARP</code>, and <code>PERCENTILE</code>.</p>
+     */
+    NotAllowedAggregations?: AuthorSpecifiedAggregation[];
+    /**
+     * @public
+     * <p>A Boolean value that indicates whether to never aggregate calculated field in filters.</p>
+     */
+    NeverAggregateInFilter?: boolean;
+    /**
+     * @public
+     * <p>The other
+     *          names or aliases for the calculated field cell value.</p>
+     */
+    CellValueSynonyms?: CellValueSynonym[];
+    /**
+     * @public
+     * <p>The non additive for the table style target.</p>
+     */
+    NonAdditive?: boolean;
+}
+/**
+ * @public
+ * <p>Represents a column in a dataset.</p>
+ */
+export interface TopicColumn {
+    /**
+     * @public
+     * <p>The name of the column.</p>
+     */
+    ColumnName: string | undefined;
+    /**
+     * @public
+     * <p>A user-friendly name for the column.</p>
+     */
+    ColumnFriendlyName?: string;
+    /**
+     * @public
+     * <p>A description of the column and its contents.</p>
+     */
+    ColumnDescription?: string;
+    /**
+     * @public
+     * <p>The other names or aliases for the column.</p>
+     */
+    ColumnSynonyms?: string[];
+    /**
+     * @public
+     * <p>The role of the column in the data. Valid values are <code>DIMENSION</code> and <code>MEASURE</code>.</p>
+     */
+    ColumnDataRole?: ColumnDataRole;
+    /**
+     * @public
+     * <p>The type of aggregation that is performed on the column data when
+     *          it's queried.</p>
+     */
+    Aggregation?: DefaultAggregation;
+    /**
+     * @public
+     * <p>A Boolean value that indicates whether the column is included in the query results.</p>
+     */
+    IsIncludedInTopic?: boolean;
+    /**
+     * @public
+     * <p>A Boolean value that indicates whether the column shows in the autocomplete functionality.</p>
+     */
+    DisableIndexing?: boolean;
+    /**
+     * @public
+     * <p>The order in which data is displayed for the column when
+     *          it's used in a comparative context.</p>
+     */
+    ComparativeOrder?: ComparativeOrder;
+    /**
+     * @public
+     * <p>The semantic type of data contained in the column.</p>
+     */
+    SemanticType?: SemanticType;
+    /**
+     * @public
+     * <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
+     */
+    TimeGranularity?: TopicTimeGranularity;
+    /**
+     * @public
+     * <p>The list of aggregation types that are allowed for the column. Valid values for this
+     *          structure are <code>COUNT</code>, <code>DISTINCT_COUNT</code>, <code>MIN</code>,
+     *             <code>MAX</code>, <code>MEDIAN</code>, <code>SUM</code>, <code>AVERAGE</code>,
+     *             <code>STDEV</code>, <code>STDEVP</code>, <code>VAR</code>,
+     *          <code>VARP</code>,
+     *          and <code>PERCENTILE</code>.</p>
+     */
+    AllowedAggregations?: AuthorSpecifiedAggregation[];
+    /**
+     * @public
+     * <p>The list of aggregation types that are not allowed for the column. Valid values for this
+     *          structure are <code>COUNT</code>, <code>DISTINCT_COUNT</code>, <code>MIN</code>,
+     *             <code>MAX</code>, <code>MEDIAN</code>, <code>SUM</code>, <code>AVERAGE</code>,
+     *             <code>STDEV</code>, <code>STDEVP</code>, <code>VAR</code>,
+     *          <code>VARP</code>,
+     *          and <code>PERCENTILE</code>.</p>
+     */
+    NotAllowedAggregations?: AuthorSpecifiedAggregation[];
+    /**
+     * @public
+     * <p>The default formatting used for values in the column.</p>
+     */
+    DefaultFormatting?: DefaultFormatting;
+    /**
+     * @public
+     * <p>A Boolean
+     *          value that indicates whether to aggregate the column data when
+     *          it's used in a filter context.</p>
+     */
+    NeverAggregateInFilter?: boolean;
+    /**
+     * @public
+     * <p>The other names or aliases for the column cell value.</p>
+     */
+    CellValueSynonyms?: CellValueSynonym[];
+    /**
+     * @public
+     * <p>The non additive value for the column.</p>
+     */
+    NonAdditive?: boolean;
+}
+/**
+ * @public
+ * <p>A structure that represents a data aggregation.</p>
+ */
+export interface DataAggregation {
+    /**
+     * @public
+     * <p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>
+     */
+    DatasetRowDateGranularity?: TopicTimeGranularity;
+    /**
+     * @public
+     * <p>The column name for the default date.</p>
+     */
+    DefaultDateColumnName?: string;
+}
 /**
  * @public
  * <p>A constant used in a category filter.</p>
@@ -7757,95 +8000,13 @@ export interface ListNamespacesResponse {
     Status?: number;
 }
 /**
- * @public
- */
-export interface ListRefreshSchedulesRequest {
-    /**
-     * @public
-     * <p>The Amazon Web Services account ID.</p>
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * @public
-     * <p>The ID of the dataset.</p>
-     */
-    DataSetId: string | undefined;
-}
-/**
- * @public
- */
-export interface ListRefreshSchedulesResponse {
-    /**
-     * @public
-     * <p>The list of refresh schedules for the dataset.</p>
-     */
-    RefreshSchedules?: RefreshSchedule[];
-    /**
-     * @public
-     * <p>The HTTP status of the request.</p>
-     */
-    Status?: number;
-    /**
-     * @public
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     */
-    RequestId?: string;
-}
-/**
- * @public
+ * @internal
  */
-export interface ListRoleMembershipsRequest {
-    /**
-     * @public
-     * <p>The name of the role.</p>
-     */
-    Role: Role | undefined;
-    /**
-     * @public
-     * <p>A pagination token that can be used in a subsequent request.</p>
-     */
-    NextToken?: string;
-    /**
-     * @public
-     * <p>The maximum number of results to return.</p>
-     */
-    MaxResults?: number;
-    /**
-     * @public
-     * <p>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</p>
-     */
-    AwsAccountId: string | undefined;
-    /**
-     * @public
-     * <p>The namespace that includes the role.</p>
-     */
-    Namespace: string | undefined;
-}
+export declare const TopicCalculatedFieldFilterSensitiveLog: (obj: TopicCalculatedField) => any;
 /**
- * @public
+ * @internal
  */
-export interface ListRoleMembershipsResponse {
-    /**
-     * @public
-     * <p>The list of groups associated with a role</p>
-     */
-    MembersList?: string[];
-    /**
-     * @public
-     * <p>A pagination token that can be used in a subsequent request.</p>
-     */
-    NextToken?: string;
-    /**
-     * @public
-     * <p>The Amazon Web Services request ID for this operation.</p>
-     */
-    RequestId?: string;
-    /**
-     * @public
-     * <p>The HTTP status of the request.</p>
-     */
-    Status?: number;
-}
+export declare const TopicColumnFilterSensitiveLog: (obj: TopicColumn) => any;
 /**
  * @internal
  */

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

@@ -1,7 +1,97 @@
 import { AccountCustomization, ResourceStatus } from "./models_0";
-import { AnalysisDefinition, AnalysisSearchFilter, AnalysisSourceEntity, AnalysisSummary } from "./models_1";
-import { _Parameters, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, LinkSharingConfiguration, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ValidationStrategy, VpcConnectionProperties } from "./models_2";
+import { AnalysisDefinition, AnalysisSearchFilter } from "./models_1";
+import { _Parameters, AnalysisSourceEntity, AnalysisSummary, AssetBundleCloudFormationOverridePropertyConfiguration, AssetBundleExportFormat, AssetBundleExportJobValidationStrategy, AssetBundleImportFailureAction, AssetBundleImportJobOverrideParameters, AssetBundleImportJobOverridePermissions, AssetBundleImportJobOverrideTags, AssetBundleImportJobOverrideValidationStrategy, AssetBundleImportSource, AssignmentStatus, ColumnGroup, ColumnLevelPermissionRule, DashboardPublishOptions, DashboardSourceEntity, DashboardVersionDefinition, DataSetImportMode, DatasetParameter, DataSetUsageConfiguration, DataSourceCredentials, DataSourceParameters, FieldFolder, Group, LinkSharingConfiguration, LogicalTable, PhysicalTable, RefreshSchedule, ResourcePermission, Role, RowLevelPermissionDataSet, RowLevelPermissionTagConfiguration, ServiceType, SslProperties, Tag, TemplateAlias, TemplateSourceEntity, TemplateVersionDefinition, ThemeAlias, ThemeConfiguration, ValidationStrategy, VpcConnectionProperties } from "./models_2";
 import { DashboardSearchFilter, DashboardSummary, DataSetRefreshProperties, DataSetSearchFilter, DataSetSummary, DataSourceSearchFilter, DataSourceSummary, FolderSearchFilter, FolderSummary, GroupSearchFilter, IdentityType, NetworkInterface, SessionTag, SnapshotConfiguration, ThemeType, TopicDetails, TopicRefreshSchedule, User, UserRole, VPCConnectionAvailabilityStatus, VPCConnectionResourceStatus } from "./models_3";
+/**
+ * @public
+ */
+export interface ListRefreshSchedulesRequest {
+    /**
+     * @public
+     * <p>The Amazon Web Services account ID.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * @public
+     * <p>The ID of the dataset.</p>
+     */
+    DataSetId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRefreshSchedulesResponse {
+    /**
+     * @public
+     * <p>The list of refresh schedules for the dataset.</p>
+     */
+    RefreshSchedules?: RefreshSchedule[];
+    /**
+     * @public
+     * <p>The HTTP status of the request.</p>
+     */
+    Status?: number;
+    /**
+     * @public
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId?: string;
+}
+/**
+ * @public
+ */
+export interface ListRoleMembershipsRequest {
+    /**
+     * @public
+     * <p>The name of the role.</p>
+     */
+    Role: Role | undefined;
+    /**
+     * @public
+     * <p>A pagination token that can be used in a subsequent request.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>The maximum number of results to return.</p>
+     */
+    MaxResults?: number;
+    /**
+     * @public
+     * <p>The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.</p>
+     */
+    AwsAccountId: string | undefined;
+    /**
+     * @public
+     * <p>The namespace that includes the role.</p>
+     */
+    Namespace: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListRoleMembershipsResponse {
+    /**
+     * @public
+     * <p>The list of groups associated with a role</p>
+     */
+    MembersList?: string[];
+    /**
+     * @public
+     * <p>A pagination token that can be used in a subsequent request.</p>
+     */
+    NextToken?: string;
+    /**
+     * @public
+     * <p>The Amazon Web Services request ID for this operation.</p>
+     */
+    RequestId?: string;
+    /**
+     * @public
+     * <p>The HTTP status of the request.</p>
+     */
+    Status?: number;
+}
 /**
  * @public
  */
@@ -2633,12 +2723,12 @@ export interface UpdateFolderPermissionsRequest {
     FolderId: string | undefined;
     /**
      * @public
-     * <p>The permissions that you want to grant on a resource.</p>
+     * <p>The permissions that you want to grant on a resource. Namespace ARNs are not supported <code>Principal</code> values for folder permissions.</p>
      */
     GrantPermissions?: ResourcePermission[];
     /**
      * @public
-     * <p>The permissions that you want to revoke from a resource.</p>
+     * <p>The permissions that you want to revoke from a resource.  Namespace ARNs are not supported <code>Principal</code> values for folder permissions.</p>
      */
     RevokePermissions?: ResourcePermission[];
 }

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

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

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

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

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

@@ -1347,6 +1347,16 @@ export interface BarChartAggregatedFieldWells {
 export interface BarChartFieldWells {
   BarChartAggregatedFieldWells?: BarChartAggregatedFieldWells;
 }
+export interface ContextMenuOption {
+  AvailabilityStatus?: DashboardBehavior;
+}
+export interface VisualMenuOption {
+  AvailabilityStatus?: DashboardBehavior;
+}
+export interface VisualInteractionOptions {
+  VisualMenuOption?: VisualMenuOption;
+  ContextMenuOption?: ContextMenuOption;
+}
 export declare const LegendPosition: {
   readonly AUTO: "AUTO";
   readonly BOTTOM: "BOTTOM";
@@ -1608,6 +1618,7 @@ export interface BarChartConfiguration {
   Tooltip?: TooltipOptions;
   ReferenceLines?: ReferenceLine[];
   ContributionAnalysisDefaults?: ContributionAnalysisDefault[];
+  Interactions?: VisualInteractionOptions;
 }
 export interface CategoryDrillDownFilter {
   Column: ColumnIdentifier | undefined;
@@ -1642,19 +1653,6 @@ export interface PredefinedHierarchy {
   Columns: ColumnIdentifier[] | undefined;
   DrillDownFilters?: DrillDownFilter[];
 }
-export interface ColumnHierarchy {
-  ExplicitHierarchy?: ExplicitHierarchy;
-  DateTimeHierarchy?: DateTimeHierarchy;
-  PredefinedHierarchy?: PredefinedHierarchy;
-}
-export interface LongFormatText {
-  PlainText?: string;
-  RichText?: string;
-}
-export interface VisualSubtitleLabelOptions {
-  Visibility?: Visibility;
-  FormatText?: LongFormatText;
-}
 export declare const CalculatedFieldFilterSensitiveLog: (
   obj: CalculatedField
 ) => any;