@aws-sdk/client-qapps 3.933.0 → 3.935.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,45 +1,5 @@
1
- import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
1
  import { DocumentType as __DocumentType } from "@smithy/types";
3
- import { QAppsServiceException as __BaseException } from "./QAppsServiceException";
4
- /**
5
- * <p>The client is not authorized to perform the requested operation.</p>
6
- * @public
7
- */
8
- export declare class AccessDeniedException extends __BaseException {
9
- readonly name: "AccessDeniedException";
10
- readonly $fault: "client";
11
- /**
12
- * @internal
13
- */
14
- constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
- }
16
- /**
17
- * @public
18
- * @enum
19
- */
20
- export declare const Action: {
21
- readonly READ: "read";
22
- readonly WRITE: "write";
23
- };
24
- /**
25
- * @public
26
- */
27
- export type Action = (typeof Action)[keyof typeof Action];
28
- /**
29
- * @public
30
- * @enum
31
- */
32
- export declare const CardType: {
33
- readonly FILE_UPLOAD: "file-upload";
34
- readonly FORM_INPUT: "form-input";
35
- readonly Q_PLUGIN: "q-plugin";
36
- readonly Q_QUERY: "q-query";
37
- readonly TEXT_INPUT: "text-input";
38
- };
39
- /**
40
- * @public
41
- */
42
- export type CardType = (typeof CardType)[keyof typeof CardType];
2
+ import { Action, AppRequiredCapability, AppStatus, CardOutputSource, CardType, DocumentScope, ExecutionStatus, InputCardComputeMode, LibraryItemStatus, PluginType, Sender, SubmissionMutationKind, UserType } from "./enums";
43
3
  /**
44
4
  * <p>A card in an Amazon Q App that allows the user to upload a file.</p>
45
5
  * @public
@@ -81,18 +41,6 @@ export interface FileUploadCard {
81
41
  */
82
42
  allowOverride?: boolean | undefined;
83
43
  }
84
- /**
85
- * @public
86
- * @enum
87
- */
88
- export declare const InputCardComputeMode: {
89
- readonly APPEND: "append";
90
- readonly REPLACE: "replace";
91
- };
92
- /**
93
- * @public
94
- */
95
- export type InputCardComputeMode = (typeof InputCardComputeMode)[keyof typeof InputCardComputeMode];
96
44
  /**
97
45
  * <p>The metadata of the form input card.</p>
98
46
  * @public
@@ -140,32 +88,6 @@ export interface FormInputCard {
140
88
  */
141
89
  computeMode?: InputCardComputeMode | undefined;
142
90
  }
143
- /**
144
- * @public
145
- * @enum
146
- */
147
- export declare const PluginType: {
148
- readonly ASANA: "ASANA";
149
- readonly ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE";
150
- readonly CUSTOM: "CUSTOM";
151
- readonly GOOGLE_CALENDAR: "GOOGLE_CALENDAR";
152
- readonly JIRA: "JIRA";
153
- readonly JIRA_CLOUD: "JIRA_CLOUD";
154
- readonly MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE";
155
- readonly MICROSOFT_TEAMS: "MICROSOFT_TEAMS";
156
- readonly PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE";
157
- readonly SALESFORCE: "SALESFORCE";
158
- readonly SALESFORCE_CRM: "SALESFORCE_CRM";
159
- readonly SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM";
160
- readonly SERVICE_NOW: "SERVICE_NOW";
161
- readonly SMARTSHEET: "SMARTSHEET";
162
- readonly ZENDESK: "ZENDESK";
163
- readonly ZENDESK_SUITE: "ZENDESK_SUITE";
164
- };
165
- /**
166
- * @public
167
- */
168
- export type PluginType = (typeof PluginType)[keyof typeof PluginType];
169
91
  /**
170
92
  * <p>A card in an Q App that integrates with a third-party plugin or service.</p>
171
93
  * @public
@@ -303,18 +225,6 @@ export interface DocumentAttribute {
303
225
  */
304
226
  value: DocumentAttributeValue | undefined;
305
227
  }
306
- /**
307
- * @public
308
- * @enum
309
- */
310
- export declare const CardOutputSource: {
311
- readonly APPROVED_SOURCES: "approved-sources";
312
- readonly LLM: "llm";
313
- };
314
- /**
315
- * @public
316
- */
317
- export type CardOutputSource = (typeof CardOutputSource)[keyof typeof CardOutputSource];
318
228
  /**
319
229
  * <p>A card in an Amazon Q App that allows the user to input text.</p>
320
230
  * @public
@@ -485,33 +395,6 @@ export interface TextInputCardInput {
485
395
  */
