@aws-sdk/client-bedrock-agent 3.556.0 → 3.560.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.
package/dist-cjs/index.js CHANGED
@@ -48,6 +48,7 @@ __export(src_exports, {
48
48
  CreateDataSourceCommand: () => CreateDataSourceCommand,
49
49
  CreateKnowledgeBaseCommand: () => CreateKnowledgeBaseCommand,
50
50
  CreationMode: () => CreationMode,
51
+ CustomControlMethod: () => CustomControlMethod,
51
52
  DataSourceStatus: () => DataSourceStatus,
52
53
  DataSourceType: () => DataSourceType,
53
54
  DeleteAgentActionGroupCommand: () => DeleteAgentActionGroupCommand,
@@ -57,6 +58,7 @@ __export(src_exports, {
57
58
  DeleteDataSourceCommand: () => DeleteDataSourceCommand,
58
59
  DeleteKnowledgeBaseCommand: () => DeleteKnowledgeBaseCommand,
59
60
  DisassociateAgentKnowledgeBaseCommand: () => DisassociateAgentKnowledgeBaseCommand,
61
+ FunctionSchema: () => FunctionSchema,
60
62
  GetAgentActionGroupCommand: () => GetAgentActionGroupCommand,
61
63
  GetAgentActionGroupResponseFilterSensitiveLog: () => GetAgentActionGroupResponseFilterSensitiveLog,
62
64
  GetAgentAliasCommand: () => GetAgentAliasCommand,
@@ -96,6 +98,7 @@ __export(src_exports, {
96
98
  StartIngestionJobCommand: () => StartIngestionJobCommand,
97
99
  TagResourceCommand: () => TagResourceCommand,
98
100
  ThrottlingException: () => ThrottlingException,
101
+ Type: () => Type,
99
102
  UntagResourceCommand: () => UntagResourceCommand,
100
103
  UpdateAgentActionGroupCommand: () => UpdateAgentActionGroupCommand,
101
104
  UpdateAgentActionGroupRequestFilterSensitiveLog: () => UpdateAgentActionGroupRequestFilterSensitiveLog,
@@ -311,11 +314,16 @@ var _AccessDeniedException = class _AccessDeniedException extends BedrockAgentSe
311
314
  };
312
315
  __name(_AccessDeniedException, "AccessDeniedException");
313
316
  var AccessDeniedException = _AccessDeniedException;
317
+ var CustomControlMethod = {
318
+ RETURN_CONTROL: "RETURN_CONTROL"
319
+ };
314
320
  var ActionGroupExecutor;
315
321
  ((ActionGroupExecutor3) => {
316
322
  ActionGroupExecutor3.visit = /* @__PURE__ */ __name((value, visitor) => {
317
323
  if (value.lambda !== void 0)
318
324
  return visitor.lambda(value.lambda);
325
+ if (value.customControl !== void 0)
326
+ return visitor.customControl(value.customControl);
319
327
  return visitor._(value.$unknown[0], value.$unknown[1]);
320
328
  }, "visit");
321
329
  })(ActionGroupExecutor || (ActionGroupExecutor = {}));
@@ -350,6 +358,21 @@ var APISchema;
350
358
  return visitor._(value.$unknown[0], value.$unknown[1]);
351
359
  }, "visit");
352
360
  })(APISchema || (APISchema = {}));
361
+ var Type = {
362
+ ARRAY: "array",
363
+ BOOLEAN: "boolean",
364
+ INTEGER: "integer",
365
+ NUMBER: "number",
366
+ STRING: "string"
367
+ };
368
+ var FunctionSchema;
369
+ ((FunctionSchema3) => {
370
+ FunctionSchema3.visit = /* @__PURE__ */ __name((value, visitor) => {
371
+ if (value.functions !== void 0)
372
+ return visitor.functions(value.functions);
373
+ return visitor._(value.$unknown[0], value.$unknown[1]);
374
+ }, "visit");
375
+ })(FunctionSchema || (FunctionSchema = {}));
353
376
  var ActionGroupSignature = {
354
377
  AMAZON_USERINPUT: "AMAZON.UserInput"
355
378
  };
@@ -532,12 +555,14 @@ var APISchemaFilterSensitiveLog = /* @__PURE__ */ __name((obj) => {
532
555
  var CreateAgentActionGroupRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
533
556
  ...obj,
534
557
  ...obj.actionGroupExecutor && { actionGroupExecutor: obj.actionGroupExecutor },
535
- ...obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) }
558
+ ...obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) },
559
+ ...obj.functionSchema && { functionSchema: obj.functionSchema }
536
560
  }), "CreateAgentActionGroupRequestFilterSensitiveLog");
