@aws-sdk/client-qapps 3.612.0

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

@@ -0,0 +1,681 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
+import { QAppsServiceException as __BaseException } from "./QAppsServiceException";
+export declare class AccessDeniedException extends __BaseException {
+  readonly name: "AccessDeniedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
+  );
+}
+export declare const CardType: {
+  readonly FILE_UPLOAD: "file-upload";
+  readonly Q_PLUGIN: "q-plugin";
+  readonly Q_QUERY: "q-query";
+  readonly TEXT_INPUT: "text-input";
+};
+export type CardType = (typeof CardType)[keyof typeof CardType];
+export interface FileUploadCard {
+  id: string | undefined;
+  title: string | undefined;
+  dependencies: string[] | undefined;
+  type: CardType | undefined;
+  filename?: string;
+  fileId?: string;
+  allowOverride?: boolean;
+}
+export declare const PluginType: {
+  readonly CUSTOM: "CUSTOM";
+  readonly JIRA: "JIRA";
+  readonly SALESFORCE: "SALESFORCE";
+  readonly SERVICE_NOW: "SERVICE_NOW";
+  readonly ZENDESK: "ZENDESK";
+};
+export type PluginType = (typeof PluginType)[keyof typeof PluginType];
+export interface QPluginCard {
+  id: string | undefined;
+  title: string | undefined;
+  dependencies: string[] | undefined;
+  type: CardType | undefined;
+  prompt: string | undefined;
+  pluginType: PluginType | undefined;
+  pluginId: string | undefined;
+}
+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 DocumentAttribute {
+  name: string | undefined;
+  value: DocumentAttributeValue | undefined;
+}
+export declare const CardOutputSource: {
+  readonly APPROVED_SOURCES: "approved-sources";
+  readonly LLM: "llm";
+};
+export type CardOutputSource =
+  (typeof CardOutputSource)[keyof typeof CardOutputSource];
+export interface TextInputCard {
+  id: string | undefined;
+  title: string | undefined;
+  dependencies: string[] | undefined;
+  type: CardType | undefined;
+  placeholder?: string;
+  defaultValue?: string;
+}
+export interface FileUploadCardInput {
+  title: string | undefined;
+  id: string | undefined;
+  type: CardType | undefined;
+  filename?: string;
+  fileId?: string;
+  allowOverride?: boolean;
+}
+export interface QPluginCardInput {
+  title: string | undefined;
+  id: string | undefined;
+  type: CardType | undefined;
+  prompt: string | undefined;
+  pluginId: string | undefined;
+}
+export interface TextInputCardInput {
+  title: string | undefined;
+  id: string | undefined;
+  type: CardType | undefined;
+  placeholder?: string;
+  defaultValue?: string;
+}
+export declare const AppRequiredCapability: {
+  readonly CREATOR_MODE: "CreatorMode";
+  readonly FILE_UPLOAD: "FileUpload";
+  readonly PLUGIN_MODE: "PluginMode";
+  readonly RETRIEVAL_MODE: "RetrievalMode";
+};
+export type AppRequiredCapability =
+  (typeof AppRequiredCapability)[keyof typeof AppRequiredCapability];
+export declare const AppStatus: {
+  readonly DELETED: "DELETED";
+  readonly DRAFT: "DRAFT";
+  readonly PUBLISHED: "PUBLISHED";
+};
+export type AppStatus = (typeof AppStatus)[keyof typeof AppStatus];
+export interface AssociateLibraryItemReviewInput {
+  instanceId: string | undefined;
+  libraryItemId: string | undefined;
+}
+export declare class InternalServerException extends __BaseException {
+  readonly name: "InternalServerException";
+  readonly $fault: "server";
+  $retryable: {};
+  retryAfterSeconds?: number;
+  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;
+  serviceCode: string | undefined;
+  quotaCode: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
+  );
+}
+export declare class ThrottlingException extends __BaseException {
+  readonly name: "ThrottlingException";
+  readonly $fault: "client";
+  $retryable: {
+    throttling: boolean;
+  };
+  serviceCode: string | undefined;
+  quotaCode: string | undefined;
+  retryAfterSeconds?: number;
+  constructor(
+    opts: __ExceptionOptionType<ThrottlingException, __BaseException>
+  );
+}
+export declare class UnauthorizedException extends __BaseException {
+  readonly name: "UnauthorizedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<UnauthorizedException, __BaseException>
+  );
+}
+export declare class ValidationException extends __BaseException {
+  readonly name: "ValidationException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ValidationException, __BaseException>
+  );
+}
+export interface AssociateQAppWithUserInput {
+  instanceId: string | undefined;
+  appId: string | undefined;
+}
+export declare const ExecutionStatus: {
+  readonly COMPLETED: "COMPLETED";
+  readonly IN_PROGRESS: "IN_PROGRESS";
+  readonly WAITING: "WAITING";
+};
+export type ExecutionStatus =
+  (typeof ExecutionStatus)[keyof typeof ExecutionStatus];
+export interface CardStatus {
+  currentState: ExecutionStatus | undefined;
+  currentValue: string | undefined;
+}
+export interface CardValue {
+  cardId: string | undefined;
+  value: string | undefined;
+}
+export interface Category {
+  id: string | undefined;
+  title: string | undefined;
+}
+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 class ContentTooLargeException extends __BaseException {
+  readonly name: "ContentTooLargeException";
+  readonly $fault: "client";
+  resourceId: string | undefined;
+  resourceType: string | undefined;
+  constructor(
+    opts: __ExceptionOptionType<ContentTooLargeException, __BaseException>
+  );
+}
+export declare const Sender: {
+  readonly SYSTEM: "SYSTEM";
+  readonly USER: "USER";
+};
+export type Sender = (typeof Sender)[keyof typeof Sender];
+export interface ConversationMessage {
+  body: string | undefined;
+  type: Sender | undefined;
+}
+export interface CreateLibraryItemInput {
+  instanceId: string | undefined;
+  appId: string | undefined;
+  appVersion: number | undefined;
+  categories: string[] | undefined;
+}
+export interface CreateLibraryItemOutput {
+  libraryItemId: string | undefined;
+  status: string | undefined;
+  createdAt: Date | undefined;
+  createdBy: string | undefined;
+  updatedAt?: Date;
+  updatedBy?: string;
+  ratingCount: number | undefined;
+}
+export interface CreateQAppOutput {
+  appId: string | undefined;
+  appArn: string | undefined;
+  title: string | undefined;
+  description?: string;
+  initialPrompt?: string;
+  appVersion: number | undefined;
+  status: AppStatus | undefined;
+  createdAt: Date | undefined;
+  createdBy: string | undefined;
+  updatedAt: Date | undefined;
+  updatedBy: string | undefined;
+  requiredCapabilities?: AppRequiredCapability[];
+}
+export interface DeleteLibraryItemInput {
+  instanceId: string | undefined;
+  libraryItemId: string | undefined;
+}
+export interface DeleteQAppInput {
+  instanceId: string | undefined;
+  appId: string | undefined;
+}
+export interface DisassociateLibraryItemReviewInput {
+  instanceId: string | undefined;
+  libraryItemId: string | undefined;
+}
+export interface DisassociateQAppFromUserInput {
+  instanceId: string | undefined;
+  appId: string | undefined;
+}
+export declare const DocumentScope: {
+  readonly APPLICATION: "APPLICATION";
+  readonly SESSION: "SESSION";
+};
+export type DocumentScope = (typeof DocumentScope)[keyof typeof DocumentScope];
+export interface GetLibraryItemInput {
+  instanceId: string | undefined;
+  libraryItemId: string | undefined;
+  appId?: string;
+}
+export interface GetLibraryItemOutput {
+  libraryItemId: string | undefined;
+  appId: string | undefined;
+  appVersion: number | undefined;
+  categories: Category[] | undefined;
+  status: string | undefined;
+  createdAt: Date | undefined;
+  createdBy: string | undefined;
+  updatedAt?: Date;
+  updatedBy?: string;
+  ratingCount: number | undefined;
+  isRatedByUser?: boolean;
+  userCount?: number;
+}
+export interface GetQAppInput {
+  instanceId: string | undefined;
+  appId: string | undefined;
+}
+export interface GetQAppSessionInput {
+  instanceId: string | undefined;
+  sessionId: string | undefined;
+}
+export interface GetQAppSessionOutput {
+  sessionId: string | undefined;
+  sessionArn: string | undefined;
+  status: ExecutionStatus | undefined;
+  cardStatus: Record<string, CardStatus> | undefined;
+}
+export interface ImportDocumentInput {
+  instanceId: string | undefined;
+  cardId: string | undefined;
+  appId: string | undefined;
+  fileContentsBase64: string | undefined;
+  fileName: string | undefined;
+  scope: DocumentScope | undefined;
+  sessionId?: string;
+}
+export interface ImportDocumentOutput {
+  fileId?: string;
+}
+export interface LibraryItemMember {
+  libraryItemId: string | undefined;
+  appId: string | undefined;
+  appVersion: number | undefined;
+  categories: Category[] | undefined;
+  status: string | undefined;
+  createdAt: Date | undefined;
+  createdBy: string | undefined;
+  updatedAt?: Date;
+  updatedBy?: string;
+  ratingCount: number | undefined;
+  isRatedByUser?: boolean;
+  userCount?: number;
+}
+export declare const LibraryItemStatus: {
+  readonly DISABLED: "DISABLED";
+  readonly PUBLISHED: "PUBLISHED";
+};
+export type LibraryItemStatus =
+  (typeof LibraryItemStatus)[keyof typeof LibraryItemStatus];
+export interface ListLibraryItemsInput {
+  instanceId: string | undefined;
+  limit?: number;
+  nextToken?: string;
+  categoryId?: string;
+}
+export interface ListLibraryItemsOutput {
+  libraryItems?: LibraryItemMember[];
+  nextToken?: string;
+}
+export interface ListQAppsInput {
+  instanceId: string | undefined;
+  limit?: number;
+  nextToken?: string;
+}
+export interface UserAppItem {
+  appId: string | undefined;
+  appArn: string | undefined;
+  title: string | undefined;
+  description?: string;
+  createdAt: Date | undefined;
+  canEdit?: boolean;
+  status?: string;
+}
+export interface ListQAppsOutput {
+  apps: UserAppItem[] | undefined;
+  nextToken?: string;
+}
+export interface ListTagsForResourceRequest {
+  resourceARN: string | undefined;
+}
+export interface ListTagsForResourceResponse {
+  tags?: Record<string, string>;
+}
+export type PredictQAppInputOptions =
+  | PredictQAppInputOptions.ConversationMember
+  | PredictQAppInputOptions.ProblemStatementMember
+  | PredictQAppInputOptions.$UnknownMember;
+export declare namespace PredictQAppInputOptions {
+  interface ConversationMember {
+    conversation: ConversationMessage[];
+    problemStatement?: never;
+    $unknown?: never;
+  }
+  interface ProblemStatementMember {
+    conversation?: never;
+    problemStatement: string;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    conversation?: never;
+    problemStatement?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    conversation: (value: ConversationMessage[]) => T;
+    problemStatement: (value: string) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: PredictQAppInputOptions, visitor: Visitor<T>) => T;
+}
+export interface PredictQAppInput {
+  instanceId: string | undefined;
+  options?: PredictQAppInputOptions;
+}
+export interface StartQAppSessionInput {
+  instanceId: string | undefined;
+  appId: string | undefined;
+  appVersion: number | undefined;
+  initialValues?: CardValue[];
+  tags?: Record<string, string>;
+}
+export interface StartQAppSessionOutput {
+  sessionId: string | undefined;
+  sessionArn: string | undefined;
+}
+export interface StopQAppSessionInput {
+  instanceId: string | undefined;
+  sessionId: string | undefined;
+}
+export interface TagResourceRequest {
+  resourceARN: string | undefined;
+  tags: Record<string, string> | undefined;
+}
+export interface TagResourceResponse {}
+export interface UntagResourceRequest {
+  resourceARN: string | undefined;
+  tagKeys: string[] | undefined;
+}
+export interface UntagResourceResponse {}
+export interface UpdateLibraryItemInput {
+  instanceId: string | undefined;
+  libraryItemId: string | undefined;
+  status?: LibraryItemStatus;
+  categories?: string[];
+}
+export interface UpdateLibraryItemOutput {
+  libraryItemId: string | undefined;
+  appId: string | undefined;
+  appVersion: number | undefined;
+  categories: Category[] | undefined;
+  status: string | undefined;
+  createdAt: Date | undefined;
+  createdBy: string | undefined;
+  updatedAt?: Date;
+  updatedBy?: string;
+  ratingCount: number | undefined;
+  isRatedByUser?: boolean;
+  userCount?: number;
+}
+export interface UpdateQAppOutput {
+  appId: string | undefined;
+  appArn: string | undefined;
+  title: string | undefined;
+  description?: string;
+  initialPrompt?: string;
+  appVersion: number | undefined;
+  status: AppStatus | undefined;
+  createdAt: Date | undefined;
+  createdBy: string | undefined;
+  updatedAt: Date | undefined;
+  updatedBy: string | undefined;
+  requiredCapabilities?: AppRequiredCapability[];
+}
+export interface UpdateQAppSessionInput {
+  instanceId: string | undefined;
+  sessionId: string | undefined;
+  values?: CardValue[];
+}
+export interface UpdateQAppSessionOutput {
+  sessionId: string | undefined;
+  sessionArn: string | undefined;
+}
+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 QQueryCard {
+  id: string | undefined;
+  title: string | undefined;
+  dependencies: string[] | undefined;
+  type: CardType | undefined;
+  prompt: string | undefined;
+  outputSource: CardOutputSource | undefined;
+  attributeFilter?: AttributeFilter;
+}
+export interface QQueryCardInput {
+  title: string | undefined;
+  id: string | undefined;
+  type: CardType | undefined;
+  prompt: string | undefined;
+  outputSource?: CardOutputSource;
+  attributeFilter?: AttributeFilter;
+}
+export type Card =
+  | Card.FileUploadMember
+  | Card.QPluginMember
+  | Card.QQueryMember
+  | Card.TextInputMember
+  | Card.$UnknownMember;
+export declare namespace Card {
+  interface TextInputMember {
+    textInput: TextInputCard;
+    qQuery?: never;
+    qPlugin?: never;
+    fileUpload?: never;
+    $unknown?: never;
+  }
+  interface QQueryMember {
+    textInput?: never;
+    qQuery: QQueryCard;
+    qPlugin?: never;
+    fileUpload?: never;
+    $unknown?: never;
+  }
+  interface QPluginMember {
+    textInput?: never;
+    qQuery?: never;
+    qPlugin: QPluginCard;
+    fileUpload?: never;
+    $unknown?: never;
+  }
+  interface FileUploadMember {
+    textInput?: never;
+    qQuery?: never;
+    qPlugin?: never;
+    fileUpload: FileUploadCard;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    textInput?: never;
+    qQuery?: never;
+    qPlugin?: never;
+    fileUpload?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    textInput: (value: TextInputCard) => T;
+    qQuery: (value: QQueryCard) => T;
+    qPlugin: (value: QPluginCard) => T;
+    fileUpload: (value: FileUploadCard) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: Card, visitor: Visitor<T>) => T;
+}
+export type CardInput =
+  | CardInput.FileUploadMember
+  | CardInput.QPluginMember
+  | CardInput.QQueryMember
+  | CardInput.TextInputMember
+  | CardInput.$UnknownMember;
+export declare namespace CardInput {
+  interface TextInputMember {
+    textInput: TextInputCardInput;
+    qQuery?: never;
+    qPlugin?: never;
+    fileUpload?: never;
+    $unknown?: never;
+  }
+  interface QQueryMember {
+    textInput?: never;
+    qQuery: QQueryCardInput;
+    qPlugin?: never;
+    fileUpload?: never;
+    $unknown?: never;
+  }
+  interface QPluginMember {
+    textInput?: never;
+    qQuery?: never;
+    qPlugin: QPluginCardInput;
+    fileUpload?: never;
+    $unknown?: never;
+  }
+  interface FileUploadMember {
+    textInput?: never;
+    qQuery?: never;
+    qPlugin?: never;
+    fileUpload: FileUploadCardInput;
+    $unknown?: never;
+  }
+  interface $UnknownMember {
+    textInput?: never;
+    qQuery?: never;
+    qPlugin?: never;
+    fileUpload?: never;
+    $unknown: [string, any];
+  }
+  interface Visitor<T> {
+    textInput: (value: TextInputCardInput) => T;
+    qQuery: (value: QQueryCardInput) => T;
+    qPlugin: (value: QPluginCardInput) => T;
+    fileUpload: (value: FileUploadCardInput) => T;
+    _: (name: string, value: any) => T;
+  }
+  const visit: <T>(value: CardInput, visitor: Visitor<T>) => T;
+}
+export interface AppDefinition {
+  appDefinitionVersion: string | undefined;
+  cards: Card[] | undefined;
+  canEdit?: boolean;
+}
+export interface AppDefinitionInput {
+  cards: CardInput[] | undefined;
+  initialPrompt?: string;
+}
+export interface CreateQAppInput {
+  instanceId: string | undefined;
+  title: string | undefined;
+  description?: string;
+  appDefinition: AppDefinitionInput | undefined;
+  tags?: Record<string, string>;
+}
+export interface GetQAppOutput {
+  appId: string | undefined;
+  appArn: string | undefined;
+  title: string | undefined;
+  description?: string;
+  initialPrompt?: string;
+  appVersion: number | undefined;
+  status: AppStatus | undefined;
+  createdAt: Date | undefined;
+  createdBy: string | undefined;
+  updatedAt: Date | undefined;
+  updatedBy: string | undefined;
+  requiredCapabilities?: AppRequiredCapability[];
+  appDefinition: AppDefinition | undefined;
+}
+export interface PredictAppDefinition {
+  title: string | undefined;
+  description?: string;
+  appDefinition: AppDefinitionInput | undefined;
+}
+export interface UpdateQAppInput {
+  instanceId: string | undefined;
+  appId: string | undefined;
+  title?: string;
+  description?: string;
+  appDefinition?: AppDefinitionInput;
+}
+export interface PredictQAppOutput {
+  app: PredictAppDefinition | undefined;
+  problemStatement: string | undefined;
+}

