@aws-sdk/client-quicksight 3.451.0 → 3.454.0

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

@@ -6,14 +6,12 @@ import {
   ActiveIAMPolicyAssignment,
   Analysis,
   AnalysisError,
-  AssetOptions,
   Entity,
   ResourceStatus,
   Sheet,
 } from "./models_0";
 import {
   AnalysisDefinition,
-  AnalysisSearchFilter,
   AnalysisSummary,
   AnonymousUserEmbeddingExperienceConfiguration,
   DashboardVisualId,
@@ -27,9 +25,14 @@ import {
   AssetBundleExportJobError,
   AssetBundleExportJobStatus,
   AssetBundleExportJobSummary,
+  AssetBundleExportJobValidationStrategy,
+  AssetBundleExportJobWarning,
   AssetBundleImportFailureAction,
   AssetBundleImportJobError,
   AssetBundleImportJobOverrideParameters,
+  AssetBundleImportJobOverridePermissions,
+  AssetBundleImportJobOverrideTags,
+  AssetBundleImportJobOverrideValidationStrategy,
   AssetBundleImportJobStatus,
   AssetBundleImportJobSummary,
   AssetBundleImportSourceDescription,
@@ -39,8 +42,10 @@ import {
   ColumnDataType,
   ColumnGroup,
   ColumnLevelPermissionRule,
+  ConstantType,
   DashboardPublishOptions,
   DashboardVersionDefinition,
+  DataAggregation,
   DataSetConfiguration,
   DataSetImportMode,
   DatasetParameter,
@@ -48,17 +53,21 @@ import {
   DataSourceParameters,
   DataSourceType,
   FieldFolder,
+  FilterClass,
   FolderType,
   Group,
   GroupMember,
   IdentityStore,
   IngestionStatus,
+  LinkSharingConfiguration,
   LogicalTable,
   MemberType,
+  NamedFilterType,
   NamespaceStatus,
   PhysicalTable,
   RefreshSchedule,
   ResourcePermission,
+  Role,
   RowLevelPermissionDataSet,
   RowLevelPermissionTagConfiguration,
   SharingModel,
@@ -70,11 +79,190 @@ import {
   TemplateVersionDefinition,
   ThemeAlias,
   ThemeConfiguration,
-  TopicDetails,
-  TopicRefreshSchedule,
+  TopicCalculatedField,
+  TopicCategoryFilter,
+  TopicColumn,
+  TopicDateRangeFilter,
+  TopicRangeFilterConstant,
+  TopicTimeGranularity,
   VpcConnectionProperties,
 } from "./models_2";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+export declare const NamedFilterAggType: {
+  readonly AVERAGE: "AVERAGE";
+  readonly COUNT: "COUNT";
+  readonly DISTINCT_COUNT: "DISTINCT_COUNT";
+  readonly MAX: "MAX";
+  readonly MEDIAN: "MEDIAN";
+  readonly MIN: "MIN";
+  readonly NO_AGGREGATION: "NO_AGGREGATION";
+  readonly STDEV: "STDEV";
+  readonly STDEVP: "STDEVP";
+  readonly SUM: "SUM";
+  readonly VAR: "VAR";
+  readonly VARP: "VARP";
+};
+export type NamedFilterAggType =
+  (typeof NamedFilterAggType)[keyof typeof NamedFilterAggType];
+export interface TopicSingularFilterConstant {
+  ConstantType?: ConstantType;
+  SingularConstant?: string;
+}
+export interface TopicNumericEqualityFilter {
+  Constant?: TopicSingularFilterConstant;
+  Aggregation?: NamedFilterAggType;
+}
+export interface TopicNumericRangeFilter {
+  Inclusive?: boolean;
+  Constant?: TopicRangeFilterConstant;
+  Aggregation?: NamedFilterAggType;
+}
+export declare const TopicRelativeDateFilterFunction: {
+  readonly LAST: "LAST";
+  readonly NEXT: "NEXT";
+  readonly NOW: "NOW";
+  readonly PREVIOUS: "PREVIOUS";
+  readonly THIS: "THIS";
+};
+export type TopicRelativeDateFilterFunction =
+  (typeof TopicRelativeDateFilterFunction)[keyof typeof TopicRelativeDateFilterFunction];
+export interface TopicRelativeDateFilter {
+  TimeGranularity?: TopicTimeGranularity;
+  RelativeDateFilterFunction?: TopicRelativeDateFilterFunction;
+  Constant?: TopicSingularFilterConstant;
+}
+export interface TopicFilter {
+  FilterDescription?: string;
+  FilterClass?: FilterClass;
+  FilterName: string | undefined;
+  FilterSynonyms?: string[];
+  OperandFieldName: string | undefined;
+  FilterType?: NamedFilterType;
+  CategoryFilter?: TopicCategoryFilter;
+  NumericEqualityFilter?: TopicNumericEqualityFilter;
+  NumericRangeFilter?: TopicNumericRangeFilter;
+  DateRangeFilter?: TopicDateRangeFilter;
+  RelativeDateFilter?: TopicRelativeDateFilter;
+}
+export declare const NamedEntityAggType: {
+  readonly AVERAGE: "AVERAGE";
+  readonly COUNT: "COUNT";
+  readonly CUSTOM: "CUSTOM";
+  readonly DISTINCT_COUNT: "DISTINCT_COUNT";
+  readonly MAX: "MAX";
+  readonly MEDIAN: "MEDIAN";
+  readonly MIN: "MIN";
+  readonly PERCENTILE: "PERCENTILE";
+  readonly STDEV: "STDEV";
+  readonly STDEVP: "STDEVP";
+  readonly SUM: "SUM";
+  readonly VAR: "VAR";
+  readonly VARP: "VARP";
+};
+export type NamedEntityAggType =
+  (typeof NamedEntityAggType)[keyof typeof NamedEntityAggType];
+export interface NamedEntityDefinitionMetric {
+  Aggregation?: NamedEntityAggType;
+  AggregationFunctionParameters?: Record<string, string>;
+}
+export declare const PropertyRole: {
+  readonly ID: "ID";
+  readonly PRIMARY: "PRIMARY";
+};
+export type PropertyRole = (typeof PropertyRole)[keyof typeof PropertyRole];
+export declare const PropertyUsage: {
+  readonly DIMENSION: "DIMENSION";
+  readonly INHERIT: "INHERIT";
+  readonly MEASURE: "MEASURE";
+};
+export type PropertyUsage = (typeof PropertyUsage)[keyof typeof PropertyUsage];
+export interface NamedEntityDefinition {
+  FieldName?: string;
+  PropertyName?: string;
+  PropertyRole?: PropertyRole;
+  PropertyUsage?: PropertyUsage;
+  Metric?: NamedEntityDefinitionMetric;
+}
+export interface SemanticEntityType {
+  TypeName?: string;
+  SubTypeName?: string;
+  TypeParameters?: Record<string, string>;
+}
+export interface TopicNamedEntity {
+  EntityName: string | undefined;
+  EntityDescription?: string;
+  EntitySynonyms?: string[];
+  SemanticEntityType?: SemanticEntityType;
+  Definition?: NamedEntityDefinition[];
+}
+export interface DatasetMetadata {
+  DatasetArn: string | undefined;
+  DatasetName?: string;
+  DatasetDescription?: string;
+  DataAggregation?: DataAggregation;
+  Filters?: TopicFilter[];
+  Columns?: TopicColumn[];
+  CalculatedFields?: TopicCalculatedField[];
+  NamedEntities?: TopicNamedEntity[];
+}
+export interface TopicDetails {
+  Name?: string;
+  Description?: string;
+  DataSets?: DatasetMetadata[];
+}
+export interface CreateTopicRequest {
+  AwsAccountId: string | undefined;
+  TopicId: string | undefined;
+  Topic: TopicDetails | undefined;
+  Tags?: Tag[];
+}
+export interface CreateTopicResponse {
+  Arn?: string;
+  TopicId?: string;
+  RefreshArn?: string;
+  RequestId?: string;
+  Status?: number;
+}
+export declare const TopicScheduleType: {
+  readonly DAILY: "DAILY";
+  readonly HOURLY: "HOURLY";
+  readonly MONTHLY: "MONTHLY";
+  readonly WEEKLY: "WEEKLY";
+};
+export type TopicScheduleType =
+  (typeof TopicScheduleType)[keyof typeof TopicScheduleType];
+export interface TopicRefreshSchedule {
+  IsEnabled: boolean | undefined;
+  BasedOnSpiceSchedule: boolean | undefined;
+  StartingAt?: Date;
+  Timezone?: string;
+  RepeatAt?: string;
+  TopicScheduleType?: TopicScheduleType;
+}
+export interface CreateTopicRefreshScheduleRequest {
+  AwsAccountId: string | undefined;
+  TopicId: string | undefined;
+  DatasetArn: string | undefined;
+  DatasetName?: string;
+  RefreshSchedule: TopicRefreshSchedule | undefined;
+}
+export interface CreateTopicRefreshScheduleResponse {
+  TopicId?: string;
+  TopicArn?: string;
+  DatasetArn?: string;
+  Status?: number;
+  RequestId?: string;
+}
+export interface CreateVPCConnectionRequest {
+  AwsAccountId: string | undefined;
+  VPCConnectionId: string | undefined;
+  Name: string | undefined;
+  SubnetIds: string[] | undefined;
+  SecurityGroupIds: string[] | undefined;
+  DnsResolvers?: string[];
+  RoleArn: string | undefined;
+  Tags?: Tag[];
+}
 export declare const VPCConnectionAvailabilityStatus: {
   readonly AVAILABLE: "AVAILABLE";
   readonly PARTIALLY_AVAILABLE: "PARTIALLY_AVAILABLE";
@@ -133,7 +321,6 @@ export interface DashboardVersion {
   Description?: string;
   ThemeArn?: string;
   Sheets?: Sheet[];
-  Options?: AssetOptions;
 }
 export interface Dashboard {
   DashboardId?: string;
@@ -436,6 +623,25 @@ export interface DeleteRefreshScheduleResponse {
   ScheduleId?: string;
   Arn?: string;
 }
+export interface DeleteRoleCustomPermissionRequest {
+  Role: Role | undefined;
+  AwsAccountId: string | undefined;
+  Namespace: string | undefined;
+}
+export interface DeleteRoleCustomPermissionResponse {
+  RequestId?: string;
+  Status?: number;
+}
+export interface DeleteRoleMembershipRequest {
+  MemberName: string | undefined;
+  Role: Role | undefined;
+  AwsAccountId: string | undefined;
+  Namespace: string | undefined;
+}
+export interface DeleteRoleMembershipResponse {
+  RequestId?: string;
+  Status?: number;
+}
 export interface DeleteTemplateRequest {
   AwsAccountId: string | undefined;
   TemplateId: string | undefined;
@@ -615,6 +821,10 @@ export interface DescribeAssetBundleExportJobResponse {
   CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration;
   RequestId?: string;
   Status?: number;
+  IncludePermissions?: boolean;
+  IncludeTags?: boolean;
+  ValidationStrategy?: AssetBundleExportJobValidationStrategy;
+  Warnings?: AssetBundleExportJobWarning[];
 }
 export interface DescribeAssetBundleImportJobRequest {
   AwsAccountId: string | undefined;
@@ -633,6 +843,9 @@ export interface DescribeAssetBundleImportJobResponse {
   FailureAction?: AssetBundleImportFailureAction;
   RequestId?: string;
   Status?: number;
+  OverridePermissions?: AssetBundleImportJobOverridePermissions;
+  OverrideTags?: AssetBundleImportJobOverrideTags;
+  OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy;
 }
 export interface DescribeDashboardRequest {
   AwsAccountId: string | undefined;
@@ -666,9 +879,6 @@ export interface DescribeDashboardPermissionsRequest {
   AwsAccountId: string | undefined;
   DashboardId: string | undefined;
 }
-export interface LinkSharingConfiguration {
-  Permissions?: ResourcePermission[];
-}
 export interface DescribeDashboardPermissionsResponse {
   DashboardId?: string;
   DashboardArn?: string;
@@ -1035,6 +1245,16 @@ export interface DescribeRefreshScheduleResponse {
   RequestId?: string;
   Arn?: string;
 }
+export interface DescribeRoleCustomPermissionRequest {
+  Role: Role | undefined;
+  AwsAccountId: string | undefined;
+  Namespace: string | undefined;
+}
+export interface DescribeRoleCustomPermissionResponse {
+  CustomPermissionsName?: string;
+  RequestId?: string;
+  Status?: number;
+}
 export interface DescribeTemplateRequest {
   AwsAccountId: string | undefined;
   TemplateId: string | undefined;
@@ -1064,7 +1284,6 @@ export interface TemplateVersion {
   SourceEntityArn?: string;
   ThemeArn?: string;
   Sheets?: Sheet[];
-  Options?: AssetOptions;
 }
 export interface Template {
   Arn?: string;
@@ -1720,6 +1939,19 @@ export interface ListRefreshSchedulesResponse {
   Status?: number;
   RequestId?: string;
 }
+export interface ListRoleMembershipsRequest {
+  Role: Role | undefined;
+  NextToken?: string;
+  MaxResults?: number;
+  AwsAccountId: string | undefined;
+  Namespace: string | undefined;
+}
+export interface ListRoleMembershipsResponse {
+  MembersList?: string[];
+  NextToken?: string;
+  RequestId?: string;
+  Status?: number;
+}
 export interface ListTagsForResourceRequest {
   ResourceArn: string | undefined;
 }
@@ -1790,202 +2022,33 @@ export interface ListThemeAliasesResponse {
   RequestId?: string;
   NextToken?: string;
 }
-export interface ListThemesRequest {
-  AwsAccountId: string | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-  Type?: ThemeType;
-}
-export interface ThemeSummary {
-  Arn?: string;
-  Name?: string;
-  ThemeId?: string;
-  LatestVersionNumber?: number;
-  CreatedTime?: Date;
-  LastUpdatedTime?: Date;
-}
-export interface ListThemesResponse {
-  ThemeSummaryList?: ThemeSummary[];
-  NextToken?: string;
-  Status?: number;
-  RequestId?: string;
-}
-export interface ListThemeVersionsRequest {
-  AwsAccountId: string | undefined;
-  ThemeId: string | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-}
-export interface ThemeVersionSummary {
-  VersionNumber?: number;
-  Arn?: string;
-  Description?: string;
-  CreatedTime?: Date;
-  Status?: ResourceStatus;
-}
-export interface ListThemeVersionsResponse {
-  ThemeVersionSummaryList?: ThemeVersionSummary[];
-  NextToken?: string;
-  Status?: number;
-  RequestId?: string;
-}
-export interface ListTopicRefreshSchedulesRequest {
-  AwsAccountId: string | undefined;
-  TopicId: string | undefined;
-}
-export interface TopicRefreshScheduleSummary {
-  DatasetId?: string;
-  DatasetArn?: string;
-  DatasetName?: string;
-  RefreshSchedule?: TopicRefreshSchedule;
-}
-export interface ListTopicRefreshSchedulesResponse {
-  TopicId?: string;
-  TopicArn?: string;
-  RefreshSchedules?: TopicRefreshScheduleSummary[];
-  Status?: number;
-  RequestId?: string;
-}
-export interface ListTopicsRequest {
-  AwsAccountId: string | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-}
-export interface TopicSummary {
-  Arn?: string;
-  TopicId?: string;
-  Name?: string;
-}
-export interface ListTopicsResponse {
-  TopicsSummaries?: TopicSummary[];
-  NextToken?: string;
-  RequestId?: string;
-  Status?: number;
-}
-export interface ListUserGroupsRequest {
-  UserName: string | undefined;
-  AwsAccountId: string | undefined;
-  Namespace: string | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-}
-export interface ListUserGroupsResponse {
-  GroupList?: Group[];
-  NextToken?: string;
-  RequestId?: string;
-  Status?: number;
-}
-export interface ListUsersRequest {
-  AwsAccountId: string | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-  Namespace: string | undefined;
-}
-export interface ListUsersResponse {
-  UserList?: User[];
-  NextToken?: string;
-  RequestId?: string;
-  Status?: number;
-}
-export interface ListVPCConnectionsRequest {
-  AwsAccountId: string | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-}
-export interface VPCConnectionSummary {
-  VPCConnectionId?: string;
-  Arn?: string;
-  Name?: string;
-  VPCId?: string;
-  SecurityGroupIds?: string[];
-  DnsResolvers?: string[];
-  Status?: VPCConnectionResourceStatus;
-  AvailabilityStatus?: VPCConnectionAvailabilityStatus;
-  NetworkInterfaces?: NetworkInterface[];
-  RoleArn?: string;
-  CreatedTime?: Date;
-  LastUpdatedTime?: Date;
-}
-export interface ListVPCConnectionsResponse {
-  VPCConnectionSummaries?: VPCConnectionSummary[];
-  NextToken?: string;
-  RequestId?: string;
-  Status?: number;
-}
-export interface PutDataSetRefreshPropertiesRequest {
-  AwsAccountId: string | undefined;
-  DataSetId: string | undefined;
-  DataSetRefreshProperties: DataSetRefreshProperties | undefined;
-}
-export interface PutDataSetRefreshPropertiesResponse {
-  RequestId?: string;
-  Status?: number;
-}
-export interface RegisterUserRequest {
-  IdentityType: IdentityType | undefined;
-  Email: string | undefined;
-  UserRole: UserRole | undefined;
-  IamArn?: string;
-  SessionName?: string;
-  AwsAccountId: string | undefined;
-  Namespace: string | undefined;
-  UserName?: string;
-  CustomPermissionsName?: string;
-  ExternalLoginFederationProviderType?: string;
-  CustomFederationProviderUrl?: string;
-  ExternalLoginId?: string;
-  Tags?: Tag[];
-}
-export interface RegisterUserResponse {
-  User?: User;
-  UserInvitationUrl?: string;
-  RequestId?: string;
-  Status?: number;
-}
-export interface RestoreAnalysisRequest {
-  AwsAccountId: string | undefined;
-  AnalysisId: string | undefined;
-}
-export interface RestoreAnalysisResponse {
-  Status?: number;
-  Arn?: string;
-  AnalysisId?: string;
-  RequestId?: string;
-}
-export interface SearchAnalysesRequest {
-  AwsAccountId: string | undefined;
-  Filters: AnalysisSearchFilter[] | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-}
-export interface SearchAnalysesResponse {
-  AnalysisSummaryList?: AnalysisSummary[];
-  NextToken?: string;
-  Status?: number;
-  RequestId?: string;
-}
-export interface SearchDashboardsRequest {
-  AwsAccountId: string | undefined;
-  Filters: DashboardSearchFilter[] | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-}
-export interface SearchDashboardsResponse {
-  DashboardSummaryList?: DashboardSummary[];
-  NextToken?: string;
-  Status?: number;
-  RequestId?: string;
-}
-export interface SearchDataSetsRequest {
-  AwsAccountId: string | undefined;
-  Filters: DataSetSearchFilter[] | undefined;
-  NextToken?: string;
-  MaxResults?: number;
-}
+export declare const TopicSingularFilterConstantFilterSensitiveLog: (
+  obj: TopicSingularFilterConstant
+) => any;
+export declare const TopicNumericEqualityFilterFilterSensitiveLog: (
+  obj: TopicNumericEqualityFilter
+) => any;
+export declare const TopicNumericRangeFilterFilterSensitiveLog: (
+  obj: TopicNumericRangeFilter
+) => any;
+export declare const TopicRelativeDateFilterFilterSensitiveLog: (
+  obj: TopicRelativeDateFilter
+) => any;
+export declare const TopicFilterFilterSensitiveLog: (obj: TopicFilter) => any;
+export declare const DatasetMetadataFilterSensitiveLog: (
+  obj: DatasetMetadata
+) => any;
+export declare const TopicDetailsFilterSensitiveLog: (obj: TopicDetails) => any;
+export declare const CreateTopicRequestFilterSensitiveLog: (
+  obj: CreateTopicRequest
+) => any;
 export declare const DataSetFilterSensitiveLog: (obj: DataSet) => any;
 export declare const DescribeAnalysisDefinitionResponseFilterSensitiveLog: (
   obj: DescribeAnalysisDefinitionResponse
 ) => any;
+export declare const DescribeAssetBundleExportJobResponseFilterSensitiveLog: (
+  obj: DescribeAssetBundleExportJobResponse
+) => any;
 export declare const DescribeAssetBundleImportJobResponseFilterSensitiveLog: (
   obj: DescribeAssetBundleImportJobResponse
 ) => any;