537
561
  var AgentActionGroupFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
538
562
  ...obj,
539
563
  ...obj.actionGroupExecutor && { actionGroupExecutor: obj.actionGroupExecutor },
540
- ...obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) }
564
+ ...obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) },
565
+ ...obj.functionSchema && { functionSchema: obj.functionSchema }
541
566
  }), "AgentActionGroupFilterSensitiveLog");
542
567
  var CreateAgentActionGroupResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
543
568
  ...obj,
@@ -550,7 +575,8 @@ var GetAgentActionGroupResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj)
550
575
  var UpdateAgentActionGroupRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
551
576
  ...obj,
552
577
  ...obj.actionGroupExecutor && { actionGroupExecutor: obj.actionGroupExecutor },
553
- ...obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) }
578
+ ...obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) },
579
+ ...obj.functionSchema && { functionSchema: obj.functionSchema }
554
580
  }), "UpdateAgentActionGroupRequestFilterSensitiveLog");
555
581
  var UpdateAgentActionGroupResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
556
582
  ...obj,
@@ -657,6 +683,7 @@ var se_CreateAgentActionGroupCommand = /* @__PURE__ */ __name(async (input, cont
657
683
  apiSchema: (_) => (0, import_smithy_client._json)(_),
658
684
  clientToken: [true, (_) => _ ?? (0, import_uuid.v4)()],
659
685
  description: [],
686
+ functionSchema: (_) => (0, import_smithy_client._json)(_),
660
687
  parentActionGroupSignature: []
661
688
  })
662
689
  );
@@ -1131,6 +1158,7 @@ var se_UpdateAgentActionGroupCommand = /* @__PURE__ */ __name(async (input, cont
1131
1158
  actionGroupState: [],
1132
1159
  apiSchema: (_) => (0, import_smithy_client._json)(_),
1133
1160
  description: [],
1161
+ functionSchema: (_) => (0, import_smithy_client._json)(_),
1134
1162
  parentActionGroupSignature: []
1135
1163
  })
1136
1164
  );
@@ -1988,6 +2016,7 @@ var de_AgentActionGroup = /* @__PURE__ */ __name((output, context) => {
1988
2016
  clientToken: import_smithy_client.expectString,
1989
2017
  createdAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseRfc3339DateTimeWithOffset)(_)),
1990
2018
  description: import_smithy_client.expectString,
2019
+ functionSchema: (_) => (0, import_smithy_client._json)((0, import_core2.awsExpectUnion)(_)),
1991
2020
  parentActionSignature: import_smithy_client.expectString,
1992
2021
  updatedAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseRfc3339DateTimeWithOffset)(_))
1993
2022
  });
@@ -3058,10 +3087,13 @@ var paginateListKnowledgeBases = (0, import_core.createPaginator)(BedrockAgentCl
3058
3087
  paginateListIngestionJobs,
3059
3088
  paginateListKnowledgeBases,
3060
3089
  AccessDeniedException,
3090
+ CustomControlMethod,
3061
3091
  ActionGroupExecutor,
3062
3092
  ConflictException,
3063
3093
  ActionGroupState,
3064
3094
  APISchema,
3095
+ Type,
3096
+ FunctionSchema,
3065
3097
  ActionGroupSignature,
3066
3098
  InternalServerException,
3067
3099
  ResourceNotFoundException,
@@ -12,11 +12,16 @@ export class AccessDeniedException extends __BaseException {
12
12
  Object.setPrototypeOf(this, AccessDeniedException.prototype);
13
13
  }
14
14
  }
15
+ export const CustomControlMethod = {
16
+ RETURN_CONTROL: "RETURN_CONTROL",
17
+ };
15
18
  export var ActionGroupExecutor;