486
396
  defaultValue?: string | undefined;
487
397
  }
488
- /**
489
- * @public
490
- * @enum
491
- */
492
- export declare const AppRequiredCapability: {
493
- readonly CREATOR_MODE: "CreatorMode";
494
- readonly FILE_UPLOAD: "FileUpload";
495
- readonly PLUGIN_MODE: "PluginMode";
496
- readonly RETRIEVAL_MODE: "RetrievalMode";
497
- };
498
- /**
499
- * @public
500
- */
501
- export type AppRequiredCapability = (typeof AppRequiredCapability)[keyof typeof AppRequiredCapability];
502
- /**
503
- * @public
504
- * @enum
505
- */
506
- export declare const AppStatus: {
507
- readonly DELETED: "DELETED";
508
- readonly DRAFT: "DRAFT";
509
- readonly PUBLISHED: "PUBLISHED";
510
- };
511
- /**
512
- * @public
513
- */
514
- export type AppStatus = (typeof AppStatus)[keyof typeof AppStatus];
515
398
  /**
516
399
  * @public
517
400
  */
@@ -527,154 +410,6 @@ export interface AssociateLibraryItemReviewInput {
527
410
  */
528
411
  libraryItemId: string | undefined;
529
412
  }
530
- /**
531
- * <p>The requested operation could not be completed due to a conflict with the current state of the resource.</p>
532
- * @public
533
- */
534
- export declare class ConflictException extends __BaseException {
535
- readonly name: "ConflictException";
536
- readonly $fault: "client";
537
- /**
538
- * <p>The unique identifier of the resource</p>
539
- * @public
540
- */
541
- resourceId: string | undefined;
542
- /**
543
- * <p>The type of the resource</p>
544
- * @public
545
- */
546
- resourceType: string | undefined;
547
- /**
548
- * @internal
549
- */
550
- constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
551
- }
552
- /**
553
- * <p>An internal service error occurred while processing the request.</p>
554
- * @public
555
- */
556
- export declare class InternalServerException extends __BaseException {
557
- readonly name: "InternalServerException";
558
- readonly $fault: "server";
559
- $retryable: {};
560
- /**
561
- * <p>The number of seconds to wait before retrying the operation</p>
562
- * @public
563
- */
564
- retryAfterSeconds?: number | undefined;
565
- /**
566
- * @internal
567
- */
568
- constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
569
- }
570
- /**
571
- * <p>The requested resource could not be found.</p>
572
- * @public
573
- */
574
- export declare class ResourceNotFoundException extends __BaseException {
575
- readonly name: "ResourceNotFoundException";
576
- readonly $fault: "client";
577
- /**
578
- * <p>The unique identifier of the resource</p>
579
- * @public
580
- */
581
- resourceId: string | undefined;
582
- /**
583
- * <p>The type of the resource</p>
584
- * @public
585
- */
586
- resourceType: string | undefined;
587
- /**
588
- * @internal
589
- */
590
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
591
- }
592
- /**
593
- * <p>The requested operation could not be completed because it would exceed the service's quota or limit.</p>
594
- * @public
595
- */
596
- export declare class ServiceQuotaExceededException extends __BaseException {
597
- readonly name: "ServiceQuotaExceededException";
598
- readonly $fault: "client";
599
- /**
600
- * <p>The unique identifier of the resource</p>
601
- * @public
602
- */
603
- resourceId: string | undefined;
604
- /**
605
- * <p>The type of the resource</p>
606
- * @public
607
- */
608
- resourceType: string | undefined;
609
- /**
610
- * <p>The code for the service where the quota was exceeded</p>
611
- * @public
612
- */
613
- serviceCode: string | undefined;
614
- /**
615
- * <p>The code of the quota that was exceeded</p>
616
- * @public
617
- */
618
- quotaCode: string | undefined;
619
- /**
620
- * @internal
621
- */
622
- constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
623
- }
624
- /**
625
- * <p>The requested operation could not be completed because too many requests were sent at once. Wait a bit and try again later.</p>
626
- * @public
627
- */
628
- export declare class ThrottlingException extends __BaseException {
629
- readonly name: "ThrottlingException";
630
- readonly $fault: "client";
631
- $retryable: {
632
- throttling: boolean;
633
- };
634
- /**
635
- * <p>The code for the service where the quota was exceeded</p>
636
- * @public
637
- */
638
- serviceCode: string | undefined;
639
- /**
640
- * <p>The code of the quota that was exceeded</p>
641
- * @public
642
- */
643
- quotaCode: string | undefined;
644
- /**
645
- * <p>The number of seconds to wait before retrying the operation</p>
646
- * @public
647
- */
648
- retryAfterSeconds?: number | undefined;
649
- /**
650
- * @internal
651
- */
652
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
653
- }
654
- /**
655
- * <p>The client is not authenticated or authorized to perform the requested operation.</p>
656
- * @public
657
- */
658
- export declare class UnauthorizedException extends __BaseException {
659
- readonly name: "UnauthorizedException";
660
- readonly $fault: "client";
661
- /**
662
- * @internal
663
- */
664
- constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
665
- }
666
- /**
667
- * <p>The input failed to satisfy the constraints specified by the service.</p>
668
- * @public
669
- */
670
- export declare class ValidationException extends __BaseException {
671
- readonly name: "ValidationException";
672
- readonly $fault: "client";
673
- /**
674
- * @internal
675
- */
676
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
677
- }
678
413
  /**
679
414
  * @public
680
415
  */
