@aws-sdk/client-quicksight 3.1061.0 → 3.1063.0

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

@@ -1,9 +1,9 @@
 import { DocumentType as __DocumentType } from "@smithy/types";
 import {
-  AgentStatus,
   AssetBundleExportFormat,
   AssetBundleImportFailureAction,
   AssignmentStatus,
+  DataSetStatus,
   DataSourceType,
   EmbeddingIdentityType,
   FieldName,
@@ -16,6 +16,7 @@ import {
   GroupFilterOperator,
   IdentityStore,
   IdentityType,
+  ImageExtractionStatus,
   IncludeFolderMembers,
   IncludeGeneratedAnswer,
   IncludeQuickSightQIndex,
@@ -23,6 +24,10 @@ import {
   IngestionRequestSource,
   IngestionRequestType,
   IngestionStatus,
+  KbIngestionStatus,
+  KnowledgeBaseSearchFilterName,
+  KnowledgeBaseSearchOperator,
+  KnowledgeBaseSortByField,
   NamespaceErrorType,
   NamespaceStatus,
   NetworkInterfaceStatus,
@@ -37,6 +42,7 @@ import {
   SelfUpgradeRequestStatus,
   SelfUpgradeStatus,
   SharingModel,
+  SortOrder,
   SpaceQuickSightResourceType,
   SpaceQuickSightSearchFilterName,
   SpaceSearchOperator,
@@ -47,12 +53,15 @@ import {
   TopicFilterOperator,
   TopicRefreshStatus,
   TopicUserExperienceVersion,
+  UserIndexCapacitySortBy,
+  UserIndexCapacitySortOrder,
   UserRole,
+  VideoExtractionStatus,
+  VideoExtractionType,
   VPCConnectionAvailabilityStatus,
   VPCConnectionResourceStatus,
 } from "./enums";
 import {
-  AccountCustomization,
   ActionConnectorSearchFilter,
   ActionConnectorSummary,
   ActiveIAMPolicyAssignment,
@@ -64,10 +73,7 @@ import {
   Sheet,
 } from "./models_0";
 import {
-  _Parameters,
-  AnalysisDefinition,
   AnalysisSearchFilter,
-  AnalysisSourceEntity,
   AnalysisSummary,
   AnonymousUserEmbeddingExperienceConfiguration,
   AssetBundleCloudFormationOverridePropertyConfiguration,
@@ -79,19 +85,16 @@ import {
   AssetBundleImportJobOverrideValidationStrategy,
   AssetBundleImportJobSummary,
   AssetBundleImportSource,
-  AuthConfig,
+  AudioExtractionConfiguration,
   AuthorizedTargetsByService,
   BookmarksConfigurations,
-  BrandDefinition,
-  BrandDetail,
   BrandSummary,
-  CustomPromptInput,
+  CapacityBytesRangeFilter,
   DashboardVisualId,
   DataSetRefreshProperties,
   ResourcePermission,
   SharedViewConfigurations,
   Tag,
-  ValidationStrategy,
   VpcConnectionProperties,
 } from "./models_2";
 import {
@@ -102,6 +105,7 @@ import {
   DashboardSummary,
   DashboardVersionSummary,
   DashboardVisualResult,
+  DataSet,
   DataSetConfiguration,
   DataSetSearchFilter,
   DataSetSummary,
@@ -112,7 +116,6 @@ import {
   GroupMember,
   Permission,
   RefreshSchedule,
-  SnapshotConfiguration,
   TemplateAlias,
   TemplateVersionDefinition,
   ThemeAlias,
@@ -120,6 +123,44 @@ import {
   TopicDetails,
   TopicRefreshSchedule,
 } from "./models_3";
+export interface DescribeDataSetResponse {
+  DataSet?: DataSet | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
+export interface DescribeDataSetPermissionsRequest {
+  AwsAccountId: string | undefined;
+  DataSetId: string | undefined;
+}
+export interface DescribeDataSetPermissionsResponse {
+  DataSetArn?: string | undefined;
+  DataSetId?: string | undefined;
+  Permissions?: ResourcePermission[] | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
+export interface DescribeDataSetRefreshPropertiesRequest {
+  AwsAccountId: string | undefined;
+  DataSetId: string | undefined;
+}
+export interface DescribeDataSetRefreshPropertiesResponse {
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+  DataSetRefreshProperties?: DataSetRefreshProperties | undefined;
+}
+export interface DescribeDataSourceRequest {
+  AwsAccountId: string | undefined;
+  DataSourceId: string | undefined;
+}
+export interface DescribeDataSourceResponse {
+  DataSource?: DataSource | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
+export interface DescribeDataSourcePermissionsRequest {
+  AwsAccountId: string | undefined;
+  DataSourceId: string | undefined;
+}
 export interface DescribeDataSourcePermissionsResponse {
   DataSourceArn?: string | undefined;
   DataSourceId?: string | undefined;
@@ -318,6 +359,72 @@ export interface DescribeKeyRegistrationResponse {
   RequestId?: string | undefined;
   Status?: number | undefined;
 }
+export interface DescribeKnowledgeBaseRequest {
+  AwsAccountId: string | undefined;
+  KnowledgeBaseId: string | undefined;
+}
+export interface KnowledgeBaseIngestionSummary {
+  IngestionId: string | undefined;
+  IngestionStatus: KbIngestionStatus | undefined;
+  StartTime?: Date | undefined;
+  EndTime?: Date | undefined;
+}
+export interface KbTemplateConfiguration {
+  template?: __DocumentType | undefined;
+}
+export interface KnowledgeBaseConfiguration {
+  templateConfiguration?: KbTemplateConfiguration | undefined;
+  eventEnabled?: boolean | undefined;
+}
+export interface ImageExtractionConfiguration {
+  imageExtractionStatus: ImageExtractionStatus | undefined;
+}
+export interface VideoExtractionConfiguration {
+  videoExtractionStatus: VideoExtractionStatus | undefined;
+  videoExtractionType?: VideoExtractionType | undefined;
+}
+export interface MediaExtractionConfiguration {
+  imageExtractionConfiguration?: ImageExtractionConfiguration | undefined;
+  audioExtractionConfiguration?: AudioExtractionConfiguration | undefined;
+  videoExtractionConfiguration?: VideoExtractionConfiguration | undefined;
+}
+export interface KnowledgeBase {
+  KnowledgeBaseArn: string | undefined;
+  KnowledgeBaseId: string | undefined;
+  Name: string | undefined;
+  Status: DataSetStatus | undefined;
+  DataSourceArn: string | undefined;
+  KnowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
+  MediaExtractionConfiguration?: MediaExtractionConfiguration | undefined;
+  Type?: string | undefined;
+  CreatedAt?: Date | undefined;
+  UpdatedAt?: Date | undefined;
+  Description?: string | undefined;
+  IsEmailNotificationOptedForIngestionFailures?: boolean | undefined;
+  FirstCompletedIngestionSummary?: KnowledgeBaseIngestionSummary | undefined;
+  FirstIncompleteIngestionSummary?: KnowledgeBaseIngestionSummary | undefined;
+  LatestIngestionSummary?: KnowledgeBaseIngestionSummary | undefined;
+  KnowledgeBaseSizeBytes?: number | undefined;
+  DocumentCount?: number | undefined;
+  PrimaryOwnerArn?: string | undefined;
+  PrimaryOwnerUsername?: string | undefined;
+}
+export interface DescribeKnowledgeBaseResponse {
+  KnowledgeBase: KnowledgeBase | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
+export interface DescribeKnowledgeBasePermissionsRequest {
+  AwsAccountId: string | undefined;
+  KnowledgeBaseId: string | undefined;
+}
+export interface DescribeKnowledgeBasePermissionsResponse {
+  KnowledgeBaseArn: string | undefined;
+  KnowledgeBaseId: string | undefined;
+  Permissions?: ResourcePermission[] | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
 export interface DescribeNamespaceRequest {
   AwsAccountId: string | undefined;
   Namespace: string | undefined;
@@ -992,6 +1099,29 @@ export interface IAMPolicyAssignmentSummary {
   AssignmentName?: string | undefined;
   AssignmentStatus?: AssignmentStatus | undefined;
 }
+export interface KnowledgeBaseSearchFilter {
+  name: KnowledgeBaseSearchFilterName | undefined;
+  operator: KnowledgeBaseSearchOperator | undefined;
+  value: string | undefined;
+}
+export interface KnowledgeBaseSortBy {
+  sortByField: KnowledgeBaseSortByField | undefined;
+  sortOrder: SortOrder | undefined;
+}
+export interface KnowledgeBaseSummary {
+  KnowledgeBaseArn: string | undefined;
+  KnowledgeBaseId: string | undefined;
+  Name: string | undefined;
+  Status: DataSetStatus | undefined;
+  DataSourceArn: string | undefined;
+  Type?: string | undefined;
+  CreatedAt?: Date | undefined;
+  UpdatedAt?: Date | undefined;
+  KnowledgeBaseSizeBytes?: number | undefined;
+  DocumentCount?: number | undefined;
+  PrimaryOwnerArn?: string | undefined;
+  PrimaryOwnerUsername?: string | undefined;
+}
 export interface ListActionConnectorsRequest {
   AwsAccountId: string | undefined;
   MaxResults?: number | undefined;
@@ -1231,6 +1361,17 @@ export interface ListIngestionsResponse {
   RequestId?: string | undefined;
   Status?: number | undefined;
 }
+export interface ListKnowledgeBasesRequest {
+  AwsAccountId: string | undefined;
+  MaxResults?: number | undefined;
+  NextToken?: string | undefined;
+}
+export interface ListKnowledgeBasesResponse {
+  KnowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
+  NextToken?: string | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
 export interface ListNamespacesRequest {
   AwsAccountId: string | undefined;
   NextToken?: string | undefined;
@@ -1521,6 +1662,60 @@ export interface ListUsersResponse {
   RequestId?: string | undefined;
   Status?: number | undefined;
 }
+export interface UserNameOrEmailFilter {
+  prefix: string | undefined;
+}
+export type UserIndexCapacityFilter =
+  | UserIndexCapacityFilter.TotalCapacityBytesMember
+  | UserIndexCapacityFilter.UserNameOrEmailMember
+  | UserIndexCapacityFilter.$UnknownMember;
+export declare namespace UserIndexCapacityFilter {
+  interface UserNameOrEmailMember {
+    userNameOrEmail: UserNameOrEmailFilter;
+    totalCapacityBytes?: never;
+    $unknown?: never;
+  }
+  interface TotalCapacityBytesMember {
+    userNameOrEmail?: never;
+    totalCapacityBytes: CapacityBytesRangeFilter;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    userNameOrEmail?: never;
+    totalCapacityBytes?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    userNameOrEmail: (value: UserNameOrEmailFilter) => T;
+    totalCapacityBytes: (value: CapacityBytesRangeFilter) => T;
+    _: (name: string, value: any) => T;
+  }
+}
+export interface ListUsersIndexCapacityRequest {
+  awsAccountId: string | undefined;
+  namespace?: string | undefined;
+  filters?: UserIndexCapacityFilter[] | undefined;
+  sortBy?: UserIndexCapacitySortBy | undefined;
+  sortOrder?: UserIndexCapacitySortOrder | undefined;
+  maxResults?: number | undefined;
+  nextToken?: string | undefined;
+}
+export interface UserIndexCapacity {
+  userArn?: string | undefined;
+  userName?: string | undefined;
+  email?: string | undefined;
+  role?: string | undefined;
+  totalCapacityBytes?: number | undefined;
+  totalKBCapacityBytes?: number | undefined;
+  totalSpaceCapacityBytes?: number | undefined;
+  kbCount?: number | undefined;
+  spaceCount?: number | undefined;
+}
+export interface ListUsersIndexCapacityResponse {
+  users?: UserIndexCapacity[] | undefined;
+  nextToken?: string | undefined;
+  requestId?: string | undefined;
+}
 export interface ListVPCConnectionsRequest {
   AwsAccountId: string | undefined;
   NextToken?: string | undefined;
@@ -1719,6 +1914,19 @@ export interface SearchGroupsResponse {
   RequestId?: string | undefined;
   Status?: number | undefined;
 }
+export interface SearchKnowledgeBasesRequest {
+  AwsAccountId: string | undefined;
+  NextToken?: string | undefined;
+  MaxResults?: number | undefined;
+  Filters?: KnowledgeBaseSearchFilter[] | undefined;
+  SortBy?: KnowledgeBaseSortBy | undefined;
+}
+export interface SearchKnowledgeBasesResponse {
+  KnowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
+  NextToken?: string | undefined;
+  RequestId?: string | undefined;
+  Status?: number | undefined;
+}
 export interface SpaceQuicksightSearchFilter {
   name: SpaceQuickSightSearchFilterName | undefined;
   operator: SpaceSearchOperator | undefined;
@@ -1808,187 +2016,3 @@ export interface StartAutomationJobResponse {
 export interface SnapshotAnonymousUser {
   RowLevelPermissionTags?: SessionTag[] | undefined;
 }
-export interface SnapshotUserConfiguration {
-  AnonymousUsers?: SnapshotAnonymousUser[] | undefined;
-}
-export interface StartDashboardSnapshotJobRequest {
-  AwsAccountId: string | undefined;
-  DashboardId: string | undefined;
-  SnapshotJobId: string | undefined;
-  UserConfiguration?: SnapshotUserConfiguration | undefined;
-  SnapshotConfiguration: SnapshotConfiguration | undefined;
-}
-export interface StartDashboardSnapshotJobResponse {
-  Arn?: string | undefined;
-  SnapshotJobId?: string | undefined;
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface StartDashboardSnapshotJobScheduleRequest {
-  AwsAccountId: string | undefined;
-  DashboardId: string | undefined;
-  ScheduleId: string | undefined;
-}
-export interface StartDashboardSnapshotJobScheduleResponse {
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface TagResourceRequest {
-  ResourceArn: string | undefined;
-  Tags: Tag[] | undefined;
-}
-export interface TagResourceResponse {
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface UntagResourceRequest {
-  ResourceArn: string | undefined;
-  TagKeys: string[] | undefined;
-}
-export interface UntagResourceResponse {
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface UpdateAccountCustomizationRequest {
-  AwsAccountId: string | undefined;
-  Namespace?: string | undefined;
-  AccountCustomization: AccountCustomization | undefined;
-}
-export interface UpdateAccountCustomizationResponse {
-  Arn?: string | undefined;
-  AwsAccountId?: string | undefined;
-  Namespace?: string | undefined;
-  AccountCustomization?: AccountCustomization | undefined;
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface UpdateAccountCustomPermissionRequest {
-  CustomPermissionsName: string | undefined;
-  AwsAccountId: string | undefined;
-}
-export interface UpdateAccountCustomPermissionResponse {
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface UpdateAccountSettingsRequest {
-  AwsAccountId: string | undefined;
-  DefaultNamespace: string | undefined;
-  NotificationEmail?: string | undefined;
-  TerminationProtectionEnabled?: boolean | undefined;
-}
-export interface UpdateAccountSettingsResponse {
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface UpdateActionConnectorRequest {
-  AwsAccountId: string | undefined;
-  ActionConnectorId: string | undefined;
-  Name: string | undefined;
-  AuthenticationConfig: AuthConfig | undefined;
-  Description?: string | undefined;
-  VpcConnectionArn?: string | undefined;
-}
-export interface UpdateActionConnectorResponse {
-  Arn?: string | undefined;
-  ActionConnectorId?: string | undefined;
-  RequestId?: string | undefined;
-  UpdateStatus?: ResourceStatus | undefined;
-  Status?: number | undefined;
-}
-export interface UpdateActionConnectorPermissionsRequest {
-  AwsAccountId: string | undefined;
-  ActionConnectorId: string | undefined;
-  GrantPermissions?: ResourcePermission[] | undefined;
-  RevokePermissions?: ResourcePermission[] | undefined;
-}
-export interface UpdateActionConnectorPermissionsResponse {
-  Arn?: string | undefined;
-  ActionConnectorId?: string | undefined;
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-  Permissions?: ResourcePermission[] | undefined;
-}
-export interface UpdateAgentRequest {
-  AgentId: string | undefined;
-  AwsAccountId: string | undefined;
-  Name: string | undefined;
-  Description?: string | undefined;
-  IconId?: string | undefined;
-  StarterPrompts?: string[] | undefined;
-  WelcomeMessage?: string | undefined;
-  CustomPromptInput?: CustomPromptInput | undefined;
-  SpacesToAdd?: string[] | undefined;
-  SpacesToRemove?: string[] | undefined;
-  ActionConnectorsToAdd?: string[] | undefined;
-  ActionConnectorsToRemove?: string[] | undefined;
-}
-export interface UpdateAgentResponse {
-  Arn: string | undefined;
-  AgentId: string | undefined;
-  AgentStatus: AgentStatus | undefined;
-  FailedToAddSpaces?: FailedToUpdateAssociation[] | undefined;
-  FailedToRemoveSpaces?: FailedToUpdateAssociation[] | undefined;
-  FailedToAddActionConnectors?: FailedToUpdateAssociation[] | undefined;
-  FailedToRemoveActionConnectors?: FailedToUpdateAssociation[] | undefined;
-  RequestId?: string | undefined;
-}
-export interface UpdateAgentPermissionsRequest {
-  AgentId: string | undefined;
-  AwsAccountId: string | undefined;
-  GrantPermissions?: ResourcePermission[] | undefined;
-  RevokePermissions?: ResourcePermission[] | undefined;
-}
-export interface UpdateAgentPermissionsResponse {
-  Arn: string | undefined;
-  AgentId: string | undefined;
-  RequestId?: string | undefined;
-  Permissions?: ResourcePermission[] | undefined;
-}
-export interface UpdateAnalysisRequest {
-  AwsAccountId: string | undefined;
-  AnalysisId: string | undefined;
-  Name: string | undefined;
-  Parameters?: _Parameters | undefined;
-  SourceEntity?: AnalysisSourceEntity | undefined;
-  ThemeArn?: string | undefined;
-  Definition?: AnalysisDefinition | undefined;
-  ValidationStrategy?: ValidationStrategy | undefined;
-}
-export interface UpdateAnalysisResponse {
-  Arn?: string | undefined;
-  AnalysisId?: string | undefined;
-  UpdateStatus?: ResourceStatus | undefined;
-  Status?: number | undefined;
-  RequestId?: string | undefined;
-}
-export interface UpdateAnalysisPermissionsRequest {
-  AwsAccountId: string | undefined;
-  AnalysisId: string | undefined;
-  GrantPermissions?: ResourcePermission[] | undefined;
-  RevokePermissions?: ResourcePermission[] | undefined;
-}
-export interface UpdateAnalysisPermissionsResponse {
-  AnalysisArn?: string | undefined;
-  AnalysisId?: string | undefined;
-  Permissions?: ResourcePermission[] | undefined;
-  RequestId?: string | undefined;
-  Status?: number | undefined;
-}
-export interface UpdateApplicationWithTokenExchangeGrantRequest {
-  AwsAccountId: string | undefined;
-  Namespace: string | undefined;
-}
-export interface UpdateApplicationWithTokenExchangeGrantResponse {
-  Status?: number | undefined;
-  RequestId?: string | undefined;
-}
-export interface UpdateBrandRequest {
-  AwsAccountId: string | undefined;
-  BrandId: string | undefined;
-  BrandDefinition?: BrandDefinition | undefined;
-}
-export interface UpdateBrandResponse {
-  RequestId?: string | undefined;
-  BrandDetail?: BrandDetail | undefined;
-  BrandDefinition?: BrandDefinition | undefined;
-}