@aws-sdk/client-quicksight 3.948.0 → 3.952.0

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

@@ -23,12 +23,12 @@ import {
   DayOfWeek,
   DefaultAggregation,
   DisplayFormat,
+  FileFormat,
   FilterClass,
   FilterOperator,
   FolderType,
   HorizontalTextAlignment,
   IdentityStore,
-  IdentityType,
   IncludeFolderMembers,
   IngestionErrorType,
   IngestionRequestSource,
@@ -50,19 +50,19 @@ import {
   RefreshInterval,
   ResourceStatus,
   Role,
+  RowLevelPermissionFormatVersion,
+  RowLevelPermissionPolicy,
   ServiceType,
   SharingModel,
   SnapshotJobStatus,
+  Status,
   TemplateErrorType,
+  TextQualifier,
   TextTransform,
-  ThemeErrorType,
-  ThemeType,
-  TopicRefreshStatus,
   TopicRelativeDateFilterFunction,
   TopicScheduleType,
   TopicTimeGranularity,
   TopicUserExperienceVersion,
-  UserRole,
   VPCConnectionAvailabilityStatus,
   VPCConnectionResourceStatus,
 } from "./enums";
@@ -84,14 +84,9 @@ import {
   ParameterDeclaration,
   Sheet,
 } from "./models_0";
-import {
-  AnalysisDefinition,
-  DataSetReference,
-  SheetDefinition,
-  StaticFile,
-} from "./models_1";
 import {
   _Parameters,
+  AnalysisDefinition,
   AssetBundleCloudFormationOverridePropertyConfiguration,
   AssetBundleExportJobValidationStrategy,
   AssetBundleImportJobOverrideParameters,
@@ -105,7 +100,6 @@ import {
   Capabilities,
   CollectiveConstant,
   ComparativeOrder,
-  CredentialPair,
   DashboardPublishOptions,
   DashboardVersionDefinition,
   DataPrepConfiguration,
@@ -113,13 +107,9 @@ import {
   DataSetUsageConfiguration,
   DisplayFormatOptions,
   LinkSharingConfiguration,
-  PerformanceConfiguration,
-  RowLevelPermissionTagConfiguration,
-  SemanticModelConfiguration,
   SslProperties,
   ValidationStrategy,
   VpcConnectionProperties,
-  WebProxyCredentials,
   AnonymousUserSnapshotJobResult,
   AssetBundleExportJobError,
   AssetBundleExportJobWarning,
@@ -131,20 +121,191 @@ import {
   ColumnLevelPermissionRule,
   ColumnSchema,
   DatasetParameter,
+  DataSetReference,
   DataSourceParameters,
   FieldFolder,
+  InputColumn,
   LogicalTable,
-  PhysicalTable,
   ResourcePermission,
-  RowLevelPermissionDataSet,
+  SheetDefinition,
   SnapshotFile,
+  SnapshotJobResultFileGroup,
   SnapshotS3DestinationConfiguration,
+  StaticFile,
   Tag,
 } from "./models_2";
+export interface UniqueKey {
+  ColumnNames: string[] | undefined;
+}
+export interface PerformanceConfiguration {
+  UniqueKeys?: UniqueKey[] | undefined;
+}
+export interface CustomSql {
+  DataSourceArn: string | undefined;
+  Name: string | undefined;
+  SqlQuery: string | undefined;
+  Columns?: InputColumn[] | undefined;
+}
+export interface RelationalTable {
+  DataSourceArn: string | undefined;
+  Catalog?: string | undefined;
+  Schema?: string | undefined;
+  Name: string | undefined;
+  InputColumns: InputColumn[] | undefined;
+}
+export interface UploadSettings {
+  Format?: FileFormat | undefined;
+  StartFromRow?: number | undefined;
+  ContainsHeader?: boolean | undefined;
+  TextQualifier?: TextQualifier | undefined;
+  Delimiter?: string | undefined;
+  CustomCellAddressRange?: string | undefined;
+}
+export interface S3Source {
+  DataSourceArn: string | undefined;
+  UploadSettings?: UploadSettings | undefined;
+  InputColumns: InputColumn[] | undefined;
+}
+export interface TablePathElement {
+  Name?: string | undefined;
+  Id?: string | undefined;
+}
+export interface SaaSTable {
+  DataSourceArn: string | undefined;
+  TablePath: TablePathElement[] | undefined;
+  InputColumns: InputColumn[] | undefined;
+}
+export type PhysicalTable =
+  | PhysicalTable.CustomSqlMember
+  | PhysicalTable.RelationalTableMember
+  | PhysicalTable.S3SourceMember
+  | PhysicalTable.SaaSTableMember
+  | PhysicalTable.$UnknownMember;
+export declare namespace PhysicalTable {
+  interface RelationalTableMember {
+    RelationalTable: RelationalTable;
+    CustomSql?: never;
+    S3Source?: never;
+    SaaSTable?: never;
+    $unknown?: never;
+  }
+  interface CustomSqlMember {
+    RelationalTable?: never;
+    CustomSql: CustomSql;
+    S3Source?: never;
+    SaaSTable?: never;
+    $unknown?: never;
+  }
+  interface S3SourceMember {
+    RelationalTable?: never;
+    CustomSql?: never;
+    S3Source: S3Source;
+    SaaSTable?: never;
+    $unknown?: never;
+  }
+  interface SaaSTableMember {
+    RelationalTable?: never;
+    CustomSql?: never;
+    S3Source?: never;
+    SaaSTable: SaaSTable;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    RelationalTable?: never;
+    CustomSql?: never;
+    S3Source?: never;
+    SaaSTable?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    RelationalTable: (value: RelationalTable) => T;
+    CustomSql: (value: CustomSql) => T;
+    S3Source: (value: S3Source) => T;
+    SaaSTable: (value: SaaSTable) => T;
+    _: (name: string, value: any) => T;
+  }
+}
+export interface RowLevelPermissionDataSet {
+  Namespace?: string | undefined;
+  Arn: string | undefined;
+  PermissionPolicy: RowLevelPermissionPolicy | undefined;
+  FormatVersion?: RowLevelPermissionFormatVersion | undefined;
+  Status?: Status | undefined;
+}
+export interface RowLevelPermissionTagRule {
+  TagKey: string | undefined;
+  ColumnName: string | undefined;
+  TagMultiValueDelimiter?: string | undefined;
+  MatchAllValue?: string | undefined;
+}
+export interface RowLevelPermissionTagConfiguration {
+  Status?: Status | undefined;
+  TagRules: RowLevelPermissionTagRule[] | undefined;
+  TagRuleConfigurations?: string[][] | undefined;
+}
+export interface RowLevelPermissionConfiguration {
+  TagConfiguration?: RowLevelPermissionTagConfiguration | undefined;
+  RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined;
+}
+export interface SemanticTable {
+  Alias: string | undefined;
+  DestinationTableId: string | undefined;
+  RowLevelPermissionConfiguration?: RowLevelPermissionConfiguration | undefined;
+}
+export interface SemanticModelConfiguration {
+  TableMap?: Record<string, SemanticTable> | undefined;
+}
+export interface CreateDataSetRequest {
+  AwsAccountId: string | undefined;
+  DataSetId: string | undefined;
+  Name: string | undefined;
+  PhysicalTableMap: Record<string, PhysicalTable> | undefined;
+  LogicalTableMap?: Record<string, LogicalTable> | undefined;
+  ImportMode: DataSetImportMode | undefined;
+  ColumnGroups?: ColumnGroup[] | undefined;
+  FieldFolders?: Record<string, FieldFolder> | undefined;
+  Permissions?: ResourcePermission[] | undefined;
+  RowLevelPermissionDataSet?: RowLevelPermissionDataSet | undefined;
+  RowLevelPermissionTagConfiguration?:
+    | RowLevelPermissionTagConfiguration
+    | undefined;
+  ColumnLevelPermissionRules?: ColumnLevelPermissionRule[] | undefined;
+  Tags?: Tag[] | undefined;
+  DataSetUsageConfiguration?: DataSetUsageConfiguration | undefined;
+  DatasetParameters?: DatasetParameter[] | undefined;
+  FolderArns?: string[] | undefined;
+  PerformanceConfiguration?: PerformanceConfiguration | undefined;
+  UseAs?: DataSetUseAs | undefined;
+  DataPrepConfiguration?: DataPrepConfiguration | undefined;
+  SemanticModelConfiguration?: SemanticModelConfiguration | undefined;
+}
+export interface CreateDataSetResponse {
+  Arn?: string | undefined;
+  DataSetId?: string | undefined;
+  IngestionArn?: string | undefined;
+  IngestionId?: string | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
+export interface CredentialPair {
+  Username: string | undefined;
+  Password: string | undefined;
+  AlternateDataSourceParameters?: DataSourceParameters[] | undefined;
+}
+export interface KeyPairCredentials {
+  KeyPairUsername: string | undefined;
+  PrivateKey: string | undefined;
+  PrivateKeyPassphrase?: string | undefined;
+}
+export interface WebProxyCredentials {
+  WebProxyUsername: string | undefined;
+  WebProxyPassword: string | undefined;
+}
 export interface DataSourceCredentials {
   CredentialPair?: CredentialPair | undefined;
   CopySourceArn?: string | undefined;
   SecretArn?: string | undefined;
+  KeyPairCredentials?: KeyPairCredentials | undefined;
   WebProxyCredentials?: WebProxyCredentials | undefined;
 }
 export interface CreateDataSourceRequest {
@@ -1431,8 +1592,12 @@ export interface SnapshotJobErrorInfo {
   ErrorMessage?: string | undefined;
   ErrorType?: string | undefined;
 }
+export interface RegisteredUserSnapshotJobResult {
+  FileGroups?: SnapshotJobResultFileGroup[] | undefined;
+}
 export interface SnapshotJobResult {
   AnonymousUsers?: AnonymousUserSnapshotJobResult[] | undefined;
+  RegisteredUsers?: RegisteredUserSnapshotJobResult[] | undefined;
 }
 export interface DescribeDashboardSnapshotJobResultResponse {
   Arn?: string | undefined;
@@ -1797,132 +1962,3 @@ export interface DescribeTemplatePermissionsResponse {
   RequestId?: string | undefined;
   Status?: number | undefined;
 }
-export interface DescribeThemeRequest {
-  AwsAccountId: string | undefined;
-  ThemeId: string | undefined;
-  VersionNumber?: number | undefined;
-  AliasName?: string | undefined;
-}
-export interface ThemeError {
-  Type?: ThemeErrorType | undefined;
-  Message?: string | undefined;
-}
-export interface ThemeVersion {
-  VersionNumber?: number | undefined;
-  Arn?: string | undefined;
-  Description?: string | undefined;
-  BaseThemeId?: string | undefined;
-  CreatedTime?: Date | undefined;
-  Configuration?: ThemeConfiguration | undefined;
-  Errors?: ThemeError[] | undefined;
-  Status?: ResourceStatus | undefined;
-}
-export interface Theme {
-  Arn?: string | undefined;
-  Name?: string | undefined;
-  ThemeId?: string | undefined;
-  Version?: ThemeVersion | undefined;
-  CreatedTime?: Date | undefined;
-  LastUpdatedTime?: Date | undefined;
-  Type?: ThemeType | undefined;
-}
-export interface DescribeThemeResponse {
-  Theme?: Theme | undefined;
-  Status?: number | undefined;
-  RequestId?: string | undefined;
-}
-export interface DescribeThemeAliasRequest {
-  AwsAccountId: string | undefined;
-  ThemeId: string | undefined;
-  AliasName: string | undefined;
-}
-export interface DescribeThemeAliasResponse {
-  ThemeAlias?: ThemeAlias | undefined;
-  Status?: number | undefined;
-  RequestId?: string | undefined;
-}
-export interface DescribeThemePermissionsRequest {
-  AwsAccountId: string | undefined;
-  ThemeId: string | undefined;
-}
-export interface DescribeThemePermissionsResponse {
-  ThemeId?: string | undefined;
-  ThemeArn?: string | undefined;
-  Permissions?: ResourcePermission[] | undefined;
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface DescribeTopicRequest {
-  AwsAccountId: string | undefined;
-  TopicId: string | undefined;
-}
-export interface DescribeTopicResponse {
-  Arn?: string | undefined;
-  TopicId?: string | undefined;
-  Topic?: TopicDetails | undefined;
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-  CustomInstructions?: CustomInstructions | undefined;
-}
-export interface DescribeTopicPermissionsRequest {
-  AwsAccountId: string | undefined;
-  TopicId: string | undefined;
-}
-export interface DescribeTopicPermissionsResponse {
-  TopicId?: string | undefined;
-  TopicArn?: string | undefined;
-  Permissions?: ResourcePermission[] | undefined;
-  Status?: number | undefined;
-  RequestId?: string | undefined;
-}
-export interface DescribeTopicRefreshRequest {
-  AwsAccountId: string | undefined;
-  TopicId: string | undefined;
-  RefreshId: string | undefined;
-}
-export interface TopicRefreshDetails {
-  RefreshArn?: string | undefined;
-  RefreshId?: string | undefined;
-  RefreshStatus?: TopicRefreshStatus | undefined;
-}
-export interface DescribeTopicRefreshResponse {
-  RefreshDetails?: TopicRefreshDetails | undefined;
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface DescribeTopicRefreshScheduleRequest {
-  AwsAccountId: string | undefined;
-  TopicId: string | undefined;
-  DatasetId: string | undefined;
-}
-export interface DescribeTopicRefreshScheduleResponse {
-  TopicId?: string | undefined;
-  TopicArn?: string | undefined;
-  DatasetArn?: string | undefined;
-  RefreshSchedule?: TopicRefreshSchedule | undefined;
-  Status?: number | undefined;
-  RequestId?: string | undefined;
-}
-export interface DescribeUserRequest {
-  UserName: string | undefined;
-  AwsAccountId: string | undefined;
-  Namespace: string | undefined;
-}
-export interface User {
-  Arn?: string | undefined;
-  UserName?: string | undefined;
-  Email?: string | undefined;
-  Role?: UserRole | undefined;
-  IdentityType?: IdentityType | undefined;
-  Active?: boolean | undefined;
-  PrincipalId?: string | undefined;
-  CustomPermissionsName?: string | undefined;
-  ExternalLoginFederationProviderType?: string | undefined;
-  ExternalLoginFederationProviderUrl?: string | undefined;
-  ExternalLoginId?: string | undefined;
-}
-export interface DescribeUserResponse {
-  User?: User | undefined;
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}

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

@@ -27,9 +27,11 @@ import {
   SearchFilterOperator,
   ServiceType,
   SharingModel,
+  ThemeErrorType,
   ThemeType,
   TopicFilterAttribute,
   TopicFilterOperator,
+  TopicRefreshStatus,
   TopicUserExperienceVersion,
   UserRole,
   VisualRole,
@@ -45,14 +47,9 @@ import {
   ActiveIAMPolicyAssignment,
 } from "./models_0";
 import {
+  _Parameters,
   AnalysisDefinition,
   AnalysisSourceEntity,
-  SharedViewConfigurations,
-  AnalysisSearchFilter,
-  AnalysisSummary,
-} from "./models_1";
-import {
-  _Parameters,
   AnonymousUserEmbeddingExperienceConfiguration,
   AssetBundleCloudFormationOverridePropertyConfiguration,
   AssetBundleExportJobValidationStrategy,
@@ -75,15 +72,14 @@ import {
   DataSetUsageConfiguration,
   DataSourceParameters,
   LinkSharingConfiguration,
-  PerformanceConfiguration,
-  RowLevelPermissionDataSet,
-  RowLevelPermissionTagConfiguration,
-  SemanticModelConfiguration,
+  SharedViewConfigurations,
   SslProperties,
   TopicIR,
   TopicTemplate,
   ValidationStrategy,
   VpcConnectionProperties,
+  AnalysisSearchFilter,
+  AnalysisSummary,
   AssetBundleExportJobSummary,
   AssetBundleImportJobSummary,
   AuthorizedTargetsByService,
@@ -93,7 +89,6 @@ import {
   DatasetParameter,
   FieldFolder,
   LogicalTable,
-  PhysicalTable,
   ResourcePermission,
   Tag,
 } from "./models_2";
@@ -101,6 +96,10 @@ import {
   CustomInstructions,
   DashboardVisualResult,
   DataSourceCredentials,
+  PerformanceConfiguration,
+  RowLevelPermissionDataSet,
+  RowLevelPermissionTagConfiguration,
+  SemanticModelConfiguration,
   SnapshotConfiguration,
   TemplateSourceEntity,
   TemplateVersionDefinition,
@@ -120,12 +119,141 @@ import {
   GroupMember,
   Ingestion,
   NamespaceInfoV2,
+  PhysicalTable,
   RefreshSchedule,
   RegisteredCustomerManagedKey,
   TemplateAlias,
   ThemeAlias,
-  User,
 } from "./models_3";
+export interface DescribeThemeRequest {
+  AwsAccountId: string | undefined;
+  ThemeId: string | undefined;
+  VersionNumber?: number | undefined;
+  AliasName?: string | undefined;
+}
+export interface ThemeError {
+  Type?: ThemeErrorType | undefined;
+  Message?: string | undefined;
+}
+export interface ThemeVersion {
+  VersionNumber?: number | undefined;
+  Arn?: string | undefined;
+  Description?: string | undefined;
+  BaseThemeId?: string | undefined;
+  CreatedTime?: Date | undefined;
+  Configuration?: ThemeConfiguration | undefined;
+  Errors?: ThemeError[] | undefined;
+  Status?: ResourceStatus | undefined;
+}
+export interface Theme {
+  Arn?: string | undefined;
+  Name?: string | undefined;
+  ThemeId?: string | undefined;
+  Version?: ThemeVersion | undefined;
+  CreatedTime?: Date | undefined;
+  LastUpdatedTime?: Date | undefined;
+  Type?: ThemeType | undefined;
+}
+export interface DescribeThemeResponse {
+  Theme?: Theme | undefined;
+  Status?: number | undefined;
+  RequestId?: string | undefined;
+}
+export interface DescribeThemeAliasRequest {
+  AwsAccountId: string | undefined;
+  ThemeId: string | undefined;
+  AliasName: string | undefined;
+}
+export interface DescribeThemeAliasResponse {
+  ThemeAlias?: ThemeAlias | undefined;
+  Status?: number | undefined;
+  RequestId?: string | undefined;
+}
+export interface DescribeThemePermissionsRequest {
+  AwsAccountId: string | undefined;
+  ThemeId: string | undefined;
+}
+export interface DescribeThemePermissionsResponse {
+  ThemeId?: string | undefined;
+  ThemeArn?: string | undefined;
+  Permissions?: ResourcePermission[] | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
+export interface DescribeTopicRequest {
+  AwsAccountId: string | undefined;
+  TopicId: string | undefined;
+}
+export interface DescribeTopicResponse {
+  Arn?: string | undefined;
+  TopicId?: string | undefined;
+  Topic?: TopicDetails | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+  CustomInstructions?: CustomInstructions | undefined;
+}
+export interface DescribeTopicPermissionsRequest {
+  AwsAccountId: string | undefined;
+  TopicId: string | undefined;
+}
+export interface DescribeTopicPermissionsResponse {
+  TopicId?: string | undefined;
+  TopicArn?: string | undefined;
+  Permissions?: ResourcePermission[] | undefined;
+  Status?: number | undefined;
+  RequestId?: string | undefined;
+}
+export interface DescribeTopicRefreshRequest {
+  AwsAccountId: string | undefined;
+  TopicId: string | undefined;
+  RefreshId: string | undefined;
+}
+export interface TopicRefreshDetails {
+  RefreshArn?: string | undefined;
+  RefreshId?: string | undefined;
+  RefreshStatus?: TopicRefreshStatus | undefined;
+}
+export interface DescribeTopicRefreshResponse {
+  RefreshDetails?: TopicRefreshDetails | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
+export interface DescribeTopicRefreshScheduleRequest {
+  AwsAccountId: string | undefined;
+  TopicId: string | undefined;
+  DatasetId: string | undefined;
+}
+export interface DescribeTopicRefreshScheduleResponse {
+  TopicId?: string | undefined;
+  TopicArn?: string | undefined;
+  DatasetArn?: string | undefined;
+  RefreshSchedule?: TopicRefreshSchedule | undefined;
+  Status?: number | undefined;
+  RequestId?: string | undefined;
+}
+export interface DescribeUserRequest {
+  UserName: string | undefined;
+  AwsAccountId: string | undefined;
+  Namespace: string | undefined;
+}
+export interface User {
+  Arn?: string | undefined;
+  UserName?: string | undefined;
+  Email?: string | undefined;
+  Role?: UserRole | undefined;
+  IdentityType?: IdentityType | undefined;
+  Active?: boolean | undefined;
+  PrincipalId?: string | undefined;
+  CustomPermissionsName?: string | undefined;
+  ExternalLoginFederationProviderType?: string | undefined;
+  ExternalLoginFederationProviderUrl?: string | undefined;
+  ExternalLoginId?: string | undefined;
+}
+export interface DescribeUserResponse {
+  User?: User | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
 export interface DescribeVPCConnectionRequest {
   AwsAccountId: string | undefined;
   VPCConnectionId: string | undefined;
@@ -365,6 +493,54 @@ export interface GetFlowPermissionsOutput {
   RequestId?: string | undefined;
   Status?: number | undefined;
 }
+export type UserIdentifier =
+  | UserIdentifier.EmailMember
+  | UserIdentifier.UserArnMember
+  | UserIdentifier.UserNameMember
+  | UserIdentifier.$UnknownMember;
+export declare namespace UserIdentifier {
+  interface UserNameMember {
+    UserName: string;
+    Email?: never;
+    UserArn?: never;
+    $unknown?: never;
+  }
+  interface EmailMember {
+    UserName?: never;
+    Email: string;
+    UserArn?: never;
+    $unknown?: never;
+  }
+  interface UserArnMember {
+    UserName?: never;
+    Email?: never;
+    UserArn: string;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    UserName?: never;
+    Email?: never;
+    UserArn?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    UserName: (value: string) => T;
+    Email: (value: string) => T;
+    UserArn: (value: string) => T;
+    _: (name: string, value: any) => T;
+  }
+}
+export interface GetIdentityContextRequest {
+  AwsAccountId: string | undefined;
+  UserIdentifier: UserIdentifier | undefined;
+  Namespace?: string | undefined;
+  SessionExpiresAt?: Date | undefined;
+}
+export interface GetIdentityContextResponse {
+  Status: number | undefined;
+  RequestId: string | undefined;
+  Context?: string | undefined;
+}
 export interface GetSessionEmbedUrlRequest {
   AwsAccountId: string | undefined;
   EntryPoint?: string | undefined;
@@ -1072,7 +1248,7 @@ export interface StartDashboardSnapshotJobRequest {
   AwsAccountId: string | undefined;
   DashboardId: string | undefined;
   SnapshotJobId: string | undefined;
-  UserConfiguration: SnapshotUserConfiguration | undefined;
+  UserConfiguration?: SnapshotUserConfiguration | undefined;
   SnapshotConfiguration: SnapshotConfiguration | undefined;
 }
 export interface StartDashboardSnapshotJobResponse {