16
19
  (function (ActionGroupExecutor) {
17
20
  ActionGroupExecutor.visit = (value, visitor) => {
18
21
  if (value.lambda !== undefined)
19
22
  return visitor.lambda(value.lambda);
23
+ if (value.customControl !== undefined)
24
+ return visitor.customControl(value.customControl);
20
25
  return visitor._(value.$unknown[0], value.$unknown[1]);
21
26
  };
22
27
  })(ActionGroupExecutor || (ActionGroupExecutor = {}));
@@ -46,6 +51,21 @@ export var APISchema;
46
51
  return visitor._(value.$unknown[0], value.$unknown[1]);
47
52
  };
48
53
  })(APISchema || (APISchema = {}));
54
+ export const Type = {
55
+ ARRAY: "array",
56
+ BOOLEAN: "boolean",
57
+ INTEGER: "integer",
58
+ NUMBER: "number",
59
+ STRING: "string",
60
+ };
61
+ export var FunctionSchema;
62
+ (function (FunctionSchema) {
63
+ FunctionSchema.visit = (value, visitor) => {
64
+ if (value.functions !== undefined)
65
+ return visitor.functions(value.functions);
66
+ return visitor._(value.$unknown[0], value.$unknown[1]);
67
+ };
68
+ })(FunctionSchema || (FunctionSchema = {}));
49
69
  export const ActionGroupSignature = {
50
70
  AMAZON_USERINPUT: "AMAZON.UserInput",
51
71
  };
@@ -204,11 +224,13 @@ export const CreateAgentActionGroupRequestFilterSensitiveLog = (obj) => ({
204
224
  ...obj,
205
225
  ...(obj.actionGroupExecutor && { actionGroupExecutor: obj.actionGroupExecutor }),
206
226
  ...(obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) }),
227
+ ...(obj.functionSchema && { functionSchema: obj.functionSchema }),
207
228
  });
208
229
  export const AgentActionGroupFilterSensitiveLog = (obj) => ({
209
230
  ...obj,
210
231
  ...(obj.actionGroupExecutor && { actionGroupExecutor: obj.actionGroupExecutor }),
211
232
  ...(obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) }),
233
+ ...(obj.functionSchema && { functionSchema: obj.functionSchema }),
212
234
  });
213
235
  export const CreateAgentActionGroupResponseFilterSensitiveLog = (obj) => ({
214
236
  ...obj,
@@ -222,6 +244,7 @@ export const UpdateAgentActionGroupRequestFilterSensitiveLog = (obj) => ({
222
244
  ...obj,
223
245
  ...(obj.actionGroupExecutor && { actionGroupExecutor: obj.actionGroupExecutor }),
224
246
  ...(obj.apiSchema && { apiSchema: APISchemaFilterSensitiveLog(obj.apiSchema) }),
247
+ ...(obj.functionSchema && { functionSchema: obj.functionSchema }),
225
248
  });
226
249
  export const UpdateAgentActionGroupResponseFilterSensitiveLog = (obj) => ({
227
250
  ...obj,
@@ -59,6 +59,7 @@ export const se_CreateAgentActionGroupCommand = async (input, context) => {
59
59
  apiSchema: (_) => _json(_),
60
60
  clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
61
61
  description: [],
62
+ functionSchema: (_) => _json(_),
62
63
  parentActionGroupSignature: [],
63
64
  }));
64
65
  b.m("PUT").h(headers).b(body);
@@ -503,6 +504,7 @@ export const se_UpdateAgentActionGroupCommand = async (input, context) => {
503
504
  actionGroupState: [],
504
505
  apiSchema: (_) => _json(_),
505
506
  description: [],
507
+ functionSchema: (_) => _json(_),
506
508
  parentActionGroupSignature: [],
507
509
  }));
508
510
  b.m("PUT").h(headers).b(body);
@@ -1355,6 +1357,7 @@ const de_AgentActionGroup = (output, context) => {
1355
1357
  clientToken: __expectString,
1356
1358
  createdAt: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
1357
1359
  description: __expectString,
1360
+ functionSchema: (_) => _json(__expectUnion(_)),
1358
1361
  parentActionSignature: __expectString,
1359
1362
  updatedAt: (_) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
1360
1363
  });