@@ -777,20 +512,6 @@ export interface BatchUpdateCategoryInput {
777
512
  */
778
513
  categories: CategoryInput[] | undefined;
779
514
  }
780
- /**
781
- * @public
782
- * @enum
783
- */
784
- export declare const ExecutionStatus: {
785
- readonly COMPLETED: "COMPLETED";
786
- readonly ERROR: "ERROR";
787
- readonly IN_PROGRESS: "IN_PROGRESS";
788
- readonly WAITING: "WAITING";
789
- };
790
- /**
791
- * @public
792
- */
793
- export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionStatus];
794
515
  /**
795
516
  * <p>A record created when a user submits a form card.</p>
796
517
  * @public
@@ -833,19 +554,6 @@ export interface CardStatus {
833
554
  */
834
555
  submissions?: Submission[] | undefined;
835
556
  }
836
- /**
837
- * @public
838
- * @enum
839
- */
840
- export declare const SubmissionMutationKind: {
841
- readonly add: "add";
842
- readonly delete: "delete";
843
- readonly edit: "edit";
844
- };
845
- /**
846
- * @public
847
- */
848
- export type SubmissionMutationKind = (typeof SubmissionMutationKind)[keyof typeof SubmissionMutationKind];
849
557
  /**
850
558
  * <p>Represents an action performed on a submission.</p>
851
559
  * @public
@@ -909,40 +617,6 @@ export interface Category {
909
617
  */
910
618
  appCount?: number | undefined;
911
619
  }
912
- /**
913
- * <p>The requested operation could not be completed because the content exceeds the maximum allowed size.</p>
914
- * @public
915
- */
916
- export declare class ContentTooLargeException extends __BaseException {
917
- readonly name: "ContentTooLargeException";
918
- readonly $fault: "client";
919
- /**
920
- * <p>The unique identifier of the resource</p>
921
- * @public
922
- */
923
- resourceId: string | undefined;
924
- /**
925
- * <p>The type of the resource</p>
926
- * @public
927
- */
928
- resourceType: string | undefined;
929
- /**
930
- * @internal
931
- */
932
- constructor(opts: __ExceptionOptionType<ContentTooLargeException, __BaseException>);
933
- }
934
- /**
935
- * @public
936
- * @enum
937
- */
938
- export declare const Sender: {
939
- readonly SYSTEM: "SYSTEM";
940
- readonly USER: "USER";
941
- };
942
- /**
943
- * @public
944
- */
945
- export type Sender = (typeof Sender)[keyof typeof Sender];
946
620
  /**
947
621
  * <p>A message in a conversation, used as input for generating an Amazon Q App definition.</p>
948
622
  * @public
@@ -1029,18 +703,6 @@ export interface CreateLibraryItemOutput {
1029
703
  */
1030
704
  isVerified?: boolean | undefined;
1031
705
  }
1032
- /**
1033
- * @public
1034
- * @enum
1035
- */
1036
- export declare const DocumentScope: {
1037
- readonly APPLICATION: "APPLICATION";
1038
- readonly SESSION: "SESSION";
1039
- };
1040
- /**
1041
- * @public
1042
- */
1043
- export type DocumentScope = (typeof DocumentScope)[keyof typeof DocumentScope];
1044
706
  /**
1045
707
  * @public
1046
708
  */
@@ -1216,18 +878,6 @@ export interface DescribeQAppPermissionsInput {
1216
878
  */
1217
879
  appId: string | undefined;
1218
880
  }
1219
- /**
1220
- * @public
1221
- * @enum
1222
- */
1223
- export declare const UserType: {
1224
- readonly OWNER: "owner";
1225
- readonly USER: "user";
1226
- };
1227
- /**
1228
- * @public
1229
- */
1230
- export type UserType = (typeof UserType)[keyof typeof UserType];
1231
881
  /**
1232
882
  * <p>The principal for which the permission applies.</p>
1233
883
  * @public
@@ -1707,18 +1357,6 @@ export interface LibraryItemMember {
1707
1357
  */
