@aws-sdk/client-quicksight 3.303.0 → 3.309.0

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

@@ -9,9 +9,12 @@ import {
   AnalysisSearchFilter,
   AnalysisSourceEntity,
   AnalysisSummary,
+  AnonymousUserEmbeddingExperienceConfiguration,
   AssignmentStatus,
   ColumnGroup,
   ColumnLevelPermissionRule,
+  DashboardVisualId,
+  FilterOperator,
   Tag,
 } from "./models_1";
 import {
@@ -23,6 +26,7 @@ import {
   DashboardVersionDefinition,
   DashboardVersionSummary,
   DataSetImportMode,
+  DataSetRefreshProperties,
   DataSetSearchFilter,
   DataSetSummary,
   DataSetUsageConfiguration,
@@ -31,18 +35,19 @@ import {
   DataSourceParameters,
   DataSourceSearchFilter,
   DataSourceSummary,
+  EmbeddingIdentityType,
   FieldFolder,
-  FolderSearchFilter,
-  FolderSummary,
+  FolderFilterAttribute,
+  FolderType,
   Group,
   GroupMember,
   IdentityType,
   Ingestion,
   LinkSharingConfiguration,
   LogicalTable,
-  MemberIdArnPair,
   NamespaceInfoV2,
   PhysicalTable,
+  RefreshSchedule,
   ResourcePermission,
   RowLevelPermissionDataSet,
   RowLevelPermissionTagConfiguration,
@@ -58,6 +63,135 @@ import {
   VpcConnectionProperties,
 } from "./models_2";
 import { QuickSightServiceException as __BaseException } from "./QuickSightServiceException";
+export interface MemberIdArnPair {
+  MemberId?: string;
+  MemberArn?: string;
+}
+export interface FolderSearchFilter {
+  Operator?: FilterOperator | string;
+  Name?: FolderFilterAttribute | string;
+  Value?: string;
+}
+export interface FolderSummary {
+  Arn?: string;
+  FolderId?: string;
+  Name?: string;
+  FolderType?: FolderType | string;
+  CreatedTime?: Date;
+  LastUpdatedTime?: Date;
+}
+export interface SessionTag {
+  Key: string | undefined;
+  Value: string | undefined;
+}
+export interface GenerateEmbedUrlForAnonymousUserRequest {
+  AwsAccountId: string | undefined;
+  SessionLifetimeInMinutes?: number;
+  Namespace: string | undefined;
+  SessionTags?: SessionTag[];
+  AuthorizedResourceArns: string[] | undefined;
+  ExperienceConfiguration:
+    | AnonymousUserEmbeddingExperienceConfiguration
+    | undefined;
+  AllowedDomains?: string[];
+}
+export interface GenerateEmbedUrlForAnonymousUserResponse {
+  EmbedUrl: string | undefined;
+  Status: number | undefined;
+  RequestId: string | undefined;
+  AnonymousUserArn: string | undefined;
+}
+export declare class SessionLifetimeInMinutesInvalidException extends __BaseException {
+  readonly name: "SessionLifetimeInMinutesInvalidException";
+  readonly $fault: "client";
+  Message?: string;
+  RequestId?: string;
+  constructor(
+    opts: __ExceptionOptionType<
+      SessionLifetimeInMinutesInvalidException,
+      __BaseException
+    >
+  );
+}
+export declare class UnsupportedPricingPlanException extends __BaseException {
+  readonly name: "UnsupportedPricingPlanException";
+  readonly $fault: "client";
+  Message?: string;
+  RequestId?: string;
+  constructor(
+    opts: __ExceptionOptionType<
+      UnsupportedPricingPlanException,
+      __BaseException
+    >
+  );
+}
+export interface StatePersistenceConfigurations {
+  Enabled: boolean | undefined;
+}
+export interface RegisteredUserDashboardFeatureConfigurations {
+  StatePersistence?: StatePersistenceConfigurations;
+}
+export interface RegisteredUserDashboardEmbeddingConfiguration {
+  InitialDashboardId: string | undefined;
+  FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations;
+}
+export interface RegisteredUserDashboardVisualEmbeddingConfiguration {
+  InitialDashboardVisualId: DashboardVisualId | undefined;
+}
+export interface RegisteredUserQSearchBarEmbeddingConfiguration {
+  InitialTopicId?: string;
+}
+export interface RegisteredUserConsoleFeatureConfigurations {
+  StatePersistence?: StatePersistenceConfigurations;
+}
+export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration {
+  InitialPath?: string;
+  FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations;
+}
+export interface RegisteredUserEmbeddingExperienceConfiguration {
+  Dashboard?: RegisteredUserDashboardEmbeddingConfiguration;
+  QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration;
+  QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration;
+  DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration;
+}
+export interface GenerateEmbedUrlForRegisteredUserRequest {
+  AwsAccountId: string | undefined;
+  SessionLifetimeInMinutes?: number;
+  UserArn: string | undefined;
+  ExperienceConfiguration:
+    | RegisteredUserEmbeddingExperienceConfiguration
+    | undefined;
+  AllowedDomains?: string[];
+}
+export interface GenerateEmbedUrlForRegisteredUserResponse {
+  EmbedUrl: string | undefined;
+  Status: number | undefined;
+  RequestId: string | undefined;
+}
+export declare class QuickSightUserNotFoundException extends __BaseException {
+  readonly name: "QuickSightUserNotFoundException";
+  readonly $fault: "client";
+  Message?: string;
+  RequestId?: string;
+  constructor(
+    opts: __ExceptionOptionType<
+      QuickSightUserNotFoundException,
+      __BaseException
+    >
+  );
+}
+export interface GetDashboardEmbedUrlRequest {
+  AwsAccountId: string | undefined;
+  DashboardId: string | undefined;
+  IdentityType: EmbeddingIdentityType | string | undefined;
+  SessionLifetimeInMinutes?: number;
+  UndoRedoDisabled?: boolean;
+  ResetDisabled?: boolean;
+  StatePersistenceEnabled?: boolean;
+  UserArn?: string;
+  Namespace?: string;
+  AdditionalDashboardIds?: string[];
+}
 export interface GetDashboardEmbedUrlResponse {
   EmbedUrl?: string;
   Status?: number;
@@ -267,6 +401,15 @@ export interface ListNamespacesResponse {
   RequestId?: string;
   Status?: number;
 }
+export interface ListRefreshSchedulesRequest {
+  AwsAccountId: string | undefined;
+  DataSetId: string | undefined;
+}
+export interface ListRefreshSchedulesResponse {
+  RefreshSchedules?: RefreshSchedule[];
+  Status?: number;
+  RequestId?: string;
+}
 export interface ListTagsForResourceRequest {
   ResourceArn: string | undefined;
 }
@@ -401,6 +544,15 @@ export interface ListUsersResponse {
   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 | string | undefined;
   Email: string | undefined;
@@ -750,6 +902,17 @@ export interface UpdatePublicSharingSettingsResponse {
   RequestId?: string;
   Status?: number;
 }
+export interface UpdateRefreshScheduleRequest {
+  DataSetId: string | undefined;
+  AwsAccountId: string | undefined;
+  Schedule: RefreshSchedule | undefined;
+}
+export interface UpdateRefreshScheduleResponse {
+  Status?: number;
+  RequestId?: string;
+  ScheduleId?: string;
+  Arn?: string;
+}
 export interface UpdateTemplateRequest {
   AwsAccountId: string | undefined;
   TemplateId: string | undefined;
@@ -847,6 +1010,16 @@ export interface UpdateUserResponse {
   RequestId?: string;
   Status?: number;
 }
+export declare const SessionTagFilterSensitiveLog: (obj: SessionTag) => any;
+export declare const GenerateEmbedUrlForAnonymousUserRequestFilterSensitiveLog: (
+  obj: GenerateEmbedUrlForAnonymousUserRequest
+) => any;
+export declare const GenerateEmbedUrlForAnonymousUserResponseFilterSensitiveLog: (
+  obj: GenerateEmbedUrlForAnonymousUserResponse
+) => any;
+export declare const GenerateEmbedUrlForRegisteredUserResponseFilterSensitiveLog: (
+  obj: GenerateEmbedUrlForRegisteredUserResponse
+) => any;
 export declare const GetDashboardEmbedUrlResponseFilterSensitiveLog: (
   obj: GetDashboardEmbedUrlResponse
 ) => any;