package/dist-types/ts3.4/pagination/Interfaces.d.ts

@@ -0,0 +1,5 @@
+import { PaginationConfiguration } from "@smithy/types";
+import { QAppsClient } from "../QAppsClient";
+export interface QAppsPaginationConfiguration extends PaginationConfiguration {
+  client: QAppsClient;
+}

package/dist-types/ts3.4/pagination/ListLibraryItemsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListLibraryItemsCommandInput,
+  ListLibraryItemsCommandOutput,
+} from "../commands/ListLibraryItemsCommand";
+import { QAppsPaginationConfiguration } from "./Interfaces";
+export declare const paginateListLibraryItems: (
+  config: QAppsPaginationConfiguration,
+  input: ListLibraryItemsCommandInput,
+  ...rest: any[]
+) => Paginator<ListLibraryItemsCommandOutput>;

package/dist-types/ts3.4/pagination/ListQAppsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  ListQAppsCommandInput,
+  ListQAppsCommandOutput,
+} from "../commands/ListQAppsCommand";
+import { QAppsPaginationConfiguration } from "./Interfaces";
+export declare const paginateListQApps: (
+  config: QAppsPaginationConfiguration,
+  input: ListQAppsCommandInput,
+  ...rest: any[]
+) => Paginator<ListQAppsCommandOutput>;

package/dist-types/ts3.4/pagination/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Interfaces";
+export * from "./ListLibraryItemsPaginator";
+export * from "./ListQAppsPaginator";