@aws-sdk/client-bedrock-agent 3.540.0 → 3.549.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/README.md +1 -2
- package/dist-types/BedrockAgent.d.ts +1 -2
- package/dist-types/BedrockAgentClient.d.ts +1 -2
- package/dist-types/commands/AssociateAgentKnowledgeBaseCommand.d.ts +8 -8
- package/dist-types/commands/CreateAgentActionGroupCommand.d.ts +9 -8
- package/dist-types/commands/CreateAgentAliasCommand.d.ts +8 -8
- package/dist-types/commands/CreateAgentCommand.d.ts +30 -7
- package/dist-types/commands/CreateDataSourceCommand.d.ts +11 -8
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +38 -7
- package/dist-types/commands/DeleteAgentActionGroupCommand.d.ts +7 -7
- package/dist-types/commands/DeleteAgentAliasCommand.d.ts +6 -6
- package/dist-types/commands/DeleteAgentCommand.d.ts +7 -7
- package/dist-types/commands/DeleteAgentVersionCommand.d.ts +7 -7
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +7 -7
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +7 -7
- package/dist-types/commands/DisassociateAgentKnowledgeBaseCommand.d.ts +7 -7
- package/dist-types/commands/GetAgentActionGroupCommand.d.ts +6 -6
- package/dist-types/commands/GetAgentAliasCommand.d.ts +6 -6
- package/dist-types/commands/GetAgentCommand.d.ts +6 -6
- package/dist-types/commands/GetAgentKnowledgeBaseCommand.d.ts +6 -6
- package/dist-types/commands/GetAgentVersionCommand.d.ts +6 -6
- package/dist-types/commands/GetDataSourceCommand.d.ts +6 -6
- package/dist-types/commands/GetIngestionJobCommand.d.ts +8 -6
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +6 -6
- package/dist-types/commands/ListAgentActionGroupsCommand.d.ts +6 -6
- package/dist-types/commands/ListAgentAliasesCommand.d.ts +6 -6
- package/dist-types/commands/ListAgentKnowledgeBasesCommand.d.ts +6 -6
- package/dist-types/commands/ListAgentVersionsCommand.d.ts +6 -6
- package/dist-types/commands/ListAgentsCommand.d.ts +5 -5
- package/dist-types/commands/ListDataSourcesCommand.d.ts +6 -6
- package/dist-types/commands/ListIngestionJobsCommand.d.ts +8 -6
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +5 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -6
- package/dist-types/commands/PrepareAgentCommand.d.ts +8 -8
- package/dist-types/commands/StartIngestionJobCommand.d.ts +10 -8
- package/dist-types/commands/TagResourceCommand.d.ts +7 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -6
- package/dist-types/commands/UpdateAgentActionGroupCommand.d.ts +8 -8
- package/dist-types/commands/UpdateAgentAliasCommand.d.ts +8 -8
- package/dist-types/commands/UpdateAgentCommand.d.ts +9 -9
- package/dist-types/commands/UpdateAgentKnowledgeBaseCommand.d.ts +7 -7
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +10 -7
- package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +26 -7
- package/dist-types/index.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +629 -534
- package/dist-types/ts3.4/models/models_0.d.ts +3 -1
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -6,8 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript BedrockAgent Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
which will echo the string
|
|
9
|
+
<p>Describes the API operations for creating and managing Amazon Bedrock agents.</p>
|
|
11
10
|
|
|
12
11
|
## Installing
|
|
13
12
|
|
|
@@ -285,8 +285,7 @@ export interface BedrockAgent {
|
|
|
285
285
|
updateKnowledgeBase(args: UpdateKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateKnowledgeBaseCommandOutput) => void): void;
|
|
286
286
|
}
|
|
287
287
|
/**
|
|
288
|
-
*
|
|
289
|
-
* which will echo the string
|
|
288
|
+
* <p>Describes the API operations for creating and managing Amazon Bedrock agents.</p>
|
|
290
289
|
* @public
|
|
291
290
|
*/
|
|
292
291
|
export declare class BedrockAgent extends BedrockAgentClient implements BedrockAgent {
|
|
@@ -191,8 +191,7 @@ export type BedrockAgentClientResolvedConfigType = __SmithyResolvedConfiguration
|
|
|
191
191
|
export interface BedrockAgentClientResolvedConfig extends BedrockAgentClientResolvedConfigType {
|
|
192
192
|
}
|
|
193
193
|
/**
|
|
194
|
-
*
|
|
195
|
-
* which will echo the string
|
|
194
|
+
* <p>Describes the API operations for creating and managing Amazon Bedrock agents.</p>
|
|
196
195
|
* @public
|
|
197
196
|
*/
|
|
198
197
|
export declare class BedrockAgentClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, BedrockAgentClientResolvedConfig> {
|
|
@@ -26,7 +26,7 @@ declare const AssociateAgentKnowledgeBaseCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* <p>Associates a knowledge base with an agent. If a knowledge base is associated and its <code>indexState</code> is set to <code>Enabled</code>, the agent queries the knowledge base for information to augment its response to the user.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -63,25 +63,25 @@ declare const AssociateAgentKnowledgeBaseCommand_base: {
|
|
|
63
63
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link AccessDeniedException} (client fault)
|
|
66
|
-
*
|
|
66
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ConflictException} (client fault)
|
|
69
|
-
*
|
|
69
|
+
* <p>There was a conflict performing an operation.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link InternalServerException} (server fault)
|
|
72
|
-
*
|
|
72
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
75
|
-
*
|
|
75
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
78
|
-
*
|
|
78
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link ThrottlingException} (client fault)
|
|
81
|
-
*
|
|
81
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
82
82
|
*
|
|
83
83
|
* @throws {@link ValidationException} (client fault)
|
|
84
|
-
*
|
|
84
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
85
85
|
*
|
|
86
86
|
* @throws {@link BedrockAgentServiceException}
|
|
87
87
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,8 @@ declare const CreateAgentActionGroupCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* Creates an
|
|
29
|
+
* <p>Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.</p>
|
|
30
|
+
* <p>To allow your agent to request the user for additional information when trying to complete a task, add an action group with the <code>parentActionGroupSignature</code> field set to <code>AMAZON.UserInput</code>. You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</p>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
33
|
* ```javascript
|
|
@@ -88,25 +89,25 @@ declare const CreateAgentActionGroupCommand_base: {
|
|
|
88
89
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
89
90
|
*
|
|
90
91
|
* @throws {@link AccessDeniedException} (client fault)
|
|
91
|
-
*
|
|
92
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
92
93
|
*
|
|
93
94
|
* @throws {@link ConflictException} (client fault)
|
|
94
|
-
*
|
|
95
|
+
* <p>There was a conflict performing an operation.</p>
|
|
95
96
|
*
|
|
96
97
|
* @throws {@link InternalServerException} (server fault)
|
|
97
|
-
*
|
|
98
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
98
99
|
*
|
|
99
100
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
100
|
-
*
|
|
101
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
101
102
|
*
|
|
102
103
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
103
|
-
*
|
|
104
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
104
105
|
*
|
|
105
106
|
* @throws {@link ThrottlingException} (client fault)
|
|
106
|
-
*
|
|
107
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
107
108
|
*
|
|
108
109
|
* @throws {@link ValidationException} (client fault)
|
|
109
|
-
*
|
|
110
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
110
111
|
*
|
|
111
112
|
* @throws {@link BedrockAgentServiceException}
|
|
112
113
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,7 @@ declare const CreateAgentAliasCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* Creates an
|
|
29
|
+
* <p>Creates an alias of an agent that can be used to deploy the agent.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -88,25 +88,25 @@ declare const CreateAgentAliasCommand_base: {
|
|
|
88
88
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
89
89
|
*
|
|
90
90
|
* @throws {@link AccessDeniedException} (client fault)
|
|
91
|
-
*
|
|
91
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
92
92
|
*
|
|
93
93
|
* @throws {@link ConflictException} (client fault)
|
|
94
|
-
*
|
|
94
|
+
* <p>There was a conflict performing an operation.</p>
|
|
95
95
|
*
|
|
96
96
|
* @throws {@link InternalServerException} (server fault)
|
|
97
|
-
*
|
|
97
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
98
98
|
*
|
|
99
99
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
100
|
-
*
|
|
100
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
101
101
|
*
|
|
102
102
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
103
|
-
*
|
|
103
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
104
104
|
*
|
|
105
105
|
* @throws {@link ThrottlingException} (client fault)
|
|
106
|
-
*
|
|
106
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
107
107
|
*
|
|
108
108
|
* @throws {@link ValidationException} (client fault)
|
|
109
|
-
*
|
|
109
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
110
110
|
*
|
|
111
111
|
* @throws {@link BedrockAgentServiceException}
|
|
112
112
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,30 @@ declare const CreateAgentCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* Creates an
|
|
29
|
+
* <p>Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.</p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>Specify the following fields for security purposes.</p>
|
|
33
|
+
* <ul>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>
|
|
36
|
+
* <code>agentResourceRoleArn</code> – The ARN of the role with permissions to create an agent.</p>
|
|
37
|
+
* </li>
|
|
38
|
+
* <li>
|
|
39
|
+
* <p>(Optional) <code>customerEncryptionKeyArn</code> – The ARN of a KMS key to encrypt the creation of the agent.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>(Optional) <code>idleSessionTTLinSeconds</code> – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent <code>InvokeAgent</code> request begins a new session.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* </ul>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>To override the default prompt behavior for agent orchestration and to use advanced prompts, include a <code>promptOverrideConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>If you agent fails to be created, the response returns a list of <code>failureReasons</code> alongside a list of <code>recommendedActions</code> for you to troubleshoot.</p>
|
|
51
|
+
* </li>
|
|
52
|
+
* </ul>
|
|
30
53
|
* @example
|
|
31
54
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
55
|
* ```javascript
|
|
@@ -125,22 +148,22 @@ declare const CreateAgentCommand_base: {
|
|
|
125
148
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
126
149
|
*
|
|
127
150
|
* @throws {@link AccessDeniedException} (client fault)
|
|
128
|
-
*
|
|
151
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
129
152
|
*
|
|
130
153
|
* @throws {@link ConflictException} (client fault)
|
|
131
|
-
*
|
|
154
|
+
* <p>There was a conflict performing an operation.</p>
|
|
132
155
|
*
|
|
133
156
|
* @throws {@link InternalServerException} (server fault)
|
|
134
|
-
*
|
|
157
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
135
158
|
*
|
|
136
159
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
137
|
-
*
|
|
160
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
138
161
|
*
|
|
139
162
|
* @throws {@link ThrottlingException} (client fault)
|
|
140
|
-
*
|
|
163
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
141
164
|
*
|
|
142
165
|
* @throws {@link ValidationException} (client fault)
|
|
143
|
-
*
|
|
166
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
144
167
|
*
|
|
145
168
|
* @throws {@link BedrockAgentServiceException}
|
|
146
169
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,10 @@ declare const CreateDataSourceCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* <p>Sets up a data source to be added to a knowledge base.</p>
|
|
30
|
+
* <important>
|
|
31
|
+
* <p>You can't change the <code>chunkingConfiguration</code> after you create the data source.</p>
|
|
32
|
+
* </important>
|
|
30
33
|
* @example
|
|
31
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
35
|
* ```javascript
|
|
@@ -104,25 +107,25 @@ declare const CreateDataSourceCommand_base: {
|
|
|
104
107
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
105
108
|
*
|
|
106
109
|
* @throws {@link AccessDeniedException} (client fault)
|
|
107
|
-
*
|
|
110
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
108
111
|
*
|
|
109
112
|
* @throws {@link ConflictException} (client fault)
|
|
110
|
-
*
|
|
113
|
+
* <p>There was a conflict performing an operation.</p>
|
|
111
114
|
*
|
|
112
115
|
* @throws {@link InternalServerException} (server fault)
|
|
113
|
-
*
|
|
116
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
114
117
|
*
|
|
115
118
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
116
|
-
*
|
|
119
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
117
120
|
*
|
|
118
121
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
119
|
-
*
|
|
122
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
120
123
|
*
|
|
121
124
|
* @throws {@link ThrottlingException} (client fault)
|
|
122
|
-
*
|
|
125
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
123
126
|
*
|
|
124
127
|
* @throws {@link ValidationException} (client fault)
|
|
125
|
-
*
|
|
128
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
126
129
|
*
|
|
127
130
|
* @throws {@link BedrockAgentServiceException}
|
|
128
131
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,38 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* <p>Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup.html">Set up your data for ingestion</a>.</p>
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create">Create a knowledge base</a>.</p>
|
|
32
|
+
* </note>
|
|
33
|
+
* <ul>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>Provide the <code>name</code> and an optional <code>description</code>.</p>
|
|
36
|
+
* </li>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>Provide the ARN with permissions to create a knowledge base in the <code>roleArn</code> field.</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>Provide the embedding model to use in the <code>embeddingModelArn</code> field in the <code>knowledgeBaseConfiguration</code> object.</p>
|
|
42
|
+
* </li>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>Provide the configuration for your vector store in the <code>storageConfiguration</code> object.</p>
|
|
45
|
+
* <ul>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>For an Amazon OpenSearch Service database, use the <code>opensearchServerlessConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector store in Amazon OpenSearch Service</a>.</p>
|
|
48
|
+
* </li>
|
|
49
|
+
* <li>
|
|
50
|
+
* <p>For an Amazon Aurora database, use the <code>RdsConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector store in Amazon Aurora</a>.</p>
|
|
51
|
+
* </li>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>For a Pinecone database, use the <code>pineconeConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html">Create a vector store in Pinecone</a>.</p>
|
|
54
|
+
* </li>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>For a Redis Enterprise Cloud database, use the <code>redisEnterpriseCloudConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html">Create a vector store in Redis Enterprise Cloud</a>.</p>
|
|
57
|
+
* </li>
|
|
58
|
+
* </ul>
|
|
59
|
+
* </li>
|
|
60
|
+
* </ul>
|
|
30
61
|
* @example
|
|
31
62
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
63
|
* ```javascript
|
|
@@ -167,22 +198,22 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
167
198
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
168
199
|
*
|
|
169
200
|
* @throws {@link AccessDeniedException} (client fault)
|
|
170
|
-
*
|
|
201
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
171
202
|
*
|
|
172
203
|
* @throws {@link ConflictException} (client fault)
|
|
173
|
-
*
|
|
204
|
+
* <p>There was a conflict performing an operation.</p>
|
|
174
205
|
*
|
|
175
206
|
* @throws {@link InternalServerException} (server fault)
|
|
176
|
-
*
|
|
207
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
177
208
|
*
|
|
178
209
|
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
179
|
-
*
|
|
210
|
+
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
180
211
|
*
|
|
181
212
|
* @throws {@link ThrottlingException} (client fault)
|
|
182
|
-
*
|
|
213
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
183
214
|
*
|
|
184
215
|
* @throws {@link ValidationException} (client fault)
|
|
185
|
-
*
|
|
216
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
186
217
|
*
|
|
187
218
|
* @throws {@link BedrockAgentServiceException}
|
|
188
219
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteAgentActionGroupCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* Deletes an
|
|
29
|
+
* <p>Deletes an action group in an agent.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -52,22 +52,22 @@ declare const DeleteAgentActionGroupCommand_base: {
|
|
|
52
52
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
53
53
|
*
|
|
54
54
|
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
-
*
|
|
55
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ConflictException} (client fault)
|
|
58
|
-
*
|
|
58
|
+
* <p>There was a conflict performing an operation.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link InternalServerException} (server fault)
|
|
61
|
-
*
|
|
61
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
-
*
|
|
64
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ThrottlingException} (client fault)
|
|
67
|
-
*
|
|
67
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ValidationException} (client fault)
|
|
70
|
-
*
|
|
70
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link BedrockAgentServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteAgentAliasCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* Deletes an
|
|
29
|
+
* <p>Deletes an alias of an agent.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -54,19 +54,19 @@ declare const DeleteAgentAliasCommand_base: {
|
|
|
54
54
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
-
*
|
|
57
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link InternalServerException} (server fault)
|
|
60
|
-
*
|
|
60
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
63
|
-
*
|
|
63
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
-
*
|
|
66
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ValidationException} (client fault)
|
|
69
|
-
*
|
|
69
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link BedrockAgentServiceException}
|
|
72
72
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteAgentCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* Deletes an
|
|
29
|
+
* <p>Deletes an agent.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -53,22 +53,22 @@ declare const DeleteAgentCommand_base: {
|
|
|
53
53
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link AccessDeniedException} (client fault)
|
|
56
|
-
*
|
|
56
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link ConflictException} (client fault)
|
|
59
|
-
*
|
|
59
|
+
* <p>There was a conflict performing an operation.</p>
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InternalServerException} (server fault)
|
|
62
|
-
*
|
|
62
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
65
|
-
*
|
|
65
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link ThrottlingException} (client fault)
|
|
68
|
-
*
|
|
68
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
69
69
|
*
|
|
70
70
|
* @throws {@link ValidationException} (client fault)
|
|
71
|
-
*
|
|
71
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
72
72
|
*
|
|
73
73
|
* @throws {@link BedrockAgentServiceException}
|
|
74
74
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteAgentVersionCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* Deletes
|
|
29
|
+
* <p>Deletes a version of an agent.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -55,22 +55,22 @@ declare const DeleteAgentVersionCommand_base: {
|
|
|
55
55
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link AccessDeniedException} (client fault)
|
|
58
|
-
*
|
|
58
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link ConflictException} (client fault)
|
|
61
|
-
*
|
|
61
|
+
* <p>There was a conflict performing an operation.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link InternalServerException} (server fault)
|
|
64
|
-
*
|
|
64
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
67
|
-
*
|
|
67
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ThrottlingException} (client fault)
|
|
70
|
-
*
|
|
70
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link ValidationException} (client fault)
|
|
73
|
-
*
|
|
73
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link BedrockAgentServiceException}
|
|
76
76
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteDataSourceCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* <p>Deletes a data source from a knowledge base.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -54,22 +54,22 @@ declare const DeleteDataSourceCommand_base: {
|
|
|
54
54
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link AccessDeniedException} (client fault)
|
|
57
|
-
*
|
|
57
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link ConflictException} (client fault)
|
|
60
|
-
*
|
|
60
|
+
* <p>There was a conflict performing an operation.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link InternalServerException} (server fault)
|
|
63
|
-
*
|
|
63
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
66
|
-
*
|
|
66
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
67
67
|
*
|
|
68
68
|
* @throws {@link ThrottlingException} (client fault)
|
|
69
|
-
*
|
|
69
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link ValidationException} (client fault)
|
|
72
|
-
*
|
|
72
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link BedrockAgentServiceException}
|
|
75
75
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|
|
@@ -26,7 +26,7 @@ declare const DeleteKnowledgeBaseCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* <p>Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DisassociateAgentKnowledgeBase.html">DisassociateAgentKnowledgeBase</a> request.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -52,22 +52,22 @@ declare const DeleteKnowledgeBaseCommand_base: {
|
|
|
52
52
|
* @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape.
|
|
53
53
|
*
|
|
54
54
|
* @throws {@link AccessDeniedException} (client fault)
|
|
55
|
-
*
|
|
55
|
+
* <p>The request is denied because of missing access permissions.</p>
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link ConflictException} (client fault)
|
|
58
|
-
*
|
|
58
|
+
* <p>There was a conflict performing an operation.</p>
|
|
59
59
|
*
|
|
60
60
|
* @throws {@link InternalServerException} (server fault)
|
|
61
|
-
*
|
|
61
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
62
62
|
*
|
|
63
63
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
64
|
-
*
|
|
64
|
+
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ThrottlingException} (client fault)
|
|
67
|
-
*
|
|
67
|
+
* <p>The number of requests exceeds the limit. Resubmit your request later.</p>
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link ValidationException} (client fault)
|
|
70
|
-
*
|
|
70
|
+
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link BedrockAgentServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from BedrockAgent service.</p>
|