@aws-sdk/client-qbusiness 3.461.0

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

@@ -0,0 +1,1406 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { DocumentType as __DocumentType } from "@smithy/types";
+import { QBusinessServiceException as __BaseException } from "./QBusinessServiceException";
+export declare const MemberRelation: {
+  readonly AND: "AND";
+  readonly OR: "OR";
+};
+export type MemberRelation =
+  (typeof MemberRelation)[keyof typeof MemberRelation];
+export declare const ReadAccessType: {
+  readonly ALLOW: "ALLOW";
+  readonly DENY: "DENY";
+};
+export type ReadAccessType =
+  (typeof ReadAccessType)[keyof typeof ReadAccessType];
+export declare const MembershipType: {
+  readonly DATASOURCE: "DATASOURCE";
+  readonly INDEX: "INDEX";
+};
+export type MembershipType =
+  (typeof MembershipType)[keyof typeof MembershipType];
+export interface PrincipalGroup {
+  name?: string;
+  access: ReadAccessType | undefined;
+  membershipType?: MembershipType;
+}
+export interface PrincipalUser {
+  id?: string;
+  access: ReadAccessType | undefined;
+  membershipType?: MembershipType;
+}
+export type Principal =
+  | Principal.GroupMember
+  | Principal.UserMember
+  | Principal.$UnknownMember;
+export declare namespace Principal {
+  interface UserMember {
+    user: PrincipalUser;
+    group?: never;
+    $unknown?: never;
+  }
+  interface GroupMember {
+    user?: never;
+    group: PrincipalGroup;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    user?: never;
+    group?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    user: (value: PrincipalUser) => T;
+    group: (value: PrincipalGroup) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: Principal, visitor: Visitor<T>) => T;
+}
+export interface AccessControl {
+  principals: Principal[] | undefined;
+  memberRelation?: MemberRelation;
+}
+export interface AccessConfiguration {
+  accessControls: AccessControl[] | undefined;
+  memberRelation?: MemberRelation;
+}
+export declare class AccessDeniedException extends __BaseException {
+  readonly name: "AccessDeniedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
+  );
+}
+export interface ActionExecutionPayloadField {
+  value: __DocumentType | undefined;
+}
+export interface ActionExecution {
+  pluginId: string | undefined;
+  payload: Record<string, ActionExecutionPayloadField> | undefined;
+  payloadFieldNameSeparator: string | undefined;
+}
+export declare const ActionPayloadFieldType: {
+  readonly ARRAY: "ARRAY";
+  readonly BOOLEAN: "BOOLEAN";
+  readonly NUMBER: "NUMBER";
+  readonly STRING: "STRING";
+};
+export type ActionPayloadFieldType =
+  (typeof ActionPayloadFieldType)[keyof typeof ActionPayloadFieldType];
+export interface ActionReviewPayloadFieldAllowedValue {
+  value?: __DocumentType;
+  displayValue?: __DocumentType;
+}
+export interface ActionReviewPayloadField {
+  displayName?: string;
+  displayOrder?: number;
+  type?: ActionPayloadFieldType;
+  value?: __DocumentType;
+  allowedValues?: ActionReviewPayloadFieldAllowedValue[];
+  required?: boolean;
+}
+export declare const PluginType: {
+  readonly JIRA: "JIRA";
+  readonly SALESFORCE: "SALESFORCE";
+  readonly SERVICE_NOW: "SERVICE_NOW";
+  readonly ZENDESK: "ZENDESK";
+};
+export type PluginType = (typeof PluginType)[keyof typeof PluginType];
+export interface ActionReview {
+  pluginId?: string;
+  pluginType?: PluginType;
+  payload?: Record<string, ActionReviewPayloadField>;
+  payloadFieldNameSeparator?: string;
+}
+export declare const ApplicationStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATING: "CREATING";
+  readonly DELETING: "DELETING";
+  readonly FAILED: "FAILED";
+  readonly UPDATING: "UPDATING";
+};
+export type ApplicationStatus =
+  (typeof ApplicationStatus)[keyof typeof ApplicationStatus];
+export interface Application {
+  displayName?: string;
+  applicationId?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+  status?: ApplicationStatus;
+}
+export declare class ConflictException extends __BaseException {
+  readonly name: "ConflictException";
+  readonly $fault: "client";
+  resourceId: string | undefined;
+  resourceType: string | undefined;
+  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+export declare const AttachmentsControlMode: {
+  readonly DISABLED: "DISABLED";
+  readonly ENABLED: "ENABLED";
+};
+export type AttachmentsControlMode =
+  (typeof AttachmentsControlMode)[keyof typeof AttachmentsControlMode];
+export interface AttachmentsConfiguration {
+  attachmentsControlMode: AttachmentsControlMode | undefined;
+}
+export interface EncryptionConfiguration {
+  kmsKeyId?: string;
+}
+export interface Tag {
+  key: string | undefined;
+  value: string | undefined;
+}
+export interface CreateApplicationRequest {
+  displayName: string | undefined;
+  roleArn: string | undefined;
+  description?: string;
+  encryptionConfiguration?: EncryptionConfiguration;
+  tags?: Tag[];
+  clientToken?: string;
+  attachmentsConfiguration?: AttachmentsConfiguration;
+}
+export interface CreateApplicationResponse {
+  applicationId?: string;
+  applicationArn?: string;
+}
+export declare class InternalServerException extends __BaseException {
+  readonly name: "InternalServerException";
+  readonly $fault: "server";
+  constructor(
+    opts: __ExceptionOptionType<InternalServerException, __BaseException>
+  );
+}
+export declare class ResourceNotFoundException extends __BaseException {
+  readonly name: "ResourceNotFoundException";
+  readonly $fault: "client";
+  resourceId: string | undefined;
+  resourceType: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
+  );
+}
+export declare class ServiceQuotaExceededException extends __BaseException {
+  readonly name: "ServiceQuotaExceededException";
+  readonly $fault: "client";
+  resourceId: string | undefined;
+  resourceType: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
+  );
+}
+export declare class ThrottlingException extends __BaseException {
+  readonly name: "ThrottlingException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ThrottlingException, __BaseException>
+  );
+}
+export interface ValidationExceptionField {
+  name: string | undefined;
+  message: string | undefined;
+}
+export declare const ValidationExceptionReason: {
+  readonly CANNOT_PARSE: "CANNOT_PARSE";
+  readonly FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED";
+  readonly UNKNOWN_OPERATION: "UNKNOWN_OPERATION";
+};
+export type ValidationExceptionReason =
+  (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
+export declare class ValidationException extends __BaseException {
+  readonly name: "ValidationException";
+  readonly $fault: "client";
+  reason: ValidationExceptionReason | undefined;
+  fields?: ValidationExceptionField[];
+  constructor(
+    opts: __ExceptionOptionType<ValidationException, __BaseException>
+  );
+}
+export interface DeleteApplicationRequest {
+  applicationId: string | undefined;
+}
+export interface DeleteApplicationResponse {}
+export interface GetApplicationRequest {
+  applicationId: string | undefined;
+}
+export interface AppliedAttachmentsConfiguration {
+  attachmentsControlMode?: AttachmentsControlMode;
+}
+export declare const ErrorCode: {
+  readonly INTERNAL_ERROR: "InternalError";
+  readonly INVALID_REQUEST: "InvalidRequest";
+  readonly RESOURCE_INACTIVE: "ResourceInactive";
+  readonly RESOURCE_NOT_FOUND: "ResourceNotFound";
+};
+export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
+export interface ErrorDetail {
+  errorMessage?: string;
+  errorCode?: ErrorCode;
+}
+export interface GetApplicationResponse {
+  displayName?: string;
+  applicationId?: string;
+  applicationArn?: string;
+  roleArn?: string;
+  status?: ApplicationStatus;
+  description?: string;
+  encryptionConfiguration?: EncryptionConfiguration;
+  createdAt?: Date;
+  updatedAt?: Date;
+  error?: ErrorDetail;
+  attachmentsConfiguration?: AppliedAttachmentsConfiguration;
+}
+export interface IndexCapacityConfiguration {
+  units?: number;
+}
+export interface CreateIndexRequest {
+  applicationId: string | undefined;
+  displayName: string | undefined;
+  description?: string;
+  tags?: Tag[];
+  capacityConfiguration?: IndexCapacityConfiguration;
+  clientToken?: string;
+}
+export interface CreateIndexResponse {
+  indexId?: string;
+  indexArn?: string;
+}
+export declare const DocumentEnrichmentConditionOperator: {
+  readonly BEGINS_WITH: "BEGINS_WITH";
+  readonly CONTAINS: "CONTAINS";
+  readonly EQUALS: "EQUALS";
+  readonly EXISTS: "EXISTS";
+  readonly GREATER_THAN: "GREATER_THAN";
+  readonly GREATER_THAN_OR_EQUALS: "GREATER_THAN_OR_EQUALS";
+  readonly LESS_THAN: "LESS_THAN";
+  readonly LESS_THAN_OR_EQUALS: "LESS_THAN_OR_EQUALS";
+  readonly NOT_CONTAINS: "NOT_CONTAINS";
+  readonly NOT_EQUALS: "NOT_EQUALS";
+  readonly NOT_EXISTS: "NOT_EXISTS";
+};
+export type DocumentEnrichmentConditionOperator =
+  (typeof DocumentEnrichmentConditionOperator)[keyof typeof DocumentEnrichmentConditionOperator];
+export type DocumentAttributeValue =
+  | DocumentAttributeValue.DateValueMember
+  | DocumentAttributeValue.LongValueMember
+  | DocumentAttributeValue.StringListValueMember
+  | DocumentAttributeValue.StringValueMember
+  | DocumentAttributeValue.$UnknownMember;
+export declare namespace DocumentAttributeValue {
+  interface StringValueMember {
+    stringValue: string;
+    stringListValue?: never;
+    longValue?: never;
+    dateValue?: never;
+    $unknown?: never;
+  }
+  interface StringListValueMember {
+    stringValue?: never;
+    stringListValue: string[];
+    longValue?: never;
+    dateValue?: never;
+    $unknown?: never;
+  }
+  interface LongValueMember {
+    stringValue?: never;
+    stringListValue?: never;
+    longValue: number;
+    dateValue?: never;
+    $unknown?: never;
+  }
+  interface DateValueMember {
+    stringValue?: never;
+    stringListValue?: never;
+    longValue?: never;
+    dateValue: Date;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    stringValue?: never;
+    stringListValue?: never;
+    longValue?: never;
+    dateValue?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    stringValue: (value: string) => T;
+    stringListValue: (value: string[]) => T;
+    longValue: (value: number) => T;
+    dateValue: (value: Date) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: DocumentAttributeValue, visitor: Visitor<T>) => T;
+}
+export interface DocumentAttributeCondition {
+  key: string | undefined;
+  operator: DocumentEnrichmentConditionOperator | undefined;
+  value?: DocumentAttributeValue;
+}
+export declare const DocumentContentOperator: {
+  readonly DELETE: "DELETE";
+};
+export type DocumentContentOperator =
+  (typeof DocumentContentOperator)[keyof typeof DocumentContentOperator];
+export declare const AttributeValueOperator: {
+  readonly DELETE: "DELETE";
+};
+export type AttributeValueOperator =
+  (typeof AttributeValueOperator)[keyof typeof AttributeValueOperator];
+export interface DocumentAttributeTarget {
+  key: string | undefined;
+  value?: DocumentAttributeValue;
+  attributeValueOperator?: AttributeValueOperator;
+}
+export interface InlineDocumentEnrichmentConfiguration {
+  condition?: DocumentAttributeCondition;
+  target?: DocumentAttributeTarget;
+  documentContentOperator?: DocumentContentOperator;
+}
+export interface HookConfiguration {
+  invocationCondition?: DocumentAttributeCondition;
+  lambdaArn?: string;
+  s3BucketName?: string;
+  roleArn?: string;
+}
+export interface DocumentEnrichmentConfiguration {
+  inlineConfigurations?: InlineDocumentEnrichmentConfiguration[];
+  preExtractionHookConfiguration?: HookConfiguration;
+  postExtractionHookConfiguration?: HookConfiguration;
+}
+export interface DataSourceVpcConfiguration {
+  subnetIds: string[] | undefined;
+  securityGroupIds: string[] | undefined;
+}
+export interface CreateDataSourceRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  displayName: string | undefined;
+  configuration: __DocumentType | undefined;
+  vpcConfiguration?: DataSourceVpcConfiguration;
+  description?: string;
+  tags?: Tag[];
+  syncSchedule?: string;
+  roleArn?: string;
+  clientToken?: string;
+  documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
+}
+export interface CreateDataSourceResponse {
+  dataSourceId?: string;
+  dataSourceArn?: string;
+}
+export interface DeleteDataSourceRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  dataSourceId: string | undefined;
+}
+export interface DeleteDataSourceResponse {}
+export interface GetDataSourceRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  dataSourceId: string | undefined;
+}
+export declare const DataSourceStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATING: "CREATING";
+  readonly DELETING: "DELETING";
+  readonly FAILED: "FAILED";
+  readonly PENDING_CREATION: "PENDING_CREATION";
+  readonly UPDATING: "UPDATING";
+};
+export type DataSourceStatus =
+  (typeof DataSourceStatus)[keyof typeof DataSourceStatus];
+export interface GetDataSourceResponse {
+  applicationId?: string;
+  indexId?: string;
+  dataSourceId?: string;
+  dataSourceArn?: string;
+  displayName?: string;
+  type?: string;
+  configuration?: __DocumentType;
+  vpcConfiguration?: DataSourceVpcConfiguration;
+  createdAt?: Date;
+  updatedAt?: Date;
+  description?: string;
+  status?: DataSourceStatus;
+  syncSchedule?: string;
+  roleArn?: string;
+  error?: ErrorDetail;
+  documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
+}
+export interface ListDataSourcesRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface DataSource {
+  displayName?: string;
+  dataSourceId?: string;
+  type?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+  status?: DataSourceStatus;
+}
+export interface ListDataSourcesResponse {
+  dataSources?: DataSource[];
+  nextToken?: string;
+}
+export interface UpdateDataSourceRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  dataSourceId: string | undefined;
+  displayName?: string;
+  configuration?: __DocumentType;
+  vpcConfiguration?: DataSourceVpcConfiguration;
+  description?: string;
+  syncSchedule?: string;
+  roleArn?: string;
+  documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
+}
+export interface UpdateDataSourceResponse {}
+export interface DeleteIndexRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+}
+export interface DeleteIndexResponse {}
+export interface GetIndexRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+}
+export declare const Status: {
+  readonly DISABLED: "DISABLED";
+  readonly ENABLED: "ENABLED";
+};
+export type Status = (typeof Status)[keyof typeof Status];
+export declare const AttributeType: {
+  readonly DATE: "DATE";
+  readonly NUMBER: "NUMBER";
+  readonly STRING: "STRING";
+  readonly STRING_LIST: "STRING_LIST";
+};
+export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
+export interface DocumentAttributeConfiguration {
+  name?: string;
+  type?: AttributeType;
+  search?: Status;
+}
+export interface TextDocumentStatistics {
+  indexedTextBytes?: number;
+  indexedTextDocumentCount?: number;
+}
+export interface IndexStatistics {
+  textDocumentStatistics?: TextDocumentStatistics;
+}
+export declare const IndexStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATING: "CREATING";
+  readonly DELETING: "DELETING";
+  readonly FAILED: "FAILED";
+  readonly UPDATING: "UPDATING";
+};
+export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
+export interface GetIndexResponse {
+  applicationId?: string;
+  indexId?: string;
+  displayName?: string;
+  indexArn?: string;
+  status?: IndexStatus;
+  description?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+  capacityConfiguration?: IndexCapacityConfiguration;
+  documentAttributeConfigurations?: DocumentAttributeConfiguration[];
+  error?: ErrorDetail;
+  indexStatistics?: IndexStatistics;
+}
+export interface ListIndicesRequest {
+  applicationId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface Index {
+  displayName?: string;
+  indexId?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+  status?: IndexStatus;
+}
+export interface ListIndicesResponse {
+  nextToken?: string;
+  indices?: Index[];
+}
+export interface UpdateIndexRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  displayName?: string;
+  description?: string;
+  capacityConfiguration?: IndexCapacityConfiguration;
+  documentAttributeConfigurations?: DocumentAttributeConfiguration[];
+}
+export interface UpdateIndexResponse {}
+export interface ListApplicationsRequest {
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface ListApplicationsResponse {
+  nextToken?: string;
+  applications?: Application[];
+}
+export interface BasicAuthConfiguration {
+  secretArn: string | undefined;
+  roleArn: string | undefined;
+}
+export interface OAuth2ClientCredentialConfiguration {
+  secretArn: string | undefined;
+  roleArn: string | undefined;
+}
+export type PluginAuthConfiguration =
+  | PluginAuthConfiguration.BasicAuthConfigurationMember
+  | PluginAuthConfiguration.OAuth2ClientCredentialConfigurationMember
+  | PluginAuthConfiguration.$UnknownMember;
+export declare namespace PluginAuthConfiguration {
+  interface BasicAuthConfigurationMember {
+    basicAuthConfiguration: BasicAuthConfiguration;
+    oAuth2ClientCredentialConfiguration?: never;
+    $unknown?: never;
+  }
+  interface OAuth2ClientCredentialConfigurationMember {
+    basicAuthConfiguration?: never;
+    oAuth2ClientCredentialConfiguration: OAuth2ClientCredentialConfiguration;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    basicAuthConfiguration?: never;
+    oAuth2ClientCredentialConfiguration?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    basicAuthConfiguration: (value: BasicAuthConfiguration) => T;
+    oAuth2ClientCredentialConfiguration: (
+      value: OAuth2ClientCredentialConfiguration
+    ) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: PluginAuthConfiguration, visitor: Visitor<T>) => T;
+}
+export interface CreatePluginRequest {
+  applicationId: string | undefined;
+  displayName: string | undefined;
+  type: PluginType | undefined;
+  serverUrl: string | undefined;
+  authConfiguration: PluginAuthConfiguration | undefined;
+  tags?: Tag[];
+  clientToken?: string;
+}
+export interface CreatePluginResponse {
+  pluginId?: string;
+  pluginArn?: string;
+}
+export interface DeletePluginRequest {
+  applicationId: string | undefined;
+  pluginId: string | undefined;
+}
+export interface DeletePluginResponse {}
+export interface GetPluginRequest {
+  applicationId: string | undefined;
+  pluginId: string | undefined;
+}
+export declare const PluginState: {
+  readonly DISABLED: "DISABLED";
+  readonly ENABLED: "ENABLED";
+};
+export type PluginState = (typeof PluginState)[keyof typeof PluginState];
+export interface GetPluginResponse {
+  applicationId?: string;
+  pluginId?: string;
+  displayName?: string;
+  type?: PluginType;
+  serverUrl?: string;
+  authConfiguration?: PluginAuthConfiguration;
+  pluginArn?: string;
+  state?: PluginState;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+export interface ListPluginsRequest {
+  applicationId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface Plugin {
+  pluginId?: string;
+  displayName?: string;
+  type?: PluginType;
+  serverUrl?: string;
+  state?: PluginState;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+export interface ListPluginsResponse {
+  nextToken?: string;
+  plugins?: Plugin[];
+}
+export interface UpdatePluginRequest {
+  applicationId: string | undefined;
+  pluginId: string | undefined;
+  displayName?: string;
+  state?: PluginState;
+  serverUrl?: string;
+  authConfiguration?: PluginAuthConfiguration;
+}
+export interface UpdatePluginResponse {}
+export interface KendraIndexConfiguration {
+  indexId: string | undefined;
+}
+export interface NativeIndexConfiguration {
+  indexId: string | undefined;
+}
+export type RetrieverConfiguration =
+  | RetrieverConfiguration.KendraIndexConfigurationMember
+  | RetrieverConfiguration.NativeIndexConfigurationMember
+  | RetrieverConfiguration.$UnknownMember;
+export declare namespace RetrieverConfiguration {
+  interface NativeIndexConfigurationMember {
+    nativeIndexConfiguration: NativeIndexConfiguration;
+    kendraIndexConfiguration?: never;
+    $unknown?: never;
+  }
+  interface KendraIndexConfigurationMember {
+    nativeIndexConfiguration?: never;
+    kendraIndexConfiguration: KendraIndexConfiguration;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    nativeIndexConfiguration?: never;
+    kendraIndexConfiguration?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    nativeIndexConfiguration: (value: NativeIndexConfiguration) => T;
+    kendraIndexConfiguration: (value: KendraIndexConfiguration) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: RetrieverConfiguration, visitor: Visitor<T>) => T;
+}
+export declare const RetrieverType: {
+  readonly KENDRA_INDEX: "KENDRA_INDEX";
+  readonly NATIVE_INDEX: "NATIVE_INDEX";
+};
+export type RetrieverType = (typeof RetrieverType)[keyof typeof RetrieverType];
+export interface CreateRetrieverRequest {
+  applicationId: string | undefined;
+  type: RetrieverType | undefined;
+  displayName: string | undefined;
+  configuration: RetrieverConfiguration | undefined;
+  roleArn?: string;
+  clientToken?: string;
+  tags?: Tag[];
+}
+export interface CreateRetrieverResponse {
+  retrieverId?: string;
+  retrieverArn?: string;
+}
+export interface DeleteRetrieverRequest {
+  applicationId: string | undefined;
+  retrieverId: string | undefined;
+}
+export interface DeleteRetrieverResponse {}
+export interface GetRetrieverRequest {
+  applicationId: string | undefined;
+  retrieverId: string | undefined;
+}
+export declare const RetrieverStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATING: "CREATING";
+  readonly FAILED: "FAILED";
+};
+export type RetrieverStatus =
+  (typeof RetrieverStatus)[keyof typeof RetrieverStatus];
+export interface GetRetrieverResponse {
+  applicationId?: string;
+  retrieverId?: string;
+  retrieverArn?: string;
+  type?: RetrieverType;
+  status?: RetrieverStatus;
+  displayName?: string;
+  configuration?: RetrieverConfiguration;
+  roleArn?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+export interface ListRetrieversRequest {
+  applicationId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface Retriever {
+  applicationId?: string;
+  retrieverId?: string;
+  type?: RetrieverType;
+  status?: RetrieverStatus;
+  displayName?: string;
+}
+export interface ListRetrieversResponse {
+  retrievers?: Retriever[];
+  nextToken?: string;
+}
+export interface UpdateRetrieverRequest {
+  applicationId: string | undefined;
+  retrieverId: string | undefined;
+  configuration?: RetrieverConfiguration;
+  displayName?: string;
+  roleArn?: string;
+}
+export interface UpdateRetrieverResponse {}
+export interface UpdateApplicationRequest {
+  applicationId: string | undefined;
+  displayName?: string;
+  description?: string;
+  roleArn?: string;
+  attachmentsConfiguration?: AttachmentsConfiguration;
+}
+export interface UpdateApplicationResponse {}
+export declare const WebExperienceSamplePromptsControlMode: {
+  readonly DISABLED: "DISABLED";
+  readonly ENABLED: "ENABLED";
+};
+export type WebExperienceSamplePromptsControlMode =
+  (typeof WebExperienceSamplePromptsControlMode)[keyof typeof WebExperienceSamplePromptsControlMode];
+export interface CreateWebExperienceRequest {
+  applicationId: string | undefined;
+  title?: string;
+  subtitle?: string;
+  welcomeMessage?: string;
+  samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
+  tags?: Tag[];
+  clientToken?: string;
+}
+export interface CreateWebExperienceResponse {
+  webExperienceId?: string;
+  webExperienceArn?: string;
+}
+export interface DeleteWebExperienceRequest {
+  applicationId: string | undefined;
+  webExperienceId: string | undefined;
+}
+export interface DeleteWebExperienceResponse {}
+export interface GetWebExperienceRequest {
+  applicationId: string | undefined;
+  webExperienceId: string | undefined;
+}
+export interface SamlConfiguration {
+  metadataXML: string | undefined;
+  roleArn: string | undefined;
+  userIdAttribute: string | undefined;
+  userGroupAttribute?: string;
+}
+export type WebExperienceAuthConfiguration =
+  | WebExperienceAuthConfiguration.SamlConfigurationMember
+  | WebExperienceAuthConfiguration.$UnknownMember;
+export declare namespace WebExperienceAuthConfiguration {
+  interface SamlConfigurationMember {
+    samlConfiguration: SamlConfiguration;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    samlConfiguration?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    samlConfiguration: (value: SamlConfiguration) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(
+    value: WebExperienceAuthConfiguration,
+    visitor: Visitor<T>
+  ) => T;
+}
+export declare const WebExperienceStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATING: "CREATING";
+  readonly DELETING: "DELETING";
+  readonly FAILED: "FAILED";
+  readonly PENDING_AUTH_CONFIG: "PENDING_AUTH_CONFIG";
+};
+export type WebExperienceStatus =
+  (typeof WebExperienceStatus)[keyof typeof WebExperienceStatus];
+export interface GetWebExperienceResponse {
+  applicationId?: string;
+  webExperienceId?: string;
+  webExperienceArn?: string;
+  defaultEndpoint?: string;
+  status?: WebExperienceStatus;
+  createdAt?: Date;
+  updatedAt?: Date;
+  title?: string;
+  subtitle?: string;
+  welcomeMessage?: string;
+  samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
+  authenticationConfiguration?: WebExperienceAuthConfiguration;
+  error?: ErrorDetail;
+}
+export interface ListWebExperiencesRequest {
+  applicationId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface WebExperience {
+  webExperienceId?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+  defaultEndpoint?: string;
+  status?: WebExperienceStatus;
+}
+export interface ListWebExperiencesResponse {
+  webExperiences?: WebExperience[];
+  nextToken?: string;
+}
+export interface UpdateWebExperienceRequest {
+  applicationId: string | undefined;
+  webExperienceId: string | undefined;
+  authenticationConfiguration?: WebExperienceAuthConfiguration;
+  title?: string;
+  subtitle?: string;
+  welcomeMessage?: string;
+  samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
+}
+export interface UpdateWebExperienceResponse {}
+export interface AttachmentInput {
+  name: string | undefined;
+  data: Uint8Array | undefined;
+}
+export declare const AttachmentStatus: {
+  readonly FAILED: "FAILED";
+  readonly SUCCEEDED: "SUCCEEDED";
+};
+export type AttachmentStatus =
+  (typeof AttachmentStatus)[keyof typeof AttachmentStatus];
+export interface AttachmentOutput {
+  name?: string;
+  status?: AttachmentStatus;
+  error?: ErrorDetail;
+}
+export interface DocumentAttribute {
+  name: string | undefined;
+  value: DocumentAttributeValue | undefined;
+}
+export interface DeleteDocument {
+  documentId: string | undefined;
+}
+export interface BatchDeleteDocumentRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  documents: DeleteDocument[] | undefined;
+  dataSourceSyncId?: string;
+}
+export interface FailedDocument {
+  id?: string;
+  error?: ErrorDetail;
+  dataSourceId?: string;
+}
+export interface BatchDeleteDocumentResponse {
+  failedDocuments?: FailedDocument[];
+}
+export interface S3 {
+  bucket: string | undefined;
+  key: string | undefined;
+}
+export type DocumentContent =
+  | DocumentContent.BlobMember
+  | DocumentContent.S3Member
+  | DocumentContent.$UnknownMember;
+export declare namespace DocumentContent {
+  interface BlobMember {
+    blob: Uint8Array;
+    s3?: never;
+    $unknown?: never;
+  }
+  interface S3Member {
+    blob?: never;
+    s3: S3;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    blob?: never;
+    s3?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    blob: (value: Uint8Array) => T;
+    s3: (value: S3) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: DocumentContent, visitor: Visitor<T>) => T;
+}
+export declare const ContentType: {
+  readonly CSV: "CSV";
+  readonly HTML: "HTML";
+  readonly JSON: "JSON";
+  readonly MD: "MD";
+  readonly MS_EXCEL: "MS_EXCEL";
+  readonly MS_WORD: "MS_WORD";
+  readonly PDF: "PDF";
+  readonly PLAIN_TEXT: "PLAIN_TEXT";
+  readonly PPT: "PPT";
+  readonly RTF: "RTF";
+  readonly XML: "XML";
+  readonly XSLT: "XSLT";
+};
+export type ContentType = (typeof ContentType)[keyof typeof ContentType];
+export interface Document {
+  id: string | undefined;
+  attributes?: DocumentAttribute[];
+  content?: DocumentContent;
+  contentType?: ContentType;
+  title?: string;
+  accessConfiguration?: AccessConfiguration;
+  documentEnrichmentConfiguration?: DocumentEnrichmentConfiguration;
+}
+export interface BatchPutDocumentRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  documents: Document[] | undefined;
+  roleArn?: string;
+  dataSourceSyncId?: string;
+}
+export interface BatchPutDocumentResponse {
+  failedDocuments?: FailedDocument[];
+}
+export interface BlockedPhrasesConfiguration {
+  blockedPhrases?: string[];
+  systemMessageOverride?: string;
+}
+export interface BlockedPhrasesConfigurationUpdate {
+  blockedPhrasesToCreateOrUpdate?: string[];
+  blockedPhrasesToDelete?: string[];
+  systemMessageOverride?: string;
+}
+export interface TextSegment {
+  beginOffset?: number;
+  endOffset?: number;
+}
+export interface SourceAttribution {
+  title?: string;
+  snippet?: string;
+  url?: string;
+  citationNumber?: number;
+  updatedAt?: Date;
+  textMessageSegments?: TextSegment[];
+}
+export interface ChatSyncOutput {
+  conversationId?: string;
+  systemMessage?: string;
+  systemMessageId?: string;
+  userMessageId?: string;
+  actionReview?: ActionReview;
+  sourceAttributions?: SourceAttribution[];
+  failedAttachments?: AttachmentOutput[];
+}
+export declare class LicenseNotFoundException extends __BaseException {
+  readonly name: "LicenseNotFoundException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<LicenseNotFoundException, __BaseException>
+  );
+}
+export interface ContentBlockerRule {
+  systemMessageOverride?: string;
+}
+export interface EligibleDataSource {
+  indexId?: string;
+  dataSourceId?: string;
+}
+export interface ContentRetrievalRule {
+  eligibleDataSources?: EligibleDataSource[];
+}
+export interface Conversation {
+  conversationId?: string;
+  title?: string;
+  startTime?: Date;
+}
+export interface UserAlias {
+  indexId?: string;
+  dataSourceId?: string;
+  userId: string | undefined;
+}
+export interface CreateUserRequest {
+  applicationId: string | undefined;
+  userId: string | undefined;
+  userAliases?: UserAlias[];
+  clientToken?: string;
+}
+export interface CreateUserResponse {}
+export interface DataSourceSyncJobMetrics {
+  documentsAdded?: string;
+  documentsModified?: string;
+  documentsDeleted?: string;
+  documentsFailed?: string;
+  documentsScanned?: string;
+}
+export declare const DataSourceSyncJobStatus: {
+  readonly ABORTED: "ABORTED";
+  readonly FAILED: "FAILED";
+  readonly INCOMPLETE: "INCOMPLETE";
+  readonly STOPPING: "STOPPING";
+  readonly SUCCEEDED: "SUCCEEDED";
+  readonly SYNCING: "SYNCING";
+  readonly SYNCING_INDEXING: "SYNCING_INDEXING";
+};
+export type DataSourceSyncJobStatus =
+  (typeof DataSourceSyncJobStatus)[keyof typeof DataSourceSyncJobStatus];
+export interface DataSourceSyncJob {
+  executionId?: string;
+  startTime?: Date;
+  endTime?: Date;
+  status?: DataSourceSyncJobStatus;
+  error?: ErrorDetail;
+  dataSourceErrorCode?: string;
+  metrics?: DataSourceSyncJobMetrics;
+}
+export interface DeleteChatControlsConfigurationRequest {
+  applicationId: string | undefined;
+}
+export interface DeleteChatControlsConfigurationResponse {}
+export interface DeleteConversationRequest {
+  conversationId: string | undefined;
+  applicationId: string | undefined;
+  userId: string | undefined;
+}
+export interface DeleteConversationResponse {}
+export interface DeleteGroupRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  groupName: string | undefined;
+  dataSourceId?: string;
+}
+export interface DeleteGroupResponse {}
+export interface DeleteUserRequest {
+  applicationId: string | undefined;
+  userId: string | undefined;
+}
+export interface DeleteUserResponse {}
+export declare const DocumentStatus: {
+  readonly DELETED: "DELETED";
+  readonly DELETING: "DELETING";
+  readonly DOCUMENT_FAILED_TO_INDEX: "DOCUMENT_FAILED_TO_INDEX";
+  readonly FAILED: "FAILED";
+  readonly INDEXED: "INDEXED";
+  readonly PROCESSING: "PROCESSING";
+  readonly RECEIVED: "RECEIVED";
+  readonly UPDATED: "UPDATED";
+};
+export type DocumentStatus =
+  (typeof DocumentStatus)[keyof typeof DocumentStatus];
+export interface DocumentDetails {
+  documentId?: string;
+  status?: DocumentStatus;
+  error?: ErrorDetail;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+export interface GetChatControlsConfigurationRequest {
+  applicationId: string | undefined;
+  maxResults?: number;
+  nextToken?: string;
+}
+export declare const ResponseScope: {
+  readonly ENTERPRISE_CONTENT_ONLY: "ENTERPRISE_CONTENT_ONLY";
+  readonly EXTENDED_KNOWLEDGE_ENABLED: "EXTENDED_KNOWLEDGE_ENABLED";
+};
+export type ResponseScope = (typeof ResponseScope)[keyof typeof ResponseScope];
+export interface UsersAndGroups {
+  userIds?: string[];
+  userGroups?: string[];
+}
+export type RuleConfiguration =
+  | RuleConfiguration.ContentBlockerRuleMember
+  | RuleConfiguration.ContentRetrievalRuleMember
+  | RuleConfiguration.$UnknownMember;
+export declare namespace RuleConfiguration {
+  interface ContentBlockerRuleMember {
+    contentBlockerRule: ContentBlockerRule;
+    contentRetrievalRule?: never;
+    $unknown?: never;
+  }
+  interface ContentRetrievalRuleMember {
+    contentBlockerRule?: never;
+    contentRetrievalRule: ContentRetrievalRule;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    contentBlockerRule?: never;
+    contentRetrievalRule?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    contentBlockerRule: (value: ContentBlockerRule) => T;
+    contentRetrievalRule: (value: ContentRetrievalRule) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: RuleConfiguration, visitor: Visitor<T>) => T;
+}
+export declare const RuleType: {
+  readonly CONTENT_BLOCKER_RULE: "CONTENT_BLOCKER_RULE";
+  readonly CONTENT_RETRIEVAL_RULE: "CONTENT_RETRIEVAL_RULE";
+};
+export type RuleType = (typeof RuleType)[keyof typeof RuleType];
+export interface Rule {
+  includedUsersAndGroups?: UsersAndGroups;
+  excludedUsersAndGroups?: UsersAndGroups;
+  ruleType: RuleType | undefined;
+  ruleConfiguration?: RuleConfiguration;
+}
+export interface TopicConfiguration {
+  name: string | undefined;
+  description?: string;
+  exampleChatMessages?: string[];
+  rules: Rule[] | undefined;
+}
+export interface GetChatControlsConfigurationResponse {
+  responseScope?: ResponseScope;
+  blockedPhrases?: BlockedPhrasesConfiguration;
+  topicConfigurations?: TopicConfiguration[];
+  nextToken?: string;
+}
+export interface GetGroupRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  groupName: string | undefined;
+  dataSourceId?: string;
+}
+export declare const GroupStatus: {
+  readonly DELETED: "DELETED";
+  readonly DELETING: "DELETING";
+  readonly FAILED: "FAILED";
+  readonly PROCESSING: "PROCESSING";
+  readonly SUCCEEDED: "SUCCEEDED";
+};
+export type GroupStatus = (typeof GroupStatus)[keyof typeof GroupStatus];
+export interface GroupStatusDetail {
+  status?: GroupStatus;
+  lastUpdatedAt?: Date;
+  errorDetail?: ErrorDetail;
+}
+export interface GetGroupResponse {
+  status?: GroupStatusDetail;
+  statusHistory?: GroupStatusDetail[];
+}
+export interface GetUserRequest {
+  applicationId: string | undefined;
+  userId: string | undefined;
+}
+export interface GetUserResponse {
+  userAliases?: UserAlias[];
+}
+export interface ListConversationsRequest {
+  applicationId: string | undefined;
+  userId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface ListConversationsResponse {
+  nextToken?: string;
+  conversations?: Conversation[];
+}
+export interface ListDataSourceSyncJobsRequest {
+  dataSourceId: string | undefined;
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+  startTime?: Date;
+  endTime?: Date;
+  statusFilter?: DataSourceSyncJobStatus;
+}
+export interface ListDataSourceSyncJobsResponse {
+  history?: DataSourceSyncJob[];
+  nextToken?: string;
+}
+export interface ListDocumentsRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  dataSourceIds?: string[];
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface ListDocumentsResponse {
+  documentDetailList?: DocumentDetails[];
+  nextToken?: string;
+}
+export interface ListGroupsRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  updatedEarlierThan: Date | undefined;
+  dataSourceId?: string;
+  nextToken?: string;
+  maxResults?: number;
+}
+export interface GroupSummary {
+  groupName?: string;
+}
+export interface ListGroupsResponse {
+  nextToken?: string;
+  items?: GroupSummary[];
+}
+export interface ListMessagesRequest {
+  conversationId: string | undefined;
+  applicationId: string | undefined;
+  userId: string | undefined;
+  nextToken?: string;
+  maxResults?: number;
+}
+export declare const MessageType: {
+  readonly SYSTEM: "SYSTEM";
+  readonly USER: "USER";
+};
+export type MessageType = (typeof MessageType)[keyof typeof MessageType];
+export interface Message {
+  messageId?: string;
+  body?: string;
+  time?: Date;
+  type?: MessageType;
+  attachments?: AttachmentOutput[];
+  sourceAttribution?: SourceAttribution[];
+  actionReview?: ActionReview;
+  actionExecution?: ActionExecution;
+}
+export interface ListMessagesResponse {
+  messages?: Message[];
+  nextToken?: string;
+}
+export interface ListTagsForResourceRequest {
+  resourceARN: string | undefined;
+}
+export interface ListTagsForResourceResponse {
+  tags?: Tag[];
+}
+export declare const MessageUsefulnessReason: {
+  readonly COMPLETE: "COMPLETE";
+  readonly FACTUALLY_CORRECT: "FACTUALLY_CORRECT";
+  readonly HARMFUL_OR_UNSAFE: "HARMFUL_OR_UNSAFE";
+  readonly HELPFUL: "HELPFUL";
+  readonly INCORRECT_OR_MISSING_SOURCES: "INCORRECT_OR_MISSING_SOURCES";
+  readonly NOT_FACTUALLY_CORRECT: "NOT_FACTUALLY_CORRECT";
+  readonly NOT_HELPFUL: "NOT_HELPFUL";
+  readonly RELEVANT_SOURCES: "RELEVANT_SOURCES";
+};
+export type MessageUsefulnessReason =
+  (typeof MessageUsefulnessReason)[keyof typeof MessageUsefulnessReason];
+export declare const MessageUsefulness: {
+  readonly NOT_USEFUL: "NOT_USEFUL";
+  readonly USEFUL: "USEFUL";
+};
+export type MessageUsefulness =
+  (typeof MessageUsefulness)[keyof typeof MessageUsefulness];
+export interface MessageUsefulnessFeedback {
+  usefulness: MessageUsefulness | undefined;
+  reason?: MessageUsefulnessReason;
+  comment?: string;
+  submittedAt: Date | undefined;
+}
+export interface PutFeedbackRequest {
+  applicationId: string | undefined;
+  userId: string | undefined;
+  conversationId: string | undefined;
+  messageId: string | undefined;
+  messageCopiedAt?: Date;
+  messageUsefulness?: MessageUsefulnessFeedback;
+}
+export interface MemberGroup {
+  groupName: string | undefined;
+  type?: MembershipType;
+}
+export interface MemberUser {
+  userId: string | undefined;
+  type?: MembershipType;
+}
+export interface GroupMembers {
+  memberGroups?: MemberGroup[];
+  memberUsers?: MemberUser[];
+}
+export interface PutGroupRequest {
+  applicationId: string | undefined;
+  indexId: string | undefined;
+  groupName: string | undefined;
+  dataSourceId?: string;
+  type: MembershipType | undefined;
+  groupMembers: GroupMembers | undefined;
+}
+export interface PutGroupResponse {}
+export interface StartDataSourceSyncJobRequest {
+  dataSourceId: string | undefined;
+  applicationId: string | undefined;
+  indexId: string | undefined;
+}
+export interface StartDataSourceSyncJobResponse {
+  executionId?: string;
+}
+export interface StopDataSourceSyncJobRequest {
+  dataSourceId: string | undefined;
+  applicationId: string | undefined;
+  indexId: string | undefined;
+}
+export interface StopDataSourceSyncJobResponse {}
+export interface TagResourceRequest {
+  resourceARN: string | undefined;
+  tags: Tag[] | undefined;
+}
+export interface TagResourceResponse {}
+export interface UntagResourceRequest {
+  resourceARN: string | undefined;
+  tagKeys: string[] | undefined;
+}
+export interface UntagResourceResponse {}
+export interface UpdateChatControlsConfigurationRequest {
+  applicationId: string | undefined;
+  clientToken?: string;
+  responseScope?: ResponseScope;
+  blockedPhrasesConfigurationUpdate?: BlockedPhrasesConfigurationUpdate;
+  topicConfigurationsToCreateOrUpdate?: TopicConfiguration[];
+  topicConfigurationsToDelete?: TopicConfiguration[];
+}
+export interface UpdateChatControlsConfigurationResponse {}
+export interface UpdateUserRequest {
+  applicationId: string | undefined;
+  userId: string | undefined;
+  userAliasesToUpdate?: UserAlias[];
+  userAliasesToDelete?: UserAlias[];
+}
+export interface UpdateUserResponse {
+  userAliasesAdded?: UserAlias[];
+  userAliasesUpdated?: UserAlias[];
+  userAliasesDeleted?: UserAlias[];
+}
+export interface AttributeFilter {
+  andAllFilters?: AttributeFilter[];
+  orAllFilters?: AttributeFilter[];
+  notFilter?: AttributeFilter;
+  equalsTo?: DocumentAttribute;
+  containsAll?: DocumentAttribute;
+  containsAny?: DocumentAttribute;
+  greaterThan?: DocumentAttribute;
+  greaterThanOrEquals?: DocumentAttribute;
+  lessThan?: DocumentAttribute;
+  lessThanOrEquals?: DocumentAttribute;
+}
+export interface ChatSyncInput {
+  applicationId: string | undefined;
+  userId: string | undefined;
+  userGroups?: string[];
+  userMessage?: string;
+  attachments?: AttachmentInput[];
+  actionExecution?: ActionExecution;
+  conversationId?: string;
+  parentMessageId?: string;
+  attributeFilter?: AttributeFilter;
+  clientToken?: string;
+}
+export declare const EncryptionConfigurationFilterSensitiveLog: (
+  obj: EncryptionConfiguration
+) => any;
+export declare const CreateApplicationRequestFilterSensitiveLog: (
+  obj: CreateApplicationRequest
+) => any;
+export declare const GetApplicationResponseFilterSensitiveLog: (
+  obj: GetApplicationResponse
+) => any;