@aws-sdk/client-bedrock-agent 3.637.0 → 3.638.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
@@ -158,6 +158,7 @@ __export(src_exports, {
158
158
  PromptTemplateType: () => PromptTemplateType,
159
159
  PromptType: () => PromptType,
160
160
  PromptVariantFilterSensitiveLog: () => PromptVariantFilterSensitiveLog,
161
+ RequireConfirmation: () => RequireConfirmation,
161
162
  ResourceNotFoundException: () => ResourceNotFoundException,
162
163
  RetrievalFlowNodeServiceConfiguration: () => RetrievalFlowNodeServiceConfiguration,
163
164
  S3DataSourceConfigurationFilterSensitiveLog: () => S3DataSourceConfigurationFilterSensitiveLog,
@@ -452,6 +453,10 @@ var Type = {
452
453
  NUMBER: "number",
453
454
  STRING: "string"
454
455
  };
456
+ var RequireConfirmation = {
457
+ DISABLED: "DISABLED",
458
+ ENABLED: "ENABLED"
459
+ };
455
460
  var FunctionSchema;
456
461
  ((FunctionSchema3) => {
457
462
  FunctionSchema3.visit = /* @__PURE__ */ __name((value, visitor) => {
@@ -4991,6 +4996,7 @@ var paginateListPrompts = (0, import_core.createPaginator)(BedrockAgentClient, L
4991
4996
  ActionGroupState,
4992
4997
  APISchema,
4993
4998
  Type,
4999
+ RequireConfirmation,
4994
5000
  FunctionSchema,
4995
5001
  ActionGroupSignature,
4996
5002
  InternalServerException,
@@ -58,6 +58,10 @@ export const Type = {
58
58
  NUMBER: "number",
59
59
  STRING: "string",
60
60
  };
61
+ export const RequireConfirmation = {
62
+ DISABLED: "DISABLED",
63
+ ENABLED: "ENABLED",
64
+ };
61
65
  export var FunctionSchema;
62
66
  (function (FunctionSchema) {
63
67
  FunctionSchema.visit = (value, visitor) => {
@@ -70,6 +70,7 @@ declare const CreateAgentActionGroupCommand_base: {
70
70
  * required: true || false,
71
71
  * },
72
72
  * },
73
+ * requireConfirmation: "ENABLED" || "DISABLED",
73
74
  * },
74
75
  * ],
75
76
  * },
@@ -110,6 +111,7 @@ declare const CreateAgentActionGroupCommand_base: {
110
111
  * // required: true || false,
111
112
  * // },
112
113
  * // },
114
+ * // requireConfirmation: "ENABLED" || "DISABLED",
113
115
  * // },
114
116
  * // ],
115
117
  * // },
@@ -27,7 +27,7 @@ declare const DeletePromptCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a prompt or a prompt version from the Prompt management tool. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-delete.html">Delete prompts from the Prompt management tool</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-delete.html">Delete a version of a prompt from the Prompt management tool</a> in the Amazon Bedrock User Guide.</p>
30
+ * <p>Deletes a prompt or a version of it, depending on whether you include the <code>promptVersion</code> field or not. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-delete.html">Delete prompts from the Prompt management tool</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-delete.html">Delete a version of a prompt from the Prompt management tool</a> in the Amazon Bedrock User Guide.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -75,6 +75,7 @@ declare const GetAgentActionGroupCommand_base: {
75
75
  * // required: true || false,
76
76
  * // },
77
77
  * // },
78
+ * // requireConfirmation: "ENABLED" || "DISABLED",
78
79
  * // },
79
80
  * // ],
80
81
  * // },
@@ -27,7 +27,7 @@ declare const GetPromptCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves information about a prompt or a version of it. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html">View information about prompts using Prompt management</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-view.html">View information about a version of your prompt</a> in the Amazon Bedrock User Guide.</p>
30
+ * <p>Retrieves information about the working draft (<code>DRAFT</code> version) of a prompt or a version of it, depending on whether you include the <code>promptVersion</code> field or not. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html">View information about prompts using Prompt management</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-view.html">View information about a version of your prompt</a> in the Amazon Bedrock User Guide.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -27,7 +27,7 @@ declare const ListPromptsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html">View information about prompts using Prompt management</a> in the Amazon Bedrock User Guide.</p>
30
+ * <p>Returns either information about the working draft (<code>DRAFT</code> version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the <code>promptIdentifier</code> field or not. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html">View information about prompts using Prompt management</a> in the Amazon Bedrock User Guide.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -65,6 +65,7 @@ declare const UpdateAgentActionGroupCommand_base: {
65
65
  * required: true || false,
66
66
  * },
67
67
  * },
68
+ * requireConfirmation: "ENABLED" || "DISABLED",
68
69
  * },
69
70
  * ],
70
71
  * },
@@ -105,6 +106,7 @@ declare const UpdateAgentActionGroupCommand_base: {
105
106
  * // required: true || false,
106
107
  * // },
107
108
  * // },
109
+ * // requireConfirmation: "ENABLED" || "DISABLED",
108
110
  * // },
109
111
  * // ],
110
112
  * // },
@@ -211,6 +211,18 @@ export interface ParameterDetail {
211
211
  */
212
212
  required?: boolean;
213
213
  }
214
+ /**
215
+ * @public
216
+ * @enum
217
+ */
218
+ export declare const RequireConfirmation: {
219
+ readonly DISABLED: "DISABLED";
220
+ readonly ENABLED: "ENABLED";
221
+ };
222
+ /**
223
+ * @public
224
+ */
225
+ export type RequireConfirmation = (typeof RequireConfirmation)[keyof typeof RequireConfirmation];
214
226
  /**
215
227
  * <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
228
  * <p>This data type is used in the following API operations:</p>
@@ -259,6 +271,11 @@ export interface Function {
259
271
  * @public
260
272
  */
261
273
  parameters?: Record<string, ParameterDetail>;
274
+ /**
275
+ * <p>Contains information if user confirmation is required to invoke the function.</p>
276
+ * @public
277
+ */
278
+ requireConfirmation?: RequireConfirmation;
262
279
  }
263
280
  /**
264
281
  * <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>
@@ -2119,7 +2136,7 @@ export interface ConfluenceSourceConfiguration {
2119
2136
  authType: ConfluenceAuthType | undefined;
2120
2137
  /**
2121
2138
  * <p>The Amazon Resource Name of an Secrets Manager secret that
2122
- * stores your authentication credentials for your SharePoint site/sites.
2139
+ * stores your authentication credentials for your Confluence instance URL.
2123
2140
  * For more information on the key-value pairs that must be included in
2124
2141
  * your secret, depending on your authentication type, see
2125
2142
  * <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector">Confluence connection configuration</a>.</p>
@@ -2209,7 +2226,7 @@ export interface SalesforceSourceConfiguration {
2209
2226
  authType: SalesforceAuthType | undefined;
2210
2227
  /**
2211
2228
  * <p>The Amazon Resource Name of an Secrets Manager secret that
2212
- * stores your authentication credentials for your SharePoint site/sites.
2229
+ * stores your authentication credentials for your Salesforce instance URL.
2213
2230
  * For more information on the key-value pairs that must be included in
2214
2231
  * your secret, depending on your authentication type, see
2215
2232
  * <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector">Salesforce connection configuration</a>.</p>
@@ -2887,14 +2904,16 @@ export interface CreateDataSourceRequest {
2887
2904
  * <p>You can set the data deletion policy to:</p>
2888
2905
  * <ul>
2889
2906
  * <li>
2890
- * <p>DELETE: Deletes all underlying data belonging to
2891
- * the data source from the vector store upon deletion of a knowledge base or data
2892
- * source resource. Note that the vector store itself is not deleted, only the
2893
- * underlying data. This flag is ignored if an Amazon Web Services account is deleted.</p>
2907
+ * <p>DELETE: Deletes all data from your data source that’s converted
2908
+ * into vector embeddings upon deletion of a knowledge base or data source resource.
2909
+ * Note that the <b>vector store itself is not deleted</b>,
2910
+ * only the data. This flag is ignored if an Amazon Web Services account is deleted.</p>
2894
2911
  * </li>
2895
2912
  * <li>
2896
- * <p>RETAIN: Retains all underlying data in your
2897
- * vector store upon deletion of a knowledge base or data source resource.</p>
2913
+ * <p>RETAIN: Retains all data from your data source that’s converted
2914
+ * into vector embeddings upon deletion of a knowledge base or data source resource.
2915
+ * Note that the <b>vector store itself is not deleted</b>
2916
+ * if you delete a knowledge base or data source resource.</p>
2898
2917
  * </li>
2899
2918
  * </ul>
2900
2919
  * @public
@@ -4400,7 +4419,7 @@ export interface GetFlowAliasRequest {
4400
4419
  */
4401
4420
  export interface GetFlowAliasResponse {
4402
4421
  /**
4403
- * <p>The name of the flow alias.</p>
4422
+ * <p>The name of the alias.</p>
4404
4423
  * @public
4405
4424
  */
4406
4425
  name: string | undefined;
@@ -4435,7 +4454,7 @@ export interface GetFlowAliasResponse {
4435
4454
  */
4436
4455
  createdAt: Date | undefined;
4437
4456
  /**
4438
- * <p>The time at which the flow alias was last updated.</p>
4457
+ * <p>The time at which the alias was last updated.</p>
4439
4458
  * @public
4440
4459
  */
4441
4460
  updatedAt: Date | undefined;
@@ -4499,7 +4518,7 @@ export interface FlowAliasSummary {
4499
4518
  */
4500
4519
  id: string | undefined;
4501
4520
  /**
4502
- * <p>The Amazon Resource Name (ARN) of the flow alias.</p>
4521
+ * <p>The Amazon Resource Name (ARN) of the alias.</p>
4503
4522
  * @public
4504
4523
  */
4505
4524
  arn: string | undefined;
@@ -4519,7 +4538,7 @@ export interface FlowAliasSummary {
4519
4538
  */
4520
4539
  export interface ListFlowAliasesResponse {
4521
4540
  /**
4522
- * <p>A list, each member of which contains information about a flow alias.</p>
4541
+ * <p>A list, each member of which contains information about an alias.</p>
4523
4542
  * @public
4524
4543
  */
4525
4544
  flowAliasSummaries: FlowAliasSummary[] | undefined;
@@ -4534,12 +4553,12 @@ export interface ListFlowAliasesResponse {
4534
4553
  */
4535
4554
  export interface UpdateFlowAliasRequest {
4536
4555
  /**
4537
- * <p>The name of the flow alias.</p>
4556
+ * <p>The name of the alias.</p>
4538
4557
  * @public
4539
4558
  */
4540
4559
  name: string | undefined;
4541
4560
  /**
4542
- * <p>A description for the flow alias.</p>
4561
+ * <p>A description for the alias.</p>
4543
4562
  * @public
4544
4563
  */
4545
4564
  description?: string;
@@ -4564,7 +4583,7 @@ export interface UpdateFlowAliasRequest {
4564
4583
  */
4565
4584
  export interface UpdateFlowAliasResponse {
4566
4585
  /**
4567
- * <p>The name of the flow alias.</p>
4586
+ * <p>The name of the alias.</p>
4568
4587
  * @public
4569
4588
  */
4570
4589
  name: string | undefined;
@@ -4599,7 +4618,7 @@ export interface UpdateFlowAliasResponse {
4599
4618
  */
4600
4619
  createdAt: Date | undefined;
4601
4620
  /**
4602
- * <p>The time at which the flow alias was last updated.</p>
4621
+ * <p>The time at which the alias was last updated.</p>
4603
4622
  * @public
4604
4623
  */
4605
4624
  updatedAt: Date | undefined;
@@ -4630,12 +4649,12 @@ export interface CreateFlowVersionRequest {
4630
4649
  */
4631
4650
  export interface CreateFlowVersionResponse {
4632
4651
  /**
4633
- * <p>The name of the flow version.</p>
4652
+ * <p>The name of the version.</p>
4634
4653
  * @public
4635
4654
  */
4636
4655
  name: string | undefined;
4637
4656
  /**
4638
- * <p>The description of the flow version.</p>
4657
+ * <p>The description of the version.</p>
4639
4658
  * @public
4640
4659
  */
4641
4660
  description?: string;
@@ -4735,7 +4754,7 @@ export interface GetFlowVersionRequest {
4735
4754
  */
4736
4755
  export interface GetFlowVersionResponse {
4737
4756
  /**
4738
- * <p>The name of the flow version.</p>
4757
+ * <p>The name of the version.</p>
4739
4758
  * @public
4740
4759
  */
4741
4760
  name: string | undefined;
@@ -4806,7 +4825,7 @@ export interface ListFlowVersionsRequest {
4806
4825
  nextToken?: string;
4807
4826
  }
4808
4827
  /**
4809
- * <p>Contains information about the flow version.</p>
4828
+ * <p>Contains information about a version of a flow.</p>
4810
4829
  * <p>This data type is used in the following API operations:</p>
4811
4830
  * <ul>
4812
4831
  * <li>
@@ -4834,7 +4853,7 @@ export interface FlowVersionSummary {
4834
4853
  */
4835
4854
  status: FlowStatus | undefined;
4836
4855
  /**
4837
- * <p>The time at the flow version was created.</p>
4856
+ * <p>The time at the version was created.</p>
4838
4857
  * @public
4839
4858
  */
4840
4859
  createdAt: Date | undefined;
@@ -6563,12 +6582,12 @@ export interface CreatePromptVersionRequest {
6563
6582
  */
6564
6583
  export interface CreatePromptVersionResponse {
6565
6584
  /**
6566
- * <p>The name of the prompt version.</p>
6585
+ * <p>The name of the prompt.</p>
6567
6586
  * @public
6568
6587
  */
6569
6588
  name: string | undefined;
6570
6589
  /**
6571
- * <p>A description for the prompt version.</p>
6590
+ * <p>A description for the version.</p>
6572
6591
  * @public
6573
6592
  */
6574
6593
  description?: string;
@@ -6623,7 +6642,7 @@ export interface DeletePromptRequest {
6623
6642
  */
6624
6643
  promptIdentifier: string | undefined;
6625
6644
  /**
6626
- * <p>The version of the prompt to delete.</p>
6645
+ * <p>The version of the prompt to delete. To delete the prompt, omit this field.</p>
6627
6646
  * @public
6628
6647
  */
6629
6648
  promptVersion?: string;
@@ -6653,7 +6672,7 @@ export interface GetPromptRequest {
6653
6672
  */
6654
6673
  promptIdentifier: string | undefined;
6655
6674
  /**
6656
- * <p>The version of the prompt about which you want to retrieve information.</p>
6675
+ * <p>The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.</p>
6657
6676
  * @public
6658
6677
  */
6659
6678
  promptVersion?: string;
@@ -6693,7 +6712,7 @@ export interface GetPromptResponse {
6693
6712
  */
6694
6713
  id: string | undefined;
6695
6714
  /**
6696
- * <p>The Amazon Resource Name (ARN) of the prompt.</p>
6715
+ * <p>The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).</p>
6697
6716
  * @public
6698
6717
  */
6699
6718
  arn: string | undefined;
@@ -6718,7 +6737,7 @@ export interface GetPromptResponse {
6718
6737
  */
6719
6738
  export interface ListPromptsRequest {
6720
6739
  /**
6721
- * <p>The unique identifier of the prompt.</p>
6740
+ * <p>The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.</p>
6722
6741
  * @public
6723
6742
  */
6724
6743
  promptIdentifier?: string;
@@ -6762,7 +6781,7 @@ export interface PromptSummary {
6762
6781
  */
6763
6782
  id: string | undefined;
6764
6783
  /**
6765
- * <p>The Amazon Resource Name (ARN) of the prompt.</p>
6784
+ * <p>The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).</p>
6766
6785
  * @public
6767
6786
  */
6768
6787
  arn: string | undefined;
@@ -94,10 +94,17 @@ export interface ParameterDetail {
94
94
  type: Type | undefined;
95
95
  required?: boolean;
96
96
  }
97
+ export declare const RequireConfirmation: {
98
+ readonly DISABLED: "DISABLED";
99
+ readonly ENABLED: "ENABLED";
100
+ };
101
+ export type RequireConfirmation =
102
+ (typeof RequireConfirmation)[keyof typeof RequireConfirmation];
97
103
  export interface Function {
98
104
  name: string | undefined;
99
105
  description?: string;
100
106
  parameters?: Record<string, ParameterDetail>;
107
+ requireConfirmation?: RequireConfirmation;
101
108
  }
102
109
  export type FunctionSchema =
103
110
  | FunctionSchema.FunctionsMember
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.637.0",
4
+ "version": "3.638.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",