@aws-sdk/client-bedrock-agent 3.1151.0 → 3.1153.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.
Files changed (49) hide show
  1. package/README.md +49 -0
  2. package/dist-cjs/index.js +263 -1
  3. package/dist-es/BedrockAgent.js +18 -0
  4. package/dist-es/commands/CreateRetrievalInstructionCommand.js +4 -0
  5. package/dist-es/commands/CreateRetrievalInstructionVersionCommand.js +4 -0
  6. package/dist-es/commands/DeleteRetrievalInstructionCommand.js +4 -0
  7. package/dist-es/commands/GetRetrievalInstructionCommand.js +4 -0
  8. package/dist-es/commands/ListRetrievalInstructionVersionsCommand.js +4 -0
  9. package/dist-es/commands/ListRetrievalInstructionsCommand.js +4 -0
  10. package/dist-es/commands/UpdateRetrievalInstructionCommand.js +4 -0
  11. package/dist-es/commands/index.js +7 -0
  12. package/dist-es/models/enums.js +23 -0
  13. package/dist-es/pagination/ListRetrievalInstructionVersionsPaginator.js +4 -0
  14. package/dist-es/pagination/ListRetrievalInstructionsPaginator.js +4 -0
  15. package/dist-es/pagination/index.js +2 -0
  16. package/dist-es/schemas/schemas_0.js +167 -0
  17. package/dist-types/BedrockAgent.d.ts +64 -0
  18. package/dist-types/BedrockAgentClient.d.ts +9 -2
  19. package/dist-types/commands/CreateRetrievalInstructionCommand.d.ts +107 -0
  20. package/dist-types/commands/CreateRetrievalInstructionVersionCommand.d.ts +98 -0
  21. package/dist-types/commands/DeleteRetrievalInstructionCommand.d.ts +92 -0
  22. package/dist-types/commands/GetRetrievalInstructionCommand.d.ts +110 -0
  23. package/dist-types/commands/ListRetrievalInstructionVersionsCommand.d.ts +94 -0
  24. package/dist-types/commands/ListRetrievalInstructionsCommand.d.ts +97 -0
  25. package/dist-types/commands/UpdateRetrievalInstructionCommand.d.ts +102 -0
  26. package/dist-types/commands/index.d.ts +7 -0
  27. package/dist-types/models/enums.d.ts +55 -0
  28. package/dist-types/models/models_1.d.ts +485 -1
  29. package/dist-types/pagination/ListRetrievalInstructionVersionsPaginator.d.ts +7 -0
  30. package/dist-types/pagination/ListRetrievalInstructionsPaginator.d.ts +7 -0
  31. package/dist-types/pagination/index.d.ts +2 -0
  32. package/dist-types/schemas/schemas_0.d.ts +25 -0
  33. package/dist-types/ts3.4/BedrockAgent.d.ts +134 -0
  34. package/dist-types/ts3.4/BedrockAgentClient.d.ts +42 -0
  35. package/dist-types/ts3.4/commands/CreateRetrievalInstructionCommand.d.ts +42 -0
  36. package/dist-types/ts3.4/commands/CreateRetrievalInstructionVersionCommand.d.ts +42 -0
  37. package/dist-types/ts3.4/commands/DeleteRetrievalInstructionCommand.d.ts +42 -0
  38. package/dist-types/ts3.4/commands/GetRetrievalInstructionCommand.d.ts +42 -0
  39. package/dist-types/ts3.4/commands/ListRetrievalInstructionVersionsCommand.d.ts +42 -0
  40. package/dist-types/ts3.4/commands/ListRetrievalInstructionsCommand.d.ts +42 -0
  41. package/dist-types/ts3.4/commands/UpdateRetrievalInstructionCommand.d.ts +42 -0
  42. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  43. package/dist-types/ts3.4/models/enums.d.ts +31 -0
  44. package/dist-types/ts3.4/models/models_1.d.ts +118 -0
  45. package/dist-types/ts3.4/pagination/ListRetrievalInstructionVersionsPaginator.d.ts +11 -0
  46. package/dist-types/ts3.4/pagination/ListRetrievalInstructionsPaginator.d.ts +11 -0
  47. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  48. package/dist-types/ts3.4/schemas/schemas_0.d.ts +25 -0
  49. package/package.json +4 -4
