From f6cf1003961f860d9be6e98615919937ee22ce78 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 27 Mar 2024 18:31:43 +0000 Subject: [PATCH] feat(client-bedrock-agent): This changes introduces metadata documents statistics and also updates the documentation for bedrock agent. --- clients/client-bedrock-agent/README.md | 3 +- .../client-bedrock-agent/src/BedrockAgent.ts | 3 +- .../src/BedrockAgentClient.ts | 3 +- .../AssociateAgentKnowledgeBaseCommand.ts | 16 +- .../commands/CreateAgentActionGroupCommand.ts | 17 +- .../src/commands/CreateAgentAliasCommand.ts | 16 +- .../src/commands/CreateAgentCommand.ts | 37 +- .../src/commands/CreateDataSourceCommand.ts | 19 +- .../commands/CreateKnowledgeBaseCommand.ts | 45 +- .../commands/DeleteAgentActionGroupCommand.ts | 14 +- .../src/commands/DeleteAgentAliasCommand.ts | 12 +- .../src/commands/DeleteAgentCommand.ts | 14 +- .../src/commands/DeleteAgentVersionCommand.ts | 14 +- .../src/commands/DeleteDataSourceCommand.ts | 14 +- .../commands/DeleteKnowledgeBaseCommand.ts | 14 +- .../DisassociateAgentKnowledgeBaseCommand.ts | 14 +- .../commands/GetAgentActionGroupCommand.ts | 12 +- .../src/commands/GetAgentAliasCommand.ts | 12 +- .../src/commands/GetAgentCommand.ts | 12 +- .../commands/GetAgentKnowledgeBaseCommand.ts | 12 +- .../src/commands/GetAgentVersionCommand.ts | 12 +- .../src/commands/GetDataSourceCommand.ts | 12 +- .../src/commands/GetIngestionJobCommand.ts | 14 +- .../src/commands/GetKnowledgeBaseCommand.ts | 12 +- .../commands/ListAgentActionGroupsCommand.ts | 12 +- .../src/commands/ListAgentAliasesCommand.ts | 12 +- .../ListAgentKnowledgeBasesCommand.ts | 12 +- .../src/commands/ListAgentVersionsCommand.ts | 12 +- .../src/commands/ListAgentsCommand.ts | 10 +- .../src/commands/ListDataSourcesCommand.ts | 12 +- .../src/commands/ListIngestionJobsCommand.ts | 14 +- .../src/commands/ListKnowledgeBasesCommand.ts | 10 +- .../commands/ListTagsForResourceCommand.ts | 12 +- .../src/commands/PrepareAgentCommand.ts | 16 +- .../src/commands/StartIngestionJobCommand.ts | 18 +- .../src/commands/TagResourceCommand.ts | 14 +- .../src/commands/UntagResourceCommand.ts | 12 +- .../commands/UpdateAgentActionGroupCommand.ts | 16 +- .../src/commands/UpdateAgentAliasCommand.ts | 16 +- .../src/commands/UpdateAgentCommand.ts | 18 +- .../UpdateAgentKnowledgeBaseCommand.ts | 14 +- .../src/commands/UpdateDataSourceCommand.ts | 17 +- .../commands/UpdateKnowledgeBaseCommand.ts | 33 +- clients/client-bedrock-agent/src/index.ts | 3 +- .../src/models/models_0.ts | 1165 +++++++------ .../sdk-codegen/aws-models/bedrock-agent.json | 1448 +++++++++++------ 46 files changed, 1963 insertions(+), 1286 deletions(-) diff --git a/clients/client-bedrock-agent/README.md b/clients/client-bedrock-agent/README.md index b36713cf1573..f7f4bafc2597 100644 --- a/clients/client-bedrock-agent/README.md +++ b/clients/client-bedrock-agent/README.md @@ -6,8 +6,7 @@ AWS SDK for JavaScript BedrockAgent Client for Node.js, Browser and React Native. -An example service, deployed with the Octane Service creator, -which will echo the string +

Describes the API operations for creating and managing Amazon Bedrock agents.

## Installing diff --git a/clients/client-bedrock-agent/src/BedrockAgent.ts b/clients/client-bedrock-agent/src/BedrockAgent.ts index 6ba5baf25d95..894928b3ac19 100644 --- a/clients/client-bedrock-agent/src/BedrockAgent.ts +++ b/clients/client-bedrock-agent/src/BedrockAgent.ts @@ -839,8 +839,7 @@ export interface BedrockAgent { } /** - * An example service, deployed with the Octane Service creator, - * which will echo the string + *

Describes the API operations for creating and managing Amazon Bedrock agents.

* @public */ export class BedrockAgent extends BedrockAgentClient implements BedrockAgent {} diff --git a/clients/client-bedrock-agent/src/BedrockAgentClient.ts b/clients/client-bedrock-agent/src/BedrockAgentClient.ts index 265c9c7a2933..1fbed7bb855a 100644 --- a/clients/client-bedrock-agent/src/BedrockAgentClient.ts +++ b/clients/client-bedrock-agent/src/BedrockAgentClient.ts @@ -408,8 +408,7 @@ export type BedrockAgentClientResolvedConfigType = __SmithyResolvedConfiguration export interface BedrockAgentClientResolvedConfig extends BedrockAgentClientResolvedConfigType {} /** - * An example service, deployed with the Octane Service creator, - * which will echo the string + *

Describes the API operations for creating and managing Amazon Bedrock agents.

* @public */ export class BedrockAgentClient extends __Client< diff --git a/clients/client-bedrock-agent/src/commands/AssociateAgentKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/AssociateAgentKnowledgeBaseCommand.ts index 7c62a4e4cfd0..2f647cde89db 100644 --- a/clients/client-bedrock-agent/src/commands/AssociateAgentKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/AssociateAgentKnowledgeBaseCommand.ts @@ -32,7 +32,7 @@ export interface AssociateAgentKnowledgeBaseCommandOutput __MetadataBearer {} /** - * Associate a Knowledge Base to an existing Amazon Bedrock Agent + *

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -69,25 +69,25 @@ export interface AssociateAgentKnowledgeBaseCommandOutput * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/CreateAgentActionGroupCommand.ts b/clients/client-bedrock-agent/src/commands/CreateAgentActionGroupCommand.ts index c20fbe510328..e3f42368412d 100644 --- a/clients/client-bedrock-agent/src/commands/CreateAgentActionGroupCommand.ts +++ b/clients/client-bedrock-agent/src/commands/CreateAgentActionGroupCommand.ts @@ -32,7 +32,8 @@ export interface CreateAgentActionGroupCommandInput extends CreateAgentActionGro export interface CreateAgentActionGroupCommandOutput extends CreateAgentActionGroupResponse, __MetadataBearer {} /** - * Creates an Action Group for existing Amazon Bedrock Agent + *

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.

+ *

To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor 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 Observation reprompting the user for more information.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -94,25 +95,25 @@ export interface CreateAgentActionGroupCommandOutput extends CreateAgentActionGr * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/CreateAgentAliasCommand.ts b/clients/client-bedrock-agent/src/commands/CreateAgentAliasCommand.ts index 93b7e03b204b..dcecb3e2a7da 100644 --- a/clients/client-bedrock-agent/src/commands/CreateAgentAliasCommand.ts +++ b/clients/client-bedrock-agent/src/commands/CreateAgentAliasCommand.ts @@ -27,7 +27,7 @@ export interface CreateAgentAliasCommandInput extends CreateAgentAliasRequest {} export interface CreateAgentAliasCommandOutput extends CreateAgentAliasResponse, __MetadataBearer {} /** - * Creates an Alias for an existing Amazon Bedrock Agent + *

Creates an alias of an agent that can be used to deploy the agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -89,25 +89,25 @@ export interface CreateAgentAliasCommandOutput extends CreateAgentAliasResponse, * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/CreateAgentCommand.ts b/clients/client-bedrock-agent/src/commands/CreateAgentCommand.ts index 12e9c2789607..a65e166dea86 100644 --- a/clients/client-bedrock-agent/src/commands/CreateAgentCommand.ts +++ b/clients/client-bedrock-agent/src/commands/CreateAgentCommand.ts @@ -32,7 +32,30 @@ export interface CreateAgentCommandInput extends CreateAgentRequest {} export interface CreateAgentCommandOutput extends CreateAgentResponse, __MetadataBearer {} /** - * Creates an Amazon Bedrock Agent + *

Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -131,22 +154,22 @@ export interface CreateAgentCommandOutput extends CreateAgentResponse, __Metadat * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/CreateDataSourceCommand.ts b/clients/client-bedrock-agent/src/commands/CreateDataSourceCommand.ts index cc258d8d48af..dd0b50bfb62f 100644 --- a/clients/client-bedrock-agent/src/commands/CreateDataSourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/CreateDataSourceCommand.ts @@ -27,7 +27,10 @@ export interface CreateDataSourceCommandInput extends CreateDataSourceRequest {} export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, __MetadataBearer {} /** - * Create a new data source + *

Sets up a data source to be added to a knowledge base.

+ * + *

You can't change the chunkingConfiguration after you create the data source.

+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -105,25 +108,25 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/CreateKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/CreateKnowledgeBaseCommand.ts index f8c6db41f2c5..63915cce534e 100644 --- a/clients/client-bedrock-agent/src/commands/CreateKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/CreateKnowledgeBaseCommand.ts @@ -27,7 +27,38 @@ export interface CreateKnowledgeBaseCommandInput extends CreateKnowledgeBaseRequ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseResponse, __MetadataBearer {} /** - * Create a new knowledge base + *

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 Set up your data for ingestion.

+ * + *

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 Create a knowledge base.

+ *
+ * * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -168,22 +199,22 @@ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseRes * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/DeleteAgentActionGroupCommand.ts b/clients/client-bedrock-agent/src/commands/DeleteAgentActionGroupCommand.ts index 685146c9590a..3cfa3e42c432 100644 --- a/clients/client-bedrock-agent/src/commands/DeleteAgentActionGroupCommand.ts +++ b/clients/client-bedrock-agent/src/commands/DeleteAgentActionGroupCommand.ts @@ -27,7 +27,7 @@ export interface DeleteAgentActionGroupCommandInput extends DeleteAgentActionGro export interface DeleteAgentActionGroupCommandOutput extends DeleteAgentActionGroupResponse, __MetadataBearer {} /** - * Deletes an Action Group for existing Amazon Bedrock Agent. + *

Deletes an action group in an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -53,22 +53,22 @@ export interface DeleteAgentActionGroupCommandOutput extends DeleteAgentActionGr * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/DeleteAgentAliasCommand.ts b/clients/client-bedrock-agent/src/commands/DeleteAgentAliasCommand.ts index 6e674cddd121..869b4fd19c7c 100644 --- a/clients/client-bedrock-agent/src/commands/DeleteAgentAliasCommand.ts +++ b/clients/client-bedrock-agent/src/commands/DeleteAgentAliasCommand.ts @@ -27,7 +27,7 @@ export interface DeleteAgentAliasCommandInput extends DeleteAgentAliasRequest {} export interface DeleteAgentAliasCommandOutput extends DeleteAgentAliasResponse, __MetadataBearer {} /** - * Deletes an Alias for a Amazon Bedrock Agent + *

Deletes an alias of an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -55,19 +55,19 @@ export interface DeleteAgentAliasCommandOutput extends DeleteAgentAliasResponse, * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/DeleteAgentCommand.ts b/clients/client-bedrock-agent/src/commands/DeleteAgentCommand.ts index a2e60adf9bd9..7c48eef8c42d 100644 --- a/clients/client-bedrock-agent/src/commands/DeleteAgentCommand.ts +++ b/clients/client-bedrock-agent/src/commands/DeleteAgentCommand.ts @@ -27,7 +27,7 @@ export interface DeleteAgentCommandInput extends DeleteAgentRequest {} export interface DeleteAgentCommandOutput extends DeleteAgentResponse, __MetadataBearer {} /** - * Deletes an Agent for existing Amazon Bedrock Agent + *

Deletes an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -54,22 +54,22 @@ export interface DeleteAgentCommandOutput extends DeleteAgentResponse, __Metadat * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/DeleteAgentVersionCommand.ts b/clients/client-bedrock-agent/src/commands/DeleteAgentVersionCommand.ts index 6ee9044a157d..77767c4d64be 100644 --- a/clients/client-bedrock-agent/src/commands/DeleteAgentVersionCommand.ts +++ b/clients/client-bedrock-agent/src/commands/DeleteAgentVersionCommand.ts @@ -27,7 +27,7 @@ export interface DeleteAgentVersionCommandInput extends DeleteAgentVersionReques export interface DeleteAgentVersionCommandOutput extends DeleteAgentVersionResponse, __MetadataBearer {} /** - * Deletes an Agent version for existing Amazon Bedrock Agent + *

Deletes a version of an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -56,22 +56,22 @@ export interface DeleteAgentVersionCommandOutput extends DeleteAgentVersionRespo * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/DeleteDataSourceCommand.ts b/clients/client-bedrock-agent/src/commands/DeleteDataSourceCommand.ts index e346bb0f6b6f..6403fa8c3893 100644 --- a/clients/client-bedrock-agent/src/commands/DeleteDataSourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/DeleteDataSourceCommand.ts @@ -27,7 +27,7 @@ export interface DeleteDataSourceCommandInput extends DeleteDataSourceRequest {} export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse, __MetadataBearer {} /** - * Delete an existing data source + *

Deletes a data source from a knowledge base.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -55,22 +55,22 @@ export interface DeleteDataSourceCommandOutput extends DeleteDataSourceResponse, * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/DeleteKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/DeleteKnowledgeBaseCommand.ts index 3b672df0b35f..3f689c9a10dc 100644 --- a/clients/client-bedrock-agent/src/commands/DeleteKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/DeleteKnowledgeBaseCommand.ts @@ -27,7 +27,7 @@ export interface DeleteKnowledgeBaseCommandInput extends DeleteKnowledgeBaseRequ export interface DeleteKnowledgeBaseCommandOutput extends DeleteKnowledgeBaseResponse, __MetadataBearer {} /** - * Delete an existing knowledge base + *

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 DisassociateAgentKnowledgeBase request.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -53,22 +53,22 @@ export interface DeleteKnowledgeBaseCommandOutput extends DeleteKnowledgeBaseRes * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/DisassociateAgentKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/DisassociateAgentKnowledgeBaseCommand.ts index e9699351cc47..f00108e4162d 100644 --- a/clients/client-bedrock-agent/src/commands/DisassociateAgentKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/DisassociateAgentKnowledgeBaseCommand.ts @@ -32,7 +32,7 @@ export interface DisassociateAgentKnowledgeBaseCommandOutput __MetadataBearer {} /** - * Disassociate an existing Knowledge Base from an Amazon Bedrock Agent + *

Disassociates a knowledge base from an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -57,22 +57,22 @@ export interface DisassociateAgentKnowledgeBaseCommandOutput * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/GetAgentActionGroupCommand.ts b/clients/client-bedrock-agent/src/commands/GetAgentActionGroupCommand.ts index 47315212b52a..695473dd3f67 100644 --- a/clients/client-bedrock-agent/src/commands/GetAgentActionGroupCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetAgentActionGroupCommand.ts @@ -31,7 +31,7 @@ export interface GetAgentActionGroupCommandInput extends GetAgentActionGroupRequ export interface GetAgentActionGroupCommandOutput extends GetAgentActionGroupResponse, __MetadataBearer {} /** - * Gets an Action Group for existing Amazon Bedrock Agent Version + *

Gets information about an action group for an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -79,19 +79,19 @@ export interface GetAgentActionGroupCommandOutput extends GetAgentActionGroupRes * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/GetAgentAliasCommand.ts b/clients/client-bedrock-agent/src/commands/GetAgentAliasCommand.ts index 1b285bc127ad..a67d1c72979b 100644 --- a/clients/client-bedrock-agent/src/commands/GetAgentAliasCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetAgentAliasCommand.ts @@ -27,7 +27,7 @@ export interface GetAgentAliasCommandInput extends GetAgentAliasRequest {} export interface GetAgentAliasCommandOutput extends GetAgentAliasResponse, __MetadataBearer {} /** - * Describes an Alias for a Amazon Bedrock Agent + *

Gets information about an alias of an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -79,19 +79,19 @@ export interface GetAgentAliasCommandOutput extends GetAgentAliasResponse, __Met * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/GetAgentCommand.ts b/clients/client-bedrock-agent/src/commands/GetAgentCommand.ts index 253671b705b4..f8c3316e8b27 100644 --- a/clients/client-bedrock-agent/src/commands/GetAgentCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetAgentCommand.ts @@ -27,7 +27,7 @@ export interface GetAgentCommandInput extends GetAgentRequest {} export interface GetAgentCommandOutput extends GetAgentResponse, __MetadataBearer {} /** - * Gets an Agent for existing Amazon Bedrock Agent + *

Gets information about an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -95,19 +95,19 @@ export interface GetAgentCommandOutput extends GetAgentResponse, __MetadataBeare * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/GetAgentKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/GetAgentKnowledgeBaseCommand.ts index 6c54edc3cc80..16ae8de6a31e 100644 --- a/clients/client-bedrock-agent/src/commands/GetAgentKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetAgentKnowledgeBaseCommand.ts @@ -27,7 +27,7 @@ export interface GetAgentKnowledgeBaseCommandInput extends GetAgentKnowledgeBase export interface GetAgentKnowledgeBaseCommandOutput extends GetAgentKnowledgeBaseResponse, __MetadataBearer {} /** - * Gets a knowledge base associated to an existing Amazon Bedrock Agent Version + *

Gets information about a knowledge base associated with an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -62,19 +62,19 @@ export interface GetAgentKnowledgeBaseCommandOutput extends GetAgentKnowledgeBas * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/GetAgentVersionCommand.ts b/clients/client-bedrock-agent/src/commands/GetAgentVersionCommand.ts index 9542133e4462..3a0e40d4fe4a 100644 --- a/clients/client-bedrock-agent/src/commands/GetAgentVersionCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetAgentVersionCommand.ts @@ -31,7 +31,7 @@ export interface GetAgentVersionCommandInput extends GetAgentVersionRequest {} export interface GetAgentVersionCommandOutput extends GetAgentVersionResponse, __MetadataBearer {} /** - * Gets an Agent version for existing Amazon Bedrock Agent + *

Gets details about a version of an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -98,19 +98,19 @@ export interface GetAgentVersionCommandOutput extends GetAgentVersionResponse, _ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts b/clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts index 1066fa707479..eacfc40b7577 100644 --- a/clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetDataSourceCommand.ts @@ -27,7 +27,7 @@ export interface GetDataSourceCommandInput extends GetDataSourceRequest {} export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __MetadataBearer {} /** - * Get an existing data source + *

Gets information about a data source.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -82,19 +82,19 @@ export interface GetDataSourceCommandOutput extends GetDataSourceResponse, __Met * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/GetIngestionJobCommand.ts b/clients/client-bedrock-agent/src/commands/GetIngestionJobCommand.ts index f7fa7b14c533..8cd344e368df 100644 --- a/clients/client-bedrock-agent/src/commands/GetIngestionJobCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetIngestionJobCommand.ts @@ -27,7 +27,7 @@ export interface GetIngestionJobCommandInput extends GetIngestionJobRequest {} export interface GetIngestionJobCommandOutput extends GetIngestionJobResponse, __MetadataBearer {} /** - * Get an ingestion job + *

Gets information about a ingestion job, in which a data source is added to a knowledge base.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -50,8 +50,10 @@ export interface GetIngestionJobCommandOutput extends GetIngestionJobResponse, _ * // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED", // required * // statistics: { // IngestionJobStatistics * // numberOfDocumentsScanned: Number("long"), + * // numberOfMetadataDocumentsScanned: Number("long"), * // numberOfNewDocumentsIndexed: Number("long"), * // numberOfModifiedDocumentsIndexed: Number("long"), + * // numberOfMetadataDocumentsModified: Number("long"), * // numberOfDocumentsDeleted: Number("long"), * // numberOfDocumentsFailed: Number("long"), * // }, @@ -72,19 +74,19 @@ export interface GetIngestionJobCommandOutput extends GetIngestionJobResponse, _ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/GetKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/GetKnowledgeBaseCommand.ts index f32af63a54a3..f8c39eac7f93 100644 --- a/clients/client-bedrock-agent/src/commands/GetKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/GetKnowledgeBaseCommand.ts @@ -27,7 +27,7 @@ export interface GetKnowledgeBaseCommandInput extends GetKnowledgeBaseRequest {} export interface GetKnowledgeBaseCommandOutput extends GetKnowledgeBaseResponse, __MetadataBearer {} /** - * Get an existing knowledge base + *

Gets information about a knoweldge base.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -113,19 +113,19 @@ export interface GetKnowledgeBaseCommandOutput extends GetKnowledgeBaseResponse, * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListAgentActionGroupsCommand.ts b/clients/client-bedrock-agent/src/commands/ListAgentActionGroupsCommand.ts index 5dc643aaf823..648e3eb6afb2 100644 --- a/clients/client-bedrock-agent/src/commands/ListAgentActionGroupsCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListAgentActionGroupsCommand.ts @@ -27,7 +27,7 @@ export interface ListAgentActionGroupsCommandInput extends ListAgentActionGroups export interface ListAgentActionGroupsCommandOutput extends ListAgentActionGroupsResponse, __MetadataBearer {} /** - * Lists an Action Group for existing Amazon Bedrock Agent Version + *

Lists the action groups for an agent and information about each one.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -64,19 +64,19 @@ export interface ListAgentActionGroupsCommandOutput extends ListAgentActionGroup * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListAgentAliasesCommand.ts b/clients/client-bedrock-agent/src/commands/ListAgentAliasesCommand.ts index c0be045e13c9..16d7729d6b54 100644 --- a/clients/client-bedrock-agent/src/commands/ListAgentAliasesCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListAgentAliasesCommand.ts @@ -27,7 +27,7 @@ export interface ListAgentAliasesCommandInput extends ListAgentAliasesRequest {} export interface ListAgentAliasesCommandOutput extends ListAgentAliasesResponse, __MetadataBearer {} /** - * Lists all the Aliases for an Amazon Bedrock Agent + *

Lists the aliases of an agent and information about each one.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -69,19 +69,19 @@ export interface ListAgentAliasesCommandOutput extends ListAgentAliasesResponse, * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListAgentKnowledgeBasesCommand.ts b/clients/client-bedrock-agent/src/commands/ListAgentKnowledgeBasesCommand.ts index 63be5fa4d300..9ea273df4fbe 100644 --- a/clients/client-bedrock-agent/src/commands/ListAgentKnowledgeBasesCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListAgentKnowledgeBasesCommand.ts @@ -27,7 +27,7 @@ export interface ListAgentKnowledgeBasesCommandInput extends ListAgentKnowledgeB export interface ListAgentKnowledgeBasesCommandOutput extends ListAgentKnowledgeBasesResponse, __MetadataBearer {} /** - * List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version + *

Lists knowledge bases associated with an agent and information about each one.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,19 +63,19 @@ export interface ListAgentKnowledgeBasesCommandOutput extends ListAgentKnowledge * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListAgentVersionsCommand.ts b/clients/client-bedrock-agent/src/commands/ListAgentVersionsCommand.ts index 65816b4dd06e..12f1ea7456ad 100644 --- a/clients/client-bedrock-agent/src/commands/ListAgentVersionsCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListAgentVersionsCommand.ts @@ -27,7 +27,7 @@ export interface ListAgentVersionsCommandInput extends ListAgentVersionsRequest export interface ListAgentVersionsCommandOutput extends ListAgentVersionsResponse, __MetadataBearer {} /** - * Lists Agent Versions + *

Lists the versions of an agent and information about each version.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -64,19 +64,19 @@ export interface ListAgentVersionsCommandOutput extends ListAgentVersionsRespons * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListAgentsCommand.ts b/clients/client-bedrock-agent/src/commands/ListAgentsCommand.ts index 9e03d45bddfb..58a2843bac02 100644 --- a/clients/client-bedrock-agent/src/commands/ListAgentsCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListAgentsCommand.ts @@ -27,7 +27,7 @@ export interface ListAgentsCommandInput extends ListAgentsRequest {} export interface ListAgentsCommandOutput extends ListAgentsResponse, __MetadataBearer {} /** - * Lists Agents + *

Lists the agents belonging to an account and information about each agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,16 +63,16 @@ export interface ListAgentsCommandOutput extends ListAgentsResponse, __MetadataB * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListDataSourcesCommand.ts b/clients/client-bedrock-agent/src/commands/ListDataSourcesCommand.ts index 3645a71c101f..bb842cc28773 100644 --- a/clients/client-bedrock-agent/src/commands/ListDataSourcesCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListDataSourcesCommand.ts @@ -27,7 +27,7 @@ export interface ListDataSourcesCommandInput extends ListDataSourcesRequest {} export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, __MetadataBearer {} /** - * List data sources + *

Lists the data sources in a knowledge base and information about each one.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -64,19 +64,19 @@ export interface ListDataSourcesCommandOutput extends ListDataSourcesResponse, _ * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListIngestionJobsCommand.ts b/clients/client-bedrock-agent/src/commands/ListIngestionJobsCommand.ts index fff7173c965b..0756f5b1ac49 100644 --- a/clients/client-bedrock-agent/src/commands/ListIngestionJobsCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListIngestionJobsCommand.ts @@ -27,7 +27,7 @@ export interface ListIngestionJobsCommandInput extends ListIngestionJobsRequest export interface ListIngestionJobsCommandOutput extends ListIngestionJobsResponse, __MetadataBearer {} /** - * List ingestion jobs + *

Lists the ingestion jobs for a data source and information about each of them.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -67,8 +67,10 @@ export interface ListIngestionJobsCommandOutput extends ListIngestionJobsRespons * // updatedAt: new Date("TIMESTAMP"), // required * // statistics: { // IngestionJobStatistics * // numberOfDocumentsScanned: Number("long"), + * // numberOfMetadataDocumentsScanned: Number("long"), * // numberOfNewDocumentsIndexed: Number("long"), * // numberOfModifiedDocumentsIndexed: Number("long"), + * // numberOfMetadataDocumentsModified: Number("long"), * // numberOfDocumentsDeleted: Number("long"), * // numberOfDocumentsFailed: Number("long"), * // }, @@ -86,19 +88,19 @@ export interface ListIngestionJobsCommandOutput extends ListIngestionJobsRespons * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListKnowledgeBasesCommand.ts b/clients/client-bedrock-agent/src/commands/ListKnowledgeBasesCommand.ts index 6800ccbbd8d4..3d6a42766f43 100644 --- a/clients/client-bedrock-agent/src/commands/ListKnowledgeBasesCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListKnowledgeBasesCommand.ts @@ -27,7 +27,7 @@ export interface ListKnowledgeBasesCommandInput extends ListKnowledgeBasesReques export interface ListKnowledgeBasesCommandOutput extends ListKnowledgeBasesResponse, __MetadataBearer {} /** - * List Knowledge Bases + *

Lists the knowledge bases in an account and information about each of them.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -62,16 +62,16 @@ export interface ListKnowledgeBasesCommandOutput extends ListKnowledgeBasesRespo * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/ListTagsForResourceCommand.ts b/clients/client-bedrock-agent/src/commands/ListTagsForResourceCommand.ts index 354c3770dcd4..086bc9959075 100644 --- a/clients/client-bedrock-agent/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/ListTagsForResourceCommand.ts @@ -27,7 +27,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} /** - * List tags for a resource + *

List all the tags for the resource you specify.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -54,19 +54,19 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/PrepareAgentCommand.ts b/clients/client-bedrock-agent/src/commands/PrepareAgentCommand.ts index 5e16761fcda8..af29f62fbf22 100644 --- a/clients/client-bedrock-agent/src/commands/PrepareAgentCommand.ts +++ b/clients/client-bedrock-agent/src/commands/PrepareAgentCommand.ts @@ -27,7 +27,7 @@ export interface PrepareAgentCommandInput extends PrepareAgentRequest {} export interface PrepareAgentCommandOutput extends PrepareAgentResponse, __MetadataBearer {} /** - * Prepares an existing Amazon Bedrock Agent to receive runtime requests + *

Creates a DRAFT version of the agent that can be used for internal testing.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -55,25 +55,25 @@ export interface PrepareAgentCommandOutput extends PrepareAgentResponse, __Metad * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/StartIngestionJobCommand.ts b/clients/client-bedrock-agent/src/commands/StartIngestionJobCommand.ts index 9a3204aea058..a3a012db9af6 100644 --- a/clients/client-bedrock-agent/src/commands/StartIngestionJobCommand.ts +++ b/clients/client-bedrock-agent/src/commands/StartIngestionJobCommand.ts @@ -27,7 +27,7 @@ export interface StartIngestionJobCommandInput extends StartIngestionJobRequest export interface StartIngestionJobCommandOutput extends StartIngestionJobResponse, __MetadataBearer {} /** - * Start a new ingestion job + *

Begins an ingestion job, in which a data source is added to a knowledge base.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -51,8 +51,10 @@ export interface StartIngestionJobCommandOutput extends StartIngestionJobRespons * // status: "STARTING" || "IN_PROGRESS" || "COMPLETE" || "FAILED", // required * // statistics: { // IngestionJobStatistics * // numberOfDocumentsScanned: Number("long"), + * // numberOfMetadataDocumentsScanned: Number("long"), * // numberOfNewDocumentsIndexed: Number("long"), * // numberOfModifiedDocumentsIndexed: Number("long"), + * // numberOfMetadataDocumentsModified: Number("long"), * // numberOfDocumentsDeleted: Number("long"), * // numberOfDocumentsFailed: Number("long"), * // }, @@ -73,25 +75,25 @@ export interface StartIngestionJobCommandOutput extends StartIngestionJobRespons * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/TagResourceCommand.ts b/clients/client-bedrock-agent/src/commands/TagResourceCommand.ts index a3cd1661dfa7..bf37842e26f6 100644 --- a/clients/client-bedrock-agent/src/commands/TagResourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/TagResourceCommand.ts @@ -27,7 +27,7 @@ export interface TagResourceCommandInput extends TagResourceRequest {} export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} /** - * Tag a resource + *

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -53,22 +53,22 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/UntagResourceCommand.ts b/clients/client-bedrock-agent/src/commands/UntagResourceCommand.ts index 9a52b6b62071..b52f7a2b1cdf 100644 --- a/clients/client-bedrock-agent/src/commands/UntagResourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/UntagResourceCommand.ts @@ -27,7 +27,7 @@ export interface UntagResourceCommandInput extends UntagResourceRequest {} export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} /** - * Untag a resource + *

Remove tags from a resource.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -53,19 +53,19 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/UpdateAgentActionGroupCommand.ts b/clients/client-bedrock-agent/src/commands/UpdateAgentActionGroupCommand.ts index 958b4cc1746b..e6b104ebeac3 100644 --- a/clients/client-bedrock-agent/src/commands/UpdateAgentActionGroupCommand.ts +++ b/clients/client-bedrock-agent/src/commands/UpdateAgentActionGroupCommand.ts @@ -32,7 +32,7 @@ export interface UpdateAgentActionGroupCommandInput extends UpdateAgentActionGro export interface UpdateAgentActionGroupCommandOutput extends UpdateAgentActionGroupResponse, __MetadataBearer {} /** - * Updates an existing Action Group for Amazon Bedrock Agent + *

Updates the configuration for an action group for an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -94,25 +94,25 @@ export interface UpdateAgentActionGroupCommandOutput extends UpdateAgentActionGr * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/UpdateAgentAliasCommand.ts b/clients/client-bedrock-agent/src/commands/UpdateAgentAliasCommand.ts index 7b0601ec9953..8b041fe654e0 100644 --- a/clients/client-bedrock-agent/src/commands/UpdateAgentAliasCommand.ts +++ b/clients/client-bedrock-agent/src/commands/UpdateAgentAliasCommand.ts @@ -27,7 +27,7 @@ export interface UpdateAgentAliasCommandInput extends UpdateAgentAliasRequest {} export interface UpdateAgentAliasCommandOutput extends UpdateAgentAliasResponse, __MetadataBearer {} /** - * Updates an existing Alias for an Amazon Bedrock Agent + *

Updates configurations for an alias of an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -86,25 +86,25 @@ export interface UpdateAgentAliasCommandOutput extends UpdateAgentAliasResponse, * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/UpdateAgentCommand.ts b/clients/client-bedrock-agent/src/commands/UpdateAgentCommand.ts index e2e33354a09a..b2832317604b 100644 --- a/clients/client-bedrock-agent/src/commands/UpdateAgentCommand.ts +++ b/clients/client-bedrock-agent/src/commands/UpdateAgentCommand.ts @@ -32,7 +32,7 @@ export interface UpdateAgentCommandInput extends UpdateAgentRequest {} export interface UpdateAgentCommandOutput extends UpdateAgentResponse, __MetadataBearer {} /** - * Updates an existing Amazon Bedrock Agent + *

Updates the configuration of an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -43,7 +43,7 @@ export interface UpdateAgentCommandOutput extends UpdateAgentResponse, __Metadat * agentId: "STRING_VALUE", // required * agentName: "STRING_VALUE", // required * instruction: "STRING_VALUE", - * foundationModel: "STRING_VALUE", + * foundationModel: "STRING_VALUE", // required * description: "STRING_VALUE", * idleSessionTTLInSeconds: Number("int"), * agentResourceRoleArn: "STRING_VALUE", // required @@ -128,25 +128,25 @@ export interface UpdateAgentCommandOutput extends UpdateAgentResponse, __Metadat * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ServiceQuotaExceededException} (client fault) - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/UpdateAgentKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/UpdateAgentKnowledgeBaseCommand.ts index 05816ce771bc..8f523879ccda 100644 --- a/clients/client-bedrock-agent/src/commands/UpdateAgentKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/UpdateAgentKnowledgeBaseCommand.ts @@ -27,7 +27,7 @@ export interface UpdateAgentKnowledgeBaseCommandInput extends UpdateAgentKnowled export interface UpdateAgentKnowledgeBaseCommandOutput extends UpdateAgentKnowledgeBaseResponse, __MetadataBearer {} /** - * Updates an existing Knowledge Base associated to an Amazon Bedrock Agent + *

Updates the configuration for a knowledge base that has been associated with an agent.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -64,22 +64,22 @@ export interface UpdateAgentKnowledgeBaseCommandOutput extends UpdateAgentKnowle * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts b/clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts index 7e9ae8830124..037cdbdf4e51 100644 --- a/clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts +++ b/clients/client-bedrock-agent/src/commands/UpdateDataSourceCommand.ts @@ -27,7 +27,10 @@ export interface UpdateDataSourceCommandInput extends UpdateDataSourceRequest {} export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, __MetadataBearer {} /** - * Update an existing data source + *

Updates configurations for a data source.

+ * + *

You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.

+ *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -105,22 +108,22 @@ export interface UpdateDataSourceCommandOutput extends UpdateDataSourceResponse, * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/commands/UpdateKnowledgeBaseCommand.ts b/clients/client-bedrock-agent/src/commands/UpdateKnowledgeBaseCommand.ts index 920c1c7cd1ab..47dc9d932815 100644 --- a/clients/client-bedrock-agent/src/commands/UpdateKnowledgeBaseCommand.ts +++ b/clients/client-bedrock-agent/src/commands/UpdateKnowledgeBaseCommand.ts @@ -27,7 +27,26 @@ export interface UpdateKnowledgeBaseCommandInput extends UpdateKnowledgeBaseRequ export interface UpdateKnowledgeBaseCommandOutput extends UpdateKnowledgeBaseResponse, __MetadataBearer {} /** - * Update an existing knowledge base + *

Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.

+ *

You can change the following fields:

+ * + *

You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -165,22 +184,22 @@ export interface UpdateKnowledgeBaseCommandOutput extends UpdateKnowledgeBaseRes * @see {@link BedrockAgentClientResolvedConfig | config} for BedrockAgentClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* * @throws {@link ConflictException} (client fault) - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* * @throws {@link InternalServerException} (server fault) - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* * @throws {@link ResourceNotFoundException} (client fault) - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ThrottlingException} (client fault) - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link ValidationException} (client fault) - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* * @throws {@link BedrockAgentServiceException} *

Base exception class for all service exceptions from BedrockAgent service.

diff --git a/clients/client-bedrock-agent/src/index.ts b/clients/client-bedrock-agent/src/index.ts index ba688fd018f8..a48d21e7b629 100644 --- a/clients/client-bedrock-agent/src/index.ts +++ b/clients/client-bedrock-agent/src/index.ts @@ -1,8 +1,7 @@ // smithy-typescript generated code /* eslint-disable */ /** - * An example service, deployed with the Octane Service creator, - * which will echo the string + *

Describes the API operations for creating and managing Amazon Bedrock agents.

* * @packageDocumentation */ diff --git a/clients/client-bedrock-agent/src/models/models_0.ts b/clients/client-bedrock-agent/src/models/models_0.ts index 938c6117b941..79e7a399fe77 100644 --- a/clients/client-bedrock-agent/src/models/models_0.ts +++ b/clients/client-bedrock-agent/src/models/models_0.ts @@ -4,7 +4,7 @@ import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from " import { BedrockAgentServiceException as __BaseException } from "./BedrockAgentServiceException"; /** - * This exception is thrown when a request is denied per access permissions + *