@@ -43,6 +43,7 @@ declare const CreateAgentActionGroupCommand_base: {
43
43
  * parentActionGroupSignature: "AMAZON.UserInput",
44
44
  * actionGroupExecutor: { // ActionGroupExecutor Union: only one key present
45
45
  * lambda: "STRING_VALUE",
46
+ * customControl: "RETURN_CONTROL",
46
47
  * },
47
48
  * apiSchema: { // APISchema Union: only one key present
48
49
  * s3: { // S3Identifier
@@ -52,6 +53,21 @@ declare const CreateAgentActionGroupCommand_base: {
52
53
  * payload: "STRING_VALUE",
53
54
  * },
54
55
  * actionGroupState: "ENABLED" || "DISABLED",
56
+ * functionSchema: { // FunctionSchema Union: only one key present
57
+ * functions: [ // Functions
58
+ * { // Function
59
+ * name: "STRING_VALUE", // required
60
+ * description: "STRING_VALUE",
61
+ * parameters: { // ParameterMap
62
+ * "<keys>": { // ParameterDetail
63
+ * description: "STRING_VALUE",
64
+ * type: "string" || "number" || "integer" || "boolean" || "array", // required
65
+ * required: true || false,
66
+ * },
67
+ * },
68
+ * },
69
+ * ],
70
+ * },
55
71
  * };
56
72
  * const command = new CreateAgentActionGroupCommand(input);
57
73
  * const response = await client.send(command);
@@ -68,6 +84,7 @@ declare const CreateAgentActionGroupCommand_base: {
68
84
  * // parentActionSignature: "AMAZON.UserInput",
69
85
  * // actionGroupExecutor: { // ActionGroupExecutor Union: only one key present
70
86
  * // lambda: "STRING_VALUE",
87
+ * // customControl: "RETURN_CONTROL",
71
88
  * // },
72
89
  * // apiSchema: { // APISchema Union: only one key present
73
90
  * // s3: { // S3Identifier
@@ -76,6 +93,21 @@ declare const CreateAgentActionGroupCommand_base: {
76
93
  * // },
77
94
  * // payload: "STRING_VALUE",
78
95
  * // },
96
+ * // functionSchema: { // FunctionSchema Union: only one key present
97
+ * // functions: [ // Functions
98
+ * // { // Function
99
+ * // name: "STRING_VALUE", // required
100
+ * // description: "STRING_VALUE",
101
+ * // parameters: { // ParameterMap
102
+ * // "<keys>": { // ParameterDetail
103
+ * // description: "STRING_VALUE",
104
+ * // type: "string" || "number" || "integer" || "boolean" || "array", // required
105
+ * // required: true || false,
106
+ * // },
107
+ * // },
108
+ * // },
109
+ * // ],
110
+ * // },
79
111
  * // actionGroupState: "ENABLED" || "DISABLED", // required
80
112
  * // },
81
113
  * // };
@@ -53,6 +53,7 @@ declare const GetAgentActionGroupCommand_base: {
53
53
  * // parentActionSignature: "AMAZON.UserInput",
54
54
  * // actionGroupExecutor: { // ActionGroupExecutor Union: only one key present
55
55
  * // lambda: "STRING_VALUE",
56
+ * // customControl: "RETURN_CONTROL",
56
57
  * // },
57
58
  * // apiSchema: { // APISchema Union: only one key present
58
59
  * // s3: { // S3Identifier
@@ -61,6 +62,21 @@ declare const GetAgentActionGroupCommand_base: {
61
62
  * // },
62
63
  * // payload: "STRING_VALUE",
63
64
  * // },
65
+ * // functionSchema: { // FunctionSchema Union: only one key present
66
+ * // functions: [ // Functions
67
+ * // { // Function
68
+ * // name: "STRING_VALUE", // required
69
+ * // description: "STRING_VALUE",
70
+ * // parameters: { // ParameterMap
71
+ * // "<keys>": { // ParameterDetail
72
+ * // description: "STRING_VALUE",
73
+ * // type: "string" || "number" || "integer" || "boolean" || "array", // required
74
+ * // required: true || false,
75
+ * // },
76
+ * // },
77
+ * // },
78
+ * // ],
79
+ * // },
64
80
  * // actionGroupState: "ENABLED" || "DISABLED", // required
65
81
  * // },
66
82
  * // };
@@ -42,6 +42,7 @@ declare const UpdateAgentActionGroupCommand_base: {
42
42
  * parentActionGroupSignature: "AMAZON.UserInput",
43
43
  * actionGroupExecutor: { // ActionGroupExecutor Union: only one key present
44
44
  * lambda: "STRING_VALUE",
45
+ * customControl: "RETURN_CONTROL",
45
46
  * },
46
47
  * actionGroupState: "ENABLED" || "DISABLED",
47
48
  * apiSchema: { // APISchema Union: only one key present
@@ -51,6 +52,21 @@ declare const UpdateAgentActionGroupCommand_base: {
51
52
  * },
52
53
  * payload: "STRING_VALUE",
53
54
  * },
55
+ * functionSchema: { // FunctionSchema Union: only one key present
56
+ * functions: [ // Functions
57
+ * { // Function
58
+ * name: "STRING_VALUE", // required
59
+ * description: "STRING_VALUE",
60
+ * parameters: { // ParameterMap
61
+ * "<keys>": { // ParameterDetail
62
+ * description: "STRING_VALUE",
63
+ * type: "string" || "number" || "integer" || "boolean" || "array", // required
64
+ * required: true || false,
65
+ * },
66
+ * },
67
+ * },
68
+ * ],
69
+ * },
54
70
  * };
55
71
  * const command = new UpdateAgentActionGroupCommand(input);
56
72
  * const response = await client.send(command);
@@ -67,6 +83,7 @@ declare const UpdateAgentActionGroupCommand_base: {
67
83
  * // parentActionSignature: "AMAZON.UserInput",
68
84
  * // actionGroupExecutor: { // ActionGroupExecutor Union: only one key present
69
85
  * // lambda: "STRING_VALUE",
86
+ * // customControl: "RETURN_CONTROL",
70
87
  * // },
71
88
  * // apiSchema: { // APISchema Union: only one key present
72
89
  * // s3: { // S3Identifier
@@ -75,6 +92,21 @@ declare const UpdateAgentActionGroupCommand_base: {
75
92
  * // },
76
93
  * // payload: "STRING_VALUE",
77
94
  * // },
95
+ * // functionSchema: { // FunctionSchema Union: only one key present
96
+ * // functions: [ // Functions
97
+ * // { // Function
98
+ * // name: "STRING_VALUE", // required
99
+ * // description: "STRING_VALUE",
100
+ * // parameters: { // ParameterMap
101
+ * // "<keys>": { // ParameterDetail
102
+ * // description: "STRING_VALUE",
103
+ * // type: "string" || "number" || "integer" || "boolean" || "array", // required
104
+ * // required: true || false,
105
+ * // },
106
+ * // },
107
+ * // },
108
+ * // ],
109
+ * // },
78
110
  * // actionGroupState: "ENABLED" || "DISABLED", // required
79
111
  * // },
80
112
  * // };
@@ -12,11 +12,22 @@ export declare class AccessDeniedException extends __BaseException {
12
12
  */
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
+ /**
16
+ * @public
17
+ * @enum
18
+ */
19
+ export declare const CustomControlMethod: {
20
+ readonly RETURN_CONTROL: "RETURN_CONTROL";
21
+ };
22
+ /**
23
+ * @public
24
+ */
25
+ export type CustomControlMethod = (typeof CustomControlMethod)[keyof typeof CustomControlMethod];
15
26
  /**
16
27
  * <p>Contains details about the Lambda function containing the business logic that is carried out upon invoking the action.</p>
17
28
  * @public
18
29
  */
19
- export type ActionGroupExecutor = ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember;
30
+ export type ActionGroupExecutor = ActionGroupExecutor.CustomControlMember | ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember;
20
31
  /**
21
32
  * @public
22
33
  */
@@ -27,6 +38,16 @@ export declare namespace ActionGroupExecutor {
27
38
  */
28
39
  interface LambdaMember {
29
40
  lambda: string;
41
+ customControl?: never;
42
+ $unknown?: never;
43
+ }
44
+ /**
45
+ * <p>To return the action group invocation results directly in the <code>InvokeAgent</code> response, specify <code>RETURN_CONTROL</code>.</p>
46
+ * @public
47
+ */
48
+ interface CustomControlMember {
49
+ lambda?: never;
50
+ customControl: CustomControlMethod;
30
51
  $unknown?: never;
31
52
  }
32
53
  /**
@@ -34,10 +55,12 @@ export declare namespace ActionGroupExecutor {
34
55
  */
35
56
  interface $UnknownMember {
36
57
  lambda?: never;
58
+ customControl?: never;
37
59
  $unknown: [string, any];
38
60
  }
39
61
  interface Visitor<T> {
40
62
  lambda: (value: string) => T;
63
+ customControl: (value: CustomControlMethod) => T;
41
64
  _: (name: string, value: any) => T;
42
65
  }
43
66
  const visit: <T>(value: ActionGroupExecutor, visitor: Visitor<T>) => T;
@@ -124,6 +147,177 @@ export declare namespace APISchema {
124
147
  }
125
148
  const visit: <T>(value: APISchema, visitor: Visitor<T>) => T;
126
149
  }
150
+ /**
151
+ * @public
152
+ * @enum
153
+ */
154
+ export declare const Type: {
155
+ readonly ARRAY: "array";
156
+ readonly BOOLEAN: "boolean";
157
+ readonly INTEGER: "integer";
158
+ readonly NUMBER: "number";
159
+ readonly STRING: "string";
160
+ };
161
+ /**
162
+ * @public
163
+ */
164
+ export type Type = (typeof Type)[keyof typeof Type];
165
+ /**
166
+ * <p>Contains details about a parameter in a function for an action group.</p>
167
+ * <p>This data type is used in the following API operations:</p>
168
+ * <ul>
169
+ * <li>
170
+ * <p>
171
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
172
+ * </p>
173
+ * </li>
174
+ * <li>
175
+ * <p>
176
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
177
+ * </p>
178
+ * </li>
179
+ * <li>
180
+ * <p>
181
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
182
+ * </p>
183
+ * </li>
184
+ * <li>
185
+ * <p>
186
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
187
+ * </p>
188
+ * </li>
189
+ * <li>
190
+ * <p>
191
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
192
+ * </p>
193
+ * </li>
194
+ * </ul>
195
+ * @public
196
+ */
197
+ export interface ParameterDetail {
198
+ /**
199
+ * <p>A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.</p>
200
+ * @public
201
+ */
202
+ description?: string;
203
+ /**
204
+ * <p>The data type of the parameter.</p>
205
+ * @public
206
+ */
207
+ type: Type | undefined;
208
+ /**
209
+ * <p>Whether the parameter is required for the agent to complete the function for action group invocation.</p>
210
+ * @public
211
+ */
212
+ required?: boolean;
213
+ }
214
+ /**
215
+ * <p>Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.</p>
216
+ * <p>This data type is used in the following API operations:</p>
217
+ * <ul>
218
+ * <li>
219
+ * <p>
220
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
221
+ * </p>
222
+ * </li>
223
+ * <li>
224
+ * <p>
225
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
226
+ * </p>
227
+ * </li>
228
+ * <li>
229
+ * <p>
230
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
231
+ * </p>
232
+ * </li>
233
+ * <li>
234
+ * <p>
235
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
236
+ * </p>
237
+ * </li>
238
+ * <li>
239
+ * <p>
240
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
241
+ * </p>
242
+ * </li>
243
+ * </ul>
244
+ * @public
245
+ */
246
+ export interface Function {
247
+ /**
248
+ * <p>A name for the function.</p>
249
+ * @public
250
+ */
251
+ name: string | undefined;
252
+ /**
253
+ * <p>A description of the function and its purpose.</p>
254
+ * @public
255
+ */
256
+ description?: string;
257
+ /**
258
+ * <p>The parameters that the agent elicits from the user to fulfill the function.</p>
259
+ * @public
260
+ */
261
+ parameters?: Record<string, ParameterDetail>;
262
+ }
263
+ /**
264
+ * <p>Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.</p>
265
+ * <p>This data type is used in the following API operations:</p>
266
+ * <ul>
267
+ * <li>
268
+ * <p>
269
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax">CreateAgentActionGroup request</a>
270
+ * </p>
271
+ * </li>
272
+ * <li>
273
+ * <p>
274
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax">CreateAgentActionGroup response</a>
275
+ * </p>
276
+ * </li>
277
+ * <li>
278
+ * <p>
279
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax">UpdateAgentActionGroup request</a>
280
+ * </p>
281
+ * </li>
282
+ * <li>
283
+ * <p>
284
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax">UpdateAgentActionGroup response</a>
285
+ * </p>
286
+ * </li>
287
+ * <li>
288
+ * <p>
289
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax">GetAgentActionGroup response</a>
290
+ * </p>
291
+ * </li>
292
+ * </ul>
293
+ * @public
294
+ */
295
+ export type FunctionSchema = FunctionSchema.FunctionsMember | FunctionSchema.$UnknownMember;
296
+ /**
297
+ * @public
298
+ */
299
+ export declare namespace FunctionSchema {
300
+ /**
301
+ * <p>A list of functions that each define an action in the action group.</p>
302
+ * @public
303
+ */
304
+ interface FunctionsMember {
305
+ functions: Function[];
306
+ $unknown?: never;
307
+ }
308
+ /**
309
+ * @public
310
+ */
311
+ interface $UnknownMember {
312
+ functions?: never;
313
+ $unknown: [string, any];
314
+ }
315
+ interface Visitor<T> {
316
+ functions: (value: Function[]) => T;
317
+ _: (name: string, value: any) => T;
318
+ }
319
+ const visit: <T>(value: FunctionSchema, visitor: Visitor<T>) => T;
320
+ }
127
321
  /**
128
322
  * @public
129
323
  * @enum
@@ -186,6 +380,11 @@ export interface CreateAgentActionGroupRequest {
186
380
  * @public
187
381
  */
188
382
  actionGroupState?: ActionGroupState;
383
+ /**
384
+ * <p>Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>
385
+ * @public
386
+ */
387
+ functionSchema?: FunctionSchema;
189
388
  }
190
389
  /**
191
390
  * <p>Contains details about an action group.</p>
@@ -249,6 +448,11 @@ export interface AgentActionGroup {
249
448
  * @public
250
449
  */
251
450
  apiSchema?: APISchema;
451
+ /**
452
+ * <p>Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.</p>
453
+ * @public
454
+ */
455
+ functionSchema?: FunctionSchema;
252
456
  /**
253
457
  * <p>Specifies whether the action group is available for the agent to invoke or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
254
458
  * @public
@@ -529,6 +733,11 @@ export interface UpdateAgentActionGroupRequest {
529
733
  * @public
530
734
  */
531
735
  apiSchema?: APISchema;
736
+ /**
737
+ * <p>Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.</p>
738
+ * @public
739
+ */
740
+ functionSchema?: FunctionSchema;
532
741
  }
533
742
  /**
534
743
  * @public
@@ -2169,7 +2378,7 @@ export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof Ingest
2169
2378
  * </li>
2170
2379
  * <li>
2171
2380
  * <p>
2172
- * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJob.html#API_agent_ListIngestionJob_ResponseSyntax">ListIngestionJob response</a>
2381
+ * <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax">ListIngestionJob response</a>
2173
2382
  * </p>
2174
2383
  * </li>
2175
2384
  * </ul>
@@ -7,20 +7,34 @@ export declare class AccessDeniedException extends __BaseException {
7
7
  opts: __ExceptionOptionType<AccessDeniedException, __BaseException>
8
8
  );
9
9
  }
10
+ export declare const CustomControlMethod: {
11
+ readonly RETURN_CONTROL: "RETURN_CONTROL";
12
+ };
13
+ export type CustomControlMethod =
14
+ (typeof CustomControlMethod)[keyof typeof CustomControlMethod];
10
15
  export type ActionGroupExecutor =
16
+ | ActionGroupExecutor.CustomControlMember
11
17
  | ActionGroupExecutor.LambdaMember
12
18
  | ActionGroupExecutor.$UnknownMember;
13
19
  export declare namespace ActionGroupExecutor {
14
20
  interface LambdaMember {
15
21
  lambda: string;
22
+ customControl?: never;
23
+ $unknown?: never;
24
+ }
25
+ interface CustomControlMember {
26
+ lambda?: never;
27
+ customControl: CustomControlMethod;
16
28
  $unknown?: never;
17
29
  }
18
30
  interface $UnknownMember {
19
31
  lambda?: never;
32
+ customControl?: never;
20
33
  $unknown: [string, any];
21
34
  }
22
35
  interface Visitor<T> {
23
36
  lambda: (value: string) => T;
37
+ customControl: (value: CustomControlMethod) => T;
24
38
  _: (name: string, value: any) => T;
25
39
  }
26
40
  const visit: <T>(value: ActionGroupExecutor, visitor: Visitor<T>) => T;
@@ -67,6 +81,42 @@ export declare namespace APISchema {
67
81
  }
68
82
  const visit: <T>(value: APISchema, visitor: Visitor<T>) => T;
69
83
  }
84
+ export declare const Type: {
85
+ readonly ARRAY: "array";
86
+ readonly BOOLEAN: "boolean";
87
+ readonly INTEGER: "integer";
88
+ readonly NUMBER: "number";
89
+ readonly STRING: "string";
90
+ };
91
+ export type Type = (typeof Type)[keyof typeof Type];
92
+ export interface ParameterDetail {
93
+ description?: string;
94
+ type: Type | undefined;
95
+ required?: boolean;
96
+ }
97
+ export interface Function {
98
+ name: string | undefined;
99
+ description?: string;
100
+ parameters?: Record<string, ParameterDetail>;
101
+ }
102
+ export type FunctionSchema =
103
+ | FunctionSchema.FunctionsMember
104
+ | FunctionSchema.$UnknownMember;
105
+ export declare namespace FunctionSchema {
106
+ interface FunctionsMember {
107
+ functions: Function[];
108
+ $unknown?: never;
109
+ }
110
+ interface $UnknownMember {
111
+ functions?: never;
112
+ $unknown: [string, any];
113
+ }
114
+ interface Visitor<T> {
115
+ functions: (value: Function[]) => T;
116
+ _: (name: string, value: any) => T;
117
+ }
118
+ const visit: <T>(value: FunctionSchema, visitor: Visitor<T>) => T;
119
+ }
70
120
  export declare const ActionGroupSignature: {
71
121
  readonly AMAZON_USERINPUT: "AMAZON.UserInput";
72
122
  };
@@ -82,6 +132,7 @@ export interface CreateAgentActionGroupRequest {
82
132
  actionGroupExecutor?: ActionGroupExecutor;
83
133
  apiSchema?: APISchema;
84
134
  actionGroupState?: ActionGroupState;
135
+ functionSchema?: FunctionSchema;
85
136
  }
86
137
  export interface AgentActionGroup {
87
138
  agentId: string | undefined;
@@ -95,6 +146,7 @@ export interface AgentActionGroup {
95
146
  parentActionSignature?: ActionGroupSignature;
96
147
  actionGroupExecutor?: ActionGroupExecutor;
97
148
  apiSchema?: APISchema;
149
+ functionSchema?: FunctionSchema;
98
150
  actionGroupState: ActionGroupState | undefined;
99
151
  }
100
152
  export interface CreateAgentActionGroupResponse {
@@ -182,6 +234,7 @@ export interface UpdateAgentActionGroupRequest {
182
234
  actionGroupExecutor?: ActionGroupExecutor;
183
235
  actionGroupState?: ActionGroupState;
184
236
  apiSchema?: APISchema;
237
+ functionSchema?: FunctionSchema;
185
238
  }
186
239
  export interface UpdateAgentActionGroupResponse {
187
240
  agentActionGroup: AgentActionGroup | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-bedrock-agent",
3
3
  "description": "AWS SDK for JavaScript Bedrock Agent Client for Node.js, Browser and React Native",
4
- "version": "3.556.0",
4
+ "version": "3.560.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-bedrock-agent",