@@ -12,6 +12,8 @@ import { type CreateFlowVersionCommandInput, type CreateFlowVersionCommandOutput
12
12
  import { type CreateKnowledgeBaseCommandInput, type CreateKnowledgeBaseCommandOutput } from "./commands/CreateKnowledgeBaseCommand";
13
13
  import { type CreatePromptCommandInput, type CreatePromptCommandOutput } from "./commands/CreatePromptCommand";
14
14
  import { type CreatePromptVersionCommandInput, type CreatePromptVersionCommandOutput } from "./commands/CreatePromptVersionCommand";
15
+ import { type CreateRetrievalInstructionCommandInput, type CreateRetrievalInstructionCommandOutput } from "./commands/CreateRetrievalInstructionCommand";
16
+ import { type CreateRetrievalInstructionVersionCommandInput, type CreateRetrievalInstructionVersionCommandOutput } from "./commands/CreateRetrievalInstructionVersionCommand";
15
17
  import { type CreateVpcConfigurationCommandInput, type CreateVpcConfigurationCommandOutput } from "./commands/CreateVpcConfigurationCommand";
16
18
  import { type DeleteAgentActionGroupCommandInput, type DeleteAgentActionGroupCommandOutput } from "./commands/DeleteAgentActionGroupCommand";
17
19
  import { type DeleteAgentAliasCommandInput, type DeleteAgentAliasCommandOutput } from "./commands/DeleteAgentAliasCommand";
@@ -25,6 +27,7 @@ import { type DeleteKnowledgeBaseCommandInput, type DeleteKnowledgeBaseCommandOu
25
27
  import { type DeleteKnowledgeBaseDocumentsCommandInput, type DeleteKnowledgeBaseDocumentsCommandOutput } from "./commands/DeleteKnowledgeBaseDocumentsCommand";
26
28
  import { type DeletePromptCommandInput, type DeletePromptCommandOutput } from "./commands/DeletePromptCommand";
27
29
  import { type DeleteResourcePolicyCommandInput, type DeleteResourcePolicyCommandOutput } from "./commands/DeleteResourcePolicyCommand";
30
+ import { type DeleteRetrievalInstructionCommandInput, type DeleteRetrievalInstructionCommandOutput } from "./commands/DeleteRetrievalInstructionCommand";
28
31
  import { type DeleteVpcConfigurationCommandInput, type DeleteVpcConfigurationCommandOutput } from "./commands/DeleteVpcConfigurationCommand";
29
32
  import { type DisassociateAgentCollaboratorCommandInput, type DisassociateAgentCollaboratorCommandOutput } from "./commands/DisassociateAgentCollaboratorCommand";
30
33
  import { type DisassociateAgentKnowledgeBaseCommandInput, type DisassociateAgentKnowledgeBaseCommandOutput } from "./commands/DisassociateAgentKnowledgeBaseCommand";
@@ -43,6 +46,7 @@ import { type GetKnowledgeBaseCommandInput, type GetKnowledgeBaseCommandOutput }
43
46
  import { type GetKnowledgeBaseDocumentsCommandInput, type GetKnowledgeBaseDocumentsCommandOutput } from "./commands/GetKnowledgeBaseDocumentsCommand";
44
47
  import { type GetPromptCommandInput, type GetPromptCommandOutput } from "./commands/GetPromptCommand";
45
48
  import { type GetResourcePolicyCommandInput, type GetResourcePolicyCommandOutput } from "./commands/GetResourcePolicyCommand";
49
+ import { type GetRetrievalInstructionCommandInput, type GetRetrievalInstructionCommandOutput } from "./commands/GetRetrievalInstructionCommand";
46
50
  import { type GetVpcConfigurationCommandInput, type GetVpcConfigurationCommandOutput } from "./commands/GetVpcConfigurationCommand";
47
51
  import { type IngestKnowledgeBaseDocumentsCommandInput, type IngestKnowledgeBaseDocumentsCommandOutput } from "./commands/IngestKnowledgeBaseDocumentsCommand";
48
52
  import { type ListAgentActionGroupsCommandInput, type ListAgentActionGroupsCommandOutput } from "./commands/ListAgentActionGroupsCommand";
@@ -59,6 +63,8 @@ import { type ListIngestionJobsCommandInput, type ListIngestionJobsCommandOutput
59
63
  import { type ListKnowledgeBaseDocumentsCommandInput, type ListKnowledgeBaseDocumentsCommandOutput } from "./commands/ListKnowledgeBaseDocumentsCommand";
60
64
  import { type ListKnowledgeBasesCommandInput, type ListKnowledgeBasesCommandOutput } from "./commands/ListKnowledgeBasesCommand";
61
65
  import { type ListPromptsCommandInput, type ListPromptsCommandOutput } from "./commands/ListPromptsCommand";
66
+ import { type ListRetrievalInstructionsCommandInput, type ListRetrievalInstructionsCommandOutput } from "./commands/ListRetrievalInstructionsCommand";
67
+ import { type ListRetrievalInstructionVersionsCommandInput, type ListRetrievalInstructionVersionsCommandOutput } from "./commands/ListRetrievalInstructionVersionsCommand";
62
68
  import { type ListTagsForResourceCommandInput, type ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
63
69
  import { type ListVpcConfigurationsCommandInput, type ListVpcConfigurationsCommandOutput } from "./commands/ListVpcConfigurationsCommand";
64
70
  import { type PrepareAgentCommandInput, type PrepareAgentCommandOutput } from "./commands/PrepareAgentCommand";
@@ -78,6 +84,7 @@ import { type UpdateFlowAliasCommandInput, type UpdateFlowAliasCommandOutput } f
78
84
  import { type UpdateFlowCommandInput, type UpdateFlowCommandOutput } from "./commands/UpdateFlowCommand";
79
85
  import { type UpdateKnowledgeBaseCommandInput, type UpdateKnowledgeBaseCommandOutput } from "./commands/UpdateKnowledgeBaseCommand";
80
86
  import { type UpdatePromptCommandInput, type UpdatePromptCommandOutput } from "./commands/UpdatePromptCommand";
87
+ import { type UpdateRetrievalInstructionCommandInput, type UpdateRetrievalInstructionCommandOutput } from "./commands/UpdateRetrievalInstructionCommand";
81
88
  import { type ValidateFlowDefinitionCommandInput, type ValidateFlowDefinitionCommandOutput } from "./commands/ValidateFlowDefinitionCommand";
82
89
  /**
83
90
  * @public
@@ -158,6 +165,18 @@ export interface BedrockAgent {
158
165
  createPromptVersion(args: CreatePromptVersionCommandInput, options?: BedrockAgentRequestOptions): Promise<CreatePromptVersionCommandOutput>;
159
166
  createPromptVersion(args: CreatePromptVersionCommandInput, cb: (err: any, data?: CreatePromptVersionCommandOutput) => void): void;
160
167
  createPromptVersion(args: CreatePromptVersionCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: CreatePromptVersionCommandOutput) => void): void;
168
+ /**
169
+ * @see {@link CreateRetrievalInstructionCommand}
170
+ */
171
+ createRetrievalInstruction(args: CreateRetrievalInstructionCommandInput, options?: BedrockAgentRequestOptions): Promise<CreateRetrievalInstructionCommandOutput>;
172
+ createRetrievalInstruction(args: CreateRetrievalInstructionCommandInput, cb: (err: any, data?: CreateRetrievalInstructionCommandOutput) => void): void;
173
+ createRetrievalInstruction(args: CreateRetrievalInstructionCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: CreateRetrievalInstructionCommandOutput) => void): void;
174
+ /**
175
+ * @see {@link CreateRetrievalInstructionVersionCommand}
176
+ */
177
+ createRetrievalInstructionVersion(args: CreateRetrievalInstructionVersionCommandInput, options?: BedrockAgentRequestOptions): Promise<CreateRetrievalInstructionVersionCommandOutput>;
178
+ createRetrievalInstructionVersion(args: CreateRetrievalInstructionVersionCommandInput, cb: (err: any, data?: CreateRetrievalInstructionVersionCommandOutput) => void): void;
179
+ createRetrievalInstructionVersion(args: CreateRetrievalInstructionVersionCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: CreateRetrievalInstructionVersionCommandOutput) => void): void;
161
180
  /**
162
181
  * @see {@link CreateVpcConfigurationCommand}
163
182
  */
@@ -236,6 +255,12 @@ export interface BedrockAgent {
236
255
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: BedrockAgentRequestOptions): Promise<DeleteResourcePolicyCommandOutput>;
237
256
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
238
257
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
258
+ /**
259
+ * @see {@link DeleteRetrievalInstructionCommand}
260
+ */
261
+ deleteRetrievalInstruction(args: DeleteRetrievalInstructionCommandInput, options?: BedrockAgentRequestOptions): Promise<DeleteRetrievalInstructionCommandOutput>;
262
+ deleteRetrievalInstruction(args: DeleteRetrievalInstructionCommandInput, cb: (err: any, data?: DeleteRetrievalInstructionCommandOutput) => void): void;
263
+ deleteRetrievalInstruction(args: DeleteRetrievalInstructionCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: DeleteRetrievalInstructionCommandOutput) => void): void;
239
264
  /**
240
265
  * @see {@link DeleteVpcConfigurationCommand}
241
266
  */
@@ -344,6 +369,12 @@ export interface BedrockAgent {
344
369
  getResourcePolicy(args: GetResourcePolicyCommandInput, options?: BedrockAgentRequestOptions): Promise<GetResourcePolicyCommandOutput>;
345
370
  getResourcePolicy(args: GetResourcePolicyCommandInput, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
346
371
  getResourcePolicy(args: GetResourcePolicyCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: GetResourcePolicyCommandOutput) => void): void;
372
+ /**
373
+ * @see {@link GetRetrievalInstructionCommand}
374
+ */
375
+ getRetrievalInstruction(args: GetRetrievalInstructionCommandInput, options?: BedrockAgentRequestOptions): Promise<GetRetrievalInstructionCommandOutput>;
376
+ getRetrievalInstruction(args: GetRetrievalInstructionCommandInput, cb: (err: any, data?: GetRetrievalInstructionCommandOutput) => void): void;
377
+ getRetrievalInstruction(args: GetRetrievalInstructionCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: GetRetrievalInstructionCommandOutput) => void): void;
347
378
  /**
348
379
  * @see {@link GetVpcConfigurationCommand}
349
380
  */
@@ -444,6 +475,19 @@ export interface BedrockAgent {
444
475
  listPrompts(args: ListPromptsCommandInput, options?: BedrockAgentRequestOptions): Promise<ListPromptsCommandOutput>;
445
476
  listPrompts(args: ListPromptsCommandInput, cb: (err: any, data?: ListPromptsCommandOutput) => void): void;
446
477
  listPrompts(args: ListPromptsCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: ListPromptsCommandOutput) => void): void;
478
+ /**
479
+ * @see {@link ListRetrievalInstructionsCommand}
480
+ */
481
+ listRetrievalInstructions(): Promise<ListRetrievalInstructionsCommandOutput>;
482
+ listRetrievalInstructions(args: ListRetrievalInstructionsCommandInput, options?: BedrockAgentRequestOptions): Promise<ListRetrievalInstructionsCommandOutput>;
483
+ listRetrievalInstructions(args: ListRetrievalInstructionsCommandInput, cb: (err: any, data?: ListRetrievalInstructionsCommandOutput) => void): void;
484
+ listRetrievalInstructions(args: ListRetrievalInstructionsCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: ListRetrievalInstructionsCommandOutput) => void): void;
485
+ /**
486
+ * @see {@link ListRetrievalInstructionVersionsCommand}
487
+ */
488
+ listRetrievalInstructionVersions(args: ListRetrievalInstructionVersionsCommandInput, options?: BedrockAgentRequestOptions): Promise<ListRetrievalInstructionVersionsCommandOutput>;
489
+ listRetrievalInstructionVersions(args: ListRetrievalInstructionVersionsCommandInput, cb: (err: any, data?: ListRetrievalInstructionVersionsCommandOutput) => void): void;
490
+ listRetrievalInstructionVersions(args: ListRetrievalInstructionVersionsCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: ListRetrievalInstructionVersionsCommandOutput) => void): void;
447
491
  /**
448
492
  * @see {@link ListTagsForResourceCommand}
449
493
  */