The request is denied because of missing access permissions.

* @public */ export class AccessDeniedException extends __BaseException { @@ -24,7 +24,7 @@ export class AccessDeniedException extends __BaseException { } /** - * Type of Executors for an Action Group + *

Contains details about the Lambda function containing the business logic that is carried out upon invoking the action.

* @public */ export type ActionGroupExecutor = ActionGroupExecutor.LambdaMember | ActionGroupExecutor.$UnknownMember; @@ -34,7 +34,7 @@ export type ActionGroupExecutor = ActionGroupExecutor.LambdaMember | ActionGroup */ export namespace ActionGroupExecutor { /** - * ARN of a Lambda. + *

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

* @public */ export interface LambdaMember { @@ -62,7 +62,7 @@ export namespace ActionGroupExecutor { } /** - * This exception is thrown when there is a conflict performing an operation + *

There was a conflict performing an operation.

* @public */ export class ConflictException extends __BaseException { @@ -96,25 +96,25 @@ export const ActionGroupState = { export type ActionGroupState = (typeof ActionGroupState)[keyof typeof ActionGroupState]; /** - * The identifier for the S3 resource. + *

Contains information about the S3 object containing the resource.

* @public */ export interface S3Identifier { /** - * A bucket in S3. + *

The name of the S3 bucket.

* @public */ s3BucketName?: string; /** - * A object key in S3. + *

The S3 object key containing the resource.

* @public */ s3ObjectKey?: string; } /** - * Contains information about the API Schema for the Action Group + *

Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

* @public */ export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema.$UnknownMember; @@ -124,7 +124,7 @@ export type APISchema = APISchema.PayloadMember | APISchema.S3Member | APISchema */ export namespace APISchema { /** - * The identifier for the S3 resource. + *

Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

* @public */ export interface S3Member { @@ -134,7 +134,7 @@ export namespace APISchema { } /** - * String OpenAPI Payload + *

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

* @public */ export interface PayloadMember { @@ -179,157 +179,159 @@ export const ActionGroupSignature = { export type ActionGroupSignature = (typeof ActionGroupSignature)[keyof typeof ActionGroupSignature]; /** - * Create Action Group Request * @public */ export interface CreateAgentActionGroupRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent for which to create the action group.

* @public */ agentId: string | undefined; /** - * Draft Version of the Agent. + *

The version of the agent for which to create the action group.

* @public */ agentVersion: string | undefined; /** - * Name for a resource. + *

The name to give the action group.

* @public */ actionGroupName: string | undefined; /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Description of the Resource. + *

A description of the action group.

* @public */ description?: string; /** - * Action Group Signature for a BuiltIn Action + *

To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor 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 Observation reprompting the user for more information.

* @public */ parentActionGroupSignature?: ActionGroupSignature; /** - * Type of Executors for an Action Group + *

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

* @public */ actionGroupExecutor?: ActionGroupExecutor; /** - * Contains information about the API Schema for the Action Group + *

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

* @public */ apiSchema?: APISchema; /** - * State of the action group + *

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

* @public */ actionGroupState?: ActionGroupState; } /** - * Contains the information of an Agent Action Group + *

Contains details about an action group.

* @public */ export interface AgentActionGroup { /** - * Identifier for a resource. + *

The unique identifier of the agent to which the action group belongs.

* @public */ agentId: string | undefined; /** - * Agent Version. + *

The version of the agent to which the action group belongs.

* @public */ agentVersion: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the action group.

* @public */ actionGroupId: string | undefined; /** - * Name for a resource. + *

The name of the action group.

* @public */ actionGroupName: string | undefined; /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Description of the Resource. + *

The description of the action group.

* @public */ description?: string; /** - * Time Stamp. + *

The time at which the action group was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the action group was last updated.

* @public */ updatedAt: Date | undefined; /** - * Action Group Signature for a BuiltIn Action + *

If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.

+ *

During orchestration, if the 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 Observation reprompting the user for more information.

* @public */ parentActionSignature?: ActionGroupSignature; /** - * Type of Executors for an Action Group + *

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

* @public */ actionGroupExecutor?: ActionGroupExecutor; /** - * Contains information about the API Schema for the Action Group + *

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

* @public */ apiSchema?: APISchema; /** - * State of the action group + *

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

* @public */ actionGroupState: ActionGroupState | undefined; } /** - * Create Action Group Response * @public */ export interface CreateAgentActionGroupResponse { /** - * Contains the information of an Agent Action Group + *

Contains details about the action group that was created.

* @public */ agentActionGroup: AgentActionGroup | undefined; } /** - * This exception is thrown if there was an unexpected error during processing of request + *

An internal server error occurred. Retry your request.

* @public */ export class InternalServerException extends __BaseException { @@ -349,7 +351,7 @@ export class InternalServerException extends __BaseException { } /** - * This exception is thrown when a resource referenced by the operation does not exist + *

The specified resource ARN was not found. Check the ARN and try your request again.

* @public */ export class ResourceNotFoundException extends __BaseException { @@ -369,7 +371,7 @@ export class ResourceNotFoundException extends __BaseException { } /** - * This exception is thrown when a request is made beyond the service quota + *

The number of requests exceeds the service quota. Resubmit your request later.

* @public */ export class ServiceQuotaExceededException extends __BaseException { @@ -389,7 +391,7 @@ export class ServiceQuotaExceededException extends __BaseException { } /** - * This exception is thrown when the number of requests exceeds the limit + *

The number of requests exceeds the limit. Resubmit your request later.

* @public */ export class ThrottlingException extends __BaseException { @@ -409,32 +411,32 @@ export class ThrottlingException extends __BaseException { } /** - * Stores information about a field passed inside a request that resulted in an exception + *

Stores information about a field passed inside a request that resulted in an validation error.

* @public */ export interface ValidationExceptionField { /** - * Non Blank String + *

The name of the field.

* @public */ name: string | undefined; /** - * Non Blank String + *

A message describing why this field failed validation.

* @public */ message: string | undefined; } /** - * This exception is thrown when the request's input validation fails + *

Input validation failed. Check your request parameters and retry the request.

* @public */ export class ValidationException extends __BaseException { readonly name: "ValidationException" = "ValidationException"; readonly $fault: "client" = "client"; /** - * list of ValidationExceptionField + *

A list of objects containing fields that caused validation errors and their corresponding validation error messages.

* @public */ fieldList?: ValidationExceptionField[]; @@ -454,228 +456,223 @@ export class ValidationException extends __BaseException { } /** - * Delete Action Group Request * @public */ export interface DeleteAgentActionGroupRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent that the action group belongs to.

* @public */ agentId: string | undefined; /** - * Draft Version of the Agent. + *

The version of the agent that the action group belongs to.

* @public */ agentVersion: string | undefined; /** - * Id generated at the server side when an Agent ActionGroup is created + *

The unique identifier of the action group to delete.

* @public */ actionGroupId: string | undefined; /** - * Skips checking if resource is in use when set to true. Defaults to false + *

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

* @public */ skipResourceInUseCheck?: boolean; } /** - * Delete Action Group Response * @public */ export interface DeleteAgentActionGroupResponse {} /** - * Get Action Group Request * @public */ export interface GetAgentActionGroupRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent that the action group belongs to.

* @public */ agentId: string | undefined; /** - * Version number generated when a version is created + *

The version of the agent that the action group belongs to.

* @public */ agentVersion: string | undefined; /** - * Id generated at the server side when an Agent Action Group is created + *

The unique identifier of the action group for which to get information.

* @public */ actionGroupId: string | undefined; } /** - * Get Action Group Response * @public */ export interface GetAgentActionGroupResponse { /** - * Contains the information of an Agent Action Group + *

Contains details about the action group.

* @public */ agentActionGroup: AgentActionGroup | undefined; } /** - * List Action Groups Request * @public */ export interface ListAgentActionGroupsRequest { /** - * Id generated at the server side when an Agent is Listed + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Id generated at the server side when an Agent is Listed + *

The version of the agent.

* @public */ agentVersion: string | undefined; /** - * Max Results. + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ maxResults?: number; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ nextToken?: string; } /** - * ActionGroup Summary + *

Contains details about an action group.

* @public */ export interface ActionGroupSummary { /** - * Identifier for a resource. + *

The unique identifier of the action group.

* @public */ actionGroupId: string | undefined; /** - * Name for a resource. + *

The name of the action group.

* @public */ actionGroupName: string | undefined; /** - * State of the action group + *

Specifies whether the action group is available for the agent to invoke or not when + * sending an InvokeAgent + * request.

* @public */ actionGroupState: ActionGroupState | undefined; /** - * Description of the Resource. + *

The description of the action group.

* @public */ description?: string; /** - * Time Stamp. + *

The time at which the action group was last updated.

* @public */ updatedAt: Date | undefined; } /** - * List Action Groups Response * @public */ export interface ListAgentActionGroupsResponse { /** - * List of ActionGroup Summaries + *

A list of objects, each of which contains information about an action group.

* @public */ actionGroupSummaries: ActionGroupSummary[] | undefined; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ nextToken?: string; } /** - * Update Action Group Request * @public */ export interface UpdateAgentActionGroupRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent for which to update the action group.

* @public */ agentId: string | undefined; /** - * Draft Version of the Agent. + *

The unique identifier of the agent version for which to update the action group.

* @public */ agentVersion: string | undefined; /** - * Id generated at the server side when an Action Group is created under Agent + *

The unique identifier of the action group.

* @public */ actionGroupId: string | undefined; /** - * Name for a resource. + *

Specifies a new name for the action group.

* @public */ actionGroupName: string | undefined; /** - * Description of the Resource. + *

Specifies a new name for the action group.

* @public */ description?: string; /** - * Action Group Signature for a BuiltIn Action + *

To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor 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 Observation reprompting the user for more information.

* @public */ parentActionGroupSignature?: ActionGroupSignature; /** - * Type of Executors for an Action Group + *

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

* @public */ actionGroupExecutor?: ActionGroupExecutor; /** - * State of the action group + *

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

* @public */ actionGroupState?: ActionGroupState; /** - * Contains information about the API Schema for the Action Group + *

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

* @public */ apiSchema?: APISchema; } /** - * Update Action Group Response * @public */ export interface UpdateAgentActionGroupResponse { /** - * Contains the information of an Agent Action Group + *

Contains details about the action group that was updated.

* @public */ agentActionGroup: AgentActionGroup | undefined; @@ -702,36 +699,36 @@ export const AgentStatus = { export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus]; /** - * Configuration for inference in prompt configuration + *

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

* @public */ export interface InferenceConfiguration { /** - * Controls randomness, higher values increase diversity + *

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

* @public */ temperature?: number; /** - * Cumulative probability cutoff for token selection + *

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

* @public */ topP?: number; /** - * Sample from the k most likely next tokens + *

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

* @public */ topK?: number; /** - * Maximum length of output + *

The maximum number of tokens to allow in the generated response.

* @public */ maximumLength?: number; /** - * List of stop sequences + *

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

* @public */ stopSequences?: string[]; @@ -782,210 +779,257 @@ export const PromptType = { export type PromptType = (typeof PromptType)[keyof typeof PromptType]; /** - * BasePromptConfiguration per Prompt Type. + *

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

* @public */ export interface PromptConfiguration { /** - * Prompt Type. + *

The step in the agent sequence that this prompt configuration applies to.

* @public */ promptType?: PromptType; /** - * Creation Mode for Prompt Configuration. + *

Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

* @public */ promptCreationMode?: CreationMode; /** - * Prompt State. + *

Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

+ * * @public */ promptState?: PromptState; /** - * Base Prompt Template. + *

Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.

* @public */ basePromptTemplate?: string; /** - * Configuration for inference in prompt configuration + *

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

* @public */ inferenceConfiguration?: InferenceConfiguration; /** - * Creation Mode for Prompt Configuration. + *

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

* @public */ parserMode?: CreationMode; } /** - * Configuration for prompt override. + *

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

* @public */ export interface PromptOverrideConfiguration { /** - * List of BasePromptConfiguration + *

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

* @public */ promptConfigurations: PromptConfiguration[] | undefined; /** - * ARN of a Lambda. + *

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.

* @public */ overrideLambda?: string; } /** - * Contains the information of an agent + *

Contains details about an agent.

* @public */ export interface Agent { /** - * Identifier for a resource. + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Name for a resource. + *

The name of the agent.

* @public */ agentName: string | undefined; /** - * Arn representation of the Agent. + *

The ARN of the agent.

* @public */ agentArn: string | undefined; /** - * Draft Agent Version. + *

The version of the agent.

* @public */ agentVersion: string | undefined; /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Instruction for the agent. + *

Instructions that tell the agent what it should do and how it should interact with users.

* @public */ instruction?: string; /** - * Schema Type for Action APIs. + *

The status of the agent and whether it is ready for use. The following statuses are possible:

+ * * @public */ agentStatus: AgentStatus | undefined; /** - * ARN or name of a Bedrock model. + *

The foundation model used for orchestration by the agent.

* @public */ foundationModel?: string; /** - * Description of the Resource. + *

The description of the agent.

* @public */ description?: string; /** - * Max Session Time. + *

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

+ *

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

* @public */ idleSessionTTLInSeconds: number | undefined; /** - * ARN of a IAM role. + *

The ARN of the IAM role with permissions to call API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

* @public */ agentResourceRoleArn: string | undefined; /** - * A KMS key ARN + *

The ARN of the KMS key that encrypts the agent.

* @public */ customerEncryptionKeyArn?: string; /** - * Time Stamp. + *

The time at which the agent was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the agent was last updated.

* @public */ updatedAt: Date | undefined; /** - * Time Stamp. + *

The time at which the agent was last prepared.

* @public */ preparedAt?: Date; /** - * Failure Reasons for Error. + *

Contains reasons that the agent-related API that you invoked failed.

* @public */ failureReasons?: string[]; /** - * The recommended actions users can take to resolve an error in failureReasons. + *

Contains recommended actions to take for the agent-related API that you invoked to succeed.

* @public */ recommendedActions?: string[]; /** - * Configuration for prompt override. + *

Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

* @public */ promptOverrideConfiguration?: PromptOverrideConfiguration; } /** - * Details about the routing configuration for an Agent alias. + *

Contains details about the routing configuration of the alias.

* @public */ export interface AgentAliasRoutingConfigurationListItem { /** - * Agent Version. + *

The version of the agent with which the alias is associated.

* @public */ agentVersion: string | undefined; } /** - * History event for an alias for an Agent. + *

Contains details about the history of the alias.

* @public */ export interface AgentAliasHistoryEvent { /** - * Routing configuration for an Agent alias. + *

Contains details about the version of the agent with which the alias is associated.

* @public */ routingConfiguration?: AgentAliasRoutingConfigurationListItem[]; /** - * Time Stamp. + *

The date that the alias stopped being associated to the version in the routingConfiguration object

* @public */ endDate?: Date; /** - * Time Stamp. + *

The date that the alias began being associated to the version in the routingConfiguration object.

* @public */ startDate?: Date; @@ -1009,120 +1053,138 @@ export const AgentAliasStatus = { export type AgentAliasStatus = (typeof AgentAliasStatus)[keyof typeof AgentAliasStatus]; /** - * Contains the information of an agent alias + *

Contains details about an alias of an agent.

* @public */ export interface AgentAlias { /** - * Identifier for a resource. + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Id for an Agent Alias generated at the server side. + *

The unique identifier of the alias of the agent.

* @public */ agentAliasId: string | undefined; /** - * Name for a resource. + *

The name of the alias of the agent.

* @public */ agentAliasName: string | undefined; /** - * Arn representation of the Agent Alias. + *

The ARN of the alias of the agent.

* @public */ agentAliasArn: string | undefined; /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Description of the Resource. + *

The description of the alias of the agent.

* @public */ description?: string; /** - * Routing configuration for an Agent alias. + *

Contains details about the routing configuration of the alias.

* @public */ routingConfiguration: AgentAliasRoutingConfigurationListItem[] | undefined; /** - * Time Stamp. + *

The time at which the alias of the agent was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the alias was last updated.

* @public */ updatedAt: Date | undefined; /** - * The list of history events for an alias for an Agent. + *

Contains details about the history of the alias.

* @public */ agentAliasHistoryEvents?: AgentAliasHistoryEvent[]; /** - * The statuses an Agent Alias can be in. + *

The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

+ * * @public */ agentAliasStatus: AgentAliasStatus | undefined; } /** - * Summary of an alias for an Agent. + *

Contains details about an alias of an agent.

* @public */ export interface AgentAliasSummary { /** - * Id for an Agent Alias generated at the server side. + *

Contains details about

* @public */ agentAliasId: string | undefined; /** - * Name for a resource. + *

The name of the alias.

* @public */ agentAliasName: string | undefined; /** - * Description of the Resource. + *

The description of the alias.

* @public */ description?: string; /** - * Routing configuration for an Agent alias. + *

Contains details about the version of the agent with which the alias is associated.

* @public */ routingConfiguration?: AgentAliasRoutingConfigurationListItem[]; /** - * The statuses an Agent Alias can be in. + *

The status of the alias.

* @public */ agentAliasStatus: AgentAliasStatus | undefined; /** - * Time Stamp. + *

The time at which the alias of the agent was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the alias was last updated.

* @public */ updatedAt: Date | undefined; @@ -1143,786 +1205,769 @@ export const KnowledgeBaseState = { export type KnowledgeBaseState = (typeof KnowledgeBaseState)[keyof typeof KnowledgeBaseState]; /** - * Contains the information of an Agent Knowledge Base. + *

Contains details about a knowledge base that is associated with an agent.

* @public */ export interface AgentKnowledgeBase { /** - * Identifier for a resource. + *

The unique identifier of the agent with which the knowledge base is associated.

* @public */ agentId: string | undefined; /** - * Agent Version. + *

The version of the agent with which the knowledge base is associated.

* @public */ agentVersion: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the association between the agent and the knowledge base.

* @public */ knowledgeBaseId: string | undefined; /** - * Description of the Resource. + *

The description of the association between the agent and the knowledge base.

* @public */ description: string | undefined; /** - * Time Stamp. + *

The time at which the association between the agent and the knowledge base was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the association between the agent and the knowledge base was last updated.

* @public */ updatedAt: Date | undefined; /** - * State of the knowledge base; whether it is enabled or disabled + *

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

* @public */ knowledgeBaseState: KnowledgeBaseState | undefined; } /** - * Agent Knowledge Base Summary + *

Contains details about a knowledge base associated with an agent.

* @public */ export interface AgentKnowledgeBaseSummary { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base associated with an agent.

* @public */ knowledgeBaseId: string | undefined; /** - * Description of the Resource. + *

The description of the knowledge base associated with an agent.

* @public */ description?: string; /** - * State of the knowledge base; whether it is enabled or disabled + *

Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

* @public */ knowledgeBaseState: KnowledgeBaseState | undefined; /** - * Time Stamp. + *

The time at which the knowledge base associated with an agent was last updated.

* @public */ updatedAt: Date | undefined; } /** - * Create Agent Request * @public */ export interface CreateAgentRequest { /** - * Name for a resource. + *

A name for the agent that you create.

* @public */ agentName: string | undefined; /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Instruction for the agent. + *

Instructions that tell the agent what it should do and how it should interact with users.

* @public */ instruction?: string; /** - * ARN or name of a Bedrock model. + *

The foundation model to be used for orchestration by the agent you create.

* @public */ foundationModel?: string; /** - * Description of the Resource. + *

A description of the agent.

* @public */ description?: string; /** - * Max Session Time. + *

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

+ *

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

* @public */ idleSessionTTLInSeconds?: number; /** - * ARN of a IAM role. + *

The ARN of the IAM role with permissions to create the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

* @public */ agentResourceRoleArn: string | undefined; /** - * A KMS key ARN + *

The ARN of the KMS key with which to encrypt the agent.

* @public */ customerEncryptionKeyArn?: string; /** - * A map of tag keys and values + *

Any tags that you want to attach to the agent.

* @public */ tags?: Record; /** - * Configuration for prompt override. + *

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

* @public */ promptOverrideConfiguration?: PromptOverrideConfiguration; } /** - * Create Agent Response * @public */ export interface CreateAgentResponse { /** - * Contains the information of an agent + *

Contains details about the agent created.

* @public */ agent: Agent | undefined; } /** - * Delete Agent Request * @public */ export interface DeleteAgentRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent to delete.

* @public */ agentId: string | undefined; /** - * Skips checking if resource is in use when set to true. Defaults to false + *

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

* @public */ skipResourceInUseCheck?: boolean; } /** - * Delete Agent Response * @public */ export interface DeleteAgentResponse { /** - * Identifier for a resource. + *

The unique identifier of the agent that was deleted.

* @public */ agentId: string | undefined; /** - * Schema Type for Action APIs. + *

The status of the agent.

* @public */ agentStatus: AgentStatus | undefined; } /** - * Get Agent Request * @public */ export interface GetAgentRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; } /** - * Get Agent Response * @public */ export interface GetAgentResponse { /** - * Contains the information of an agent + *

Contains details about the agent.

* @public */ agent: Agent | undefined; } /** - * List Agent Request * @public */ export interface ListAgentsRequest { /** - * Max Results. + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ maxResults?: number; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ nextToken?: string; } /** - * Summary of Agent. + *

Contains details about an agent.

* @public */ export interface AgentSummary { /** - * Identifier for a resource. + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Name for a resource. + *

The name of the agent.

* @public */ agentName: string | undefined; /** - * Schema Type for Action APIs. + *

The status of the agent.

* @public */ agentStatus: AgentStatus | undefined; /** - * Description of the Resource. + *

The description of the agent.

* @public */ description?: string; /** - * Time Stamp. + *

The time at which the agent was last updated.

* @public */ updatedAt: Date | undefined; /** - * Agent Version. + *

The latest version of the agent.

* @public */ latestAgentVersion?: string; } /** - * List Agent Response * @public */ export interface ListAgentsResponse { /** - * List of AgentSummary. + *

A list of objects, each of which contains information about an agent.

* @public */ agentSummaries: AgentSummary[] | undefined; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ nextToken?: string; } /** - * PrepareAgent Request * @public */ export interface PrepareAgentRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent for which to create a DRAFT version.

* @public */ agentId: string | undefined; } /** - * PrepareAgent Response * @public */ export interface PrepareAgentResponse { /** - * Identifier for a resource. + *

The unique identifier of the agent for which the DRAFT version was created.

* @public */ agentId: string | undefined; /** - * Schema Type for Action APIs. + *

The status of the DRAFT version and whether it is ready for use.

* @public */ agentStatus: AgentStatus | undefined; /** - * Agent Version. + *

The version of the agent.

* @public */ agentVersion: string | undefined; /** - * Time Stamp. + *

The time at which the DRAFT version of the agent was last prepared.

* @public */ preparedAt: Date | undefined; } /** - * Update Agent Request * @public */ export interface UpdateAgentRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Name for a resource. + *

Specifies a new name for the agent.

* @public */ agentName: string | undefined; /** - * Instruction for the agent. + *

Specifies new instructions that tell the agent what it should do and how it should interact with users.

* @public */ instruction?: string; /** - * ARN or name of a Bedrock model. + *

Specifies a new foundation model to be used for orchestration by the agent.

* @public */ - foundationModel?: string; + foundationModel: string | undefined; /** - * Description of the Resource. + *

Specifies a new description of the agent.

* @public */ description?: string; /** - * Max Session Time. + *

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

+ *

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

* @public */ idleSessionTTLInSeconds?: number; /** - * ARN of a IAM role. + *

The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

* @public */ agentResourceRoleArn: string | undefined; /** - * A KMS key ARN + *

The ARN of the KMS key with which to encrypt the agent.

* @public */ customerEncryptionKeyArn?: string; /** - * Configuration for prompt override. + *

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

* @public */ promptOverrideConfiguration?: PromptOverrideConfiguration; } /** - * Update Agent Response * @public */ export interface UpdateAgentResponse { /** - * Contains the information of an agent + *

Contains details about the agent that was updated.

* @public */ agent: Agent | undefined; } /** - * Contains the information of an agent version. + *

Contains details about a version of an agent.

* @public */ export interface AgentVersion { /** - * Identifier for a resource. + *

The unique identifier of the agent that the version belongs to.

* @public */ agentId: string | undefined; /** - * Name for a resource. + *

The name of the agent that the version belongs to.

* @public */ agentName: string | undefined; /** - * Arn representation of the Agent. + *

The ARN of the agent that the version belongs to.

* @public */ agentArn: string | undefined; /** - * Numerical Agent Version. + *

The version number.

* @public */ version: string | undefined; /** - * Instruction for the agent. + *

The instructions provided to the agent.

* @public */ instruction?: string; /** - * Schema Type for Action APIs. + *

The status of the agent that the version belongs to.

* @public */ agentStatus: AgentStatus | undefined; /** - * ARN or name of a Bedrock model. + *

The foundation model that the version invokes.

* @public */ foundationModel?: string; /** - * Description of the Resource. + *

The description of the version.

* @public */ description?: string; /** - * Max Session Time. + *

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

+ *

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

* @public */ idleSessionTTLInSeconds: number | undefined; /** - * ARN of a IAM role. + *

The ARN of the IAM role with permissions to invoke API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

* @public */ agentResourceRoleArn: string | undefined; /** - * A KMS key ARN + *

The ARN of the KMS key that encrypts the agent.

* @public */ customerEncryptionKeyArn?: string; /** - * Time Stamp. + *

The time at which the version was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the version was last updated.

* @public */ updatedAt: Date | undefined; /** - * Failure Reasons for Error. + *

A list of reasons that the API operation on the version failed.

* @public */ failureReasons?: string[]; /** - * The recommended actions users can take to resolve an error in failureReasons. + *

A list of recommended actions to take for the failed API operation on the version to succeed.

* @public */ recommendedActions?: string[]; /** - * Configuration for prompt override. + *

Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

* @public */ promptOverrideConfiguration?: PromptOverrideConfiguration; } /** - * Summary of agent version. + *

Contains details about a version of an agent.

* @public */ export interface AgentVersionSummary { /** - * Name for a resource. + *

The name of the agent to which the version belongs.

* @public */ agentName: string | undefined; /** - * Schema Type for Action APIs. + *

The status of the agent to which the version belongs.

* @public */ agentStatus: AgentStatus | undefined; /** - * Agent Version. + *

The version of the agent.

* @public */ agentVersion: string | undefined; /** - * Time Stamp. + *

The time at which the version was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the version was last updated.

* @public */ updatedAt: Date | undefined; /** - * Description of the Resource. + *

The description of the version of the agent.

* @public */ description?: string; } /** - * Create Agent Alias Request * @public */ export interface CreateAgentAliasRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Name for a resource. + *

The name of the alias.

* @public */ agentAliasName: string | undefined; /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Description of the Resource. + *

A description of the alias of the agent.

* @public */ description?: string; /** - * Routing configuration for an Agent alias. + *

Contains details about the routing configuration of the alias.

* @public */ routingConfiguration?: AgentAliasRoutingConfigurationListItem[]; /** - * A map of tag keys and values + *

Any tags that you want to attach to the alias of the agent.

* @public */ tags?: Record; } /** - * Create Agent Alias Response * @public */ export interface CreateAgentAliasResponse { /** - * Contains the information of an agent alias + *

Contains details about the alias that was created.

* @public */ agentAlias: AgentAlias | undefined; } /** - * Delete Agent Alias Request * @public */ export interface DeleteAgentAliasRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent that the alias belongs to.

* @public */ agentId: string | undefined; /** - * Id generated at the server side when an Agent Alias is created + *

The unique identifier of the alias to delete.

* @public */ agentAliasId: string | undefined; } /** - * Delete Agent Alias Response * @public */ export interface DeleteAgentAliasResponse { /** - * Identifier for a resource. + *

The unique identifier of the agent that the alias belongs to.

* @public */ agentId: string | undefined; /** - * Id for an Agent Alias generated at the server side. + *

The unique identifier of the alias that was deleted.

* @public */ agentAliasId: string | undefined; /** - * The statuses an Agent Alias can be in. + *

The status of the alias.

* @public */ agentAliasStatus: AgentAliasStatus | undefined; } /** - * Get Agent Alias Request * @public */ export interface GetAgentAliasRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent to which the alias to get information belongs.

* @public */ agentId: string | undefined; /** - * Id generated at the server side when an Agent Alias is created + *

The unique identifier of the alias for which to get information.

* @public */ agentAliasId: string | undefined; } /** - * Get Agent Alias Response * @public */ export interface GetAgentAliasResponse { /** - * Contains the information of an agent alias + *

Contains information about the alias.

* @public */ agentAlias: AgentAlias | undefined; } /** - * List Agent Aliases Request * @public */ export interface ListAgentAliasesRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Max Results. + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ maxResults?: number; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ nextToken?: string; } /** - * List Agent Aliases Response * @public */ export interface ListAgentAliasesResponse { /** - * The list of summaries of all the aliases for an Agent. + *

A list of objects, each of which contains information about an alias of the agent.

* @public */ agentAliasSummaries: AgentAliasSummary[] | undefined; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ nextToken?: string; } /** - * Update Agent Alias Request * @public */ export interface UpdateAgentAliasRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Id generated at the server side when an Agent Alias is created + *

The unique identifier of the alias.

* @public */ agentAliasId: string | undefined; /** - * Name for a resource. + *

Specifies a new name for the alias.

* @public */ agentAliasName: string | undefined; /** - * Description of the Resource. + *

Specifies a new description for the alias.

* @public */ description?: string; /** - * Routing configuration for an Agent alias. + *

Contains details about the routing configuration of the alias.

* @public */ routingConfiguration?: AgentAliasRoutingConfigurationListItem[]; } /** - * Update Agent Alias Response * @public */ export interface UpdateAgentAliasResponse { /** - * Contains the information of an agent alias + *

Contains details about the alias that was updated.

* @public */ agentAlias: AgentAlias | undefined; } /** - * Configures an S3 data source location. + *

Contains information about the S3 configuration of the data source.

* @public */ export interface S3DataSourceConfiguration { /** - * A S3 bucket ARN + *

The ARN of the bucket that contains the data source.

* @public */ bucketArn: string | undefined; /** - * A list of S3 prefixes. + *

A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.

* @public */ inclusionPrefixes?: string[]; @@ -1942,30 +1987,30 @@ export const DataSourceType = { export type DataSourceType = (typeof DataSourceType)[keyof typeof DataSourceType]; /** - * Specifies a raw data source location to ingest. + *

Contains details about how a data source is stored.

* @public */ export interface DataSourceConfiguration { /** - * The type of the data source location. + *

The type of storage for the data source.

* @public */ type: DataSourceType | undefined; /** - * Configures an S3 data source location. + *

Contains details about the configuration of the S3 object containing the data source.

* @public */ s3Configuration?: S3DataSourceConfiguration; } /** - * Server-side encryption configuration. + *

Contains the configuration for server-side encryption.

* @public */ export interface ServerSideEncryptionConfiguration { /** - * A KMS key ARN + *

The ARN of the KMS key used to encrypt the resource.

* @public */ kmsKeyArn?: string; @@ -1986,48 +2031,58 @@ export const ChunkingStrategy = { export type ChunkingStrategy = (typeof ChunkingStrategy)[keyof typeof ChunkingStrategy]; /** - * Configures fixed size chunking strategy + *

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

* @public */ export interface FixedSizeChunkingConfiguration { /** - * The maximum number of tokens per chunk. + *

The maximum number of tokens to include in a chunk.

* @public */ maxTokens: number | undefined; /** - * The overlap percentage between adjacent chunks. + *

The percentage of overlap between adjacent chunks of a data source.

* @public */ overlapPercentage: number | undefined; } /** - * Configures chunking strategy + *

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

* @public */ export interface ChunkingConfiguration { /** - * The type of chunking strategy + *

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

+ *
    + *
  • + *

    + * FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

    + *
  • + *
  • + *

    + * NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

    + *
  • + *
* @public */ chunkingStrategy: ChunkingStrategy | undefined; /** - * Configures fixed size chunking strategy + *

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

* @public */ fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration; } /** - * Configures ingestion for a vector knowledge base + *

Contains details about how to ingest the documents in a data source.

* @public */ export interface VectorIngestionConfiguration { /** - * Configures chunking strategy + *

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

* @public */ chunkingConfiguration?: ChunkingConfiguration; @@ -2038,43 +2093,44 @@ export interface VectorIngestionConfiguration { */ export interface CreateDataSourceRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to which to add the data source.

* @public */ knowledgeBaseId: string | undefined; /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Name for a resource. + *

The name of the data source.

* @public */ name: string | undefined; /** - * Description of the Resource. + *

A description of the data source.

* @public */ description?: string; /** - * Specifies a raw data source location to ingest. + *

Contains metadata about where the data source is stored.

* @public */ dataSourceConfiguration: DataSourceConfiguration | undefined; /** - * Server-side encryption configuration. + *

Contains details about the server-side encryption for the data source.

* @public */ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration; /** - * Configures ingestion for a vector knowledge base + *

Contains details about how to ingest the documents in the data source.

* @public */ vectorIngestionConfiguration?: VectorIngestionConfiguration; @@ -2095,66 +2151,74 @@ export const DataSourceStatus = { export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus]; /** - * Contains the information of a data source. + *

Contains details about a data source.

* @public */ export interface DataSource { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to which the data source belongs.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source.

* @public */ dataSourceId: string | undefined; /** - * Name for a resource. + *

The name of the data source.

* @public */ name: string | undefined; /** - * The status of a data source. + *

The status of the data source. The following statuses are possible:

+ *
    + *
  • + *

    Available – The data source has been created and is ready for ingestion into the knowledge base.

    + *
  • + *
  • + *

    Deleting – The data source is being deleted.

    + *
  • + *
* @public */ status: DataSourceStatus | undefined; /** - * Description of the Resource. + *

The description of the data source.

* @public */ description?: string; /** - * Specifies a raw data source location to ingest. + *

Contains details about how the data source is stored.

* @public */ dataSourceConfiguration: DataSourceConfiguration | undefined; /** - * Server-side encryption configuration. + *

Contains details about the configuration of the server-side encryption.

* @public */ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration; /** - * Configures ingestion for a vector knowledge base + *

Contains details about how to ingest the documents in the data source.

* @public */ vectorIngestionConfiguration?: VectorIngestionConfiguration; /** - * Time Stamp. + *

The time at which the data source was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the data source was last updated.

* @public */ updatedAt: Date | undefined; @@ -2165,7 +2229,7 @@ export interface DataSource { */ export interface CreateDataSourceResponse { /** - * Contains the information of a data source. + *

Contains details about the data source.

* @public */ dataSource: DataSource | undefined; @@ -2176,13 +2240,13 @@ export interface CreateDataSourceResponse { */ export interface DeleteDataSourceRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base from which to delete the data source.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source to delete.

* @public */ dataSourceId: string | undefined; @@ -2193,19 +2257,19 @@ export interface DeleteDataSourceRequest { */ export interface DeleteDataSourceResponse { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to which the data source that was deleted belonged.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source that was deleted.

* @public */ dataSourceId: string | undefined; /** - * The status of a data source. + *

The status of the data source.

* @public */ status: DataSourceStatus | undefined; @@ -2216,13 +2280,13 @@ export interface DeleteDataSourceResponse { */ export interface GetDataSourceRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base that the data source was added to.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source.

* @public */ dataSourceId: string | undefined; @@ -2233,7 +2297,7 @@ export interface GetDataSourceRequest { */ export interface GetDataSourceResponse { /** - * Contains the information of a data source. + *

Contains details about the data source.

* @public */ dataSource: DataSource | undefined; @@ -2244,61 +2308,61 @@ export interface GetDataSourceResponse { */ export interface ListDataSourcesRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base for which to return a list of information.

* @public */ knowledgeBaseId: string | undefined; /** - * Max Results. + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ maxResults?: number; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ nextToken?: string; } /** - * Summary information of a data source. + *

Contains details about a data source.

* @public */ export interface DataSourceSummary { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to which the data source belongs.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source.

* @public */ dataSourceId: string | undefined; /** - * Name for a resource. + *

The name of the data source.

* @public */ name: string | undefined; /** - * The status of a data source. + *

The status of the data source.

* @public */ status: DataSourceStatus | undefined; /** - * Description of the Resource. + *

The description of the data source.

* @public */ description?: string; /** - * Time Stamp. + *

The time at which the data source was last updated.

* @public */ updatedAt: Date | undefined; @@ -2309,13 +2373,13 @@ export interface DataSourceSummary { */ export interface ListDataSourcesResponse { /** - * list of data source summaries + *

A list of objects, each of which contains information about a data source.

* @public */ dataSourceSummaries: DataSourceSummary[] | undefined; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ nextToken?: string; @@ -2326,43 +2390,43 @@ export interface ListDataSourcesResponse { */ export interface UpdateDataSourceRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to which the data source belongs.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source.

* @public */ dataSourceId: string | undefined; /** - * Name for a resource. + *

Specifies a new name for the data source.

* @public */ name: string | undefined; /** - * Description of the Resource. + *

Specifies a new description for the data source.

* @public */ description?: string; /** - * Specifies a raw data source location to ingest. + *

Contains details about the storage configuration of the data source.

* @public */ dataSourceConfiguration: DataSourceConfiguration | undefined; /** - * Server-side encryption configuration. + *

Contains details about server-side encryption of the data source.

* @public */ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration; /** - * Configures ingestion for a vector knowledge base + *

Contains details about how to ingest the documents in the data source.

* @public */ vectorIngestionConfiguration?: VectorIngestionConfiguration; @@ -2373,7 +2437,7 @@ export interface UpdateDataSourceRequest { */ export interface UpdateDataSourceResponse { /** - * Contains the information of a data source. + *

Contains details about the data source.

* @public */ dataSource: DataSource | undefined; @@ -2384,55 +2448,67 @@ export interface UpdateDataSourceResponse { */ export interface GetIngestionJobRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base for which the ingestion job applies.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source in the ingestion job.

* @public */ dataSourceId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the ingestion job.

* @public */ ingestionJobId: string | undefined; } /** - * The document level statistics of an ingestion job + *

Contains the statistics for the ingestion job.

* @public */ export interface IngestionJobStatistics { /** - * Number of scanned documents + *

The total number of source documents that were scanned. Includes new, updated, and unchanged documents.

* @public */ numberOfDocumentsScanned?: number; /** - * Number of indexed documents + *

The total number of metadata files that were scanned. Includes new, updated, and unchanged files.

+ * @public + */ + numberOfMetadataDocumentsScanned?: number; + + /** + *

The number of new source documents in the data source that were successfully indexed.

* @public */ numberOfNewDocumentsIndexed?: number; /** - * Number of modified documents indexed + *

The number of modified source documents in the data source that were successfully indexed.

* @public */ numberOfModifiedDocumentsIndexed?: number; /** - * Number of deleted documents + *

The number of metadata files that were updated or deleted.

+ * @public + */ + numberOfMetadataDocumentsModified?: number; + + /** + *

The number of source documents that was deleted.

* @public */ numberOfDocumentsDeleted?: number; /** - * Number of failed documents + *

The number of source documents that failed to be ingested.

* @public */ numberOfDocumentsFailed?: number; @@ -2455,60 +2531,78 @@ export const IngestionJobStatus = { export type IngestionJobStatus = (typeof IngestionJobStatus)[keyof typeof IngestionJobStatus]; /** - * Contains the information of an ingestion job. + *

Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.

+ *

This data type is used in the following API operations:

+ * * @public */ export interface IngestionJob { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to which the data source is being added.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the ingested data source.

* @public */ dataSourceId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the ingestion job.

* @public */ ingestionJobId: string | undefined; /** - * Description of the Resource. + *

The description of the ingestion job.

* @public */ description?: string; /** - * The status of an ingestion job. + *

The status of the ingestion job.

* @public */ status: IngestionJobStatus | undefined; /** - * The document level statistics of an ingestion job + *

Contains statistics about the ingestion job.

* @public */ statistics?: IngestionJobStatistics; /** - * Failure Reasons for Error. + *

A list of reasons that the ingestion job failed.

* @public */ failureReasons?: string[]; /** - * Time Stamp. + *

The time at which the ingestion job started.

* @public */ startedAt: Date | undefined; /** - * Time Stamp. + *

The time at which the ingestion job was last updated.

* @public */ updatedAt: Date | undefined; @@ -2519,7 +2613,7 @@ export interface IngestionJob { */ export interface GetIngestionJobResponse { /** - * Contains the information of an ingestion job. + *

Contains details about the ingestion job.

* @public */ ingestionJob: IngestionJob | undefined; @@ -2553,24 +2647,24 @@ export const IngestionJobFilterOperator = { export type IngestionJobFilterOperator = (typeof IngestionJobFilterOperator)[keyof typeof IngestionJobFilterOperator]; /** - * Filters the response returned by ListIngestionJobs operation. + *

Defines a filter by which to filter the results.

* @public */ export interface IngestionJobFilter { /** - * The name of the field to filter ingestion jobs. + *

The attribute by which to filter the results.

* @public */ attribute: IngestionJobFilterAttribute | undefined; /** - * The operator used to filter ingestion jobs. + *

The operation to carry out between the attribute and the values.

* @public */ operator: IngestionJobFilterOperator | undefined; /** - * The list of values used to filter ingestion jobs. + *

A list of values for the attribute.

* @public */ values: string[] | undefined; @@ -2606,18 +2700,18 @@ export const SortOrder = { export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder]; /** - * Sorts the response returned by ListIngestionJobs operation. + *

Parameters by which to sort the results.

* @public */ export interface IngestionJobSortBy { /** - * The name of the field to sort ingestion jobs. + *

The attribute by which to sort the results.

* @public */ attribute: IngestionJobSortByAttribute | undefined; /** - * Order to sort results by. + *

The order by which to sort the results.

* @public */ order: SortOrder | undefined; @@ -2628,91 +2722,91 @@ export interface IngestionJobSortBy { */ export interface ListIngestionJobsRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base for which to return ingestion jobs.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source for which to return ingestion jobs.

* @public */ dataSourceId: string | undefined; /** - * List of IngestionJobFilters + *

Contains a definition of a filter for which to filter the results.

* @public */ filters?: IngestionJobFilter[]; /** - * Sorts the response returned by ListIngestionJobs operation. + *

Contains details about how to sort the results.

* @public */ sortBy?: IngestionJobSortBy; /** - * Max Results. + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ maxResults?: number; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ nextToken?: string; } /** - * Summary information of an ingestion job. + *

Contains details about an ingestion job.

* @public */ export interface IngestionJobSummary { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to which the data source is added.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source in the ingestion job.

* @public */ dataSourceId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the ingestion job.

* @public */ ingestionJobId: string | undefined; /** - * Description of the Resource. + *

The description of the ingestion job.

* @public */ description?: string; /** - * The status of an ingestion job. + *

The status of the ingestion job.

* @public */ status: IngestionJobStatus | undefined; /** - * Time Stamp. + *

The time at which the ingestion job was started.

* @public */ startedAt: Date | undefined; /** - * Time Stamp. + *

The time at which the ingestion job was last updated.

* @public */ updatedAt: Date | undefined; /** - * The document level statistics of an ingestion job + *

Contains statistics for the ingestion job.

* @public */ statistics?: IngestionJobStatistics; @@ -2723,13 +2817,13 @@ export interface IngestionJobSummary { */ export interface ListIngestionJobsResponse { /** - * List of IngestionJobSummaries + *

A list of objects, each of which contains information about an ingestion job.

* @public */ ingestionJobSummaries: IngestionJobSummary[] | undefined; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ nextToken?: string; @@ -2740,25 +2834,26 @@ export interface ListIngestionJobsResponse { */ export interface StartIngestionJobRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to which to add the data source.

* @public */ knowledgeBaseId: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the data source to ingest.

* @public */ dataSourceId: string | undefined; /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Description of the Resource. + *

A description of the ingestion job.

* @public */ description?: string; @@ -2769,55 +2864,53 @@ export interface StartIngestionJobRequest { */ export interface StartIngestionJobResponse { /** - * Contains the information of an ingestion job. + *

An object containing information about the ingestion job.

* @public */ ingestionJob: IngestionJob | undefined; } /** - * Associate Agent Knowledge Base Request * @public */ export interface AssociateAgentKnowledgeBaseRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent with which you want to associate the knowledge base.

* @public */ agentId: string | undefined; /** - * Draft Version of the Agent. + *

The version of the agent with which you want to associate the knowledge base.

* @public */ agentVersion: string | undefined; /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to associate with the agent.

* @public */ knowledgeBaseId: string | undefined; /** - * Description of the Resource. + *

A description of what the agent should use the knowledge base for.

* @public */ description: string | undefined; /** - * State of the knowledge base; whether it is enabled or disabled + *

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

* @public */ knowledgeBaseState?: KnowledgeBaseState; } /** - * Associate Agent Knowledge Base Response * @public */ export interface AssociateAgentKnowledgeBaseResponse { /** - * Contains the information of an Agent Knowledge Base. + *

Contains details about the knowledge base that has been associated with the agent.

* @public */ agentKnowledgeBase: AgentKnowledgeBase | undefined; @@ -2837,246 +2930,246 @@ export const KnowledgeBaseType = { export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType]; /** - * Configurations for a vector knowledge base. + *

Contains details about the model used to create vector embeddings for the knowledge base.

* @public */ export interface VectorKnowledgeBaseConfiguration { /** - * Arn of a Bedrock model. + *

The ARN of the model used to create vector embeddings for the knowledge base.

* @public */ embeddingModelArn: string | undefined; } /** - * Configures a bedrock knowledge base. + *

Contains details about the embeddings configuration of the knowledge base.

* @public */ export interface KnowledgeBaseConfiguration { /** - * The type of a knowledge base. + *

The type of data that the data source is converted into for the knowledge base.

* @public */ type: KnowledgeBaseType | undefined; /** - * Configurations for a vector knowledge base. + *

Contains details about the embeddings model that'sused to convert the data source.

* @public */ vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration; } /** - * A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names + *

Contains the names of the fields to which to map information about the vector store.

* @public */ export interface OpenSearchServerlessFieldMapping { /** - * Name of the field + *

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

* @public */ vectorField: string | undefined; /** - * Name of the field + *

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

* @public */ textField: string | undefined; /** - * Name of the field + *

The name of the field in which Amazon Bedrock stores metadata about the vector store.

* @public */ metadataField: string | undefined; } /** - * Contains the configurations to use OpenSearch Serverless to store knowledge base data. + *

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.

* @public */ export interface OpenSearchServerlessConfiguration { /** - * Arn of an OpenSearch Serverless collection. + *

The ARN of the OpenSearch Service vector store.

* @public */ collectionArn: string | undefined; /** - * Arn of an OpenSearch Serverless index. + *

The name of the vector store.

* @public */ vectorIndexName: string | undefined; /** - * A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names + *

Contains the names of the fields to which to map information about the vector store.

* @public */ fieldMapping: OpenSearchServerlessFieldMapping | undefined; } /** - * A mapping of Bedrock Knowledge Base fields to Pinecone field names + *

Contains the names of the fields to which to map information about the vector store.

* @public */ export interface PineconeFieldMapping { /** - * Name of the field + *

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

* @public */ textField: string | undefined; /** - * Name of the field + *

The name of the field in which Amazon Bedrock stores metadata about the vector store.

* @public */ metadataField: string | undefined; } /** - * Contains the configurations to use Pinecone to store knowledge base data. + *

Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.

* @public */ export interface PineconeConfiguration { /** - * Pinecone connection string + *

The endpoint URL for your index management page.

* @public */ connectionString: string | undefined; /** - * Arn of a SecretsManager Secret. + *

The ARN of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

* @public */ credentialsSecretArn: string | undefined; /** - * Pinecone namespace + *

The namespace to be used to write new data to your database.

* @public */ namespace?: string; /** - * A mapping of Bedrock Knowledge Base fields to Pinecone field names + *

Contains the names of the fields to which to map information about the vector store.

* @public */ fieldMapping: PineconeFieldMapping | undefined; } /** - * A mapping of Bedrock Knowledge Base fields to RDS column names + *

Contains the names of the fields to which to map information about the vector store.

* @public */ export interface RdsFieldMapping { /** - * Name of the column + *

The name of the field in which Amazon Bedrock stores the ID for each entry.

* @public */ primaryKeyField: string | undefined; /** - * Name of the column + *

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

* @public */ vectorField: string | undefined; /** - * Name of the column + *

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

* @public */ textField: string | undefined; /** - * Name of the column + *

The name of the field in which Amazon Bedrock stores metadata about the vector store.

* @public */ metadataField: string | undefined; } /** - * Contains the configurations to use RDS to store knowledge base data. + *

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

* @public */ export interface RdsConfiguration { /** - * Arn of a RDS Resource. + *

The ARN of the vector store.

* @public */ resourceArn: string | undefined; /** - * Arn of a SecretsManager Secret. + *

The ARN of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.

* @public */ credentialsSecretArn: string | undefined; /** - * Name of the database within RDS + *

The name of your Amazon RDS database.

* @public */ databaseName: string | undefined; /** - * Name of the table within RDS + *

The name of the table in the database.

* @public */ tableName: string | undefined; /** - * A mapping of Bedrock Knowledge Base fields to RDS column names + *

Contains the names of the fields to which to map information about the vector store.

* @public */ fieldMapping: RdsFieldMapping | undefined; } /** - * A mapping of Bedrock Knowledge Base fields to Redis Cloud field names + *

Contains the names of the fields to which to map information about the vector store.

* @public */ export interface RedisEnterpriseCloudFieldMapping { /** - * Name of the field + *

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

* @public */ vectorField: string | undefined; /** - * Name of the field + *

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

* @public */ textField: string | undefined; /** - * Name of the field + *

The name of the field in which Amazon Bedrock stores metadata about the vector store.

* @public */ metadataField: string | undefined; } /** - * Contains the configurations to use Redis Enterprise Cloud to store knowledge base data. + *

Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.

* @public */ export interface RedisEnterpriseCloudConfiguration { /** - * Redis enterprise cloud endpoint + *

The endpoint URL of the Redis Enterprise Cloud database.

* @public */ endpoint: string | undefined; /** - * Name of a redis enterprise cloud index + *

The name of the vector index.

* @public */ vectorIndexName: string | undefined; /** - * Arn of a SecretsManager Secret. + *

The ARN of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.

* @public */ credentialsSecretArn: string | undefined; /** - * A mapping of Bedrock Knowledge Base fields to Redis Cloud field names + *

Contains the names of the fields to which to map information about the vector store.

* @public */ fieldMapping: RedisEnterpriseCloudFieldMapping | undefined; @@ -3099,36 +3192,36 @@ export const KnowledgeBaseStorageType = { export type KnowledgeBaseStorageType = (typeof KnowledgeBaseStorageType)[keyof typeof KnowledgeBaseStorageType]; /** - * Configures the physical storage of ingested data in a knowledge base. + *

Contains the storage configuration of the knowledge base.

* @public */ export interface StorageConfiguration { /** - * The storage type of a knowledge base. + *

The vector store service in which the knowledge base is stored.

* @public */ type: KnowledgeBaseStorageType | undefined; /** - * Contains the configurations to use OpenSearch Serverless to store knowledge base data. + *

Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

* @public */ opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration; /** - * Contains the configurations to use Pinecone to store knowledge base data. + *

Contains the storage configuration of the knowledge base in Pinecone.

* @public */ pineconeConfiguration?: PineconeConfiguration; /** - * Contains the configurations to use Redis Enterprise Cloud to store knowledge base data. + *

Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

* @public */ redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration; /** - * Contains the configurations to use RDS to store knowledge base data. + *

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

* @public */ rdsConfiguration?: RdsConfiguration; @@ -3139,43 +3232,44 @@ export interface StorageConfiguration { */ export interface CreateKnowledgeBaseRequest { /** - * Client specified token used for idempotency checks + *

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, + * Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

* @public */ clientToken?: string; /** - * Name for a resource. + *

A name for the knowledge base.

* @public */ name: string | undefined; /** - * Description of the Resource. + *

A description of the knowledge base.

* @public */ description?: string; /** - * ARN of a IAM role. + *

The ARN of the IAM role with permissions to create the knowledge base.

* @public */ roleArn: string | undefined; /** - * Configures a bedrock knowledge base. + *

Contains details about the embeddings model used for the knowledge base.

* @public */ knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined; /** - * Configures the physical storage of ingested data in a knowledge base. + *

Contains details about the configuration of the vector database used for the knowledge base.

* @public */ storageConfiguration: StorageConfiguration | undefined; /** - * A map of tag keys and values + *

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

* @public */ tags?: Record; @@ -3199,72 +3293,89 @@ export const KnowledgeBaseStatus = { export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus]; /** - * Contains the information of a knowledge base. + *

Contains information about a knowledge base.

* @public */ export interface KnowledgeBase { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base.

* @public */ knowledgeBaseId: string | undefined; /** - * Name for a resource. + *

The name of the knowledge base.

* @public */ name: string | undefined; /** - * ARN of a KnowledgeBase + *

The ARN of the knowledge base.

* @public */ knowledgeBaseArn: string | undefined; /** - * Description of the Resource. + *

The description of the knowledge base.

* @public */ description?: string; /** - * ARN of a IAM role. + *

The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_.

* @public */ roleArn: string | undefined; /** - * Configures a bedrock knowledge base. + *

Contains details about the embeddings configuration of the knowledge base.

* @public */ knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined; /** - * Configures the physical storage of ingested data in a knowledge base. + *

Contains details about the storage configuration of the knowledge base.

* @public */ storageConfiguration: StorageConfiguration | undefined; /** - * The status of a knowledge base. + *

The status of the knowledge base. The following statuses are possible:

+ *
    + *
  • + *

    CREATING – The knowledge base is being created.

    + *
  • + *
  • + *

    ACTIVE – The knowledge base is ready to be queried.

    + *
  • + *
  • + *

    DELETING – The knowledge base is being deleted.

    + *
  • + *
  • + *

    UPDATING – The knowledge base is being updated.

    + *
  • + *
  • + *

    FAILED – The knowledge base API operation failed.

    + *
  • + *
* @public */ status: KnowledgeBaseStatus | undefined; /** - * Time Stamp. + *

The time at which the knowledge base was created.

* @public */ createdAt: Date | undefined; /** - * Time Stamp. + *

The time at which the knowledge base was last updated.

* @public */ updatedAt: Date | undefined; /** - * Failure Reasons for Error. + *

A list of reasons that the API operation on the knowledge base failed.

* @public */ failureReasons?: string[]; @@ -3275,7 +3386,7 @@ export interface KnowledgeBase { */ export interface CreateKnowledgeBaseResponse { /** - * Contains the information of a knowledge base. + *

Contains details about the knowledge base.

* @public */ knowledgeBase: KnowledgeBase | undefined; @@ -3286,7 +3397,7 @@ export interface CreateKnowledgeBaseResponse { */ export interface DeleteKnowledgeBaseRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to delete.

* @public */ knowledgeBaseId: string | undefined; @@ -3297,79 +3408,75 @@ export interface DeleteKnowledgeBaseRequest { */ export interface DeleteKnowledgeBaseResponse { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base that was deleted.

* @public */ knowledgeBaseId: string | undefined; /** - * The status of a knowledge base. + *

The status of the knowledge base and whether it has been successfully deleted.

* @public */ status: KnowledgeBaseStatus | undefined; } /** - * Disassociate Agent Knowledge Base Request * @public */ export interface DisassociateAgentKnowledgeBaseRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent from which to disassociate the knowledge base.

* @public */ agentId: string | undefined; /** - * Draft Version of the Agent. + *

The version of the agent from which to disassociate the knowledge base.

* @public */ agentVersion: string | undefined; /** - * Id generated at the server side when a Knowledge Base is associated to an Agent + *

The unique identifier of the knowledge base to disassociate.

* @public */ knowledgeBaseId: string | undefined; } /** - * Disassociate Agent Knowledge Base Response * @public */ export interface DisassociateAgentKnowledgeBaseResponse {} /** - * Get Agent Knowledge Base Request * @public */ export interface GetAgentKnowledgeBaseRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent with which the knowledge base is associated.

* @public */ agentId: string | undefined; /** - * Version number generated when a version is created + *

The version of the agent with which the knowledge base is associated.

* @public */ agentVersion: string | undefined; /** - * Id generated at the server side when a Knowledge Base is associated + *

The unique identifier of the knowledge base associated with the agent.

* @public */ knowledgeBaseId: string | undefined; } /** - * Get Agent Knowledge Base Response * @public */ export interface GetAgentKnowledgeBaseResponse { /** - * Contains the information of an Agent Knowledge Base. + *

Contains details about a knowledge base attached to an agent.

* @public */ agentKnowledgeBase: AgentKnowledgeBase | undefined; @@ -3380,7 +3487,7 @@ export interface GetAgentKnowledgeBaseResponse { */ export interface GetKnowledgeBaseRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base for which to get information.

* @public */ knowledgeBaseId: string | undefined; @@ -3391,55 +3498,53 @@ export interface GetKnowledgeBaseRequest { */ export interface GetKnowledgeBaseResponse { /** - * Contains the information of a knowledge base. + *

Contains details about the knowledge base.

* @public */ knowledgeBase: KnowledgeBase | undefined; } /** - * List Agent Knowledge Bases Request * @public */ export interface ListAgentKnowledgeBasesRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent for which to return information about knowledge bases associated with it.

* @public */ agentId: string | undefined; /** - * Version number generated when a version is created + *

The version of the agent for which to return information about knowledge bases associated with it.

* @public */ agentVersion: string | undefined; /** - * Max Results. + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ maxResults?: number; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ nextToken?: string; } /** - * List Agent Knowledge Bases Response * @public */ export interface ListAgentKnowledgeBasesResponse { /** - * List of Agent Knowledge Base Summaries + *

A list of objects, each of which contains information about a knowledge base associated with the agent.

* @public */ agentKnowledgeBaseSummaries: AgentKnowledgeBaseSummary[] | undefined; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ nextToken?: string; @@ -3450,49 +3555,49 @@ export interface ListAgentKnowledgeBasesResponse { */ export interface ListKnowledgeBasesRequest { /** - * Max Results. + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ maxResults?: number; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ nextToken?: string; } /** - * Summary information of a knowledge base. + *

Contains details about a knowledge base.

* @public */ export interface KnowledgeBaseSummary { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base.

* @public */ knowledgeBaseId: string | undefined; /** - * Name for a resource. + *

The name of the knowledge base.

* @public */ name: string | undefined; /** - * Description of the Resource. + *

The description of the knowledge base.

* @public */ description?: string; /** - * The status of a knowledge base. + *

The status of the knowledge base.

* @public */ status: KnowledgeBaseStatus | undefined; /** - * Time Stamp. + *

The time at which the knowledge base was last updated.

* @public */ updatedAt: Date | undefined; @@ -3503,61 +3608,59 @@ export interface KnowledgeBaseSummary { */ export interface ListKnowledgeBasesResponse { /** - * List of KnowledgeBaseSummaries + *

A list of objects, each of which contains information about a knowledge base.

* @public */ knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ nextToken?: string; } /** - * Update Agent Knowledge Base Request * @public */ export interface UpdateAgentKnowledgeBaseRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent associated with the knowledge base that you want to update.

* @public */ agentId: string | undefined; /** - * Draft Version of the Agent. + *

The version of the agent associated with the knowledge base that you want to update.

* @public */ agentVersion: string | undefined; /** - * Id generated at the server side when a Knowledge Base is associated to an Agent + *

The unique identifier of the knowledge base that has been associated with an agent.

* @public */ knowledgeBaseId: string | undefined; /** - * Description of the Resource. + *

Specifies a new description for the knowledge base associated with an agent.

* @public */ description?: string; /** - * State of the knowledge base; whether it is enabled or disabled + *

Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

* @public */ knowledgeBaseState?: KnowledgeBaseState; } /** - * Update Agent Knowledge Base Response * @public */ export interface UpdateAgentKnowledgeBaseResponse { /** - * Contains the information of an Agent Knowledge Base. + *

Contains details about the knowledge base that has been associated with an agent.

* @public */ agentKnowledgeBase: AgentKnowledgeBase | undefined; @@ -3568,37 +3671,37 @@ export interface UpdateAgentKnowledgeBaseResponse { */ export interface UpdateKnowledgeBaseRequest { /** - * Identifier for a resource. + *

The unique identifier of the knowledge base to update.

* @public */ knowledgeBaseId: string | undefined; /** - * Name for a resource. + *

Specifies a new name for the knowledge base.

* @public */ name: string | undefined; /** - * Description of the Resource. + *

Specifies a new description for the knowledge base.

* @public */ description?: string; /** - * ARN of a IAM role. + *

Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to modify the knowledge base.

* @public */ roleArn: string | undefined; /** - * Configures a bedrock knowledge base. + *

Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

* @public */ knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined; /** - * Configures the physical storage of ingested data in a knowledge base. + *

Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

* @public */ storageConfiguration: StorageConfiguration | undefined; @@ -3609,7 +3712,7 @@ export interface UpdateKnowledgeBaseRequest { */ export interface UpdateKnowledgeBaseResponse { /** - * Contains the information of a knowledge base. + *

Contains details about the knowledge base.

* @public */ knowledgeBase: KnowledgeBase | undefined; @@ -3620,7 +3723,7 @@ export interface UpdateKnowledgeBaseResponse { */ export interface ListTagsForResourceRequest { /** - * ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base] + *

The ARN of the resource for which to list tags.

* @public */ resourceArn: string | undefined; @@ -3631,7 +3734,7 @@ export interface ListTagsForResourceRequest { */ export interface ListTagsForResourceResponse { /** - * A map of tag keys and values + *

The key-value pairs for the tags associated with the resource.

* @public */ tags?: Record; @@ -3642,13 +3745,13 @@ export interface ListTagsForResourceResponse { */ export interface TagResourceRequest { /** - * ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base] + *

The ARN of the resource to tag.

* @public */ resourceArn: string | undefined; /** - * A map of tag keys and values + *

An object containing key-value pairs that define the tags to attach to the resource.

* @public */ tags: Record | undefined; @@ -3664,13 +3767,13 @@ export interface TagResourceResponse {} */ export interface UntagResourceRequest { /** - * ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base] + *

The ARN of the resource from which to remove tags.

* @public */ resourceArn: string | undefined; /** - * List of Tag Keys + *

A list of keys of the tags to remove from the resource.

* @public */ tagKeys: string[] | undefined; @@ -3682,120 +3785,114 @@ export interface UntagResourceRequest { export interface UntagResourceResponse {} /** - * Delete Agent Version Request * @public */ export interface DeleteAgentVersionRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent that the version belongs to.

* @public */ agentId: string | undefined; /** - * Numerical Agent Version. + *

The version of the agent to delete.

* @public */ agentVersion: string | undefined; /** - * Skips checking if resource is in use when set to true. Defaults to false + *

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

* @public */ skipResourceInUseCheck?: boolean; } /** - * Delete Agent Version Response * @public */ export interface DeleteAgentVersionResponse { /** - * Identifier for a resource. + *

The unique identifier of the agent that the version belongs to.

* @public */ agentId: string | undefined; /** - * Numerical Agent Version. + *

The version that was deleted.

* @public */ agentVersion: string | undefined; /** - * Schema Type for Action APIs. + *

The status of the agent version.

* @public */ agentStatus: AgentStatus | undefined; } /** - * Get Agent Version Request * @public */ export interface GetAgentVersionRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Numerical Agent Version. + *

The version of the agent.

* @public */ agentVersion: string | undefined; } /** - * Get Agent Version Response * @public */ export interface GetAgentVersionResponse { /** - * Contains the information of an agent version. + *

Contains details about the version of the agent.

* @public */ agentVersion: AgentVersion | undefined; } /** - * List Agent Versions Request * @public */ export interface ListAgentVersionsRequest { /** - * Id generated at the server side when an Agent is created + *

The unique identifier of the agent.

* @public */ agentId: string | undefined; /** - * Max Results. + *

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

* @public */ maxResults?: number; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

* @public */ nextToken?: string; } /** - * List Agent Versions Response * @public */ export interface ListAgentVersionsResponse { /** - * List of AgentVersionSummary. + *

A list of objects, each of which contains information about a version of the agent.

* @public */ agentVersionSummaries: AgentVersionSummary[] | undefined; /** - * Opaque continuation token of previous paginated response. + *

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

* @public */ nextToken?: string; diff --git a/codegen/sdk-codegen/aws-models/bedrock-agent.json b/codegen/sdk-codegen/aws-models/bedrock-agent.json index 45d043b886b4..37d627b1a615 100644 --- a/codegen/sdk-codegen/aws-models/bedrock-agent.json +++ b/codegen/sdk-codegen/aws-models/bedrock-agent.json @@ -5,14 +5,20 @@ "type": "union", "members": { "s3": { - "target": "com.amazonaws.bedrockagent#S3Identifier" + "target": "com.amazonaws.bedrockagent#S3Identifier", + "traits": { + "smithy.api#documentation": "

Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

" + } }, "payload": { - "target": "com.amazonaws.bedrockagent#Payload" + "target": "com.amazonaws.bedrockagent#Payload", + "traits": { + "smithy.api#documentation": "

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.

" + } } }, "traits": { - "smithy.api#documentation": "Contains information about the API Schema for the Action Group" + "smithy.api#documentation": "

Contains details about the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas. You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

" } }, "com.amazonaws.bedrockagent#AccessDeniedException": { @@ -23,7 +29,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request is denied per access permissions", + "smithy.api#documentation": "

The request is denied because of missing access permissions.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -32,11 +38,14 @@ "type": "union", "members": { "lambda": { - "target": "com.amazonaws.bedrockagent#LambdaArn" + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

" + } } }, "traits": { - "smithy.api#documentation": "Type of Executors for an Action Group" + "smithy.api#documentation": "

Contains details about the Lambda function containing the business logic that is carried out upon invoking the action.

" } }, "com.amazonaws.bedrockagent#ActionGroupResource": { @@ -68,9 +77,6 @@ "smithy.api#enumValue": "AMAZON.UserInput" } } - }, - "traits": { - "smithy.api#documentation": "Action Group Signature for a BuiltIn Action" } }, "com.amazonaws.bedrockagent#ActionGroupState": { @@ -88,9 +94,6 @@ "smithy.api#enumValue": "DISABLED" } } - }, - "traits": { - "smithy.api#documentation": "State of the action group" } }, "com.amazonaws.bedrockagent#ActionGroupSummaries": { @@ -99,7 +102,6 @@ "target": "com.amazonaws.bedrockagent#ActionGroupSummary" }, "traits": { - "smithy.api#documentation": "List of ActionGroup Summaries", "smithy.api#length": { "max": 10 } @@ -111,33 +113,40 @@ "actionGroupId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the action group.

", "smithy.api#required": {} } }, "actionGroupName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the action group.

", "smithy.api#required": {} } }, "actionGroupState": { "target": "com.amazonaws.bedrockagent#ActionGroupState", "traits": { + "smithy.api#documentation": "

Specifies whether the action group is available for the agent to invoke or not when\n sending an InvokeAgent\n request.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the action group.

" + } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the action group was last updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "ActionGroup Summary" + "smithy.api#documentation": "

Contains details about an action group.

" } }, "com.amazonaws.bedrockagent#Agent": { @@ -146,87 +155,123 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#required": {} } }, "agentName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the agent.

", "smithy.api#required": {} } }, "agentArn": { "target": "com.amazonaws.bedrockagent#AgentArn", "traits": { + "smithy.api#documentation": "

The ARN of the agent.

", "smithy.api#required": {} } }, "agentVersion": { "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { + "smithy.api#documentation": "

The version of the agent.

", "smithy.api#required": {} } }, "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken" + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + } }, "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction" + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "

Instructions that tell the agent what it should do and how it should interact with users.

" + } }, "agentStatus": { "target": "com.amazonaws.bedrockagent#AgentStatus", "traits": { + "smithy.api#documentation": "

The status of the agent and whether it is ready for use. The following statuses are possible:

\n
    \n
  • \n

    CREATING – The agent is being created.

    \n
  • \n
  • \n

    PREPARING – The agent is being prepared.

    \n
  • \n
  • \n

    PREPARED – The agent is prepared and ready to be invoked.

    \n
  • \n
  • \n

    NOT_PREPARED – The agent has been created but not yet prepared.

    \n
  • \n
  • \n

    FAILED – The agent API operation failed.

    \n
  • \n
  • \n

    UPDATING – The agent is being updated.

    \n
  • \n
  • \n

    DELETING – The agent is being deleted.

    \n
  • \n
", "smithy.api#required": {} } }, "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier" + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The foundation model used for orchestration by the agent.

" + } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the agent.

" + } }, "idleSessionTTLInSeconds": { "target": "com.amazonaws.bedrockagent#SessionTTL", "traits": { + "smithy.api#documentation": "

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

\n

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

", "smithy.api#required": {} } }, "agentResourceRoleArn": { "target": "com.amazonaws.bedrockagent#AgentRoleArn", "traits": { + "smithy.api#documentation": "

The ARN of the IAM role with permissions to call API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

", "smithy.api#required": {} } }, "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn" + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that encrypts the agent.

" + } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the agent was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the agent was last updated.

", "smithy.api#required": {} } }, "preparedAt": { - "target": "com.amazonaws.bedrockagent#DateTimestamp" + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The time at which the agent was last prepared.

" + } }, "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons" + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "

Contains reasons that the agent-related API that you invoked failed.

" + } }, "recommendedActions": { - "target": "com.amazonaws.bedrockagent#RecommendedActions" + "target": "com.amazonaws.bedrockagent#RecommendedActions", + "traits": { + "smithy.api#documentation": "

Contains recommended actions to take for the agent-related API that you invoked to succeed.

" + } }, "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration" + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

" + } } }, "traits": { - "smithy.api#documentation": "Contains the information of an agent" + "smithy.api#documentation": "

Contains details about an agent.

" } }, "com.amazonaws.bedrockagent#AgentActionGroup": { @@ -235,63 +280,85 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent to which the action group belongs.

", "smithy.api#required": {} } }, "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { + "smithy.api#documentation": "

The version of the agent to which the action group belongs.

", "smithy.api#required": {} } }, "actionGroupId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the action group.

", "smithy.api#required": {} } }, "actionGroupName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the action group.

", "smithy.api#required": {} } }, "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken" + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the action group.

" + } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the action group was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the action group was last updated.

", "smithy.api#required": {} } }, "parentActionSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature" + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "

If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group.

\n

During orchestration, if the 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 Observation reprompting the user for more information.

" + } }, "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor" + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

" + } }, "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema" + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

" + } }, "actionGroupState": { "target": "com.amazonaws.bedrockagent#ActionGroupState", "traits": { + "smithy.api#documentation": "

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the information of an Agent Action Group" + "smithy.api#documentation": "

Contains details about an action group.

" } }, "com.amazonaws.bedrockagent#AgentAlias": { @@ -300,69 +367,85 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#required": {} } }, "agentAliasId": { "target": "com.amazonaws.bedrockagent#AgentAliasId", "traits": { + "smithy.api#documentation": "

The unique identifier of the alias of the agent.

", "smithy.api#required": {} } }, "agentAliasName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the alias of the agent.

", "smithy.api#required": {} } }, "agentAliasArn": { "target": "com.amazonaws.bedrockagent#AgentAliasArn", "traits": { + "smithy.api#documentation": "

The ARN of the alias of the agent.

", "smithy.api#required": {} } }, "clientToken": { - "target": "com.amazonaws.bedrockagent#ClientToken" + "target": "com.amazonaws.bedrockagent#ClientToken", + "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

" + } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the alias of the agent.

" + } }, "routingConfiguration": { "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", "traits": { + "smithy.api#documentation": "

Contains details about the routing configuration of the alias.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the alias of the agent was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the alias was last updated.

", "smithy.api#required": {} } }, "agentAliasHistoryEvents": { - "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvents" + "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvents", + "traits": { + "smithy.api#documentation": "

Contains details about the history of the alias.

" + } }, "agentAliasStatus": { "target": "com.amazonaws.bedrockagent#AgentAliasStatus", "traits": { + "smithy.api#documentation": "

The status of the alias of the agent and whether it is ready for use. The following statuses are possible:

\n
    \n
  • \n

    CREATING – The agent alias is being created.

    \n
  • \n
  • \n

    PREPARED – The agent alias is finished being created or updated and is ready to be invoked.

    \n
  • \n
  • \n

    FAILED – The agent alias API operation failed.

    \n
  • \n
  • \n

    UPDATING – The agent alias is being updated.

    \n
  • \n
  • \n

    DELETING – The agent alias is being deleted.

    \n
  • \n
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the information of an agent alias" + "smithy.api#documentation": "

Contains details about an alias of an agent.

" } }, "com.amazonaws.bedrockagent#AgentAliasArn": { "type": "string", "traits": { - "smithy.api#documentation": "Arn representation of the Agent Alias.", "smithy.api#length": { "max": 2048 }, @@ -373,17 +456,26 @@ "type": "structure", "members": { "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration" + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the version of the agent with which the alias is associated.

" + } }, "endDate": { - "target": "com.amazonaws.bedrockagent#DateTimestamp" + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The date that the alias stopped being associated to the version in the routingConfiguration object

" + } }, "startDate": { - "target": "com.amazonaws.bedrockagent#DateTimestamp" + "target": "com.amazonaws.bedrockagent#DateTimestamp", + "traits": { + "smithy.api#documentation": "

The date that the alias began being associated to the version in the routingConfiguration object.

" + } } }, "traits": { - "smithy.api#documentation": "History event for an alias for an Agent." + "smithy.api#documentation": "

Contains details about the history of the alias.

" } }, "com.amazonaws.bedrockagent#AgentAliasHistoryEvents": { @@ -392,7 +484,6 @@ "target": "com.amazonaws.bedrockagent#AgentAliasHistoryEvent" }, "traits": { - "smithy.api#documentation": "The list of history events for an alias for an Agent.", "smithy.api#length": { "max": 10 } @@ -401,7 +492,6 @@ "com.amazonaws.bedrockagent#AgentAliasId": { "type": "string", "traits": { - "smithy.api#documentation": "Id for an Agent Alias generated at the server side.", "smithy.api#length": { "min": 10, "max": 10 @@ -415,7 +505,6 @@ "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfigurationListItem" }, "traits": { - "smithy.api#documentation": "Routing configuration for an Agent alias.", "smithy.api#length": { "max": 1 } @@ -427,12 +516,13 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { + "smithy.api#documentation": "

The version of the agent with which the alias is associated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Details about the routing configuration for an Agent alias." + "smithy.api#documentation": "

Contains details about the routing configuration of the alias.

" } }, "com.amazonaws.bedrockagent#AgentAliasStatus": { @@ -468,9 +558,6 @@ "smithy.api#enumValue": "DELETING" } } - }, - "traits": { - "smithy.api#documentation": "The statuses an Agent Alias can be in." } }, "com.amazonaws.bedrockagent#AgentAliasSummaries": { @@ -479,7 +566,6 @@ "target": "com.amazonaws.bedrockagent#AgentAliasSummary" }, "traits": { - "smithy.api#documentation": "The list of summaries of all the aliases for an Agent.", "smithy.api#length": { "max": 10 } @@ -491,48 +577,58 @@ "agentAliasId": { "target": "com.amazonaws.bedrockagent#AgentAliasId", "traits": { + "smithy.api#documentation": "

Contains details about

", "smithy.api#required": {} } }, "agentAliasName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the alias.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the alias.

" + } }, "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration" + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the version of the agent with which the alias is associated.

" + } }, "agentAliasStatus": { "target": "com.amazonaws.bedrockagent#AgentAliasStatus", "traits": { + "smithy.api#documentation": "

The status of the alias.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the alias of the agent was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the alias was last updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Summary of an alias for an Agent." + "smithy.api#documentation": "

Contains details about an alias of an agent.

" } }, "com.amazonaws.bedrockagent#AgentArn": { "type": "string", "traits": { - "smithy.api#documentation": "Arn representation of the Agent.", "smithy.api#length": { "max": 2048 }, @@ -545,48 +641,55 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent with which the knowledge base is associated.

", "smithy.api#required": {} } }, "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { + "smithy.api#documentation": "

The version of the agent with which the knowledge base is associated.

", "smithy.api#required": {} } }, "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the association between the agent and the knowledge base.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagent#Description", "traits": { + "smithy.api#documentation": "

The description of the association between the agent and the knowledge base.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the association between the agent and the knowledge base was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the association between the agent and the knowledge base was last updated.

", "smithy.api#required": {} } }, "knowledgeBaseState": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", "traits": { + "smithy.api#documentation": "

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the information of an Agent Knowledge Base." + "smithy.api#documentation": "

Contains details about a knowledge base that is associated with an agent.

" } }, "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries": { @@ -595,7 +698,6 @@ "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummary" }, "traits": { - "smithy.api#documentation": "List of Agent Knowledge Base Summaries", "smithy.api#length": { "max": 10 } @@ -607,27 +709,33 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base associated with an agent.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the knowledge base associated with an agent.

" + } }, "knowledgeBaseState": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", "traits": { + "smithy.api#documentation": "

Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the knowledge base associated with an agent was last updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Agent Knowledge Base Summary" + "smithy.api#documentation": "

Contains details about a knowledge base associated with an agent.

" } }, "com.amazonaws.bedrockagent#AgentResource": { @@ -656,11 +764,10 @@ "com.amazonaws.bedrockagent#AgentRoleArn": { "type": "string", "traits": { - "smithy.api#documentation": "ARN of a IAM role.", "smithy.api#length": { "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents.+$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForAgents_.+$" } }, "com.amazonaws.bedrockagent#AgentStatus": { @@ -714,9 +821,6 @@ "smithy.api#enumValue": "UPDATING" } } - }, - "traits": { - "smithy.api#documentation": "Schema Type for Action APIs." } }, "com.amazonaws.bedrockagent#AgentSummaries": { @@ -725,7 +829,6 @@ "target": "com.amazonaws.bedrockagent#AgentSummary" }, "traits": { - "smithy.api#documentation": "List of AgentSummary.", "smithy.api#length": { "max": 10 } @@ -737,36 +840,46 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#required": {} } }, "agentName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the agent.

", "smithy.api#required": {} } }, "agentStatus": { "target": "com.amazonaws.bedrockagent#AgentStatus", "traits": { + "smithy.api#documentation": "

The status of the agent.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the agent.

" + } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the agent was last updated.

", "smithy.api#required": {} } }, "latestAgentVersion": { - "target": "com.amazonaws.bedrockagent#Version" + "target": "com.amazonaws.bedrockagent#Version", + "traits": { + "smithy.api#documentation": "

The latest version of the agent.

" + } } }, "traits": { - "smithy.api#documentation": "Summary of Agent." + "smithy.api#documentation": "

Contains details about an agent.

" } }, "com.amazonaws.bedrockagent#AgentVersion": { @@ -775,81 +888,111 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent that the version belongs to.

", "smithy.api#required": {} } }, "agentName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the agent that the version belongs to.

", "smithy.api#required": {} } }, "agentArn": { "target": "com.amazonaws.bedrockagent#AgentArn", "traits": { + "smithy.api#documentation": "

The ARN of the agent that the version belongs to.

", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.bedrockagent#NumericalVersion", "traits": { + "smithy.api#documentation": "

The version number.

", "smithy.api#required": {} } }, "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction" + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "

The instructions provided to the agent.

" + } }, "agentStatus": { "target": "com.amazonaws.bedrockagent#AgentStatus", "traits": { + "smithy.api#documentation": "

The status of the agent that the version belongs to.

", "smithy.api#required": {} } }, "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier" + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The foundation model that the version invokes.

" + } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the version.

" + } }, "idleSessionTTLInSeconds": { "target": "com.amazonaws.bedrockagent#SessionTTL", "traits": { + "smithy.api#documentation": "

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

\n

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

", "smithy.api#required": {} } }, "agentResourceRoleArn": { "target": "com.amazonaws.bedrockagent#AgentRoleArn", "traits": { + "smithy.api#documentation": "

The ARN of the IAM role with permissions to invoke API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

", "smithy.api#required": {} } }, "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn" + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that encrypts the agent.

" + } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the version was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the version was last updated.

", "smithy.api#required": {} } }, "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons" + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "

A list of reasons that the API operation on the version failed.

" + } }, "recommendedActions": { - "target": "com.amazonaws.bedrockagent#RecommendedActions" + "target": "com.amazonaws.bedrockagent#RecommendedActions", + "traits": { + "smithy.api#documentation": "

A list of recommended actions to take for the failed API operation on the version to succeed.

" + } }, "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration" + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.

" + } } }, "traits": { - "smithy.api#documentation": "Contains the information of an agent version." + "smithy.api#documentation": "

Contains details about a version of an agent.

" } }, "com.amazonaws.bedrockagent#AgentVersionSummaries": { @@ -858,7 +1001,6 @@ "target": "com.amazonaws.bedrockagent#AgentVersionSummary" }, "traits": { - "smithy.api#documentation": "List of AgentVersionSummary.", "smithy.api#length": { "max": 10 } @@ -870,39 +1012,47 @@ "agentName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the agent to which the version belongs.

", "smithy.api#required": {} } }, "agentStatus": { "target": "com.amazonaws.bedrockagent#AgentStatus", "traits": { + "smithy.api#documentation": "

The status of the agent to which the version belongs.

", "smithy.api#required": {} } }, "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { + "smithy.api#documentation": "

The version of the agent.

", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the version was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the version was last updated.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the version of the agent.

" + } } }, "traits": { - "smithy.api#documentation": "Summary of agent version." + "smithy.api#documentation": "

Contains details about a version of an agent.

" } }, "com.amazonaws.bedrockagent#AliasResource": { @@ -977,7 +1127,7 @@ "additionalExposedHeaders": ["x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id"], "maxAge": 86400 }, - "smithy.api#documentation": "An example service, deployed with the Octane Service creator,\nwhich will echo the string", + "smithy.api#documentation": "

Describes the API operations for creating and managing Amazon Bedrock agents.

", "smithy.api#title": "Agents for Amazon Bedrock", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1677,7 +1827,7 @@ } ], "traits": { - "smithy.api#documentation": "Associate a Knowledge Base to an existing Amazon Bedrock Agent", + "smithy.api#documentation": "

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -1693,7 +1843,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent with which you want to associate the knowledge base.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1701,7 +1851,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#documentation": "

The version of the agent with which you want to associate the knowledge base.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1709,21 +1859,25 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to associate with the agent.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.bedrockagent#Description", "traits": { + "smithy.api#documentation": "

A description of what the agent should use the knowledge base for.

", "smithy.api#required": {} } }, "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState" + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

" + } } }, "traits": { - "smithy.api#documentation": "Associate Agent Knowledge Base Request", "smithy.api#input": {} } }, @@ -1733,19 +1887,18 @@ "agentKnowledgeBase": { "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", "traits": { + "smithy.api#documentation": "

Contains details about the knowledge base that has been associated with the agent.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Associate Agent Knowledge Base Response", "smithy.api#output": {} } }, "com.amazonaws.bedrockagent#BasePromptTemplate": { "type": "string", "traits": { - "smithy.api#documentation": "Base Prompt Template.", "smithy.api#length": { "min": 1, "max": 100000 @@ -1755,7 +1908,6 @@ "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn": { "type": "string", "traits": { - "smithy.api#documentation": "Arn of a Bedrock model.", "smithy.api#length": { "min": 20, "max": 1011 @@ -1769,15 +1921,19 @@ "chunkingStrategy": { "target": "com.amazonaws.bedrockagent#ChunkingStrategy", "traits": { + "smithy.api#documentation": "

Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.

\n
    \n
  • \n

    \n FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration.

    \n
  • \n
  • \n

    \n NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.

    \n
  • \n
", "smithy.api#required": {} } }, "fixedSizeChunkingConfiguration": { - "target": "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration" + "target": "com.amazonaws.bedrockagent#FixedSizeChunkingConfiguration", + "traits": { + "smithy.api#documentation": "

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

" + } } }, "traits": { - "smithy.api#documentation": "Configures chunking strategy" + "smithy.api#documentation": "

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

" } }, "com.amazonaws.bedrockagent#ChunkingStrategy": { @@ -1795,15 +1951,11 @@ "smithy.api#enumValue": "NONE" } } - }, - "traits": { - "smithy.api#documentation": "The type of chunking strategy" } }, "com.amazonaws.bedrockagent#ClientToken": { "type": "string", "traits": { - "smithy.api#documentation": "Client specified token used for idempotency checks", "smithy.api#length": { "min": 33, "max": 256 @@ -1814,7 +1966,6 @@ "com.amazonaws.bedrockagent#ColumnName": { "type": "string", "traits": { - "smithy.api#documentation": "Name of the column", "smithy.api#length": { "max": 63 }, @@ -1829,7 +1980,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when there is a conflict performing an operation", + "smithy.api#documentation": "

There was a conflict performing an operation.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1863,7 +2014,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon Bedrock Agent", + "smithy.api#documentation": "

Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

\n
    \n
  • \n

    Specify the following fields for security purposes.

    \n
      \n
    • \n

      \n agentResourceRoleArn – The ARN of the role with permissions to create an agent.

      \n
    • \n
    • \n

      (Optional) customerEncryptionKeyArn – The ARN of a KMS key to encrypt the creation of the agent.

      \n
    • \n
    • \n

      (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.

      \n
    • \n
    \n
  • \n
  • \n

    To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

    \n
  • \n
  • \n

    If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

    \n
  • \n
", "smithy.api#http": { "code": 202, "method": "PUT", @@ -1905,7 +2056,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Action Group for existing Amazon Bedrock Agent", + "smithy.api#documentation": "

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.

\n

To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor 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 Observation reprompting the user for more information.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -1921,7 +2072,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent for which to create the action group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1929,7 +2080,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#documentation": "

The version of the agent for which to create the action group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1937,33 +2088,49 @@ "actionGroupName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name to give the action group.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

A description of the action group.

" + } }, "parentActionGroupSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature" + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "

To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

\n

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 Observation reprompting the user for more information.

" + } }, "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor" + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

" + } }, "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema" + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

" + } }, "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState" + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

" + } } }, "traits": { - "smithy.api#documentation": "Create Action Group Request", "smithy.api#input": {} } }, @@ -1973,12 +2140,12 @@ "agentActionGroup": { "target": "com.amazonaws.bedrockagent#AgentActionGroup", "traits": { + "smithy.api#documentation": "

Contains details about the action group that was created.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Create Action Group Response", "smithy.api#output": {} } }, @@ -2014,7 +2181,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Alias for an existing Amazon Bedrock Agent", + "smithy.api#documentation": "

Creates an alias of an agent that can be used to deploy the agent.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -2030,7 +2197,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2038,27 +2205,37 @@ "agentAliasName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the alias.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

A description of the alias of the agent.

" + } }, "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration" + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the routing configuration of the alias.

" + } }, "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap" + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "

Any tags that you want to attach to the alias of the agent.

" + } } }, "traits": { - "smithy.api#documentation": "Create Agent Alias Request", "smithy.api#input": {} } }, @@ -2068,12 +2245,12 @@ "agentAlias": { "target": "com.amazonaws.bedrockagent#AgentAlias", "traits": { + "smithy.api#documentation": "

Contains details about the alias that was created.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Create Agent Alias Response", "smithy.api#output": {} } }, @@ -2083,45 +2260,68 @@ "agentName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

A name for the agent that you create.

", "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction" + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "

Instructions that tell the agent what it should do and how it should interact with users.

" + } }, "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier" + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#documentation": "

The foundation model to be used for orchestration by the agent you create.

" + } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

A description of the agent.

" + } }, "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL" + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

\n

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

" + } }, "agentResourceRoleArn": { "target": "com.amazonaws.bedrockagent#AgentRoleArn", "traits": { + "smithy.api#documentation": "

The ARN of the IAM role with permissions to create the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

", "smithy.api#required": {} } }, "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn" + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key with which to encrypt the agent.

" + } }, "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap" + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "

Any tags that you want to attach to the agent.

" + } }, "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration" + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

" + } } }, "traits": { - "smithy.api#documentation": "Create Agent Request", "smithy.api#input": {} } }, @@ -2131,12 +2331,12 @@ "agent": { "target": "com.amazonaws.bedrockagent#Agent", "traits": { + "smithy.api#documentation": "

Contains details about the agent created.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Create Agent Response", "smithy.api#output": {} } }, @@ -2172,7 +2372,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new data source", + "smithy.api#documentation": "

Sets up a data source to be added to a knowledge base.

\n \n

You can't change the chunkingConfiguration after you create the data source.

\n
", "smithy.api#http": { "code": 200, "method": "PUT", @@ -2188,6 +2388,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to which to add the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2195,29 +2396,41 @@ "clientToken": { "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the data source.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

A description of the data source.

" + } }, "dataSourceConfiguration": { "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", "traits": { + "smithy.api#documentation": "

Contains metadata about where the data source is stored.

", "smithy.api#required": {} } }, "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration" + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the server-side encryption for the data source.

" + } }, "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration" + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about how to ingest the documents in the data source.

" + } } }, "traits": { @@ -2230,6 +2443,7 @@ "dataSource": { "target": "com.amazonaws.bedrockagent#DataSource", "traits": { + "smithy.api#documentation": "

Contains details about the data source.

", "smithy.api#required": {} } } @@ -2267,7 +2481,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new knowledge base", + "smithy.api#documentation": "

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 Set up your data for ingestion.

\n \n

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 Create a knowledge base.

\n
\n
    \n
  • \n

    Provide the name and an optional description.

    \n
  • \n
  • \n

    Provide the ARN with permissions to create a knowledge base in the roleArn field.

    \n
  • \n
  • \n

    Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.

    \n
  • \n
  • \n

    Provide the configuration for your vector store in the storageConfiguration object.

    \n \n
  • \n
", "smithy.api#http": { "code": 202, "method": "PUT", @@ -2283,38 +2497,49 @@ "clientToken": { "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

A name for the knowledge base.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

A description of the knowledge base.

" + } }, "roleArn": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", "traits": { + "smithy.api#documentation": "

The ARN of the IAM role with permissions to create the knowledge base.

", "smithy.api#required": {} } }, "knowledgeBaseConfiguration": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", "traits": { + "smithy.api#documentation": "

Contains details about the embeddings model used for the knowledge base.

", "smithy.api#required": {} } }, "storageConfiguration": { "target": "com.amazonaws.bedrockagent#StorageConfiguration", "traits": { + "smithy.api#documentation": "

Contains details about the configuration of the vector database used for the knowledge base.

", "smithy.api#required": {} } }, "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap" + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

" + } } }, "traits": { @@ -2327,6 +2552,7 @@ "knowledgeBase": { "target": "com.amazonaws.bedrockagent#KnowledgeBase", "traits": { + "smithy.api#documentation": "

Contains details about the knowledge base.

", "smithy.api#required": {} } } @@ -2350,9 +2576,6 @@ "smithy.api#enumValue": "OVERRIDDEN" } } - }, - "traits": { - "smithy.api#documentation": "Creation Mode for Prompt Configuration." } }, "com.amazonaws.bedrockagent#DataSource": { @@ -2361,57 +2584,73 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source belongs.

", "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the data source.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagent#DataSourceStatus", "traits": { + "smithy.api#documentation": "

The status of the data source. The following statuses are possible:

\n
    \n
  • \n

    Available – The data source has been created and is ready for ingestion into the knowledge base.

    \n
  • \n
  • \n

    Deleting – The data source is being deleted.

    \n
  • \n
", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the data source.

" + } }, "dataSourceConfiguration": { "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", "traits": { + "smithy.api#documentation": "

Contains details about how the data source is stored.

", "smithy.api#required": {} } }, "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration" + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the configuration of the server-side encryption.

" + } }, "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration" + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about how to ingest the documents in the data source.

" + } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the data source was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the data source was last updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the information of a data source." + "smithy.api#documentation": "

Contains details about a data source.

" } }, "com.amazonaws.bedrockagent#DataSourceConfiguration": { @@ -2420,15 +2659,19 @@ "type": { "target": "com.amazonaws.bedrockagent#DataSourceType", "traits": { + "smithy.api#documentation": "

The type of storage for the data source.

", "smithy.api#required": {} } }, "s3Configuration": { - "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration" + "target": "com.amazonaws.bedrockagent#S3DataSourceConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the configuration of the S3 object containing the data source.

" + } } }, "traits": { - "smithy.api#documentation": "Specifies a raw data source location to ingest." + "smithy.api#documentation": "

Contains details about how a data source is stored.

" } }, "com.amazonaws.bedrockagent#DataSourceResource": { @@ -2466,18 +2709,12 @@ "smithy.api#enumValue": "DELETING" } } - }, - "traits": { - "smithy.api#documentation": "The status of a data source." } }, "com.amazonaws.bedrockagent#DataSourceSummaries": { "type": "list", "member": { "target": "com.amazonaws.bedrockagent#DataSourceSummary" - }, - "traits": { - "smithy.api#documentation": "list of data source summaries" } }, "com.amazonaws.bedrockagent#DataSourceSummary": { @@ -2486,39 +2723,47 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source belongs.

", "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the data source.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagent#DataSourceStatus", "traits": { + "smithy.api#documentation": "

The status of the data source.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the data source.

" + } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the data source was last updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Summary information of a data source." + "smithy.api#documentation": "

Contains details about a data source.

" } }, "com.amazonaws.bedrockagent#DataSourceType": { @@ -2530,15 +2775,11 @@ "smithy.api#enumValue": "S3" } } - }, - "traits": { - "smithy.api#documentation": "The type of the data source location." } }, "com.amazonaws.bedrockagent#DateTimestamp": { "type": "timestamp", "traits": { - "smithy.api#documentation": "Time Stamp.", "smithy.api#timestampFormat": "date-time" } }, @@ -2571,7 +2812,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Agent for existing Amazon Bedrock Agent", + "smithy.api#documentation": "

Deletes an agent.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -2610,7 +2851,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Action Group for existing Amazon Bedrock Agent.", + "smithy.api#documentation": "

Deletes an action group in an agent.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -2626,7 +2867,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent that the action group belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2634,7 +2875,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#documentation": "

The version of the agent that the action group belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2642,7 +2883,7 @@ "actionGroupId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent ActionGroup is created", + "smithy.api#documentation": "

The unique identifier of the action group to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2651,13 +2892,12 @@ "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Skips checking if resource is in use when set to true. Defaults to false", + "smithy.api#documentation": "

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

", "smithy.api#httpQuery": "skipResourceInUseCheck" } } }, "traits": { - "smithy.api#documentation": "Delete Action Group Request", "smithy.api#input": {} } }, @@ -2665,7 +2905,6 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Delete Action Group Response", "smithy.api#output": {} } }, @@ -2695,7 +2934,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Alias for a Amazon Bedrock Agent", + "smithy.api#documentation": "

Deletes an alias of an agent.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -2711,7 +2950,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent that the alias belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2719,14 +2958,13 @@ "agentAliasId": { "target": "com.amazonaws.bedrockagent#AgentAliasId", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent Alias is created", + "smithy.api#documentation": "

The unique identifier of the alias to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Delete Agent Alias Request", "smithy.api#input": {} } }, @@ -2736,24 +2974,26 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent that the alias belongs to.

", "smithy.api#required": {} } }, "agentAliasId": { "target": "com.amazonaws.bedrockagent#AgentAliasId", "traits": { + "smithy.api#documentation": "

The unique identifier of the alias that was deleted.

", "smithy.api#required": {} } }, "agentAliasStatus": { "target": "com.amazonaws.bedrockagent#AgentAliasStatus", "traits": { + "smithy.api#documentation": "

The status of the alias.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Delete Agent Alias Response", "smithy.api#output": {} } }, @@ -2763,7 +3003,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2772,13 +3012,12 @@ "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Skips checking if resource is in use when set to true. Defaults to false", + "smithy.api#documentation": "

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

", "smithy.api#httpQuery": "skipResourceInUseCheck" } } }, "traits": { - "smithy.api#documentation": "Delete Agent Request", "smithy.api#input": {} } }, @@ -2788,18 +3027,19 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent that was deleted.

", "smithy.api#required": {} } }, "agentStatus": { "target": "com.amazonaws.bedrockagent#AgentStatus", "traits": { + "smithy.api#documentation": "

The status of the agent.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Delete Agent Response", "smithy.api#output": {} } }, @@ -2832,7 +3072,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Agent version for existing Amazon Bedrock Agent", + "smithy.api#documentation": "

Deletes a version of an agent.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -2848,7 +3088,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent that the version belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2856,6 +3096,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#NumericalVersion", "traits": { + "smithy.api#documentation": "

The version of the agent to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2864,13 +3105,12 @@ "target": "smithy.api#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Skips checking if resource is in use when set to true. Defaults to false", + "smithy.api#documentation": "

By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

", "smithy.api#httpQuery": "skipResourceInUseCheck" } } }, "traits": { - "smithy.api#documentation": "Delete Agent Version Request", "smithy.api#input": {} } }, @@ -2880,24 +3120,26 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent that the version belongs to.

", "smithy.api#required": {} } }, "agentVersion": { "target": "com.amazonaws.bedrockagent#NumericalVersion", "traits": { + "smithy.api#documentation": "

The version that was deleted.

", "smithy.api#required": {} } }, "agentStatus": { "target": "com.amazonaws.bedrockagent#AgentStatus", "traits": { + "smithy.api#documentation": "

The status of the agent version.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Delete Agent Version Response", "smithy.api#output": {} } }, @@ -2930,7 +3172,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete an existing data source", + "smithy.api#documentation": "

Deletes a data source from a knowledge base.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -2946,6 +3188,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base from which to delete the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2953,6 +3196,7 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2968,18 +3212,21 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source that was deleted belonged.

", "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source that was deleted.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagent#DataSourceStatus", "traits": { + "smithy.api#documentation": "

The status of the data source.

", "smithy.api#required": {} } } @@ -3017,7 +3264,7 @@ } ], "traits": { - "smithy.api#documentation": "Delete an existing knowledge base", + "smithy.api#documentation": "

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 DisassociateAgentKnowledgeBase request.

", "smithy.api#http": { "code": 202, "method": "DELETE", @@ -3033,6 +3280,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3048,12 +3296,14 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base that was deleted.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", "traits": { + "smithy.api#documentation": "

The status of the knowledge base and whether it has been successfully deleted.

", "smithy.api#required": {} } } @@ -3065,7 +3315,6 @@ "com.amazonaws.bedrockagent#Description": { "type": "string", "traits": { - "smithy.api#documentation": "Description of the Resource.", "smithy.api#length": { "min": 1, "max": 200 @@ -3101,7 +3350,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociate an existing Knowledge Base from an Amazon Bedrock Agent", + "smithy.api#documentation": "

Disassociates a knowledge base from an agent.

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -3117,7 +3366,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent from which to disassociate the knowledge base.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3125,7 +3374,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#documentation": "

The version of the agent from which to disassociate the knowledge base.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3133,14 +3382,13 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when a Knowledge Base is associated to an Agent", + "smithy.api#documentation": "

The unique identifier of the knowledge base to disassociate.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Disassociate Agent Knowledge Base Request", "smithy.api#input": {} } }, @@ -3148,14 +3396,12 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Disassociate Agent Knowledge Base Response", "smithy.api#output": {} } }, "com.amazonaws.bedrockagent#DraftVersion": { "type": "string", "traits": { - "smithy.api#documentation": "Draft Agent Version.", "smithy.api#length": { "min": 5, "max": 5 @@ -3166,7 +3412,6 @@ "com.amazonaws.bedrockagent#FailureReason": { "type": "string", "traits": { - "smithy.api#documentation": "Failure Reason for Error.", "smithy.api#length": { "max": 2048 } @@ -3178,7 +3423,6 @@ "target": "com.amazonaws.bedrockagent#FailureReason" }, "traits": { - "smithy.api#documentation": "Failure Reasons for Error.", "smithy.api#length": { "max": 2048 } @@ -3187,7 +3431,6 @@ "com.amazonaws.bedrockagent#FieldName": { "type": "string", "traits": { - "smithy.api#documentation": "Name of the field", "smithy.api#length": { "max": 2048 }, @@ -3200,7 +3443,7 @@ "maxTokens": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The maximum number of tokens per chunk.", + "smithy.api#documentation": "

The maximum number of tokens to include in a chunk.

", "smithy.api#range": { "min": 1 }, @@ -3210,7 +3453,7 @@ "overlapPercentage": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "The overlap percentage between adjacent chunks.", + "smithy.api#documentation": "

The percentage of overlap between adjacent chunks of a data source.

", "smithy.api#range": { "min": 1, "max": 99 @@ -3220,7 +3463,7 @@ } }, "traits": { - "smithy.api#documentation": "Configures fixed size chunking strategy" + "smithy.api#documentation": "

Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.

" } }, "com.amazonaws.bedrockagent#GetAgent": { @@ -3249,7 +3492,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets an Agent for existing Amazon Bedrock Agent", + "smithy.api#documentation": "

Gets information about an agent.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3285,7 +3528,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets an Action Group for existing Amazon Bedrock Agent Version", + "smithy.api#documentation": "

Gets information about an action group for an agent.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3301,7 +3544,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent that the action group belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3309,7 +3552,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "Version number generated when a version is created", + "smithy.api#documentation": "

The version of the agent that the action group belongs to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3317,14 +3560,13 @@ "actionGroupId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent Action Group is created", + "smithy.api#documentation": "

The unique identifier of the action group for which to get information.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Action Group Request", "smithy.api#input": {} } }, @@ -3334,12 +3576,12 @@ "agentActionGroup": { "target": "com.amazonaws.bedrockagent#AgentActionGroup", "traits": { + "smithy.api#documentation": "

Contains details about the action group.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Action Group Response", "smithy.api#output": {} } }, @@ -3369,7 +3611,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an Alias for a Amazon Bedrock Agent", + "smithy.api#documentation": "

Gets information about an alias of an agent.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3385,7 +3627,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent to which the alias to get information belongs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3393,14 +3635,13 @@ "agentAliasId": { "target": "com.amazonaws.bedrockagent#AgentAliasId", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent Alias is created", + "smithy.api#documentation": "

The unique identifier of the alias for which to get information.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Agent Alias Request", "smithy.api#input": {} } }, @@ -3410,12 +3651,12 @@ "agentAlias": { "target": "com.amazonaws.bedrockagent#AgentAlias", "traits": { + "smithy.api#documentation": "

Contains information about the alias.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Agent Alias Response", "smithy.api#output": {} } }, @@ -3445,7 +3686,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets a knowledge base associated to an existing Amazon Bedrock Agent Version", + "smithy.api#documentation": "

Gets information about a knowledge base associated with an agent.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3461,7 +3702,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent with which the knowledge base is associated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3469,7 +3710,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "Version number generated when a version is created", + "smithy.api#documentation": "

The version of the agent with which the knowledge base is associated.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3477,14 +3718,13 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when a Knowledge Base is associated", + "smithy.api#documentation": "

The unique identifier of the knowledge base associated with the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Agent Knowledge Base Request", "smithy.api#input": {} } }, @@ -3494,12 +3734,12 @@ "agentKnowledgeBase": { "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", "traits": { + "smithy.api#documentation": "

Contains details about a knowledge base attached to an agent.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Agent Knowledge Base Response", "smithy.api#output": {} } }, @@ -3509,14 +3749,13 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Agent Request", "smithy.api#input": {} } }, @@ -3526,12 +3765,12 @@ "agent": { "target": "com.amazonaws.bedrockagent#Agent", "traits": { + "smithy.api#documentation": "

Contains details about the agent.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Agent Response", "smithy.api#output": {} } }, @@ -3561,7 +3800,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets an Agent version for existing Amazon Bedrock Agent", + "smithy.api#documentation": "

Gets details about a version of an agent.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3577,7 +3816,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3585,13 +3824,13 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#NumericalVersion", "traits": { + "smithy.api#documentation": "

The version of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Agent Version Request", "smithy.api#input": {} } }, @@ -3601,12 +3840,12 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#AgentVersion", "traits": { + "smithy.api#documentation": "

Contains details about the version of the agent.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Get Agent Version Response", "smithy.api#output": {} } }, @@ -3636,7 +3875,7 @@ } ], "traits": { - "smithy.api#documentation": "Get an existing data source", + "smithy.api#documentation": "

Gets information about a data source.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3652,6 +3891,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base that the data source was added to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3659,6 +3899,7 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3674,6 +3915,7 @@ "dataSource": { "target": "com.amazonaws.bedrockagent#DataSource", "traits": { + "smithy.api#documentation": "

Contains details about the data source.

", "smithy.api#required": {} } } @@ -3708,7 +3950,7 @@ } ], "traits": { - "smithy.api#documentation": "Get an ingestion job", + "smithy.api#documentation": "

Gets information about a ingestion job, in which a data source is added to a knowledge base.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3724,6 +3966,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base for which the ingestion job applies.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3731,6 +3974,7 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source in the ingestion job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3738,6 +3982,7 @@ "ingestionJobId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the ingestion job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3753,6 +3998,7 @@ "ingestionJob": { "target": "com.amazonaws.bedrockagent#IngestionJob", "traits": { + "smithy.api#documentation": "

Contains details about the ingestion job.

", "smithy.api#required": {} } } @@ -3787,7 +4033,7 @@ } ], "traits": { - "smithy.api#documentation": "Get an existing knowledge base", + "smithy.api#documentation": "

Gets information about a knoweldge base.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3803,6 +4049,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base for which to get information.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3818,6 +4065,7 @@ "knowledgeBase": { "target": "com.amazonaws.bedrockagent#KnowledgeBase", "traits": { + "smithy.api#documentation": "

Contains details about the knowledge base.

", "smithy.api#required": {} } } @@ -3829,7 +4077,6 @@ "com.amazonaws.bedrockagent#Id": { "type": "string", "traits": { - "smithy.api#documentation": "Identifier for a resource.", "smithy.api#pattern": "^[0-9a-zA-Z]{10}$" } }, @@ -3837,23 +4084,38 @@ "type": "structure", "members": { "temperature": { - "target": "com.amazonaws.bedrockagent#Temperature" + "target": "com.amazonaws.bedrockagent#Temperature", + "traits": { + "smithy.api#documentation": "

The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.

" + } }, "topP": { - "target": "com.amazonaws.bedrockagent#TopP" + "target": "com.amazonaws.bedrockagent#TopP", + "traits": { + "smithy.api#documentation": "

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.

" + } }, "topK": { - "target": "com.amazonaws.bedrockagent#TopK" + "target": "com.amazonaws.bedrockagent#TopK", + "traits": { + "smithy.api#documentation": "

While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.

" + } }, "maximumLength": { - "target": "com.amazonaws.bedrockagent#MaximumLength" + "target": "com.amazonaws.bedrockagent#MaximumLength", + "traits": { + "smithy.api#documentation": "

The maximum number of tokens to allow in the generated response.

" + } }, "stopSequences": { - "target": "com.amazonaws.bedrockagent#StopSequences" + "target": "com.amazonaws.bedrockagent#StopSequences", + "traits": { + "smithy.api#documentation": "

A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.

" + } } }, "traits": { - "smithy.api#documentation": "Configuration for inference in prompt configuration" + "smithy.api#documentation": "

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

" } }, "com.amazonaws.bedrockagent#IngestionJob": { @@ -3862,51 +4124,66 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source is being added.

", "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the ingested data source.

", "smithy.api#required": {} } }, "ingestionJobId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the ingestion job.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the ingestion job.

" + } }, "status": { "target": "com.amazonaws.bedrockagent#IngestionJobStatus", "traits": { + "smithy.api#documentation": "

The status of the ingestion job.

", "smithy.api#required": {} } }, "statistics": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatistics" + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "traits": { + "smithy.api#documentation": "

Contains statistics about the ingestion job.

" + } }, "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons" + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "

A list of reasons that the ingestion job failed.

" + } }, "startedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the ingestion job started.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the ingestion job was last updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the information of an ingestion job." + "smithy.api#documentation": "

Contains details about an ingestion job, which converts a data source to embeddings for a vector store in knowledge base.

\n

This data type is used in the following API operations:

\n " } }, "com.amazonaws.bedrockagent#IngestionJobFilter": { @@ -3915,24 +4192,27 @@ "attribute": { "target": "com.amazonaws.bedrockagent#IngestionJobFilterAttribute", "traits": { + "smithy.api#documentation": "

The attribute by which to filter the results.

", "smithy.api#required": {} } }, "operator": { "target": "com.amazonaws.bedrockagent#IngestionJobFilterOperator", "traits": { + "smithy.api#documentation": "

The operation to carry out between the attribute and the values.

", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.bedrockagent#IngestionJobFilterValues", "traits": { + "smithy.api#documentation": "

A list of values for the attribute.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Filters the response returned by ListIngestionJobs operation." + "smithy.api#documentation": "

Defines a filter by which to filter the results.

" } }, "com.amazonaws.bedrockagent#IngestionJobFilterAttribute": { @@ -3944,9 +4224,6 @@ "smithy.api#enumValue": "STATUS" } } - }, - "traits": { - "smithy.api#documentation": "The name of the field to filter ingestion jobs." } }, "com.amazonaws.bedrockagent#IngestionJobFilterOperator": { @@ -3958,15 +4235,11 @@ "smithy.api#enumValue": "EQ" } } - }, - "traits": { - "smithy.api#documentation": "The operator used to filter ingestion jobs." } }, "com.amazonaws.bedrockagent#IngestionJobFilterValue": { "type": "string", "traits": { - "smithy.api#documentation": "The value used to filter ingestion jobs.", "smithy.api#length": { "min": 0, "max": 100 @@ -3980,7 +4253,6 @@ "target": "com.amazonaws.bedrockagent#IngestionJobFilterValue" }, "traits": { - "smithy.api#documentation": "The list of values used to filter ingestion jobs.", "smithy.api#length": { "min": 0, "max": 10 @@ -3993,7 +4265,6 @@ "target": "com.amazonaws.bedrockagent#IngestionJobFilter" }, "traits": { - "smithy.api#documentation": "List of IngestionJobFilters", "smithy.api#length": { "min": 1, "max": 1 @@ -4020,18 +4291,20 @@ "attribute": { "target": "com.amazonaws.bedrockagent#IngestionJobSortByAttribute", "traits": { + "smithy.api#documentation": "

The attribute by which to sort the results.

", "smithy.api#required": {} } }, "order": { "target": "com.amazonaws.bedrockagent#SortOrder", "traits": { + "smithy.api#documentation": "

The order by which to sort the results.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Sorts the response returned by ListIngestionJobs operation." + "smithy.api#documentation": "

Parameters by which to sort the results.

" } }, "com.amazonaws.bedrockagent#IngestionJobSortByAttribute": { @@ -4049,9 +4322,6 @@ "smithy.api#enumValue": "STARTED_AT" } } - }, - "traits": { - "smithy.api#documentation": "The name of the field to sort ingestion jobs." } }, "com.amazonaws.bedrockagent#IngestionJobStatistics": { @@ -4061,40 +4331,54 @@ "target": "smithy.api#PrimitiveLong", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Number of scanned documents" + "smithy.api#documentation": "

The total number of source documents that were scanned. Includes new, updated, and unchanged documents.

" + } + }, + "numberOfMetadataDocumentsScanned": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The total number of metadata files that were scanned. Includes new, updated, and unchanged files.

" } }, "numberOfNewDocumentsIndexed": { "target": "smithy.api#PrimitiveLong", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Number of indexed documents" + "smithy.api#documentation": "

The number of new source documents in the data source that were successfully indexed.

" } }, "numberOfModifiedDocumentsIndexed": { "target": "smithy.api#PrimitiveLong", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Number of modified documents indexed" + "smithy.api#documentation": "

The number of modified source documents in the data source that were successfully indexed.

" + } + }, + "numberOfMetadataDocumentsModified": { + "target": "smithy.api#PrimitiveLong", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of metadata files that were updated or deleted.

" } }, "numberOfDocumentsDeleted": { "target": "smithy.api#PrimitiveLong", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Number of deleted documents" + "smithy.api#documentation": "

The number of source documents that was deleted.

" } }, "numberOfDocumentsFailed": { "target": "smithy.api#PrimitiveLong", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Number of failed documents" + "smithy.api#documentation": "

The number of source documents that failed to be ingested.

" } } }, "traits": { - "smithy.api#documentation": "The document level statistics of an ingestion job" + "smithy.api#documentation": "

Contains the statistics for the ingestion job.

" } }, "com.amazonaws.bedrockagent#IngestionJobStatus": { @@ -4124,18 +4408,12 @@ "smithy.api#enumValue": "FAILED" } } - }, - "traits": { - "smithy.api#documentation": "The status of an ingestion job." } }, "com.amazonaws.bedrockagent#IngestionJobSummaries": { "type": "list", "member": { "target": "com.amazonaws.bedrockagent#IngestionJobSummary" - }, - "traits": { - "smithy.api#documentation": "List of IngestionJobSummaries" } }, "com.amazonaws.bedrockagent#IngestionJobSummary": { @@ -4144,54 +4422,65 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source is added.

", "smithy.api#required": {} } }, "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source in the ingestion job.

", "smithy.api#required": {} } }, "ingestionJobId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the ingestion job.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the ingestion job.

" + } }, "status": { "target": "com.amazonaws.bedrockagent#IngestionJobStatus", "traits": { + "smithy.api#documentation": "

The status of the ingestion job.

", "smithy.api#required": {} } }, "startedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the ingestion job was started.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the ingestion job was last updated.

", "smithy.api#required": {} } }, "statistics": { - "target": "com.amazonaws.bedrockagent#IngestionJobStatistics" + "target": "com.amazonaws.bedrockagent#IngestionJobStatistics", + "traits": { + "smithy.api#documentation": "

Contains statistics for the ingestion job.

" + } } }, "traits": { - "smithy.api#documentation": "Summary information of an ingestion job." + "smithy.api#documentation": "

Contains details about an ingestion job.

" } }, "com.amazonaws.bedrockagent#Instruction": { "type": "string", "traits": { - "smithy.api#documentation": "Instruction for the agent.", "smithy.api#length": { "min": 40, "max": 1200 @@ -4207,7 +4496,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown if there was an unexpected error during processing of request", + "smithy.api#documentation": "

An internal server error occurred. Retry your request.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -4215,7 +4504,6 @@ "com.amazonaws.bedrockagent#KmsKeyArn": { "type": "string", "traits": { - "smithy.api#documentation": "A KMS key ARN", "smithy.api#length": { "min": 1, "max": 2048 @@ -4229,72 +4517,86 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the knowledge base.

", "smithy.api#required": {} } }, "knowledgeBaseArn": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseArn", "traits": { + "smithy.api#documentation": "

The ARN of the knowledge base.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the knowledge base.

" + } }, "roleArn": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", "traits": { + "smithy.api#documentation": "

The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_.

", "smithy.api#required": {} } }, "knowledgeBaseConfiguration": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", "traits": { + "smithy.api#documentation": "

Contains details about the embeddings configuration of the knowledge base.

", "smithy.api#required": {} } }, "storageConfiguration": { "target": "com.amazonaws.bedrockagent#StorageConfiguration", "traits": { + "smithy.api#documentation": "

Contains details about the storage configuration of the knowledge base.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", "traits": { + "smithy.api#documentation": "

The status of the knowledge base. The following statuses are possible:

\n
    \n
  • \n

    CREATING – The knowledge base is being created.

    \n
  • \n
  • \n

    ACTIVE – The knowledge base is ready to be queried.

    \n
  • \n
  • \n

    DELETING – The knowledge base is being deleted.

    \n
  • \n
  • \n

    UPDATING – The knowledge base is being updated.

    \n
  • \n
  • \n

    FAILED – The knowledge base API operation failed.

    \n
  • \n
", "smithy.api#required": {} } }, "createdAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the knowledge base was created.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the knowledge base was last updated.

", "smithy.api#required": {} } }, "failureReasons": { - "target": "com.amazonaws.bedrockagent#FailureReasons" + "target": "com.amazonaws.bedrockagent#FailureReasons", + "traits": { + "smithy.api#documentation": "

A list of reasons that the API operation on the knowledge base failed.

" + } } }, "traits": { - "smithy.api#documentation": "Contains the information of a knowledge base." + "smithy.api#documentation": "

Contains information about a knowledge base.

" } }, "com.amazonaws.bedrockagent#KnowledgeBaseArn": { "type": "string", "traits": { - "smithy.api#documentation": "ARN of a KnowledgeBase", "smithy.api#length": { "max": 128 }, @@ -4307,15 +4609,19 @@ "type": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseType", "traits": { + "smithy.api#documentation": "

The type of data that the data source is converted into for the knowledge base.

", "smithy.api#required": {} } }, "vectorKnowledgeBaseConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration" + "target": "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the embeddings model that'sused to convert the data source.

" + } } }, "traits": { - "smithy.api#documentation": "Configures a bedrock knowledge base." + "smithy.api#documentation": "

Contains details about the embeddings configuration of the knowledge base.

" } }, "com.amazonaws.bedrockagent#KnowledgeBaseResource": { @@ -4356,11 +4662,10 @@ "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn": { "type": "string", "traits": { - "smithy.api#documentation": "ARN of a IAM role.", "smithy.api#length": { "max": 2048 }, - "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?AmazonBedrockExecutionRoleForKnowledgeBase.+$" + "smithy.api#pattern": "^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$" } }, "com.amazonaws.bedrockagent#KnowledgeBaseState": { @@ -4378,9 +4683,6 @@ "smithy.api#enumValue": "DISABLED" } } - }, - "traits": { - "smithy.api#documentation": "State of the knowledge base; whether it is enabled or disabled" } }, "com.amazonaws.bedrockagent#KnowledgeBaseStatus": { @@ -4416,9 +4718,6 @@ "smithy.api#enumValue": "FAILED" } } - }, - "traits": { - "smithy.api#documentation": "The status of a knowledge base." } }, "com.amazonaws.bedrockagent#KnowledgeBaseStorageType": { @@ -4448,18 +4747,12 @@ "smithy.api#enumValue": "RDS" } } - }, - "traits": { - "smithy.api#documentation": "The storage type of a knowledge base." } }, "com.amazonaws.bedrockagent#KnowledgeBaseSummaries": { "type": "list", "member": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummary" - }, - "traits": { - "smithy.api#documentation": "List of KnowledgeBaseSummaries" } }, "com.amazonaws.bedrockagent#KnowledgeBaseSummary": { @@ -4468,33 +4761,40 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

The name of the knowledge base.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

The description of the knowledge base.

" + } }, "status": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseStatus", "traits": { + "smithy.api#documentation": "

The status of the knowledge base.

", "smithy.api#required": {} } }, "updatedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the knowledge base was last updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Summary information of a knowledge base." + "smithy.api#documentation": "

Contains details about a knowledge base.

" } }, "com.amazonaws.bedrockagent#KnowledgeBaseType": { @@ -4506,15 +4806,11 @@ "smithy.api#enumValue": "VECTOR" } } - }, - "traits": { - "smithy.api#documentation": "The type of a knowledge base." } }, "com.amazonaws.bedrockagent#LambdaArn": { "type": "string", "traits": { - "smithy.api#documentation": "ARN of a Lambda.", "smithy.api#length": { "max": 2048 }, @@ -4547,7 +4843,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists an Action Group for existing Amazon Bedrock Agent Version", + "smithy.api#documentation": "

Lists the action groups for an agent and information about each one.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -4569,7 +4865,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is Listed", + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4577,20 +4873,25 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is Listed", + "smithy.api#documentation": "

The version of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults" + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Action Groups Request", "smithy.api#input": {} } }, @@ -4600,15 +4901,18 @@ "actionGroupSummaries": { "target": "com.amazonaws.bedrockagent#ActionGroupSummaries", "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains information about an action group.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Action Groups Response", "smithy.api#output": {} } }, @@ -4638,7 +4942,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the Aliases for an Amazon Bedrock Agent", + "smithy.api#documentation": "

Lists the aliases of an agent and information about each one.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -4660,20 +4964,25 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults" + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Agent Aliases Request", "smithy.api#input": {} } }, @@ -4683,15 +4992,18 @@ "agentAliasSummaries": { "target": "com.amazonaws.bedrockagent#AgentAliasSummaries", "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains information about an alias of the agent.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Agent Aliases Response", "smithy.api#output": {} } }, @@ -4721,7 +5033,7 @@ } ], "traits": { - "smithy.api#documentation": "List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version", + "smithy.api#documentation": "

Lists knowledge bases associated with an agent and information about each one.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -4743,7 +5055,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent for which to return information about knowledge bases associated with it.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4751,20 +5063,25 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { - "smithy.api#documentation": "Version number generated when a version is created", + "smithy.api#documentation": "

The version of the agent for which to return information about knowledge bases associated with it.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults" + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Agent Knowledge Bases Request", "smithy.api#input": {} } }, @@ -4774,15 +5091,18 @@ "agentKnowledgeBaseSummaries": { "target": "com.amazonaws.bedrockagent#AgentKnowledgeBaseSummaries", "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains information about a knowledge base associated with the agent.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Agent Knowledge Bases Response", "smithy.api#output": {} } }, @@ -4812,7 +5132,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Agent Versions", + "smithy.api#documentation": "

Lists the versions of an agent and information about each version.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -4834,20 +5154,25 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults" + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Agent Versions Request", "smithy.api#input": {} } }, @@ -4857,15 +5182,18 @@ "agentVersionSummaries": { "target": "com.amazonaws.bedrockagent#AgentVersionSummaries", "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains information about a version of the agent.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Agent Versions Response", "smithy.api#output": {} } }, @@ -4892,7 +5220,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists Agents", + "smithy.api#documentation": "

Lists the agents belonging to an account and information about each agent.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -4912,14 +5240,19 @@ "type": "structure", "members": { "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults" + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Agent Request", "smithy.api#input": {} } }, @@ -4929,15 +5262,18 @@ "agentSummaries": { "target": "com.amazonaws.bedrockagent#AgentSummaries", "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains information about an agent.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } } }, "traits": { - "smithy.api#documentation": "List Agent Response", "smithy.api#output": {} } }, @@ -4967,7 +5303,7 @@ } ], "traits": { - "smithy.api#documentation": "List data sources", + "smithy.api#documentation": "

Lists the data sources in a knowledge base and information about each one.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -4989,15 +5325,22 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base for which to return a list of information.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults" + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } } }, "traits": { @@ -5010,11 +5353,15 @@ "dataSourceSummaries": { "target": "com.amazonaws.bedrockagent#DataSourceSummaries", "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains information about a data source.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } } }, "traits": { @@ -5047,7 +5394,7 @@ } ], "traits": { - "smithy.api#documentation": "List ingestion jobs", + "smithy.api#documentation": "

Lists the ingestion jobs for a data source and information about each of them.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -5069,6 +5416,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base for which to return ingestion jobs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5076,21 +5424,34 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source for which to return ingestion jobs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "filters": { - "target": "com.amazonaws.bedrockagent#IngestionJobFilters" + "target": "com.amazonaws.bedrockagent#IngestionJobFilters", + "traits": { + "smithy.api#documentation": "

Contains a definition of a filter for which to filter the results.

" + } }, "sortBy": { - "target": "com.amazonaws.bedrockagent#IngestionJobSortBy" + "target": "com.amazonaws.bedrockagent#IngestionJobSortBy", + "traits": { + "smithy.api#documentation": "

Contains details about how to sort the results.

" + } }, "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults" + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } } }, "traits": { @@ -5103,11 +5464,15 @@ "ingestionJobSummaries": { "target": "com.amazonaws.bedrockagent#IngestionJobSummaries", "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains information about an ingestion job.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } } }, "traits": { @@ -5137,7 +5502,7 @@ } ], "traits": { - "smithy.api#documentation": "List Knowledge Bases", + "smithy.api#documentation": "

Lists the knowledge bases in an account and information about each of them.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -5157,10 +5522,16 @@ "type": "structure", "members": { "maxResults": { - "target": "com.amazonaws.bedrockagent#MaxResults" + "target": "com.amazonaws.bedrockagent#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

" + } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

" + } } }, "traits": { @@ -5173,11 +5544,15 @@ "knowledgeBaseSummaries": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseSummaries", "traits": { + "smithy.api#documentation": "

A list of objects, each of which contains information about a knowledge base.

", "smithy.api#required": {} } }, "nextToken": { - "target": "com.amazonaws.bedrockagent#NextToken" + "target": "com.amazonaws.bedrockagent#NextToken", + "traits": { + "smithy.api#documentation": "

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

" + } } }, "traits": { @@ -5210,7 +5585,7 @@ } ], "traits": { - "smithy.api#documentation": "List tags for a resource", + "smithy.api#documentation": "

List all the tags for the resource you specify.

", "smithy.api#http": { "code": 200, "method": "GET", @@ -5225,6 +5600,7 @@ "resourceArn": { "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", "traits": { + "smithy.api#documentation": "

The ARN of the resource for which to list tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5238,7 +5614,10 @@ "type": "structure", "members": { "tags": { - "target": "com.amazonaws.bedrockagent#TagsMap" + "target": "com.amazonaws.bedrockagent#TagsMap", + "traits": { + "smithy.api#documentation": "

The key-value pairs for the tags associated with the resource.

" + } } }, "traits": { @@ -5248,7 +5627,6 @@ "com.amazonaws.bedrockagent#MaxResults": { "type": "integer", "traits": { - "smithy.api#documentation": "Max Results.", "smithy.api#range": { "min": 1, "max": 1000 @@ -5258,7 +5636,6 @@ "com.amazonaws.bedrockagent#MaximumLength": { "type": "integer", "traits": { - "smithy.api#documentation": "Maximum length of output", "smithy.api#range": { "min": 0, "max": 4096 @@ -5268,7 +5645,6 @@ "com.amazonaws.bedrockagent#ModelIdentifier": { "type": "string", "traits": { - "smithy.api#documentation": "ARN or name of a Bedrock model.", "smithy.api#length": { "min": 1, "max": 2048 @@ -5279,14 +5655,12 @@ "com.amazonaws.bedrockagent#Name": { "type": "string", "traits": { - "smithy.api#documentation": "Name for a resource.", "smithy.api#pattern": "^([0-9a-zA-Z][_-]?){1,100}$" } }, "com.amazonaws.bedrockagent#NextToken": { "type": "string", "traits": { - "smithy.api#documentation": "Opaque continuation token of previous paginated response.", "smithy.api#length": { "min": 1, "max": 2048 @@ -5297,21 +5671,18 @@ "com.amazonaws.bedrockagent#NonBlankString": { "type": "string", "traits": { - "smithy.api#documentation": "Non Blank String", "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.bedrockagent#NumericalVersion": { "type": "string", "traits": { - "smithy.api#documentation": "Numerical Agent Version.", "smithy.api#pattern": "^[0-9]{1,5}$" } }, "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn": { "type": "string", "traits": { - "smithy.api#documentation": "Arn of an OpenSearch Serverless collection.", "smithy.api#length": { "max": 2048 }, @@ -5324,24 +5695,27 @@ "collectionArn": { "target": "com.amazonaws.bedrockagent#OpenSearchServerlessCollectionArn", "traits": { + "smithy.api#documentation": "

The ARN of the OpenSearch Service vector store.

", "smithy.api#required": {} } }, "vectorIndexName": { "target": "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName", "traits": { + "smithy.api#documentation": "

The name of the vector store.

", "smithy.api#required": {} } }, "fieldMapping": { "target": "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping", "traits": { + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the configurations to use OpenSearch Serverless to store knowledge base data." + "smithy.api#documentation": "

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see Create a vector index in Amazon OpenSearch Service.

" } }, "com.amazonaws.bedrockagent#OpenSearchServerlessFieldMapping": { @@ -5350,30 +5724,32 @@ "vectorField": { "target": "com.amazonaws.bedrockagent#FieldName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

", "smithy.api#required": {} } }, "textField": { "target": "com.amazonaws.bedrockagent#FieldName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

", "smithy.api#required": {} } }, "metadataField": { "target": "com.amazonaws.bedrockagent#FieldName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names" + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

" } }, "com.amazonaws.bedrockagent#OpenSearchServerlessIndexName": { "type": "string", "traits": { - "smithy.api#documentation": "Arn of an OpenSearch Serverless index.", "smithy.api#length": { "max": 2048 }, @@ -5383,7 +5759,6 @@ "com.amazonaws.bedrockagent#Payload": { "type": "string", "traits": { - "smithy.api#documentation": "String OpenAPI Payload", "smithy.api#sensitive": {} } }, @@ -5393,33 +5768,38 @@ "connectionString": { "target": "com.amazonaws.bedrockagent#PineconeConnectionString", "traits": { + "smithy.api#documentation": "

The endpoint URL for your index management page.

", "smithy.api#required": {} } }, "credentialsSecretArn": { "target": "com.amazonaws.bedrockagent#SecretArn", "traits": { + "smithy.api#documentation": "

The ARN of the secret that you created in Secrets Manager that is linked to your Pinecone API key.

", "smithy.api#required": {} } }, "namespace": { - "target": "com.amazonaws.bedrockagent#PineconeNamespace" + "target": "com.amazonaws.bedrockagent#PineconeNamespace", + "traits": { + "smithy.api#documentation": "

The namespace to be used to write new data to your database.

" + } }, "fieldMapping": { "target": "com.amazonaws.bedrockagent#PineconeFieldMapping", "traits": { + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the configurations to use Pinecone to store knowledge base data." + "smithy.api#documentation": "

Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see Create a vector index in Pinecone.

" } }, "com.amazonaws.bedrockagent#PineconeConnectionString": { "type": "string", "traits": { - "smithy.api#documentation": "Pinecone connection string", "smithy.api#length": { "max": 2048 }, @@ -5432,24 +5812,25 @@ "textField": { "target": "com.amazonaws.bedrockagent#FieldName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

", "smithy.api#required": {} } }, "metadataField": { "target": "com.amazonaws.bedrockagent#FieldName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A mapping of Bedrock Knowledge Base fields to Pinecone field names" + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

" } }, "com.amazonaws.bedrockagent#PineconeNamespace": { "type": "string", "traits": { - "smithy.api#documentation": "Pinecone namespace", "smithy.api#length": { "max": 2048 }, @@ -5488,7 +5869,7 @@ } ], "traits": { - "smithy.api#documentation": "Prepares an existing Amazon Bedrock Agent to receive runtime requests", + "smithy.api#documentation": "

Creates a DRAFT version of the agent that can be used for internal testing.

", "smithy.api#http": { "code": 202, "method": "POST", @@ -5503,14 +5884,13 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent for which to create a DRAFT version.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "PrepareAgent Request", "smithy.api#input": {} } }, @@ -5520,30 +5900,33 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the agent for which the DRAFT version was created.

", "smithy.api#required": {} } }, "agentStatus": { "target": "com.amazonaws.bedrockagent#AgentStatus", "traits": { + "smithy.api#documentation": "

The status of the DRAFT version and whether it is ready for use.

", "smithy.api#required": {} } }, "agentVersion": { "target": "com.amazonaws.bedrockagent#Version", "traits": { + "smithy.api#documentation": "

The version of the agent.

", "smithy.api#required": {} } }, "preparedAt": { "target": "com.amazonaws.bedrockagent#DateTimestamp", "traits": { + "smithy.api#documentation": "

The time at which the DRAFT version of the agent was last prepared.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "PrepareAgent Response", "smithy.api#output": {} } }, @@ -5551,26 +5934,44 @@ "type": "structure", "members": { "promptType": { - "target": "com.amazonaws.bedrockagent#PromptType" + "target": "com.amazonaws.bedrockagent#PromptType", + "traits": { + "smithy.api#documentation": "

The step in the agent sequence that this prompt configuration applies to.

" + } }, "promptCreationMode": { - "target": "com.amazonaws.bedrockagent#CreationMode" + "target": "com.amazonaws.bedrockagent#CreationMode", + "traits": { + "smithy.api#documentation": "

Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

" + } }, "promptState": { - "target": "com.amazonaws.bedrockagent#PromptState" + "target": "com.amazonaws.bedrockagent#PromptState", + "traits": { + "smithy.api#documentation": "

Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

\n
    \n
  • \n

    \n PRE_PROCESSINGENABLED\n

    \n
  • \n
  • \n

    \n ORCHESTRATIONENABLED\n

    \n
  • \n
  • \n

    \n KNOWLEDGE_BASE_RESPONSE_GENERATIONENABLED\n

    \n
  • \n
  • \n

    \n POST_PROCESSINGDISABLED\n

    \n
  • \n
" + } }, "basePromptTemplate": { - "target": "com.amazonaws.bedrockagent#BasePromptTemplate" + "target": "com.amazonaws.bedrockagent#BasePromptTemplate", + "traits": { + "smithy.api#documentation": "

Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.

" + } }, "inferenceConfiguration": { - "target": "com.amazonaws.bedrockagent#InferenceConfiguration" + "target": "com.amazonaws.bedrockagent#InferenceConfiguration", + "traits": { + "smithy.api#documentation": "

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

" + } }, "parserMode": { - "target": "com.amazonaws.bedrockagent#CreationMode" + "target": "com.amazonaws.bedrockagent#CreationMode", + "traits": { + "smithy.api#documentation": "

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

" + } } }, "traits": { - "smithy.api#documentation": "BasePromptConfiguration per Prompt Type." + "smithy.api#documentation": "

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

" } }, "com.amazonaws.bedrockagent#PromptConfigurations": { @@ -5579,7 +5980,6 @@ "target": "com.amazonaws.bedrockagent#PromptConfiguration" }, "traits": { - "smithy.api#documentation": "List of BasePromptConfiguration", "smithy.api#length": { "max": 10 } @@ -5591,15 +5991,19 @@ "promptConfigurations": { "target": "com.amazonaws.bedrockagent#PromptConfigurations", "traits": { + "smithy.api#documentation": "

Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.

", "smithy.api#required": {} } }, "overrideLambda": { - "target": "com.amazonaws.bedrockagent#LambdaArn" + "target": "com.amazonaws.bedrockagent#LambdaArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.

" + } } }, "traits": { - "smithy.api#documentation": "Configuration for prompt override.", + "smithy.api#documentation": "

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

", "smithy.api#sensitive": {} } }, @@ -5618,9 +6022,6 @@ "smithy.api#enumValue": "DISABLED" } } - }, - "traits": { - "smithy.api#documentation": "Prompt State." } }, "com.amazonaws.bedrockagent#PromptType": { @@ -5650,15 +6051,11 @@ "smithy.api#enumValue": "KNOWLEDGE_BASE_RESPONSE_GENERATION" } } - }, - "traits": { - "smithy.api#documentation": "Prompt Type." } }, "com.amazonaws.bedrockagent#RdsArn": { "type": "string", "traits": { - "smithy.api#documentation": "Arn of a RDS Resource.", "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$" } }, @@ -5668,42 +6065,46 @@ "resourceArn": { "target": "com.amazonaws.bedrockagent#RdsArn", "traits": { + "smithy.api#documentation": "

The ARN of the vector store.

", "smithy.api#required": {} } }, "credentialsSecretArn": { "target": "com.amazonaws.bedrockagent#SecretArn", "traits": { + "smithy.api#documentation": "

The ARN of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.

", "smithy.api#required": {} } }, "databaseName": { "target": "com.amazonaws.bedrockagent#RdsDatabaseName", "traits": { + "smithy.api#documentation": "

The name of your Amazon RDS database.

", "smithy.api#required": {} } }, "tableName": { "target": "com.amazonaws.bedrockagent#RdsTableName", "traits": { + "smithy.api#documentation": "

The name of the table in the database.

", "smithy.api#required": {} } }, "fieldMapping": { "target": "com.amazonaws.bedrockagent#RdsFieldMapping", "traits": { + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the configurations to use RDS to store knowledge base data." + "smithy.api#documentation": "

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

" } }, "com.amazonaws.bedrockagent#RdsDatabaseName": { "type": "string", "traits": { - "smithy.api#documentation": "Name of the database within RDS", "smithy.api#length": { "max": 63 }, @@ -5716,36 +6117,39 @@ "primaryKeyField": { "target": "com.amazonaws.bedrockagent#ColumnName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores the ID for each entry.

", "smithy.api#required": {} } }, "vectorField": { "target": "com.amazonaws.bedrockagent#ColumnName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

", "smithy.api#required": {} } }, "textField": { "target": "com.amazonaws.bedrockagent#ColumnName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

", "smithy.api#required": {} } }, "metadataField": { "target": "com.amazonaws.bedrockagent#ColumnName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A mapping of Bedrock Knowledge Base fields to RDS column names" + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

" } }, "com.amazonaws.bedrockagent#RdsTableName": { "type": "string", "traits": { - "smithy.api#documentation": "Name of the table within RDS", "smithy.api#length": { "max": 63 }, @@ -5755,7 +6159,6 @@ "com.amazonaws.bedrockagent#RecommendedAction": { "type": "string", "traits": { - "smithy.api#documentation": "The recommended action users can take to resolve an error in failureReasons.", "smithy.api#length": { "max": 2048 } @@ -5767,7 +6170,6 @@ "target": "com.amazonaws.bedrockagent#RecommendedAction" }, "traits": { - "smithy.api#documentation": "The recommended actions users can take to resolve an error in failureReasons.", "smithy.api#length": { "max": 2048 } @@ -5779,36 +6181,39 @@ "endpoint": { "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint", "traits": { + "smithy.api#documentation": "

The endpoint URL of the Redis Enterprise Cloud database.

", "smithy.api#required": {} } }, "vectorIndexName": { "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName", "traits": { + "smithy.api#documentation": "

The name of the vector index.

", "smithy.api#required": {} } }, "credentialsSecretArn": { "target": "com.amazonaws.bedrockagent#SecretArn", "traits": { + "smithy.api#documentation": "

The ARN of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.

", "smithy.api#required": {} } }, "fieldMapping": { "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudFieldMapping", "traits": { + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Contains the configurations to use Redis Enterprise Cloud to store knowledge base data." + "smithy.api#documentation": "

Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see Create a vector index in Redis Enterprise Cloud.

" } }, "com.amazonaws.bedrockagent#RedisEnterpriseCloudEndpoint": { "type": "string", "traits": { - "smithy.api#documentation": "Redis enterprise cloud endpoint", "smithy.api#length": { "max": 2048 }, @@ -5821,30 +6226,32 @@ "vectorField": { "target": "com.amazonaws.bedrockagent#FieldName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

", "smithy.api#required": {} } }, "textField": { "target": "com.amazonaws.bedrockagent#FieldName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

", "smithy.api#required": {} } }, "metadataField": { "target": "com.amazonaws.bedrockagent#FieldName", "traits": { + "smithy.api#documentation": "

The name of the field in which Amazon Bedrock stores metadata about the vector store.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A mapping of Bedrock Knowledge Base fields to Redis Cloud field names" + "smithy.api#documentation": "

Contains the names of the fields to which to map information about the vector store.

" } }, "com.amazonaws.bedrockagent#RedisEnterpriseCloudIndexName": { "type": "string", "traits": { - "smithy.api#documentation": "Name of a redis enterprise cloud index", "smithy.api#length": { "max": 2048 }, @@ -5859,7 +6266,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a resource referenced by the operation does not exist", + "smithy.api#documentation": "

The specified resource ARN was not found. Check the ARN and try your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -5867,7 +6274,6 @@ "com.amazonaws.bedrockagent#S3BucketArn": { "type": "string", "traits": { - "smithy.api#documentation": "A S3 bucket ARN", "smithy.api#length": { "min": 1, "max": 2048 @@ -5878,7 +6284,6 @@ "com.amazonaws.bedrockagent#S3BucketName": { "type": "string", "traits": { - "smithy.api#documentation": "A bucket in S3.", "smithy.api#length": { "min": 3, "max": 63 @@ -5892,35 +6297,44 @@ "bucketArn": { "target": "com.amazonaws.bedrockagent#S3BucketArn", "traits": { + "smithy.api#documentation": "

The ARN of the bucket that contains the data source.

", "smithy.api#required": {} } }, "inclusionPrefixes": { - "target": "com.amazonaws.bedrockagent#S3Prefixes" + "target": "com.amazonaws.bedrockagent#S3Prefixes", + "traits": { + "smithy.api#documentation": "

A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.

" + } } }, "traits": { - "smithy.api#documentation": "Configures an S3 data source location." + "smithy.api#documentation": "

Contains information about the S3 configuration of the data source.

" } }, "com.amazonaws.bedrockagent#S3Identifier": { "type": "structure", "members": { "s3BucketName": { - "target": "com.amazonaws.bedrockagent#S3BucketName" + "target": "com.amazonaws.bedrockagent#S3BucketName", + "traits": { + "smithy.api#documentation": "

The name of the S3 bucket.

" + } }, "s3ObjectKey": { - "target": "com.amazonaws.bedrockagent#S3ObjectKey" + "target": "com.amazonaws.bedrockagent#S3ObjectKey", + "traits": { + "smithy.api#documentation": "

The S3 object key containing the resource.

" + } } }, "traits": { - "smithy.api#documentation": "The identifier for the S3 resource." + "smithy.api#documentation": "

Contains information about the S3 object containing the resource.

" } }, "com.amazonaws.bedrockagent#S3ObjectKey": { "type": "string", "traits": { - "smithy.api#documentation": "A object key in S3.", "smithy.api#length": { "min": 1, "max": 1024 @@ -5931,7 +6345,6 @@ "com.amazonaws.bedrockagent#S3Prefix": { "type": "string", "traits": { - "smithy.api#documentation": "Prefix for s3 object.", "smithy.api#length": { "min": 1, "max": 300 @@ -5944,7 +6357,6 @@ "target": "com.amazonaws.bedrockagent#S3Prefix" }, "traits": { - "smithy.api#documentation": "A list of S3 prefixes.", "smithy.api#length": { "min": 1, "max": 1 @@ -5954,7 +6366,6 @@ "com.amazonaws.bedrockagent#SecretArn": { "type": "string", "traits": { - "smithy.api#documentation": "Arn of a SecretsManager Secret.", "smithy.api#pattern": "^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$" } }, @@ -5962,11 +6373,14 @@ "type": "structure", "members": { "kmsKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn" + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key used to encrypt the resource.

" + } } }, "traits": { - "smithy.api#documentation": "Server-side encryption configuration." + "smithy.api#documentation": "

Contains the configuration for server-side encryption.

" } }, "com.amazonaws.bedrockagent#ServiceQuotaExceededException": { @@ -5977,7 +6391,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when a request is made beyond the service quota", + "smithy.api#documentation": "

The number of requests exceeds the service quota. Resubmit your request later.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -5985,7 +6399,6 @@ "com.amazonaws.bedrockagent#SessionTTL": { "type": "integer", "traits": { - "smithy.api#documentation": "Max Session Time.", "smithy.api#range": { "min": 60, "max": 3600 @@ -6007,9 +6420,6 @@ "smithy.api#enumValue": "DESCENDING" } } - }, - "traits": { - "smithy.api#documentation": "Order to sort results by." } }, "com.amazonaws.bedrockagent#StartIngestionJob": { @@ -6044,7 +6454,7 @@ } ], "traits": { - "smithy.api#documentation": "Start a new ingestion job", + "smithy.api#documentation": "

Begins an ingestion job, in which a data source is added to a knowledge base.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -6060,6 +6470,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to which to add the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6067,6 +6478,7 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source to ingest.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6074,11 +6486,15 @@ "clientToken": { "target": "com.amazonaws.bedrockagent#ClientToken", "traits": { + "smithy.api#documentation": "

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,\n Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

", "smithy.api#idempotencyToken": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

A description of the ingestion job.

" + } } }, "traits": { @@ -6091,6 +6507,7 @@ "ingestionJob": { "target": "com.amazonaws.bedrockagent#IngestionJob", "traits": { + "smithy.api#documentation": "

An object containing information about the ingestion job.

", "smithy.api#required": {} } } @@ -6105,7 +6522,6 @@ "target": "smithy.api#String" }, "traits": { - "smithy.api#documentation": "List of stop sequences", "smithy.api#length": { "min": 0, "max": 4 @@ -6118,30 +6534,42 @@ "type": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseStorageType", "traits": { + "smithy.api#documentation": "

The vector store service in which the knowledge base is stored.

", "smithy.api#required": {} } }, "opensearchServerlessConfiguration": { - "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration" + "target": "com.amazonaws.bedrockagent#OpenSearchServerlessConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.

" + } }, "pineconeConfiguration": { - "target": "com.amazonaws.bedrockagent#PineconeConfiguration" + "target": "com.amazonaws.bedrockagent#PineconeConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the storage configuration of the knowledge base in Pinecone.

" + } }, "redisEnterpriseCloudConfiguration": { - "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration" + "target": "com.amazonaws.bedrockagent#RedisEnterpriseCloudConfiguration", + "traits": { + "smithy.api#documentation": "

Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.

" + } }, "rdsConfiguration": { - "target": "com.amazonaws.bedrockagent#RdsConfiguration" + "target": "com.amazonaws.bedrockagent#RdsConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

" + } } }, "traits": { - "smithy.api#documentation": "Configures the physical storage of ingested data in a knowledge base." + "smithy.api#documentation": "

Contains the storage configuration of the knowledge base.

" } }, "com.amazonaws.bedrockagent#TagKey": { "type": "string", "traits": { - "smithy.api#documentation": "Key of a tag", "smithy.api#length": { "min": 1, "max": 128 @@ -6155,7 +6583,6 @@ "target": "com.amazonaws.bedrockagent#TagKey" }, "traits": { - "smithy.api#documentation": "List of Tag Keys", "smithy.api#length": { "min": 0, "max": 200 @@ -6191,7 +6618,7 @@ } ], "traits": { - "smithy.api#documentation": "Tag a resource", + "smithy.api#documentation": "

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -6205,6 +6632,7 @@ "resourceArn": { "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", "traits": { + "smithy.api#documentation": "

The ARN of the resource to tag.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6212,6 +6640,7 @@ "tags": { "target": "com.amazonaws.bedrockagent#TagsMap", "traits": { + "smithy.api#documentation": "

An object containing key-value pairs that define the tags to attach to the resource.

", "smithy.api#required": {} } } @@ -6230,7 +6659,6 @@ "com.amazonaws.bedrockagent#TagValue": { "type": "string", "traits": { - "smithy.api#documentation": "Value of a tag", "smithy.api#length": { "min": 0, "max": 256 @@ -6241,7 +6669,6 @@ "com.amazonaws.bedrockagent#TaggableResourcesArn": { "type": "string", "traits": { - "smithy.api#documentation": "ARN of Taggable resources: [Agent, AgentAlias, Knowledge-Base]", "smithy.api#length": { "min": 20, "max": 1011 @@ -6270,15 +6697,11 @@ }, "value": { "target": "com.amazonaws.bedrockagent#TagValue" - }, - "traits": { - "smithy.api#documentation": "A map of tag keys and values" } }, "com.amazonaws.bedrockagent#Temperature": { "type": "float", "traits": { - "smithy.api#documentation": "Controls randomness, higher values increase diversity", "smithy.api#range": { "min": 0, "max": 1 @@ -6293,7 +6716,7 @@ } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the number of requests exceeds the limit", + "smithy.api#documentation": "

The number of requests exceeds the limit. Resubmit your request later.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -6301,7 +6724,6 @@ "com.amazonaws.bedrockagent#TopK": { "type": "integer", "traits": { - "smithy.api#documentation": "Sample from the k most likely next tokens", "smithy.api#range": { "min": 0, "max": 500 @@ -6311,7 +6733,6 @@ "com.amazonaws.bedrockagent#TopP": { "type": "float", "traits": { - "smithy.api#documentation": "Cumulative probability cutoff for token selection", "smithy.api#range": { "min": 0, "max": 1 @@ -6344,7 +6765,7 @@ } ], "traits": { - "smithy.api#documentation": "Untag a resource", + "smithy.api#documentation": "

Remove tags from a resource.

", "smithy.api#http": { "code": 200, "method": "DELETE", @@ -6359,6 +6780,7 @@ "resourceArn": { "target": "com.amazonaws.bedrockagent#TaggableResourcesArn", "traits": { + "smithy.api#documentation": "

The ARN of the resource from which to remove tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6366,6 +6788,7 @@ "tagKeys": { "target": "com.amazonaws.bedrockagent#TagKeyList", "traits": { + "smithy.api#documentation": "

A list of keys of the tags to remove from the resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -6414,7 +6837,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing Amazon Bedrock Agent", + "smithy.api#documentation": "

Updates the configuration of an agent.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -6456,7 +6879,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing Action Group for Amazon Bedrock Agent", + "smithy.api#documentation": "

Updates the configuration for an action group for an agent.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -6472,7 +6895,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent for which to update the action group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6480,7 +6903,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#documentation": "

The unique identifier of the agent version for which to update the action group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6488,7 +6911,7 @@ "actionGroupId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Action Group is created under Agent", + "smithy.api#documentation": "

The unique identifier of the action group.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6496,27 +6919,42 @@ "actionGroupName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

Specifies a new name for the action group.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

Specifies a new name for the action group.

" + } }, "parentActionGroupSignature": { - "target": "com.amazonaws.bedrockagent#ActionGroupSignature" + "target": "com.amazonaws.bedrockagent#ActionGroupSignature", + "traits": { + "smithy.api#documentation": "

To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

\n

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 Observation reprompting the user for more information.

" + } }, "actionGroupExecutor": { - "target": "com.amazonaws.bedrockagent#ActionGroupExecutor" + "target": "com.amazonaws.bedrockagent#ActionGroupExecutor", + "traits": { + "smithy.api#documentation": "

The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.

" + } }, "actionGroupState": { - "target": "com.amazonaws.bedrockagent#ActionGroupState" + "target": "com.amazonaws.bedrockagent#ActionGroupState", + "traits": { + "smithy.api#documentation": "

Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

" + } }, "apiSchema": { - "target": "com.amazonaws.bedrockagent#APISchema" + "target": "com.amazonaws.bedrockagent#APISchema", + "traits": { + "smithy.api#documentation": "

Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

" + } } }, "traits": { - "smithy.api#documentation": "Update Action Group Request", "smithy.api#input": {} } }, @@ -6526,12 +6964,12 @@ "agentActionGroup": { "target": "com.amazonaws.bedrockagent#AgentActionGroup", "traits": { + "smithy.api#documentation": "

Contains details about the action group that was updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Update Action Group Response", "smithy.api#output": {} } }, @@ -6567,7 +7005,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing Alias for an Amazon Bedrock Agent", + "smithy.api#documentation": "

Updates configurations for an alias of an agent.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -6583,7 +7021,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6591,7 +7029,7 @@ "agentAliasId": { "target": "com.amazonaws.bedrockagent#AgentAliasId", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent Alias is created", + "smithy.api#documentation": "

The unique identifier of the alias.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6599,18 +7037,24 @@ "agentAliasName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

Specifies a new name for the alias.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

Specifies a new description for the alias.

" + } }, "routingConfiguration": { - "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration" + "target": "com.amazonaws.bedrockagent#AgentAliasRoutingConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about the routing configuration of the alias.

" + } } }, "traits": { - "smithy.api#documentation": "Update Agent Alias Request", "smithy.api#input": {} } }, @@ -6620,12 +7064,12 @@ "agentAlias": { "target": "com.amazonaws.bedrockagent#AgentAlias", "traits": { + "smithy.api#documentation": "

Contains details about the alias that was updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Update Agent Alias Response", "smithy.api#output": {} } }, @@ -6658,7 +7102,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing Knowledge Base associated to an Amazon Bedrock Agent", + "smithy.api#documentation": "

Updates the configuration for a knowledge base that has been associated with an agent.

", "smithy.api#http": { "code": 200, "method": "PUT", @@ -6674,7 +7118,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent associated with the knowledge base that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6682,7 +7126,7 @@ "agentVersion": { "target": "com.amazonaws.bedrockagent#DraftVersion", "traits": { - "smithy.api#documentation": "Draft Version of the Agent.", + "smithy.api#documentation": "

The version of the agent associated with the knowledge base that you want to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6690,20 +7134,25 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when a Knowledge Base is associated to an Agent", + "smithy.api#documentation": "

The unique identifier of the knowledge base that has been associated with an agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

Specifies a new description for the knowledge base associated with an agent.

" + } }, "knowledgeBaseState": { - "target": "com.amazonaws.bedrockagent#KnowledgeBaseState" + "target": "com.amazonaws.bedrockagent#KnowledgeBaseState", + "traits": { + "smithy.api#documentation": "

Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

" + } } }, "traits": { - "smithy.api#documentation": "Update Agent Knowledge Base Request", "smithy.api#input": {} } }, @@ -6713,12 +7162,12 @@ "agentKnowledgeBase": { "target": "com.amazonaws.bedrockagent#AgentKnowledgeBase", "traits": { + "smithy.api#documentation": "

Contains details about the knowledge base that has been associated with an agent.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Update Agent Knowledge Base Response", "smithy.api#output": {} } }, @@ -6728,7 +7177,7 @@ "agentId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { - "smithy.api#documentation": "Id generated at the server side when an Agent is created", + "smithy.api#documentation": "

The unique identifier of the agent.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6736,36 +7185,57 @@ "agentName": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

Specifies a new name for the agent.

", "smithy.api#required": {} } }, "instruction": { - "target": "com.amazonaws.bedrockagent#Instruction" + "target": "com.amazonaws.bedrockagent#Instruction", + "traits": { + "smithy.api#documentation": "

Specifies new instructions that tell the agent what it should do and how it should interact with users.

" + } }, "foundationModel": { - "target": "com.amazonaws.bedrockagent#ModelIdentifier" + "target": "com.amazonaws.bedrockagent#ModelIdentifier", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "

Specifies a new foundation model to be used for orchestration by the agent.

", + "smithy.api#required": {} + } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

Specifies a new description of the agent.

" + } }, "idleSessionTTLInSeconds": { - "target": "com.amazonaws.bedrockagent#SessionTTL" + "target": "com.amazonaws.bedrockagent#SessionTTL", + "traits": { + "smithy.api#documentation": "

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

\n

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

" + } }, "agentResourceRoleArn": { "target": "com.amazonaws.bedrockagent#AgentRoleArn", "traits": { + "smithy.api#documentation": "

The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.

", "smithy.api#required": {} } }, "customerEncryptionKeyArn": { - "target": "com.amazonaws.bedrockagent#KmsKeyArn" + "target": "com.amazonaws.bedrockagent#KmsKeyArn", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key with which to encrypt the agent.

" + } }, "promptOverrideConfiguration": { - "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration" + "target": "com.amazonaws.bedrockagent#PromptOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

" + } } }, "traits": { - "smithy.api#documentation": "Update Agent Request", "smithy.api#input": {} } }, @@ -6775,12 +7245,12 @@ "agent": { "target": "com.amazonaws.bedrockagent#Agent", "traits": { + "smithy.api#documentation": "

Contains details about the agent that was updated.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Update Agent Response", "smithy.api#output": {} } }, @@ -6813,7 +7283,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an existing data source", + "smithy.api#documentation": "

Updates configurations for a data source.

\n \n

You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.

\n
", "smithy.api#http": { "code": 200, "method": "PUT", @@ -6829,6 +7299,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to which the data source belongs.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6836,6 +7307,7 @@ "dataSourceId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the data source.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6843,23 +7315,34 @@ "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

Specifies a new name for the data source.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

Specifies a new description for the data source.

" + } }, "dataSourceConfiguration": { "target": "com.amazonaws.bedrockagent#DataSourceConfiguration", "traits": { + "smithy.api#documentation": "

Contains details about the storage configuration of the data source.

", "smithy.api#required": {} } }, "serverSideEncryptionConfiguration": { - "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration" + "target": "com.amazonaws.bedrockagent#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about server-side encryption of the data source.

" + } }, "vectorIngestionConfiguration": { - "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration" + "target": "com.amazonaws.bedrockagent#VectorIngestionConfiguration", + "traits": { + "smithy.api#documentation": "

Contains details about how to ingest the documents in the data source.

" + } } }, "traits": { @@ -6872,6 +7355,7 @@ "dataSource": { "target": "com.amazonaws.bedrockagent#DataSource", "traits": { + "smithy.api#documentation": "

Contains details about the data source.

", "smithy.api#required": {} } } @@ -6909,7 +7393,7 @@ } ], "traits": { - "smithy.api#documentation": "Update an existing knowledge base", + "smithy.api#documentation": "

Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.

\n

You can change the following fields:

\n
    \n
  • \n

    \n name\n

    \n
  • \n
  • \n

    \n description\n

    \n
  • \n
  • \n

    \n roleArn\n

    \n
  • \n
\n

You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.

", "smithy.api#http": { "code": 202, "method": "PUT", @@ -6925,6 +7409,7 @@ "knowledgeBaseId": { "target": "com.amazonaws.bedrockagent#Id", "traits": { + "smithy.api#documentation": "

The unique identifier of the knowledge base to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6932,27 +7417,34 @@ "name": { "target": "com.amazonaws.bedrockagent#Name", "traits": { + "smithy.api#documentation": "

Specifies a new name for the knowledge base.

", "smithy.api#required": {} } }, "description": { - "target": "com.amazonaws.bedrockagent#Description" + "target": "com.amazonaws.bedrockagent#Description", + "traits": { + "smithy.api#documentation": "

Specifies a new description for the knowledge base.

" + } }, "roleArn": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseRoleArn", "traits": { + "smithy.api#documentation": "

Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to modify the knowledge base.

", "smithy.api#required": {} } }, "knowledgeBaseConfiguration": { "target": "com.amazonaws.bedrockagent#KnowledgeBaseConfiguration", "traits": { + "smithy.api#documentation": "

Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

", "smithy.api#required": {} } }, "storageConfiguration": { "target": "com.amazonaws.bedrockagent#StorageConfiguration", "traits": { + "smithy.api#documentation": "

Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

", "smithy.api#required": {} } } @@ -6967,6 +7459,7 @@ "knowledgeBase": { "target": "com.amazonaws.bedrockagent#KnowledgeBase", "traits": { + "smithy.api#documentation": "

Contains details about the knowledge base.

", "smithy.api#required": {} } } @@ -6982,11 +7475,14 @@ "target": "com.amazonaws.bedrockagent#NonBlankString" }, "fieldList": { - "target": "com.amazonaws.bedrockagent#ValidationExceptionFieldList" + "target": "com.amazonaws.bedrockagent#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "

A list of objects containing fields that caused validation errors and their corresponding validation error messages.

" + } } }, "traits": { - "smithy.api#documentation": "This exception is thrown when the request's input validation fails", + "smithy.api#documentation": "

Input validation failed. Check your request parameters and retry the request.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6997,38 +7493,40 @@ "name": { "target": "com.amazonaws.bedrockagent#NonBlankString", "traits": { + "smithy.api#documentation": "

The name of the field.

", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.bedrockagent#NonBlankString", "traits": { + "smithy.api#documentation": "

A message describing why this field failed validation.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Stores information about a field passed inside a request that resulted in an exception" + "smithy.api#documentation": "

Stores information about a field passed inside a request that resulted in an validation error.

" } }, "com.amazonaws.bedrockagent#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.bedrockagent#ValidationExceptionField" - }, - "traits": { - "smithy.api#documentation": "list of ValidationExceptionField" } }, "com.amazonaws.bedrockagent#VectorIngestionConfiguration": { "type": "structure", "members": { "chunkingConfiguration": { - "target": "com.amazonaws.bedrockagent#ChunkingConfiguration" + "target": "com.amazonaws.bedrockagent#ChunkingConfiguration", + "traits": { + "smithy.api#documentation": "

Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.

" + } } }, "traits": { - "smithy.api#documentation": "Configures ingestion for a vector knowledge base" + "smithy.api#documentation": "

Contains details about how to ingest the documents in a data source.

" } }, "com.amazonaws.bedrockagent#VectorKnowledgeBaseConfiguration": { @@ -7037,18 +7535,18 @@ "embeddingModelArn": { "target": "com.amazonaws.bedrockagent#BedrockEmbeddingModelArn", "traits": { + "smithy.api#documentation": "

The ARN of the model used to create vector embeddings for the knowledge base.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Configurations for a vector knowledge base." + "smithy.api#documentation": "

Contains details about the model used to create vector embeddings for the knowledge base.

" } }, "com.amazonaws.bedrockagent#Version": { "type": "string", "traits": { - "smithy.api#documentation": "Agent Version.", "smithy.api#length": { "min": 1, "max": 5