1708
1358
  isVerified?: boolean | undefined;
1709
1359
  }
1710
- /**
1711
- * @public
1712
- * @enum
1713
- */
1714
- export declare const LibraryItemStatus: {
1715
- readonly DISABLED: "DISABLED";
1716
- readonly PUBLISHED: "PUBLISHED";
1717
- };
1718
- /**
1719
- * @public
1720
- */
1721
- export type LibraryItemStatus = (typeof LibraryItemStatus)[keyof typeof LibraryItemStatus];
1722
1360
  /**
1723
1361
  * @public
1724
1362
  */
@@ -5,5 +5,7 @@ export { RuntimeExtension } from "./runtimeExtensions";
5
5
  export { QAppsExtensionConfiguration } from "./extensionConfiguration";
6
6
  export * from "./commands";
7
7
  export * from "./pagination";
8
- export * from "./models";
8
+ export * from "./models/enums";
9
+ export * from "./models/errors";
10
+ export * from "./models/models_0";
9
11
  export { QAppsServiceException } from "./models/QAppsServiceException";
@@ -0,0 +1,94 @@
1
+ export declare const Action: {
2
+ readonly READ: "read";
3
+ readonly WRITE: "write";
4
+ };
5
+ export type Action = (typeof Action)[keyof typeof Action];
6
+ export declare const CardType: {
7
+ readonly FILE_UPLOAD: "file-upload";
8
+ readonly FORM_INPUT: "form-input";
9
+ readonly Q_PLUGIN: "q-plugin";
10
+ readonly Q_QUERY: "q-query";
11
+ readonly TEXT_INPUT: "text-input";
12
+ };
13
+ export type CardType = (typeof CardType)[keyof typeof CardType];
14
+ export declare const InputCardComputeMode: {
15
+ readonly APPEND: "append";
16
+ readonly REPLACE: "replace";
17
+ };
18
+ export type InputCardComputeMode =
19
+ (typeof InputCardComputeMode)[keyof typeof InputCardComputeMode];
20
+ export declare const PluginType: {
21
+ readonly ASANA: "ASANA";
22
+ readonly ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE";
23
+ readonly CUSTOM: "CUSTOM";
24
+ readonly GOOGLE_CALENDAR: "GOOGLE_CALENDAR";
25
+ readonly JIRA: "JIRA";
26
+ readonly JIRA_CLOUD: "JIRA_CLOUD";
27
+ readonly MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE";
28
+ readonly MICROSOFT_TEAMS: "MICROSOFT_TEAMS";
29
+ readonly PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE";
30
+ readonly SALESFORCE: "SALESFORCE";
31
+ readonly SALESFORCE_CRM: "SALESFORCE_CRM";
32
+ readonly SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM";
33
+ readonly SERVICE_NOW: "SERVICE_NOW";
34
+ readonly SMARTSHEET: "SMARTSHEET";
35
+ readonly ZENDESK: "ZENDESK";
36
+ readonly ZENDESK_SUITE: "ZENDESK_SUITE";
37
+ };
38
+ export type PluginType = (typeof PluginType)[keyof typeof PluginType];
39
+ export declare const CardOutputSource: {
40
+ readonly APPROVED_SOURCES: "approved-sources";
41
+ readonly LLM: "llm";
42
+ };
43
+ export type CardOutputSource =
44
+ (typeof CardOutputSource)[keyof typeof CardOutputSource];
45
+ export declare const AppRequiredCapability: {
46
+ readonly CREATOR_MODE: "CreatorMode";
47
+ readonly FILE_UPLOAD: "FileUpload";
48
+ readonly PLUGIN_MODE: "PluginMode";
49
+ readonly RETRIEVAL_MODE: "RetrievalMode";
50
+ };
51
+ export type AppRequiredCapability =
52
+ (typeof AppRequiredCapability)[keyof typeof AppRequiredCapability];
53
+ export declare const AppStatus: {
54
+ readonly DELETED: "DELETED";
55
+ readonly DRAFT: "DRAFT";
56
+ readonly PUBLISHED: "PUBLISHED";
57
+ };
58
+ export type AppStatus = (typeof AppStatus)[keyof typeof AppStatus];
59
+ export declare const ExecutionStatus: {
60
+ readonly COMPLETED: "COMPLETED";
61
+ readonly ERROR: "ERROR";
62
+ readonly IN_PROGRESS: "IN_PROGRESS";
63
+ readonly WAITING: "WAITING";
64
+ };
65
+ export type ExecutionStatus =
66
+ (typeof ExecutionStatus)[keyof typeof ExecutionStatus];
67
+ export declare const SubmissionMutationKind: {
68
+ readonly add: "add";
69
+ readonly delete: "delete";
70
+ readonly edit: "edit";
71
+ };
72
+ export type SubmissionMutationKind =
73
+ (typeof SubmissionMutationKind)[keyof typeof SubmissionMutationKind];
74
+ export declare const Sender: {
75
+ readonly SYSTEM: "SYSTEM";
76
+ readonly USER: "USER";
77
+ };
78
+ export type Sender = (typeof Sender)[keyof typeof Sender];
79
+ export declare const DocumentScope: {
80
+ readonly APPLICATION: "APPLICATION";
81
+ readonly SESSION: "SESSION";
82
+ };
83
+ export type DocumentScope = (typeof DocumentScope)[keyof typeof DocumentScope];
84
+ export declare const UserType: {
85
+ readonly OWNER: "owner";
86
+ readonly USER: "user";
87
+ };
88
+ export type UserType = (typeof UserType)[keyof typeof UserType];
89
+ export declare const LibraryItemStatus: {
90
+ readonly DISABLED: "DISABLED";
91
+ readonly PUBLISHED: "PUBLISHED";
92
+ };
93
+ export type LibraryItemStatus =
94
+ (typeof LibraryItemStatus)[keyof typeof LibraryItemStatus];
@@ -0,0 +1,81 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { QAppsServiceException as __BaseException } from "./QAppsServiceException";
3
+ export declare class AccessDeniedException extends __BaseException {
4
+ readonly name: "AccessDeniedException";
5
+ readonly $fault: "client";
6
+ constructor(
7
+ opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
8
+ );
9
+ }
10
+ export declare class ConflictException extends __BaseException {
11
+ readonly name: "ConflictException";
12
+ readonly $fault: "client";
13
+ resourceId: string | undefined;
14
+ resourceType: string | undefined;
15
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
16
+ }
17
+ export declare class InternalServerException extends __BaseException {
18
+ readonly name: "InternalServerException";
19
+ readonly $fault: "server";
20
+ $retryable: {};
21
+ retryAfterSeconds?: number | undefined;
22
+ constructor(
23
+ opts: __ExceptionOptionType<InternalServerException, __BaseException>
24
+ );
25
+ }
26
+ export declare class ResourceNotFoundException extends __BaseException {
27
+ readonly name: "ResourceNotFoundException";
28
+ readonly $fault: "client";
29
+ resourceId: string | undefined;
30
+ resourceType: string | undefined;
31
+ constructor(
32
+ opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
33
+ );
34
+ }
35
+ export declare class ServiceQuotaExceededException extends __BaseException {
36
+ readonly name: "ServiceQuotaExceededException";
37
+ readonly $fault: "client";
38
+ resourceId: string | undefined;
39
+ resourceType: string | undefined;
40
+ serviceCode: string | undefined;
41
+ quotaCode: string | undefined;
42
+ constructor(
43
+ opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
44
+ );
45
+ }
46
+ export declare class ThrottlingException extends __BaseException {
47
+ readonly name: "ThrottlingException";
48
+ readonly $fault: "client";
49
+ $retryable: {
50
+ throttling: boolean;
51
+ };
52
+ serviceCode: string | undefined;
53
+ quotaCode: string | undefined;
54
+ retryAfterSeconds?: number | undefined;
55
+ constructor(
56
+ opts: __ExceptionOptionType<ThrottlingException, __BaseException>
57
+ );
58
+ }
59
+ export declare class UnauthorizedException extends __BaseException {
60
+ readonly name: "UnauthorizedException";
61
+ readonly $fault: "client";
62
+ constructor(
63
+ opts: __ExceptionOptionType<UnauthorizedException, __BaseException>
64
+ );
65
+ }
66
+ export declare class ValidationException extends __BaseException {
67
+ readonly name: "ValidationException";
68
+ readonly $fault: "client";
69
+ constructor(
70
+ opts: __ExceptionOptionType<ValidationException, __BaseException>
71
+ );
72
+ }
73
+ export declare class ContentTooLargeException extends __BaseException {
74
+ readonly name: "ContentTooLargeException";
75
+ readonly $fault: "client";
76
+ resourceId: string | undefined;
77
+ resourceType: string | undefined;
78
+ constructor(
79
+ opts: __ExceptionOptionType<ContentTooLargeException, __BaseException>
80
+ );
81
+ }