@@ -558,6 +602,12 @@ export interface BedrockAgent {
558
602
  updatePrompt(args: UpdatePromptCommandInput, options?: BedrockAgentRequestOptions): Promise<UpdatePromptCommandOutput>;
559
603
  updatePrompt(args: UpdatePromptCommandInput, cb: (err: any, data?: UpdatePromptCommandOutput) => void): void;
560
604
  updatePrompt(args: UpdatePromptCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: UpdatePromptCommandOutput) => void): void;
605
+ /**
606
+ * @see {@link UpdateRetrievalInstructionCommand}
607
+ */
608
+ updateRetrievalInstruction(args: UpdateRetrievalInstructionCommandInput, options?: BedrockAgentRequestOptions): Promise<UpdateRetrievalInstructionCommandOutput>;
609
+ updateRetrievalInstruction(args: UpdateRetrievalInstructionCommandInput, cb: (err: any, data?: UpdateRetrievalInstructionCommandOutput) => void): void;
610
+ updateRetrievalInstruction(args: UpdateRetrievalInstructionCommandInput, options: BedrockAgentRequestOptions, cb: (err: any, data?: UpdateRetrievalInstructionCommandOutput) => void): void;
561
611
  /**
562
612
  * @see {@link ValidateFlowDefinitionCommand}
563
613
  */
@@ -662,6 +712,20 @@ export interface BedrockAgent {
662
712
  * @returns AsyncIterable of {@link ListPromptsCommandOutput}.
663
713
  */
664
714
  paginateListPrompts(args?: ListPromptsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListPromptsCommandOutput>;
715
+ /**
716
+ * @see {@link ListRetrievalInstructionsCommand}
717
+ * @param args - command input.
718
+ * @param paginationConfig - optional pagination config.
719
+ * @returns AsyncIterable of {@link ListRetrievalInstructionsCommandOutput}.
720
+ */
721
+ paginateListRetrievalInstructions(args?: ListRetrievalInstructionsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListRetrievalInstructionsCommandOutput>;
722
+ /**
723
+ * @see {@link ListRetrievalInstructionVersionsCommand}
724
+ * @param args - command input.
725
+ * @param paginationConfig - optional pagination config.
726
+ * @returns AsyncIterable of {@link ListRetrievalInstructionVersionsCommandOutput}.
727
+ */
728
+ paginateListRetrievalInstructionVersions(args: ListRetrievalInstructionVersionsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListRetrievalInstructionVersionsCommandOutput>;
665
729
  /**
666
730
  * @see {@link ListVpcConfigurationsCommand}
667
731
  * @param args - command input.
@@ -18,6 +18,8 @@ import type { CreateFlowVersionCommandInput, CreateFlowVersionCommandOutput } fr
18
18
  import type { CreateKnowledgeBaseCommandInput, CreateKnowledgeBaseCommandOutput } from "./commands/CreateKnowledgeBaseCommand";
19
19
  import type { CreatePromptCommandInput, CreatePromptCommandOutput } from "./commands/CreatePromptCommand";
20
20
  import type { CreatePromptVersionCommandInput, CreatePromptVersionCommandOutput } from "./commands/CreatePromptVersionCommand";
21
+ import type { CreateRetrievalInstructionCommandInput, CreateRetrievalInstructionCommandOutput } from "./commands/CreateRetrievalInstructionCommand";
22
+ import type { CreateRetrievalInstructionVersionCommandInput, CreateRetrievalInstructionVersionCommandOutput } from "./commands/CreateRetrievalInstructionVersionCommand";
21
23
  import type { CreateVpcConfigurationCommandInput, CreateVpcConfigurationCommandOutput } from "./commands/CreateVpcConfigurationCommand";
22
24
  import type { DeleteAgentActionGroupCommandInput, DeleteAgentActionGroupCommandOutput } from "./commands/DeleteAgentActionGroupCommand";
23
25
  import type { DeleteAgentAliasCommandInput, DeleteAgentAliasCommandOutput } from "./commands/DeleteAgentAliasCommand";
@@ -31,6 +33,7 @@ import type { DeleteKnowledgeBaseCommandInput, DeleteKnowledgeBaseCommandOutput
31
33
  import type { DeleteKnowledgeBaseDocumentsCommandInput, DeleteKnowledgeBaseDocumentsCommandOutput } from "./commands/DeleteKnowledgeBaseDocumentsCommand";
32
34
  import type { DeletePromptCommandInput, DeletePromptCommandOutput } from "./commands/DeletePromptCommand";
33
35
  import type { DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput } from "./commands/DeleteResourcePolicyCommand";
36
+ import type { DeleteRetrievalInstructionCommandInput, DeleteRetrievalInstructionCommandOutput } from "./commands/DeleteRetrievalInstructionCommand";
34
37
  import type { DeleteVpcConfigurationCommandInput, DeleteVpcConfigurationCommandOutput } from "./commands/DeleteVpcConfigurationCommand";
35
38
  import type { DisassociateAgentCollaboratorCommandInput, DisassociateAgentCollaboratorCommandOutput } from "./commands/DisassociateAgentCollaboratorCommand";
36
39
  import type { DisassociateAgentKnowledgeBaseCommandInput, DisassociateAgentKnowledgeBaseCommandOutput } from "./commands/DisassociateAgentKnowledgeBaseCommand";
@@ -49,6 +52,7 @@ import type { GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput } from
49
52
  import type { GetKnowledgeBaseDocumentsCommandInput, GetKnowledgeBaseDocumentsCommandOutput } from "./commands/GetKnowledgeBaseDocumentsCommand";
50
53
  import type { GetPromptCommandInput, GetPromptCommandOutput } from "./commands/GetPromptCommand";
51
54
  import type { GetResourcePolicyCommandInput, GetResourcePolicyCommandOutput } from "./commands/GetResourcePolicyCommand";
55
+ import type { GetRetrievalInstructionCommandInput, GetRetrievalInstructionCommandOutput } from "./commands/GetRetrievalInstructionCommand";
52
56
  import type { GetVpcConfigurationCommandInput, GetVpcConfigurationCommandOutput } from "./commands/GetVpcConfigurationCommand";
53
57
  import type { IngestKnowledgeBaseDocumentsCommandInput, IngestKnowledgeBaseDocumentsCommandOutput } from "./commands/IngestKnowledgeBaseDocumentsCommand";
54
58
  import type { ListAgentActionGroupsCommandInput, ListAgentActionGroupsCommandOutput } from "./commands/ListAgentActionGroupsCommand";
@@ -65,6 +69,8 @@ import type { ListIngestionJobsCommandInput, ListIngestionJobsCommandOutput } fr
65
69
  import type { ListKnowledgeBaseDocumentsCommandInput, ListKnowledgeBaseDocumentsCommandOutput } from "./commands/ListKnowledgeBaseDocumentsCommand";
66
70
  import type { ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput } from "./commands/ListKnowledgeBasesCommand";
67
71
  import type { ListPromptsCommandInput, ListPromptsCommandOutput } from "./commands/ListPromptsCommand";
72
+ import type { ListRetrievalInstructionsCommandInput, ListRetrievalInstructionsCommandOutput } from "./commands/ListRetrievalInstructionsCommand";
73
+ import type { ListRetrievalInstructionVersionsCommandInput, ListRetrievalInstructionVersionsCommandOutput } from "./commands/ListRetrievalInstructionVersionsCommand";
68
74
  import type { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
69
75
  import type { ListVpcConfigurationsCommandInput, ListVpcConfigurationsCommandOutput } from "./commands/ListVpcConfigurationsCommand";
70
76
  import type { PrepareAgentCommandInput, PrepareAgentCommandOutput } from "./commands/PrepareAgentCommand";
@@ -84,6 +90,7 @@ import type { UpdateFlowAliasCommandInput, UpdateFlowAliasCommandOutput } from "
84
90
  import type { UpdateFlowCommandInput, UpdateFlowCommandOutput } from "./commands/UpdateFlowCommand";
85
91
  import type { UpdateKnowledgeBaseCommandInput, UpdateKnowledgeBaseCommandOutput } from "./commands/UpdateKnowledgeBaseCommand";
86
92
  import type { UpdatePromptCommandInput, UpdatePromptCommandOutput } from "./commands/UpdatePromptCommand";
93
+ import type { UpdateRetrievalInstructionCommandInput, UpdateRetrievalInstructionCommandOutput } from "./commands/UpdateRetrievalInstructionCommand";
87
94
  import type { ValidateFlowDefinitionCommandInput, ValidateFlowDefinitionCommandOutput } from "./commands/ValidateFlowDefinitionCommand";
88
95
  import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters";
89
96
  import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
@@ -91,11 +98,11 @@ export { __Client };
91
98
  /**
92
99
  * @public
93
100
  */
94
- export type ServiceInputTypes = AssociateAgentCollaboratorCommandInput | AssociateAgentKnowledgeBaseCommandInput | CreateAgentActionGroupCommandInput | CreateAgentAliasCommandInput | CreateAgentCommandInput | CreateDataSourceCommandInput | CreateFlowAliasCommandInput | CreateFlowCommandInput | CreateFlowVersionCommandInput | CreateKnowledgeBaseCommandInput | CreatePromptCommandInput | CreatePromptVersionCommandInput | CreateVpcConfigurationCommandInput | DeleteAgentActionGroupCommandInput | DeleteAgentAliasCommandInput | DeleteAgentCommandInput | DeleteAgentVersionCommandInput | DeleteDataSourceCommandInput | DeleteFlowAliasCommandInput | DeleteFlowCommandInput | DeleteFlowVersionCommandInput | DeleteKnowledgeBaseCommandInput | DeleteKnowledgeBaseDocumentsCommandInput | DeletePromptCommandInput | DeleteResourcePolicyCommandInput | DeleteVpcConfigurationCommandInput | DisassociateAgentCollaboratorCommandInput | DisassociateAgentKnowledgeBaseCommandInput | GetAgentActionGroupCommandInput | GetAgentAliasCommandInput | GetAgentCollaboratorCommandInput | GetAgentCommandInput | GetAgentKnowledgeBaseCommandInput | GetAgentVersionCommandInput | GetDataSourceCommandInput | GetFlowAliasCommandInput | GetFlowCommandInput | GetFlowVersionCommandInput | GetIngestionJobCommandInput | GetKnowledgeBaseCommandInput | GetKnowledgeBaseDocumentsCommandInput | GetPromptCommandInput | GetResourcePolicyCommandInput | GetVpcConfigurationCommandInput | IngestKnowledgeBaseDocumentsCommandInput | ListAgentActionGroupsCommandInput | ListAgentAliasesCommandInput | ListAgentCollaboratorsCommandInput | ListAgentKnowledgeBasesCommandInput | ListAgentVersionsCommandInput | ListAgentsCommandInput | ListDataSourcesCommandInput | ListFlowAliasesCommandInput | ListFlowVersionsCommandInput | ListFlowsCommandInput | ListIngestionJobsCommandInput | ListKnowledgeBaseDocumentsCommandInput | ListKnowledgeBasesCommandInput | ListPromptsCommandInput | ListTagsForResourceCommandInput | ListVpcConfigurationsCommandInput | PrepareAgentCommandInput | PrepareFlowCommandInput | PutResourcePolicyCommandInput | StartIngestionJobCommandInput | StopIngestionJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAgentActionGroupCommandInput | UpdateAgentAliasCommandInput | UpdateAgentCollaboratorCommandInput | UpdateAgentCommandInput | UpdateAgentKnowledgeBaseCommandInput | UpdateDataSourceCommandInput | UpdateFlowAliasCommandInput | UpdateFlowCommandInput | UpdateKnowledgeBaseCommandInput | UpdatePromptCommandInput | ValidateFlowDefinitionCommandInput;
101
+ export type ServiceInputTypes = AssociateAgentCollaboratorCommandInput | AssociateAgentKnowledgeBaseCommandInput | CreateAgentActionGroupCommandInput | CreateAgentAliasCommandInput | CreateAgentCommandInput | CreateDataSourceCommandInput | CreateFlowAliasCommandInput | CreateFlowCommandInput | CreateFlowVersionCommandInput | CreateKnowledgeBaseCommandInput | CreatePromptCommandInput | CreatePromptVersionCommandInput | CreateRetrievalInstructionCommandInput | CreateRetrievalInstructionVersionCommandInput | CreateVpcConfigurationCommandInput | DeleteAgentActionGroupCommandInput | DeleteAgentAliasCommandInput | DeleteAgentCommandInput | DeleteAgentVersionCommandInput | DeleteDataSourceCommandInput | DeleteFlowAliasCommandInput | DeleteFlowCommandInput | DeleteFlowVersionCommandInput | DeleteKnowledgeBaseCommandInput | DeleteKnowledgeBaseDocumentsCommandInput | DeletePromptCommandInput | DeleteResourcePolicyCommandInput | DeleteRetrievalInstructionCommandInput | DeleteVpcConfigurationCommandInput | DisassociateAgentCollaboratorCommandInput | DisassociateAgentKnowledgeBaseCommandInput | GetAgentActionGroupCommandInput | GetAgentAliasCommandInput | GetAgentCollaboratorCommandInput | GetAgentCommandInput | GetAgentKnowledgeBaseCommandInput | GetAgentVersionCommandInput | GetDataSourceCommandInput | GetFlowAliasCommandInput | GetFlowCommandInput | GetFlowVersionCommandInput | GetIngestionJobCommandInput | GetKnowledgeBaseCommandInput | GetKnowledgeBaseDocumentsCommandInput | GetPromptCommandInput | GetResourcePolicyCommandInput | GetRetrievalInstructionCommandInput | GetVpcConfigurationCommandInput | IngestKnowledgeBaseDocumentsCommandInput | ListAgentActionGroupsCommandInput | ListAgentAliasesCommandInput | ListAgentCollaboratorsCommandInput | ListAgentKnowledgeBasesCommandInput | ListAgentVersionsCommandInput | ListAgentsCommandInput | ListDataSourcesCommandInput | ListFlowAliasesCommandInput | ListFlowVersionsCommandInput | ListFlowsCommandInput | ListIngestionJobsCommandInput | ListKnowledgeBaseDocumentsCommandInput | ListKnowledgeBasesCommandInput | ListPromptsCommandInput | ListRetrievalInstructionVersionsCommandInput | ListRetrievalInstructionsCommandInput | ListTagsForResourceCommandInput | ListVpcConfigurationsCommandInput | PrepareAgentCommandInput | PrepareFlowCommandInput | PutResourcePolicyCommandInput | StartIngestionJobCommandInput | StopIngestionJobCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAgentActionGroupCommandInput | UpdateAgentAliasCommandInput | UpdateAgentCollaboratorCommandInput | UpdateAgentCommandInput | UpdateAgentKnowledgeBaseCommandInput | UpdateDataSourceCommandInput | UpdateFlowAliasCommandInput | UpdateFlowCommandInput | UpdateKnowledgeBaseCommandInput | UpdatePromptCommandInput | UpdateRetrievalInstructionCommandInput | ValidateFlowDefinitionCommandInput;
95
102
  /**
96
103
  * @public
97
104
  */
98
- export type ServiceOutputTypes = AssociateAgentCollaboratorCommandOutput | AssociateAgentKnowledgeBaseCommandOutput | CreateAgentActionGroupCommandOutput | CreateAgentAliasCommandOutput | CreateAgentCommandOutput | CreateDataSourceCommandOutput | CreateFlowAliasCommandOutput | CreateFlowCommandOutput | CreateFlowVersionCommandOutput | CreateKnowledgeBaseCommandOutput | CreatePromptCommandOutput | CreatePromptVersionCommandOutput | CreateVpcConfigurationCommandOutput | DeleteAgentActionGroupCommandOutput | DeleteAgentAliasCommandOutput | DeleteAgentCommandOutput | DeleteAgentVersionCommandOutput | DeleteDataSourceCommandOutput | DeleteFlowAliasCommandOutput | DeleteFlowCommandOutput | DeleteFlowVersionCommandOutput | DeleteKnowledgeBaseCommandOutput | DeleteKnowledgeBaseDocumentsCommandOutput | DeletePromptCommandOutput | DeleteResourcePolicyCommandOutput | DeleteVpcConfigurationCommandOutput | DisassociateAgentCollaboratorCommandOutput | DisassociateAgentKnowledgeBaseCommandOutput | GetAgentActionGroupCommandOutput | GetAgentAliasCommandOutput | GetAgentCollaboratorCommandOutput | GetAgentCommandOutput | GetAgentKnowledgeBaseCommandOutput | GetAgentVersionCommandOutput | GetDataSourceCommandOutput | GetFlowAliasCommandOutput | GetFlowCommandOutput | GetFlowVersionCommandOutput | GetIngestionJobCommandOutput | GetKnowledgeBaseCommandOutput | GetKnowledgeBaseDocumentsCommandOutput | GetPromptCommandOutput | GetResourcePolicyCommandOutput | GetVpcConfigurationCommandOutput | IngestKnowledgeBaseDocumentsCommandOutput | ListAgentActionGroupsCommandOutput | ListAgentAliasesCommandOutput | ListAgentCollaboratorsCommandOutput | ListAgentKnowledgeBasesCommandOutput | ListAgentVersionsCommandOutput | ListAgentsCommandOutput | ListDataSourcesCommandOutput | ListFlowAliasesCommandOutput | ListFlowVersionsCommandOutput | ListFlowsCommandOutput | ListIngestionJobsCommandOutput | ListKnowledgeBaseDocumentsCommandOutput | ListKnowledgeBasesCommandOutput | ListPromptsCommandOutput | ListTagsForResourceCommandOutput | ListVpcConfigurationsCommandOutput | PrepareAgentCommandOutput | PrepareFlowCommandOutput | PutResourcePolicyCommandOutput | StartIngestionJobCommandOutput | StopIngestionJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAgentActionGroupCommandOutput | UpdateAgentAliasCommandOutput | UpdateAgentCollaboratorCommandOutput | UpdateAgentCommandOutput | UpdateAgentKnowledgeBaseCommandOutput | UpdateDataSourceCommandOutput | UpdateFlowAliasCommandOutput | UpdateFlowCommandOutput | UpdateKnowledgeBaseCommandOutput | UpdatePromptCommandOutput | ValidateFlowDefinitionCommandOutput;
105
+ export type ServiceOutputTypes = AssociateAgentCollaboratorCommandOutput | AssociateAgentKnowledgeBaseCommandOutput | CreateAgentActionGroupCommandOutput | CreateAgentAliasCommandOutput | CreateAgentCommandOutput | CreateDataSourceCommandOutput | CreateFlowAliasCommandOutput | CreateFlowCommandOutput | CreateFlowVersionCommandOutput | CreateKnowledgeBaseCommandOutput | CreatePromptCommandOutput | CreatePromptVersionCommandOutput | CreateRetrievalInstructionCommandOutput | CreateRetrievalInstructionVersionCommandOutput | CreateVpcConfigurationCommandOutput | DeleteAgentActionGroupCommandOutput | DeleteAgentAliasCommandOutput | DeleteAgentCommandOutput | DeleteAgentVersionCommandOutput | DeleteDataSourceCommandOutput | DeleteFlowAliasCommandOutput | DeleteFlowCommandOutput | DeleteFlowVersionCommandOutput | DeleteKnowledgeBaseCommandOutput | DeleteKnowledgeBaseDocumentsCommandOutput | DeletePromptCommandOutput | DeleteResourcePolicyCommandOutput | DeleteRetrievalInstructionCommandOutput | DeleteVpcConfigurationCommandOutput | DisassociateAgentCollaboratorCommandOutput | DisassociateAgentKnowledgeBaseCommandOutput | GetAgentActionGroupCommandOutput | GetAgentAliasCommandOutput | GetAgentCollaboratorCommandOutput | GetAgentCommandOutput | GetAgentKnowledgeBaseCommandOutput | GetAgentVersionCommandOutput | GetDataSourceCommandOutput | GetFlowAliasCommandOutput | GetFlowCommandOutput | GetFlowVersionCommandOutput | GetIngestionJobCommandOutput | GetKnowledgeBaseCommandOutput | GetKnowledgeBaseDocumentsCommandOutput | GetPromptCommandOutput | GetResourcePolicyCommandOutput | GetRetrievalInstructionCommandOutput | GetVpcConfigurationCommandOutput | IngestKnowledgeBaseDocumentsCommandOutput | ListAgentActionGroupsCommandOutput | ListAgentAliasesCommandOutput | ListAgentCollaboratorsCommandOutput | ListAgentKnowledgeBasesCommandOutput | ListAgentVersionsCommandOutput | ListAgentsCommandOutput | ListDataSourcesCommandOutput | ListFlowAliasesCommandOutput | ListFlowVersionsCommandOutput | ListFlowsCommandOutput | ListIngestionJobsCommandOutput | ListKnowledgeBaseDocumentsCommandOutput | ListKnowledgeBasesCommandOutput | ListPromptsCommandOutput | ListRetrievalInstructionVersionsCommandOutput | ListRetrievalInstructionsCommandOutput | ListTagsForResourceCommandOutput | ListVpcConfigurationsCommandOutput | PrepareAgentCommandOutput | PrepareFlowCommandOutput | PutResourcePolicyCommandOutput | StartIngestionJobCommandOutput | StopIngestionJobCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAgentActionGroupCommandOutput | UpdateAgentAliasCommandOutput | UpdateAgentCollaboratorCommandOutput | UpdateAgentCommandOutput | UpdateAgentKnowledgeBaseCommandOutput | UpdateDataSourceCommandOutput | UpdateFlowAliasCommandOutput | UpdateFlowCommandOutput | UpdateKnowledgeBaseCommandOutput | UpdatePromptCommandOutput | UpdateRetrievalInstructionCommandOutput | ValidateFlowDefinitionCommandOutput;
99
106
  /**
100
107
  * @public
101
108
  */
@@ -0,0 +1,107 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { CreateRetrievalInstructionRequest, CreateRetrievalInstructionResponse } from "../models/models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link CreateRetrievalInstructionCommand}.
11
+ */
12
+ export interface CreateRetrievalInstructionCommandInput extends CreateRetrievalInstructionRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link CreateRetrievalInstructionCommand}.
18
+ */
19
+ export interface CreateRetrievalInstructionCommandOutput extends CreateRetrievalInstructionResponse, __MetadataBearer {
20
+ }
21
+ declare const CreateRetrievalInstructionCommand_base: {
22
+ new (input: CreateRetrievalInstructionCommandInput): import("@smithy/core/client").CommandImpl<CreateRetrievalInstructionCommandInput, CreateRetrievalInstructionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: CreateRetrievalInstructionCommandInput): import("@smithy/core/client").CommandImpl<CreateRetrievalInstructionCommandInput, CreateRetrievalInstructionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Creates a new retrieval instruction. The retrieval instruction is usable once its status becomes ACTIVE. Use GetRetrievalInstruction to check whether it is ready.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { BedrockAgentClient, CreateRetrievalInstructionCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
32
+ * // const { BedrockAgentClient, CreateRetrievalInstructionCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
33
+ * // import type { BedrockAgentClientConfig } from "@aws-sdk/client-bedrock-agent";
34
+ * const config = {}; // type is BedrockAgentClientConfig
35
+ * const client = new BedrockAgentClient(config);
36
+ * const input = { // CreateRetrievalInstructionRequest
37
+ * clientToken: "STRING_VALUE",
38
+ * name: "STRING_VALUE", // required
39
+ * instruction: { // RetrievalInstructionContent
40
+ * retrievalGuidance: "STRING_VALUE",
41
+ * persona: "STRING_VALUE",
42
+ * answerFormat: "STRING_VALUE",
43
+ * answerPolicy: "STRING_VALUE",
44
+ * },
45
+ * description: "STRING_VALUE",
46
+ * customerEncryptionKeyArn: "STRING_VALUE",
47
+ * tags: { // TagsMap
48
+ * "<keys>": "STRING_VALUE",
49
+ * },
50
+ * };
51
+ * const command = new CreateRetrievalInstructionCommand(input);
52
+ * const response = await client.send(command);
53
+ * // { // CreateRetrievalInstructionResponse
54
+ * // retrievalInstructionId: "STRING_VALUE", // required
55
+ * // retrievalInstructionArn: "STRING_VALUE", // required
56
+ * // name: "STRING_VALUE", // required
57
+ * // status: "ACTIVE" || "INACTIVE", // required
58
+ * // lastTransitionStatus: "CREATING" || "UPDATING" || "CREATE_SUCCESSFUL" || "CREATE_FAILED" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED", // required
59
+ * // createdAt: new Date("TIMESTAMP"), // required
60
+ * // updatedAt: new Date("TIMESTAMP"), // required
61
+ * // };
62
+ *
63
+ * ```
64
+ *
65
+ * @param CreateRetrievalInstructionCommandInput - {@link CreateRetrievalInstructionCommandInput}
66
+ * @returns {@link CreateRetrievalInstructionCommandOutput}
67
+ * @see {@link CreateRetrievalInstructionCommandInput} for command's `input` shape.
68
+ * @see {@link CreateRetrievalInstructionCommandOutput} for command's `response` shape.
69
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
70
+ *
71
+ * @throws {@link AccessDeniedException} (client fault)
72
+ * <p>The request is denied because of missing access permissions.</p>
73
+ *
74
+ * @throws {@link ConflictException} (client fault)
75
+ * <p>There was a conflict performing an operation.</p>
76
+ *
77
+ * @throws {@link InternalServerException} (server fault)
78
+ * <p>An internal server error occurred. Retry your request.</p>
79
+ *
80
+ * @throws {@link ServiceQuotaExceededException} (client fault)
81
+ * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
82
+ *
83
+ * @throws {@link ThrottlingException} (client fault)
84
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
85
+ *
86
+ * @throws {@link ValidationException} (client fault)
87
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
88
+ *
89
+ * @throws {@link BedrockAgentServiceException}
90
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
91
+ *
92
+ *
93
+ * @public
94
+ */
95
+ export declare class CreateRetrievalInstructionCommand extends CreateRetrievalInstructionCommand_base {
96
+ /** @internal type navigation helper, not in runtime. */
97
+ protected static __types: {
98
+ api: {
99
+ input: CreateRetrievalInstructionRequest;
100
+ output: CreateRetrievalInstructionResponse;
101
+ };
102
+ sdk: {
103
+ input: CreateRetrievalInstructionCommandInput;
104
+ output: CreateRetrievalInstructionCommandOutput;
105
+ };
106
+ };
107
+ }
@@ -0,0 +1,98 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { CreateRetrievalInstructionVersionRequest, CreateRetrievalInstructionVersionResponse } from "../models/models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link CreateRetrievalInstructionVersionCommand}.
11
+ */
12
+ export interface CreateRetrievalInstructionVersionCommandInput extends CreateRetrievalInstructionVersionRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link CreateRetrievalInstructionVersionCommand}.
18
+ */
19
+ export interface CreateRetrievalInstructionVersionCommandOutput extends CreateRetrievalInstructionVersionResponse, __MetadataBearer {
20
+ }
21
+ declare const CreateRetrievalInstructionVersionCommand_base: {
22
+ new (input: CreateRetrievalInstructionVersionCommandInput): import("@smithy/core/client").CommandImpl<CreateRetrievalInstructionVersionCommandInput, CreateRetrievalInstructionVersionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: CreateRetrievalInstructionVersionCommandInput): import("@smithy/core/client").CommandImpl<CreateRetrievalInstructionVersionCommandInput, CreateRetrievalInstructionVersionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Creates an immutable numbered version from the retrieval instruction's current reviewed content. The service creates the version synchronously.</p> <p>The service numbers versions from 1 and assigns them in order, never reusing a number.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { BedrockAgentClient, CreateRetrievalInstructionVersionCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
32
+ * // const { BedrockAgentClient, CreateRetrievalInstructionVersionCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
33
+ * // import type { BedrockAgentClientConfig } from "@aws-sdk/client-bedrock-agent";
34
+ * const config = {}; // type is BedrockAgentClientConfig
35
+ * const client = new BedrockAgentClient(config);
36
+ * const input = { // CreateRetrievalInstructionVersionRequest
37
+ * retrievalInstructionId: "STRING_VALUE", // required
38
+ * description: "STRING_VALUE",
39
+ * clientToken: "STRING_VALUE",
40
+ * };
41
+ * const command = new CreateRetrievalInstructionVersionCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // CreateRetrievalInstructionVersionResponse
44
+ * // retrievalInstructionId: "STRING_VALUE", // required
45
+ * // retrievalInstructionArn: "STRING_VALUE", // required
46
+ * // version: "STRING_VALUE", // required
47
+ * // createdAt: new Date("TIMESTAMP"), // required
48
+ * // description: "STRING_VALUE",
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param CreateRetrievalInstructionVersionCommandInput - {@link CreateRetrievalInstructionVersionCommandInput}
54
+ * @returns {@link CreateRetrievalInstructionVersionCommandOutput}
55
+ * @see {@link CreateRetrievalInstructionVersionCommandInput} for command's `input` shape.
56
+ * @see {@link CreateRetrievalInstructionVersionCommandOutput} for command's `response` shape.
57
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
58
+ *
59
+ * @throws {@link AccessDeniedException} (client fault)
60
+ * <p>The request is denied because of missing access permissions.</p>
61
+ *
62
+ * @throws {@link ConflictException} (client fault)
63
+ * <p>There was a conflict performing an operation.</p>
64
+ *
65
+ * @throws {@link InternalServerException} (server fault)
66
+ * <p>An internal server error occurred. Retry your request.</p>
67
+ *
68
+ * @throws {@link ResourceNotFoundException} (client fault)
69
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
70
+ *
71
+ * @throws {@link ServiceQuotaExceededException} (client fault)
72
+ * <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
73
+ *
74
+ * @throws {@link ThrottlingException} (client fault)
75
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
76
+ *
77
+ * @throws {@link ValidationException} (client fault)
78
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
79
+ *
80
+ * @throws {@link BedrockAgentServiceException}
81
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
82
+ *
83
+ *
84
+ * @public
85
+ */
86
+ export declare class CreateRetrievalInstructionVersionCommand extends CreateRetrievalInstructionVersionCommand_base {
87
+ /** @internal type navigation helper, not in runtime. */
88
+ protected static __types: {
89
+ api: {
90
+ input: CreateRetrievalInstructionVersionRequest;
91
+ output: CreateRetrievalInstructionVersionResponse;
92
+ };
93
+ sdk: {
94
+ input: CreateRetrievalInstructionVersionCommandInput;
95
+ output: CreateRetrievalInstructionVersionCommandOutput;
96
+ };
97
+ };
98
+ }
@@ -0,0 +1,92 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DeleteRetrievalInstructionRequest, DeleteRetrievalInstructionResponse } from "../models/models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link DeleteRetrievalInstructionCommand}.
11
+ */
12
+ export interface DeleteRetrievalInstructionCommandInput extends DeleteRetrievalInstructionRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link DeleteRetrievalInstructionCommand}.
18
+ */
19
+ export interface DeleteRetrievalInstructionCommandOutput extends DeleteRetrievalInstructionResponse, __MetadataBearer {
20
+ }
21
+ declare const DeleteRetrievalInstructionCommand_base: {
22
+ new (input: DeleteRetrievalInstructionCommandInput): import("@smithy/core/client").CommandImpl<DeleteRetrievalInstructionCommandInput, DeleteRetrievalInstructionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: DeleteRetrievalInstructionCommandInput): import("@smithy/core/client").CommandImpl<DeleteRetrievalInstructionCommandInput, DeleteRetrievalInstructionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Deletes a retrieval instruction or a single version of it. Omit retrievalInstructionVersion to delete the retrieval instruction itself; the service rejects that request with ConflictException while the retrieval instruction has versions or while lastTransitionStatus is CREATING or UPDATING. Specify retrievalInstructionVersion to delete only that version; the retrieval instruction and its other versions are unaffected.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { BedrockAgentClient, DeleteRetrievalInstructionCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
32
+ * // const { BedrockAgentClient, DeleteRetrievalInstructionCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
33
+ * // import type { BedrockAgentClientConfig } from "@aws-sdk/client-bedrock-agent";
34
+ * const config = {}; // type is BedrockAgentClientConfig
35
+ * const client = new BedrockAgentClient(config);
36
+ * const input = { // DeleteRetrievalInstructionRequest
37
+ * retrievalInstructionId: "STRING_VALUE", // required
38
+ * retrievalInstructionVersion: "STRING_VALUE",
39
+ * };
40
+ * const command = new DeleteRetrievalInstructionCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // DeleteRetrievalInstructionResponse
43
+ * // retrievalInstructionId: "STRING_VALUE", // required
44
+ * // retrievalInstructionArn: "STRING_VALUE", // required
45
+ * // version: "STRING_VALUE",
46
+ * // };
47
+ *
48
+ * ```
49
+ *
50
+ * @param DeleteRetrievalInstructionCommandInput - {@link DeleteRetrievalInstructionCommandInput}
51
+ * @returns {@link DeleteRetrievalInstructionCommandOutput}
52
+ * @see {@link DeleteRetrievalInstructionCommandInput} for command's `input` shape.
53
+ * @see {@link DeleteRetrievalInstructionCommandOutput} for command's `response` shape.
54
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
55
+ *
56
+ * @throws {@link AccessDeniedException} (client fault)
57
+ * <p>The request is denied because of missing access permissions.</p>
58
+ *
59
+ * @throws {@link ConflictException} (client fault)
60
+ * <p>There was a conflict performing an operation.</p>
61
+ *
62
+ * @throws {@link InternalServerException} (server fault)
63
+ * <p>An internal server error occurred. Retry your request.</p>
64
+ *
65
+ * @throws {@link ResourceNotFoundException} (client fault)
66
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
67
+ *
68
+ * @throws {@link ThrottlingException} (client fault)
69
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
70
+ *
71
+ * @throws {@link ValidationException} (client fault)
72
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
73
+ *
74
+ * @throws {@link BedrockAgentServiceException}
75
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
76
+ *
77
+ *
78
+ * @public
79
+ */
80
+ export declare class DeleteRetrievalInstructionCommand extends DeleteRetrievalInstructionCommand_base {
81
+ /** @internal type navigation helper, not in runtime. */
82
+ protected static __types: {
83
+ api: {
84
+ input: DeleteRetrievalInstructionRequest;
85
+ output: DeleteRetrievalInstructionResponse;
86
+ };
87
+ sdk: {
88
+ input: DeleteRetrievalInstructionCommandInput;
89
+ output: DeleteRetrievalInstructionCommandOutput;
90
+ };
91
+ };
92
+ }
@@ -0,0 +1,110 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { GetRetrievalInstructionRequest, GetRetrievalInstructionResponse } from "../models/models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link GetRetrievalInstructionCommand}.
11
+ */
12
+ export interface GetRetrievalInstructionCommandInput extends GetRetrievalInstructionRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link GetRetrievalInstructionCommand}.
18
+ */
19
+ export interface GetRetrievalInstructionCommandOutput extends GetRetrievalInstructionResponse, __MetadataBearer {
20
+ }
21
+ declare const GetRetrievalInstructionCommand_base: {
22
+ new (input: GetRetrievalInstructionCommandInput): import("@smithy/core/client").CommandImpl<GetRetrievalInstructionCommandInput, GetRetrievalInstructionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: GetRetrievalInstructionCommandInput): import("@smithy/core/client").CommandImpl<GetRetrievalInstructionCommandInput, GetRetrievalInstructionCommandOutput, import("..").BedrockAgentClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Gets a retrieval instruction. Also used to poll the terminal reporting of an asynchronous create or update.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { BedrockAgentClient, GetRetrievalInstructionCommand } from "@aws-sdk/client-bedrock-agent"; // ES Modules import
32
+ * // const { BedrockAgentClient, GetRetrievalInstructionCommand } = require("@aws-sdk/client-bedrock-agent"); // CommonJS import
33
+ * // import type { BedrockAgentClientConfig } from "@aws-sdk/client-bedrock-agent";
34
+ * const config = {}; // type is BedrockAgentClientConfig
35
+ * const client = new BedrockAgentClient(config);
36
+ * const input = { // GetRetrievalInstructionRequest
37
+ * retrievalInstructionId: "STRING_VALUE", // required
38
+ * retrievalInstructionVersion: "STRING_VALUE",
39
+ * };
40
+ * const command = new GetRetrievalInstructionCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // GetRetrievalInstructionResponse
43
+ * // retrievalInstructionId: "STRING_VALUE", // required
44
+ * // retrievalInstructionArn: "STRING_VALUE", // required
45
+ * // name: "STRING_VALUE", // required
46
+ * // status: "ACTIVE" || "INACTIVE", // required
47
+ * // lastTransitionStatus: "CREATING" || "UPDATING" || "CREATE_SUCCESSFUL" || "CREATE_FAILED" || "UPDATE_SUCCESSFUL" || "UPDATE_FAILED", // required
48
+ * // instruction: { // RetrievalInstructionContent
49
+ * // retrievalGuidance: "STRING_VALUE",
50
+ * // persona: "STRING_VALUE",
51
+ * // answerFormat: "STRING_VALUE",
52
+ * // answerPolicy: "STRING_VALUE",
53
+ * // },
54
+ * // createdAt: new Date("TIMESTAMP"), // required
55
+ * // updatedAt: new Date("TIMESTAMP"), // required
56
+ * // description: "STRING_VALUE",
57
+ * // customerEncryptionKeyArn: "STRING_VALUE",
58
+ * // lastTransitionStatusReasons: [ // RetrievalInstructionFailureReasons
59
+ * // { // RetrievalInstructionFailureReason
60
+ * // fieldName: "RETRIEVAL_GUIDANCE" || "PERSONA" || "ANSWER_FORMAT" || "ANSWER_POLICY",
61
+ * // code: "CONTENT_REJECTED" || "CLIENT_ERROR" || "INTERNAL_ERROR", // required
62
+ * // message: "STRING_VALUE", // required
63
+ * // },
64
+ * // ],
65
+ * // version: "STRING_VALUE",
66
+ * // latestVersion: "STRING_VALUE",
67
+ * // };
68
+ *
69
+ * ```
70
+ *
71
+ * @param GetRetrievalInstructionCommandInput - {@link GetRetrievalInstructionCommandInput}
72
+ * @returns {@link GetRetrievalInstructionCommandOutput}
73
+ * @see {@link GetRetrievalInstructionCommandInput} for command's `input` shape.
74
+ * @see {@link GetRetrievalInstructionCommandOutput} for command's `response` shape.
75
+ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
76
+ *
77
+ * @throws {@link AccessDeniedException} (client fault)
78
+ * <p>The request is denied because of missing access permissions.</p>
79
+ *
80
+ * @throws {@link InternalServerException} (server fault)
81
+ * <p>An internal server error occurred. Retry your request.</p>
82
+ *
83
+ * @throws {@link ResourceNotFoundException} (client fault)
84
+ * <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
85
+ *
86
+ * @throws {@link ThrottlingException} (client fault)
87
+ * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
88
+ *
89
+ * @throws {@link ValidationException} (client fault)
90
+ * <p>Input validation failed. Check your request parameters and retry the request.</p>
91
+ *
92
+ * @throws {@link BedrockAgentServiceException}
93
+ * <p>Base exception class for all service exceptions from BedrockAgent service.</p>
94
+ *
95
+ *
96
+ * @public
97
+ */
98
+ export declare class GetRetrievalInstructionCommand extends GetRetrievalInstructionCommand_base {
99
+ /** @internal type navigation helper, not in runtime. */
100
+ protected static __types: {
101
+ api: {
102
+ input: GetRetrievalInstructionRequest;
103
+ output: GetRetrievalInstructionResponse;
104
+ };
105
+ sdk: {
106
+ input: GetRetrievalInstructionCommandInput;
107
+ output: GetRetrievalInstructionCommandOutput;
108
+ };
109
+ };
110
+ }