# Agents for Amazon Bedrock
The following actions are supported by Agents for Amazon Bedrock:
+ [AssociateAgentCollaborator](API_agent_AssociateAgentCollaborator.md)
+ [AssociateAgentKnowledgeBase](API_agent_AssociateAgentKnowledgeBase.md)
+ [CreateAgent](API_agent_CreateAgent.md)
+ [CreateAgentActionGroup](API_agent_CreateAgentActionGroup.md)
+ [CreateAgentAlias](API_agent_CreateAgentAlias.md)
+ [CreateDataSource](API_agent_CreateDataSource.md)
+ [CreateFlow](API_agent_CreateFlow.md)
+ [CreateFlowAlias](API_agent_CreateFlowAlias.md)
+ [CreateFlowVersion](API_agent_CreateFlowVersion.md)
+ [CreateKnowledgeBase](API_agent_CreateKnowledgeBase.md)
+ [CreatePrompt](API_agent_CreatePrompt.md)
+ [CreatePromptVersion](API_agent_CreatePromptVersion.md)
+ [DeleteAgent](API_agent_DeleteAgent.md)
+ [DeleteAgentActionGroup](API_agent_DeleteAgentActionGroup.md)
+ [DeleteAgentAlias](API_agent_DeleteAgentAlias.md)
+ [DeleteAgentVersion](API_agent_DeleteAgentVersion.md)
+ [DeleteDataSource](API_agent_DeleteDataSource.md)
+ [DeleteFlow](API_agent_DeleteFlow.md)
+ [DeleteFlowAlias](API_agent_DeleteFlowAlias.md)
+ [DeleteFlowVersion](API_agent_DeleteFlowVersion.md)
+ [DeleteKnowledgeBase](API_agent_DeleteKnowledgeBase.md)
+ [DeleteKnowledgeBaseDocuments](API_agent_DeleteKnowledgeBaseDocuments.md)
+ [DeletePrompt](API_agent_DeletePrompt.md)
+ [DisassociateAgentCollaborator](API_agent_DisassociateAgentCollaborator.md)
+ [DisassociateAgentKnowledgeBase](API_agent_DisassociateAgentKnowledgeBase.md)
+ [GetAgent](API_agent_GetAgent.md)
+ [GetAgentActionGroup](API_agent_GetAgentActionGroup.md)
+ [GetAgentAlias](API_agent_GetAgentAlias.md)
+ [GetAgentCollaborator](API_agent_GetAgentCollaborator.md)
+ [GetAgentKnowledgeBase](API_agent_GetAgentKnowledgeBase.md)
+ [GetAgentVersion](API_agent_GetAgentVersion.md)
+ [GetDataSource](API_agent_GetDataSource.md)
+ [GetFlow](API_agent_GetFlow.md)
+ [GetFlowAlias](API_agent_GetFlowAlias.md)
+ [GetFlowVersion](API_agent_GetFlowVersion.md)
+ [GetIngestionJob](API_agent_GetIngestionJob.md)
+ [GetKnowledgeBase](API_agent_GetKnowledgeBase.md)
+ [GetKnowledgeBaseDocuments](API_agent_GetKnowledgeBaseDocuments.md)
+ [GetPrompt](API_agent_GetPrompt.md)
+ [IngestKnowledgeBaseDocuments](API_agent_IngestKnowledgeBaseDocuments.md)
+ [ListAgentActionGroups](API_agent_ListAgentActionGroups.md)
+ [ListAgentAliases](API_agent_ListAgentAliases.md)
+ [ListAgentCollaborators](API_agent_ListAgentCollaborators.md)
+ [ListAgentKnowledgeBases](API_agent_ListAgentKnowledgeBases.md)
+ [ListAgents](API_agent_ListAgents.md)
+ [ListAgentVersions](API_agent_ListAgentVersions.md)
+ [ListDataSources](API_agent_ListDataSources.md)
+ [ListFlowAliases](API_agent_ListFlowAliases.md)
+ [ListFlows](API_agent_ListFlows.md)
+ [ListFlowVersions](API_agent_ListFlowVersions.md)
+ [ListIngestionJobs](API_agent_ListIngestionJobs.md)
+ [ListKnowledgeBaseDocuments](API_agent_ListKnowledgeBaseDocuments.md)
+ [ListKnowledgeBases](API_agent_ListKnowledgeBases.md)
+ [ListPrompts](API_agent_ListPrompts.md)
+ [ListTagsForResource](API_agent_ListTagsForResource.md)
+ [PrepareAgent](API_agent_PrepareAgent.md)
+ [PrepareFlow](API_agent_PrepareFlow.md)
+ [StartIngestionJob](API_agent_StartIngestionJob.md)
+ [StopIngestionJob](API_agent_StopIngestionJob.md)
+ [TagResource](API_agent_TagResource.md)
+ [UntagResource](API_agent_UntagResource.md)
+ [UpdateAgent](API_agent_UpdateAgent.md)
+ [UpdateAgentActionGroup](API_agent_UpdateAgentActionGroup.md)
+ [UpdateAgentAlias](API_agent_UpdateAgentAlias.md)
+ [UpdateAgentCollaborator](API_agent_UpdateAgentCollaborator.md)
+ [UpdateAgentKnowledgeBase](API_agent_UpdateAgentKnowledgeBase.md)
+ [UpdateDataSource](API_agent_UpdateDataSource.md)
+ [UpdateFlow](API_agent_UpdateFlow.md)
+ [UpdateFlowAlias](API_agent_UpdateFlowAlias.md)
+ [UpdateKnowledgeBase](API_agent_UpdateKnowledgeBase.md)
+ [UpdatePrompt](API_agent_UpdatePrompt.md)
+ [ValidateFlowDefinition](API_agent_ValidateFlowDefinition.md)
# AssociateAgentCollaborator
Makes an agent a collaborator for another agent.
## Request Syntax
```
PUT /agents/agentId/agentversions/agentVersion/agentcollaborators/ HTTP/1.1
Content-type: application/json
{
"agentDescriptor": {
"aliasArn": "string"
},
"clientToken": "string",
"collaborationInstruction": "string",
"collaboratorName": "string",
"relayConversationHistory": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_AssociateAgentCollaborator_RequestSyntax) **
The agent's ID.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_AssociateAgentCollaborator_RequestSyntax) **
An agent version.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [agentDescriptor](#API_agent_AssociateAgentCollaborator_RequestSyntax) **
The alias of the collaborator agent.
Type: [AgentDescriptor](API_agent_AgentDescriptor.md) object
Required: Yes
** [clientToken](#API_agent_AssociateAgentCollaborator_RequestSyntax) **
A client token.
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [collaborationInstruction](#API_agent_AssociateAgentCollaborator_RequestSyntax) **
Instruction for the collaborator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Required: Yes
** [collaboratorName](#API_agent_AssociateAgentCollaborator_RequestSyntax) **
A name for the collaborator.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [relayConversationHistory](#API_agent_AssociateAgentCollaborator_RequestSyntax) **
A relay conversation history for the collaborator.
Type: String
Valid Values: `TO_COLLABORATOR | DISABLED`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentCollaborator": {
"agentDescriptor": {
"aliasArn": "string"
},
"agentId": "string",
"agentVersion": "string",
"clientToken": "string",
"collaborationInstruction": "string",
"collaboratorId": "string",
"collaboratorName": "string",
"createdAt": "string",
"lastUpdatedAt": "string",
"relayConversationHistory": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentCollaborator](#API_agent_AssociateAgentCollaborator_ResponseSyntax) **
Details about the collaborator.
Type: [AgentCollaborator](API_agent_AgentCollaborator.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AssociateAgentCollaborator)
# AssociateAgentKnowledgeBase
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.
## Request Syntax
```
PUT /agents/agentId/agentversions/agentVersion/knowledgebases/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"knowledgeBaseId": "string",
"knowledgeBaseState": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_AssociateAgentKnowledgeBase_RequestSyntax) **
The unique identifier of the agent with which you want to associate the knowledge base.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_AssociateAgentKnowledgeBase_RequestSyntax) **
The version of the agent with which you want to associate the knowledge base.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_agent_AssociateAgentKnowledgeBase_RequestSyntax) **
A description of what the agent should use the knowledge base for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
** [knowledgeBaseId](#API_agent_AssociateAgentKnowledgeBase_RequestSyntax) **
The unique identifier of the knowledge base to associate with the agent.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseState](#API_agent_AssociateAgentKnowledgeBase_RequestSyntax) **
Specifies whether to use the knowledge base or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentKnowledgeBase": {
"agentId": "string",
"agentVersion": "string",
"createdAt": "string",
"description": "string",
"knowledgeBaseId": "string",
"knowledgeBaseState": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentKnowledgeBase](#API_agent_AssociateAgentKnowledgeBase_ResponseSyntax) **
Contains details about the knowledge base that has been associated with the agent.
Type: [AgentKnowledgeBase](API_agent_AgentKnowledgeBase.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase)
# CreateAgent
Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
+ Specify the following fields for security purposes.
+ `agentResourceRoleArn` – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
+ (Optional) `customerEncryptionKeyArn` – The Amazon Resource Name (ARN) of a AWS KMS key to encrypt the creation of the agent.
+ (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.
+ To enable your agent to retain conversational context across multiple sessions, include a `memoryConfiguration` object. For more information, see [Configure memory](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-configure-memory.html).
+ To override the default prompt behavior for agent orchestration and to use advanced prompts, include a `promptOverrideConfiguration` object. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
+ If your agent fails to be created, the response returns a list of `failureReasons` alongside a list of `recommendedActions` for you to troubleshoot.
+ The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
## Request Syntax
```
PUT /agents/ HTTP/1.1
Content-type: application/json
{
"agentCollaboration": "string",
"agentName": "string",
"agentResourceRoleArn": "string",
"clientToken": "string",
"customerEncryptionKeyArn": "string",
"customOrchestration": {
"executor": { ... }
},
"description": "string",
"foundationModel": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"idleSessionTTLInSeconds": number,
"instruction": "string",
"memoryConfiguration": {
"enabledMemoryTypes": [ "string" ],
"sessionSummaryConfiguration": {
"maxRecentSessions": number
},
"storageDays": number
},
"orchestrationType": "string",
"promptOverrideConfiguration": {
"overrideLambda": "string",
"promptConfigurations": [
{
"additionalModelRequestFields": JSON value,
"basePromptTemplate": "string",
"foundationModel": "string",
"inferenceConfiguration": {
"maximumLength": number,
"stopSequences": [ "string" ],
"temperature": number,
"topK": number,
"topP": number
},
"parserMode": "string",
"promptCreationMode": "string",
"promptState": "string",
"promptType": "string"
}
]
},
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [agentCollaboration](#API_agent_CreateAgent_RequestSyntax) **
The agent's collaboration role.
Type: String
Valid Values: `SUPERVISOR | SUPERVISOR_ROUTER | DISABLED`
Required: No
** [agentName](#API_agent_CreateAgent_RequestSyntax) **
A name for the agent that you create.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [agentResourceRoleArn](#API_agent_CreateAgent_RequestSyntax) **
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: No
** [clientToken](#API_agent_CreateAgent_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [customerEncryptionKeyArn](#API_agent_CreateAgent_RequestSyntax) **
The Amazon Resource Name (ARN) of the AWS KMS key with which to encrypt the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
Required: No
** [customOrchestration](#API_agent_CreateAgent_RequestSyntax) **
Contains details of the custom orchestration configured for the agent.
Type: [CustomOrchestration](API_agent_CustomOrchestration.md) object
Required: No
** [description](#API_agent_CreateAgent_RequestSyntax) **
A description of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [foundationModel](#API_agent_CreateAgent_RequestSyntax) **
The identifier for the model that you want to be used for orchestration by the agent you create.
The `modelId` to provide depends on the type of model or throughput that you use:
+ If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see [Amazon Bedrock base model IDs (on-demand throughput)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide.
+ If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see [Supported Regions and models for cross-region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide.
+ If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see [Run inference using a Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide.
+ If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see [Use a custom model in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide.
+ If you use an [imported model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html), specify the ARN of the imported model. You can get the model ARN from a successful call to [CreateModelImportJob](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html) or from the Imported models page in the Amazon Bedrock console.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?`
Required: No
** [guardrailConfiguration](#API_agent_CreateAgent_RequestSyntax) **
The unique Guardrail configuration assigned to the agent when it is created.
Type: [GuardrailConfiguration](API_agent_GuardrailConfiguration.md) object
Required: No
** [idleSessionTTLInSeconds](#API_agent_CreateAgent_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 5400.
Required: No
** [instruction](#API_agent_CreateAgent_RequestSyntax) **
Instructions that tell the agent what it should do and how it should interact with users.
Type: String
Length Constraints: Minimum length of 40. Maximum length of 4000.
Required: No
** [memoryConfiguration](#API_agent_CreateAgent_RequestSyntax) **
Contains the details of the memory configured for the agent.
Type: [MemoryConfiguration](API_agent_MemoryConfiguration.md) object
Required: No
** [orchestrationType](#API_agent_CreateAgent_RequestSyntax) **
Specifies the type of orchestration strategy for the agent. This is set to `DEFAULT` orchestration type, by default.
Type: String
Valid Values: `DEFAULT | CUSTOM_ORCHESTRATION`
Required: No
** [promptOverrideConfiguration](#API_agent_CreateAgent_RequestSyntax) **
Contains configurations to override prompts in different parts of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
Type: [PromptOverrideConfiguration](API_agent_PromptOverrideConfiguration.md) object
Required: No
** [tags](#API_agent_CreateAgent_RequestSyntax) **
Any tags that you want to attach to the agent.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"agent": {
"agentArn": "string",
"agentCollaboration": "string",
"agentId": "string",
"agentName": "string",
"agentResourceRoleArn": "string",
"agentStatus": "string",
"agentVersion": "string",
"clientToken": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"customOrchestration": {
"executor": { ... }
},
"description": "string",
"failureReasons": [ "string" ],
"foundationModel": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"idleSessionTTLInSeconds": number,
"instruction": "string",
"memoryConfiguration": {
"enabledMemoryTypes": [ "string" ],
"sessionSummaryConfiguration": {
"maxRecentSessions": number
},
"storageDays": number
},
"orchestrationType": "string",
"preparedAt": "string",
"promptOverrideConfiguration": {
"overrideLambda": "string",
"promptConfigurations": [
{
"additionalModelRequestFields": JSON value,
"basePromptTemplate": "string",
"foundationModel": "string",
"inferenceConfiguration": {
"maximumLength": number,
"stopSequences": [ "string" ],
"temperature": number,
"topK": number,
"topP": number
},
"parserMode": "string",
"promptCreationMode": "string",
"promptState": "string",
"promptType": "string"
}
]
},
"recommendedActions": [ "string" ],
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [agent](#API_agent_CreateAgent_ResponseSyntax) **
Contains details about the agent created.
Type: [Agent](API_agent_Agent.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of CreateAgent.
```
PUT /agents/ HTTP/1.1
Content-type: application/json
{
"agentName": "o1nvve1",
"agentResourceRoleArn": "arn:aws:iam::123456789012:role/AmazonBedrockExecutionRoleForAgents_user",
"instruction": "You are an IT agent who solves customer's problems",
"description": "Description is here",
"idleSessionTTLInSeconds": 900,
"foundationModel": "anthropic.claude-v2"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreateAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreateAgent)
# CreateAgentActionGroup
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`.
To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the `parentActionGroupSignature` field set to `AMAZON.CodeInterpreter`.
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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) reprompting the user for more information.
## Request Syntax
```
PUT /agents/agentId/agentversions/agentVersion/actiongroups/ HTTP/1.1
Content-type: application/json
{
"actionGroupExecutor": { ... },
"actionGroupName": "string",
"actionGroupState": "string",
"apiSchema": { ... },
"clientToken": "string",
"description": "string",
"functionSchema": { ... },
"parentActionGroupSignature": "string",
"parentActionGroupSignatureParams": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_CreateAgentActionGroup_RequestSyntax) **
The unique identifier of the agent for which to create the action group.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_CreateAgentActionGroup_RequestSyntax) **
The version of the agent for which to create the action group.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [actionGroupExecutor](#API_agent_CreateAgentActionGroup_RequestSyntax) **
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.
Type: [ActionGroupExecutor](API_agent_ActionGroupExecutor.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [actionGroupName](#API_agent_CreateAgentActionGroup_RequestSyntax) **
The name to give the action group.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [actionGroupState](#API_agent_CreateAgentActionGroup_RequestSyntax) **
Specifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
** [apiSchema](#API_agent_CreateAgentActionGroup_RequestSyntax) **
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](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html).
Type: [APISchema](API_agent_APISchema.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [clientToken](#API_agent_CreateAgentActionGroup_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [description](#API_agent_CreateAgentActionGroup_RequestSyntax) **
A description of the action group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [functionSchema](#API_agent_CreateAgentActionGroup_RequestSyntax) **
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
Type: [FunctionSchema](API_agent_FunctionSchema.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [parentActionGroupSignature](#API_agent_CreateAgentActionGroup_RequestSyntax) **
Specify a built-in or computer use action for this action group. If you specify a value, you must leave the `description`, `apiSchema`, and `actionGroupExecutor` fields empty for this action group.
+ To allow your agent to request the user for additional information when trying to complete a task, set this field to `AMAZON.UserInput`.
+ To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to `AMAZON.CodeInterpreter`.
+ To allow your agent to use an Anthropic computer use tool, specify one of the following values.
**Important**
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see [Configure an Amazon Bedrock Agent to complete tasks with computer use tools](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html).
+ `ANTHROPIC.Computer` - Gives the agent permission to use the mouse and keyboard and take screenshots.
+ `ANTHROPIC.TextEditor` - Gives the agent permission to view, create and edit files.
+ `ANTHROPIC.Bash` - Gives the agent permission to run commands in a bash shell.
Type: String
Valid Values: `AMAZON.UserInput | AMAZON.CodeInterpreter | ANTHROPIC.Computer | ANTHROPIC.Bash | ANTHROPIC.TextEditor`
Required: No
** [parentActionGroupSignatureParams](#API_agent_CreateAgentActionGroup_RequestSyntax) **
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see [Configure an Amazon Bedrock Agent to complete tasks with computer use tools](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html).
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 100.
Value Length Constraints: Minimum length of 0. Maximum length of 100.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentActionGroup": {
"actionGroupExecutor": { ... },
"actionGroupId": "string",
"actionGroupName": "string",
"actionGroupState": "string",
"agentId": "string",
"agentVersion": "string",
"apiSchema": { ... },
"clientToken": "string",
"createdAt": "string",
"description": "string",
"functionSchema": { ... },
"parentActionGroupSignatureParams": {
"string" : "string"
},
"parentActionSignature": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentActionGroup](#API_agent_CreateAgentActionGroup_ResponseSyntax) **
Contains details about the action group that was created.
Type: [AgentActionGroup](API_agent_AgentActionGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Create an action group using an OpenAPI schema and a Lambda function
The following example creates an action group using an OpenAPI schema uploaded to an Amazon S3 bucket and sends the information elicited from the user to a Lambda function.
```
PUT /agents/AGENT12345/agentversions/DRAFT/actiongroups/ HTTP/1.1
Content-type: application/json
{
"actionGroupName": "Test Action",
"actionGroupState": "ENABLED",
"apiSchema": {
"s3": {
"s3BucketName": "apischema-s3",
"s3ObjectKey": "it_agent_openapi.json"
}
},
"description": "Testing latest IT Management action",
"actionGroupExecutor": {
"lambda": "arn:aws:lambda:us-west-2:123456789012:function:ItAgentLambda"
}
}
```
### Create an action group using an OpenAPI schema and return control
The following example creates an action group using an OpenAPI schema uploaded to an Amazon S3 bucket and returns control by sending the information in the `InvokeAgent` response.
```
{
"actionGroupName": "WeatherAPIs",
"description": "Actions to get current weather and historical trends for a location",
"actionGroupState": "ENABLED",
"apiSchema": {
"s3": {
"s3BucketName": "openapi-spec-iad",
"s3ObjectKey": "get_weather_openapi.yaml"
}
},
"actionGroupExecutor": {
"customControl": "RETURN_CONTROL"
}
}
```
### Create an action group using function details and return control
The following example creates an action group using function details and returns control by sending the information in the `InvokeAgent` response
```
PUT /agents/AGENT12345/agentversions/DRAFT/actiongroups/ HTTP/1.1
Content-type: application/json
{
"actionGroupName": "OrderManagementAction",
"description": "Action to get the order history, product details, product availability and to update the order",
"actionGroupState": "ENABLED",
"actionGroupExecutor": {
"customControl": "RETURN_CONTROL"
},
"functionSchema": {
"functions": [{
"name": "GetOrderDetails",
"description": "Retrieves the order history for a given OrderId and returns productId, color, productName, size, productType, quantity, and status."
"parameters": {
"orderId": {
"type": "string",
"required": true
}
}
}]
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreateAgentActionGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreateAgentActionGroup)
# CreateAgentAlias
Creates an alias of an agent that can be used to deploy the agent.
## Request Syntax
```
PUT /agents/agentId/agentaliases/ HTTP/1.1
Content-type: application/json
{
"agentAliasName": "string",
"clientToken": "string",
"description": "string",
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
],
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_CreateAgentAlias_RequestSyntax) **
The unique identifier of the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [agentAliasName](#API_agent_CreateAgentAlias_RequestSyntax) **
The name of the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [clientToken](#API_agent_CreateAgentAlias_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [description](#API_agent_CreateAgentAlias_RequestSyntax) **
A description of the alias of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [routingConfiguration](#API_agent_CreateAgentAlias_RequestSyntax) **
Contains details about the routing configuration of the alias.
Type: Array of [AgentAliasRoutingConfigurationListItem](API_agent_AgentAliasRoutingConfigurationListItem.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
** [tags](#API_agent_CreateAgentAlias_RequestSyntax) **
Any tags that you want to attach to the alias of the agent.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"agentAlias": {
"agentAliasArn": "string",
"agentAliasHistoryEvents": [
{
"endDate": "string",
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
],
"startDate": "string"
}
],
"agentAliasId": "string",
"agentAliasName": "string",
"agentAliasStatus": "string",
"agentId": "string",
"aliasInvocationState": "string",
"clientToken": "string",
"createdAt": "string",
"description": "string",
"failureReasons": [ "string" ],
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
],
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [agentAlias](#API_agent_CreateAgentAlias_ResponseSyntax) **
Contains details about the alias that was created.
Type: [AgentAlias](API_agent_AgentAlias.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of CreateAgentAlias.
```
PUT /agents/ABCDEFGHIJ/agentaliases/ HTTP/1.1
Content-type: application/json
{
"agentAliasName": "TestName",
"description": "Alias is test"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreateAgentAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreateAgentAlias)
# CreateDataSource
Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the `dataSourceConfiguration` field.
**Important**
You can't change the `chunkingConfiguration` after you create the data source connector.
## Request Syntax
```
PUT /knowledgebases/knowledgeBaseId/datasources/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"dataDeletionPolicy": "string",
"dataSourceConfiguration": {
"confluenceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostType": "string",
"hostUrl": "string"
}
},
"s3Configuration": {
"bucketArn": "string",
"bucketOwnerAccountId": "string",
"inclusionPrefixes": [ "string" ]
},
"salesforceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostUrl": "string"
}
},
"sharePointConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"domain": "string",
"hostType": "string",
"siteUrls": [ "string" ],
"tenantId": "string"
}
},
"type": "string",
"webConfiguration": {
"crawlerConfiguration": {
"crawlerLimits": {
"maxPages": number,
"rateLimit": number
},
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"scope": "string",
"userAgent": "string",
"userAgentHeader": "string"
},
"sourceConfiguration": {
"urlConfiguration": {
"seedUrls": [
{
"url": "string"
}
]
}
}
}
},
"description": "string",
"name": "string",
"serverSideEncryptionConfiguration": {
"kmsKeyArn": "string"
},
"vectorIngestionConfiguration": {
"chunkingConfiguration": {
"chunkingStrategy": "string",
"fixedSizeChunkingConfiguration": {
"maxTokens": number,
"overlapPercentage": number
},
"hierarchicalChunkingConfiguration": {
"levelConfigurations": [
{
"maxTokens": number
}
],
"overlapTokens": number
},
"semanticChunkingConfiguration": {
"breakpointPercentileThreshold": number,
"bufferSize": number,
"maxTokens": number
}
},
"contextEnrichmentConfiguration": {
"bedrockFoundationModelConfiguration": {
"enrichmentStrategyConfiguration": {
"method": "string"
},
"modelArn": "string"
},
"type": "string"
},
"customTransformationConfiguration": {
"intermediateStorage": {
"s3Location": {
"uri": "string"
}
},
"transformations": [
{
"stepToApply": "string",
"transformationFunction": {
"transformationLambdaConfiguration": {
"lambdaArn": "string"
}
}
}
]
},
"parsingConfiguration": {
"bedrockDataAutomationConfiguration": {
"parsingModality": "string"
},
"bedrockFoundationModelConfiguration": {
"modelArn": "string",
"parsingModality": "string",
"parsingPrompt": {
"parsingPromptText": "string"
}
},
"parsingStrategy": "string"
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [knowledgeBaseId](#API_agent_CreateDataSource_RequestSyntax) **
The unique identifier of the knowledge base to which to add the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_CreateDataSource_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [dataDeletionPolicy](#API_agent_CreateDataSource_RequestSyntax) **
The data deletion policy for the data source.
You can set the data deletion policy to:
+ DELETE: Deletes all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the **vector store itself is not deleted**, only the data. This flag is ignored if an AWS account is deleted.
+ RETAIN: Retains all data from your data source that’s converted into vector embeddings upon deletion of a knowledge base or data source resource. Note that the **vector store itself is not deleted** if you delete a knowledge base or data source resource.
Type: String
Valid Values: `RETAIN | DELETE`
Required: No
** [dataSourceConfiguration](#API_agent_CreateDataSource_RequestSyntax) **
The connection configuration for the data source.
Type: [DataSourceConfiguration](API_agent_DataSourceConfiguration.md) object
Required: Yes
** [description](#API_agent_CreateDataSource_RequestSyntax) **
A description of the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [name](#API_agent_CreateDataSource_RequestSyntax) **
The name of the data source.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [serverSideEncryptionConfiguration](#API_agent_CreateDataSource_RequestSyntax) **
Contains details about the server-side encryption for the data source.
Type: [ServerSideEncryptionConfiguration](API_agent_ServerSideEncryptionConfiguration.md) object
Required: No
** [vectorIngestionConfiguration](#API_agent_CreateDataSource_RequestSyntax) **
Contains details about how to ingest the documents in the data source.
Type: [VectorIngestionConfiguration](API_agent_VectorIngestionConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"dataSource": {
"createdAt": "string",
"dataDeletionPolicy": "string",
"dataSourceConfiguration": {
"confluenceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostType": "string",
"hostUrl": "string"
}
},
"s3Configuration": {
"bucketArn": "string",
"bucketOwnerAccountId": "string",
"inclusionPrefixes": [ "string" ]
},
"salesforceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostUrl": "string"
}
},
"sharePointConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"domain": "string",
"hostType": "string",
"siteUrls": [ "string" ],
"tenantId": "string"
}
},
"type": "string",
"webConfiguration": {
"crawlerConfiguration": {
"crawlerLimits": {
"maxPages": number,
"rateLimit": number
},
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"scope": "string",
"userAgent": "string",
"userAgentHeader": "string"
},
"sourceConfiguration": {
"urlConfiguration": {
"seedUrls": [
{
"url": "string"
}
]
}
}
}
},
"dataSourceId": "string",
"description": "string",
"failureReasons": [ "string" ],
"knowledgeBaseId": "string",
"name": "string",
"serverSideEncryptionConfiguration": {
"kmsKeyArn": "string"
},
"status": "string",
"updatedAt": "string",
"vectorIngestionConfiguration": {
"chunkingConfiguration": {
"chunkingStrategy": "string",
"fixedSizeChunkingConfiguration": {
"maxTokens": number,
"overlapPercentage": number
},
"hierarchicalChunkingConfiguration": {
"levelConfigurations": [
{
"maxTokens": number
}
],
"overlapTokens": number
},
"semanticChunkingConfiguration": {
"breakpointPercentileThreshold": number,
"bufferSize": number,
"maxTokens": number
}
},
"contextEnrichmentConfiguration": {
"bedrockFoundationModelConfiguration": {
"enrichmentStrategyConfiguration": {
"method": "string"
},
"modelArn": "string"
},
"type": "string"
},
"customTransformationConfiguration": {
"intermediateStorage": {
"s3Location": {
"uri": "string"
}
},
"transformations": [
{
"stepToApply": "string",
"transformationFunction": {
"transformationLambdaConfiguration": {
"lambdaArn": "string"
}
}
}
]
},
"parsingConfiguration": {
"bedrockDataAutomationConfiguration": {
"parsingModality": "string"
},
"bedrockFoundationModelConfiguration": {
"modelArn": "string",
"parsingModality": "string",
"parsingPrompt": {
"parsingPromptText": "string"
}
},
"parsingStrategy": "string"
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [dataSource](#API_agent_CreateDataSource_ResponseSyntax) **
Contains details about the data source.
Type: [DataSource](API_agent_DataSource.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreateDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreateDataSource)
# CreateFlow
Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see [How it works](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html) and [Create a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /flows/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"customerEncryptionKeyArn": "string",
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"category": "string",
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
},
"description": "string",
"executionRoleArn": "string",
"name": "string",
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_CreateFlow_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [customerEncryptionKeyArn](#API_agent_CreateFlow_RequestSyntax) **
The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
Required: No
** [definition](#API_agent_CreateFlow_RequestSyntax) **
A definition of the nodes and connections between nodes in the flow.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
Required: No
** [description](#API_agent_CreateFlow_RequestSyntax) **
A description for the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [executionRoleArn](#API_agent_CreateFlow_RequestSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+`
Required: Yes
** [name](#API_agent_CreateFlow_RequestSyntax) **
A name for the flow.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [tags](#API_agent_CreateFlow_RequestSyntax) **
Any tags that you want to attach to the flow. For more information, see [Tagging resources in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"category": "string",
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
},
"description": "string",
"executionRoleArn": "string",
"id": "string",
"name": "string",
"status": "string",
"updatedAt": "string",
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_CreateFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}`
** [createdAt](#API_agent_CreateFlow_ResponseSyntax) **
The time at which the flow was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_CreateFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key that you encrypted the flow with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [definition](#API_agent_CreateFlow_ResponseSyntax) **
A definition of the nodes and connections between nodes in the flow.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
** [description](#API_agent_CreateFlow_ResponseSyntax) **
The description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [executionRoleArn](#API_agent_CreateFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+`
** [id](#API_agent_CreateFlow_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_CreateFlow_ResponseSyntax) **
The name of the flow.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [status](#API_agent_CreateFlow_ResponseSyntax) **
The status of the flow. When you submit this request, the status will be `NotPrepared`. If creation fails, the status becomes `Failed`.
Type: String
Valid Values: `Failed | Prepared | Preparing | NotPrepared`
** [updatedAt](#API_agent_CreateFlow_ResponseSyntax) **
The time at which the flow was last updated.
Type: Timestamp
** [version](#API_agent_CreateFlow_ResponseSyntax) **
The version of the flow. When you create a flow, the version created is the `DRAFT` version.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreateFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreateFlow)
# CreateFlowAlias
Creates an alias of a flow for deployment. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /flows/flowIdentifier/aliases HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"concurrencyConfiguration": {
"maxConcurrency": number,
"type": "string"
},
"description": "string",
"name": "string",
"routingConfiguration": [
{
"flowVersion": "string"
}
],
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_CreateFlowAlias_RequestSyntax) **
The unique identifier of the flow for which to create an alias.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_CreateFlowAlias_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [concurrencyConfiguration](#API_agent_CreateFlowAlias_RequestSyntax) **
The configuration that specifies how nodes in the flow are executed in parallel.
Type: [FlowAliasConcurrencyConfiguration](API_agent_FlowAliasConcurrencyConfiguration.md) object
Required: No
** [description](#API_agent_CreateFlowAlias_RequestSyntax) **
A description for the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [name](#API_agent_CreateFlowAlias_RequestSyntax) **
A name for the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [routingConfiguration](#API_agent_CreateFlowAlias_RequestSyntax) **
Contains information about the version to which to map the alias.
Type: Array of [FlowAliasRoutingConfigurationListItem](API_agent_FlowAliasRoutingConfigurationListItem.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** [tags](#API_agent_CreateFlowAlias_RequestSyntax) **
Any tags that you want to attach to the alias of the flow. For more information, see [Tagging resources in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"arn": "string",
"concurrencyConfiguration": {
"maxConcurrency": number,
"type": "string"
},
"createdAt": "string",
"description": "string",
"flowId": "string",
"id": "string",
"name": "string",
"routingConfiguration": [
{
"flowVersion": "string"
}
],
"updatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_CreateFlowAlias_ResponseSyntax) **
The Amazon Resource Name (ARN) of the alias.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})`
** [concurrencyConfiguration](#API_agent_CreateFlowAlias_ResponseSyntax) **
The configuration that specifies how nodes in the flow are executed in parallel.
Type: [FlowAliasConcurrencyConfiguration](API_agent_FlowAliasConcurrencyConfiguration.md) object
** [createdAt](#API_agent_CreateFlowAlias_ResponseSyntax) **
The time at which the alias was created.
Type: Timestamp
** [description](#API_agent_CreateFlowAlias_ResponseSyntax) **
The description of the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [flowId](#API_agent_CreateFlowAlias_ResponseSyntax) **
The unique identifier of the flow that the alias belongs to.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [id](#API_agent_CreateFlowAlias_ResponseSyntax) **
The unique identifier of the alias.
Type: String
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})`
** [name](#API_agent_CreateFlowAlias_ResponseSyntax) **
The name of the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [routingConfiguration](#API_agent_CreateFlowAlias_ResponseSyntax) **
Contains information about the version that the alias is mapped to.
Type: Array of [FlowAliasRoutingConfigurationListItem](API_agent_FlowAliasRoutingConfigurationListItem.md) objects
Array Members: Fixed number of 1 item.
** [updatedAt](#API_agent_CreateFlowAlias_ResponseSyntax) **
The time at which the alias of the flow was last updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreateFlowAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreateFlowAlias)
# CreateFlowVersion
Creates a version of the flow that you can deploy. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /flows/flowIdentifier/versions HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"description": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_CreateFlowVersion_RequestSyntax) **
The unique identifier of the flow that you want to create a version of.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_CreateFlowVersion_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [description](#API_agent_CreateFlowVersion_RequestSyntax) **
A description of the version of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"category": "string",
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
},
"description": "string",
"executionRoleArn": "string",
"id": "string",
"name": "string",
"status": "string",
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_CreateFlowVersion_ResponseSyntax) **
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}`
** [createdAt](#API_agent_CreateFlowVersion_ResponseSyntax) **
The time at which the flow was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_CreateFlowVersion_ResponseSyntax) **
The KMS key that the flow is encrypted with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [definition](#API_agent_CreateFlowVersion_ResponseSyntax) **
A definition of the nodes and connections in the flow.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
** [description](#API_agent_CreateFlowVersion_ResponseSyntax) **
The description of the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [executionRoleArn](#API_agent_CreateFlowVersion_ResponseSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+`
** [id](#API_agent_CreateFlowVersion_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_CreateFlowVersion_ResponseSyntax) **
The name of the version.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [status](#API_agent_CreateFlowVersion_ResponseSyntax) **
The status of the flow.
Type: String
Valid Values: `Failed | Prepared | Preparing | NotPrepared`
** [version](#API_agent_CreateFlowVersion_ResponseSyntax) **
The version of the flow that was created. Versions are numbered incrementally, starting from 1.
Type: String
Pattern: `[0-9]{1,5}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreateFlowVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreateFlowVersion)
# CreateKnowledgeBase
Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. 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 a knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowlege-base-prereq.html).
**Note**
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](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create).
+ Provide the `name` and an optional `description`.
+ Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the `roleArn` field.
+ Provide the embedding model to use in the `embeddingModelArn` field in the `knowledgeBaseConfiguration` object.
+ Provide the configuration for your vector store in the `storageConfiguration` object.
+ For an Amazon OpenSearch Service database, use the `opensearchServerlessConfiguration` object. For more information, see [Create a vector store in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html).
+ For an Amazon Aurora database, use the `RdsConfiguration` object. For more information, see [Create a vector store in Amazon Aurora](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html).
+ For a Pinecone database, use the `pineconeConfiguration` object. For more information, see [Create a vector store in Pinecone](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html).
+ For a Redis Enterprise Cloud database, use the `redisEnterpriseCloudConfiguration` object. For more information, see [Create a vector store in Redis Enterprise Cloud](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html).
## Request Syntax
```
PUT /knowledgebases/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"description": "string",
"knowledgeBaseConfiguration": {
"kendraKnowledgeBaseConfiguration": {
"kendraIndexArn": "string"
},
"sqlKnowledgeBaseConfiguration": {
"redshiftConfiguration": {
"queryEngineConfiguration": {
"provisionedConfiguration": {
"authConfiguration": {
"databaseUser": "string",
"type": "string",
"usernamePasswordSecretArn": "string"
},
"clusterIdentifier": "string"
},
"serverlessConfiguration": {
"authConfiguration": {
"type": "string",
"usernamePasswordSecretArn": "string"
},
"workgroupArn": "string"
},
"type": "string"
},
"queryGenerationConfiguration": {
"executionTimeoutSeconds": number,
"generationContext": {
"curatedQueries": [
{
"naturalLanguage": "string",
"sql": "string"
}
],
"tables": [
{
"columns": [
{
"description": "string",
"inclusion": "string",
"name": "string"
}
],
"description": "string",
"inclusion": "string",
"name": "string"
}
]
}
},
"storageConfigurations": [
{
"awsDataCatalogConfiguration": {
"tableNames": [ "string" ]
},
"redshiftConfiguration": {
"databaseName": "string"
},
"type": "string"
}
]
},
"type": "string"
},
"type": "string",
"vectorKnowledgeBaseConfiguration": {
"embeddingModelArn": "string",
"embeddingModelConfiguration": {
"bedrockEmbeddingModelConfiguration": {
"audio": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
],
"dimensions": number,
"embeddingDataType": "string",
"video": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
]
}
},
"supplementalDataStorageConfiguration": {
"storageLocations": [
{
"s3Location": {
"uri": "string"
},
"type": "string"
}
]
}
}
},
"name": "string",
"roleArn": "string",
"storageConfiguration": {
"mongoDbAtlasConfiguration": {
"collectionName": "string",
"credentialsSecretArn": "string",
"databaseName": "string",
"endpoint": "string",
"endpointServiceName": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"textIndexName": "string",
"vectorIndexName": "string"
},
"neptuneAnalyticsConfiguration": {
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"graphArn": "string"
},
"opensearchManagedClusterConfiguration": {
"domainArn": "string",
"domainEndpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"opensearchServerlessConfiguration": {
"collectionArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"pineconeConfiguration": {
"connectionString": "string",
"credentialsSecretArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"namespace": "string"
},
"rdsConfiguration": {
"credentialsSecretArn": "string",
"databaseName": "string",
"fieldMapping": {
"customMetadataField": "string",
"metadataField": "string",
"primaryKeyField": "string",
"textField": "string",
"vectorField": "string"
},
"resourceArn": "string",
"tableName": "string"
},
"redisEnterpriseCloudConfiguration": {
"credentialsSecretArn": "string",
"endpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"s3VectorsConfiguration": {
"indexArn": "string",
"indexName": "string",
"vectorBucketArn": "string"
},
"type": "string"
},
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_CreateKnowledgeBase_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [description](#API_agent_CreateKnowledgeBase_RequestSyntax) **
A description of the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [knowledgeBaseConfiguration](#API_agent_CreateKnowledgeBase_RequestSyntax) **
Contains details about the embeddings model used for the knowledge base.
Type: [KnowledgeBaseConfiguration](API_agent_KnowledgeBaseConfiguration.md) object
Required: Yes
** [name](#API_agent_CreateKnowledgeBase_RequestSyntax) **
A name for the knowledge base.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [roleArn](#API_agent_CreateKnowledgeBase_RequestSyntax) **
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** [storageConfiguration](#API_agent_CreateKnowledgeBase_RequestSyntax) **
Contains details about the configuration of the vector database used for the knowledge base.
Type: [StorageConfiguration](API_agent_StorageConfiguration.md) object
Required: No
** [tags](#API_agent_CreateKnowledgeBase_RequestSyntax) **
Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"knowledgeBase": {
"createdAt": "string",
"description": "string",
"failureReasons": [ "string" ],
"knowledgeBaseArn": "string",
"knowledgeBaseConfiguration": {
"kendraKnowledgeBaseConfiguration": {
"kendraIndexArn": "string"
},
"sqlKnowledgeBaseConfiguration": {
"redshiftConfiguration": {
"queryEngineConfiguration": {
"provisionedConfiguration": {
"authConfiguration": {
"databaseUser": "string",
"type": "string",
"usernamePasswordSecretArn": "string"
},
"clusterIdentifier": "string"
},
"serverlessConfiguration": {
"authConfiguration": {
"type": "string",
"usernamePasswordSecretArn": "string"
},
"workgroupArn": "string"
},
"type": "string"
},
"queryGenerationConfiguration": {
"executionTimeoutSeconds": number,
"generationContext": {
"curatedQueries": [
{
"naturalLanguage": "string",
"sql": "string"
}
],
"tables": [
{
"columns": [
{
"description": "string",
"inclusion": "string",
"name": "string"
}
],
"description": "string",
"inclusion": "string",
"name": "string"
}
]
}
},
"storageConfigurations": [
{
"awsDataCatalogConfiguration": {
"tableNames": [ "string" ]
},
"redshiftConfiguration": {
"databaseName": "string"
},
"type": "string"
}
]
},
"type": "string"
},
"type": "string",
"vectorKnowledgeBaseConfiguration": {
"embeddingModelArn": "string",
"embeddingModelConfiguration": {
"bedrockEmbeddingModelConfiguration": {
"audio": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
],
"dimensions": number,
"embeddingDataType": "string",
"video": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
]
}
},
"supplementalDataStorageConfiguration": {
"storageLocations": [
{
"s3Location": {
"uri": "string"
},
"type": "string"
}
]
}
}
},
"knowledgeBaseId": "string",
"name": "string",
"roleArn": "string",
"status": "string",
"storageConfiguration": {
"mongoDbAtlasConfiguration": {
"collectionName": "string",
"credentialsSecretArn": "string",
"databaseName": "string",
"endpoint": "string",
"endpointServiceName": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"textIndexName": "string",
"vectorIndexName": "string"
},
"neptuneAnalyticsConfiguration": {
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"graphArn": "string"
},
"opensearchManagedClusterConfiguration": {
"domainArn": "string",
"domainEndpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"opensearchServerlessConfiguration": {
"collectionArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"pineconeConfiguration": {
"connectionString": "string",
"credentialsSecretArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"namespace": "string"
},
"rdsConfiguration": {
"credentialsSecretArn": "string",
"databaseName": "string",
"fieldMapping": {
"customMetadataField": "string",
"metadataField": "string",
"primaryKeyField": "string",
"textField": "string",
"vectorField": "string"
},
"resourceArn": "string",
"tableName": "string"
},
"redisEnterpriseCloudConfiguration": {
"credentialsSecretArn": "string",
"endpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"s3VectorsConfiguration": {
"indexArn": "string",
"indexName": "string",
"vectorBucketArn": "string"
},
"type": "string"
},
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [knowledgeBase](#API_agent_CreateKnowledgeBase_ResponseSyntax) **
Contains details about the knowledge base.
Type: [KnowledgeBase](API_agent_KnowledgeBase.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreateKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreateKnowledgeBase)
# CreatePrompt
Creates a prompt in your prompt library that you can add to a flow. For more information, see [Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and [Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /prompts/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"customerEncryptionKeyArn": "string",
"defaultVariant": "string",
"description": "string",
"name": "string",
"tags": {
"string" : "string"
},
"variants": [
{
"additionalModelRequestFields": JSON value,
"genAiResource": { ... },
"inferenceConfiguration": { ... },
"metadata": [
{
"key": "string",
"value": "string"
}
],
"modelId": "string",
"name": "string",
"templateConfiguration": { ... },
"templateType": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_CreatePrompt_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [customerEncryptionKeyArn](#API_agent_CreatePrompt_RequestSyntax) **
The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
Required: No
** [defaultVariant](#API_agent_CreatePrompt_RequestSyntax) **
The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** [description](#API_agent_CreatePrompt_RequestSyntax) **
A description for the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [name](#API_agent_CreatePrompt_RequestSyntax) **
A name for the prompt.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [tags](#API_agent_CreatePrompt_RequestSyntax) **
Any tags that you want to attach to the prompt. For more information, see [Tagging resources in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: No
** [variants](#API_agent_CreatePrompt_RequestSyntax) **
A list of objects, each containing details about a variant of the prompt.
Type: Array of [PromptVariant](API_agent_PromptVariant.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"defaultVariant": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string",
"variants": [
{
"additionalModelRequestFields": JSON value,
"genAiResource": { ... },
"inferenceConfiguration": { ... },
"metadata": [
{
"key": "string",
"value": "string"
}
],
"modelId": "string",
"name": "string",
"templateConfiguration": { ... },
"templateType": "string"
}
],
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_CreatePrompt_ResponseSyntax) **
The Amazon Resource Name (ARN) of the prompt.
Type: String
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)`
** [createdAt](#API_agent_CreatePrompt_ResponseSyntax) **
The time at which the prompt was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_CreatePrompt_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [defaultVariant](#API_agent_CreatePrompt_ResponseSyntax) **
The name of the default variant for your prompt.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [description](#API_agent_CreatePrompt_ResponseSyntax) **
The description of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [id](#API_agent_CreatePrompt_ResponseSyntax) **
The unique identifier of the prompt.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_CreatePrompt_ResponseSyntax) **
The name of the prompt.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [updatedAt](#API_agent_CreatePrompt_ResponseSyntax) **
The time at which the prompt was last updated.
Type: Timestamp
** [variants](#API_agent_CreatePrompt_ResponseSyntax) **
A list of objects, each containing details about a variant of the prompt.
Type: Array of [PromptVariant](API_agent_PromptVariant.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
** [version](#API_agent_CreatePrompt_ResponseSyntax) **
The version of the prompt. When you create a prompt, the version created is the `DRAFT` version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreatePrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreatePrompt)
# CreatePromptVersion
Creates a static snapshot of your prompt that can be deployed to production. For more information, see [Deploy prompts using Prompt management by creating versions](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /prompts/promptIdentifier/versions HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"description": "string",
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [promptIdentifier](#API_agent_CreatePromptVersion_RequestSyntax) **
The unique identifier of the prompt that you want to create a version of.
Pattern: `([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_CreatePromptVersion_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [description](#API_agent_CreatePromptVersion_RequestSyntax) **
A description for the version of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [tags](#API_agent_CreatePromptVersion_RequestSyntax) **
Any tags that you want to attach to the version of the prompt. For more information, see [Tagging resources in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"defaultVariant": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string",
"variants": [
{
"additionalModelRequestFields": JSON value,
"genAiResource": { ... },
"inferenceConfiguration": { ... },
"metadata": [
{
"key": "string",
"value": "string"
}
],
"modelId": "string",
"name": "string",
"templateConfiguration": { ... },
"templateType": "string"
}
],
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_CreatePromptVersion_ResponseSyntax) **
The Amazon Resource Name (ARN) of the version of the prompt.
Type: String
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)`
** [createdAt](#API_agent_CreatePromptVersion_ResponseSyntax) **
The time at which the prompt was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_CreatePromptVersion_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [defaultVariant](#API_agent_CreatePromptVersion_ResponseSyntax) **
The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [description](#API_agent_CreatePromptVersion_ResponseSyntax) **
A description for the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [id](#API_agent_CreatePromptVersion_ResponseSyntax) **
The unique identifier of the prompt.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_CreatePromptVersion_ResponseSyntax) **
The name of the prompt.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [updatedAt](#API_agent_CreatePromptVersion_ResponseSyntax) **
The time at which the prompt was last updated.
Type: Timestamp
** [variants](#API_agent_CreatePromptVersion_ResponseSyntax) **
A list of objects, each containing details about a variant of the prompt.
Type: Array of [PromptVariant](API_agent_PromptVariant.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
** [version](#API_agent_CreatePromptVersion_ResponseSyntax) **
The version of the prompt that was created. Versions are numbered incrementally, starting from 1.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/CreatePromptVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CreatePromptVersion)
# DeleteAgent
Deletes an agent.
## Request Syntax
```
DELETE /agents/agentId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_DeleteAgent_RequestSyntax) **
The unique identifier of the agent to delete.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [skipResourceInUseCheck](#API_agent_DeleteAgent_RequestSyntax) **
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.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"agentId": "string",
"agentStatus": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [agentId](#API_agent_DeleteAgent_ResponseSyntax) **
The unique identifier of the agent that was deleted.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [agentStatus](#API_agent_DeleteAgent_ResponseSyntax) **
The status of the agent.
Type: String
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of DeleteAgent.
```
DELETE /agents/ABCDEFGHIJ/ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteAgent)
# DeleteAgentActionGroup
Deletes an action group in an agent.
## Request Syntax
```
DELETE /agents/agentId/agentversions/agentVersion/actiongroups/actionGroupId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [actionGroupId](#API_agent_DeleteAgentActionGroup_RequestSyntax) **
The unique identifier of the action group to delete.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentId](#API_agent_DeleteAgentActionGroup_RequestSyntax) **
The unique identifier of the agent that the action group belongs to.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_DeleteAgentActionGroup_RequestSyntax) **
The version of the agent that the action group belongs to.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
** [skipResourceInUseCheck](#API_agent_DeleteAgentActionGroup_RequestSyntax) **
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.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of DeleteAgentActionGroup.
```
DELETE /agents/ABCDEFGHIJ/agentversions/1/actiongroups/ABCDEFGHIJ/ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteAgentActionGroup)
# DeleteAgentAlias
Deletes an alias of an agent.
## Request Syntax
```
DELETE /agents/agentId/agentaliases/agentAliasId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentAliasId](#API_agent_DeleteAgentAlias_RequestSyntax) **
The unique identifier of the alias to delete.
Length Constraints: Fixed length of 10.
Pattern: `(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [agentId](#API_agent_DeleteAgentAlias_RequestSyntax) **
The unique identifier of the agent that the alias belongs to.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"agentAliasId": "string",
"agentAliasStatus": "string",
"agentId": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [agentAliasId](#API_agent_DeleteAgentAlias_ResponseSyntax) **
The unique identifier of the alias that was deleted.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `(\bTSTALIASID\b|[0-9a-zA-Z]+)`
** [agentAliasStatus](#API_agent_DeleteAgentAlias_ResponseSyntax) **
The status of the alias.
Type: String
Valid Values: `CREATING | PREPARED | FAILED | UPDATING | DELETING | DISSOCIATED`
** [agentId](#API_agent_DeleteAgentAlias_ResponseSyntax) **
The unique identifier of the agent that the alias belongs to.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of DeleteAgentAlias.
```
DELETE /agents/ABCDEFGHIJ/agentaliases/ABCDEFGHIJ/ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteAgentAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteAgentAlias)
# DeleteAgentVersion
Deletes a version of an agent.
## Request Syntax
```
DELETE /agents/agentId/agentversions/agentVersion/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_DeleteAgentVersion_RequestSyntax) **
The unique identifier of the agent that the version belongs to.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_DeleteAgentVersion_RequestSyntax) **
The version of the agent to delete.
Pattern: `[0-9]{1,5}`
Required: Yes
** [skipResourceInUseCheck](#API_agent_DeleteAgentVersion_RequestSyntax) **
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.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"agentId": "string",
"agentStatus": "string",
"agentVersion": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [agentId](#API_agent_DeleteAgentVersion_ResponseSyntax) **
The unique identifier of the agent that the version belongs to.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [agentStatus](#API_agent_DeleteAgentVersion_ResponseSyntax) **
The status of the agent version.
Type: String
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING`
** [agentVersion](#API_agent_DeleteAgentVersion_ResponseSyntax) **
The version that was deleted.
Type: String
Pattern: `[0-9]{1,5}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of DeleteAgentVersion.
```
DELETE /agents/ABCDEFGHIJ/agentversions/1/?skipResourceInUseCheck=true HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteAgentVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteAgentVersion)
# DeleteDataSource
Deletes a data source from a knowledge base.
## Request Syntax
```
DELETE /knowledgebases/knowledgeBaseId/datasources/dataSourceId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_DeleteDataSource_RequestSyntax) **
The unique identifier of the data source to delete.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_DeleteDataSource_RequestSyntax) **
The unique identifier of the knowledge base from which to delete the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"dataSourceId": "string",
"knowledgeBaseId": "string",
"status": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [dataSourceId](#API_agent_DeleteDataSource_ResponseSyntax) **
The unique identifier of the data source that was deleted.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [knowledgeBaseId](#API_agent_DeleteDataSource_ResponseSyntax) **
The unique identifier of the knowledge base to which the data source that was deleted belonged.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [status](#API_agent_DeleteDataSource_ResponseSyntax) **
The status of the data source.
Type: String
Valid Values: `AVAILABLE | DELETING | DELETE_UNSUCCESSFUL`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteDataSource)
# DeleteFlow
Deletes a flow.
## Request Syntax
```
DELETE /flows/flowIdentifier/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_DeleteFlow_RequestSyntax) **
The unique identifier of the flow.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
** [skipResourceInUseCheck](#API_agent_DeleteFlow_RequestSyntax) **
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.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"id": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [id](#API_agent_DeleteFlow_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteFlow)
# DeleteFlowAlias
Deletes an alias of a flow.
## Request Syntax
```
DELETE /flows/flowIdentifier/aliases/aliasIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [aliasIdentifier](#API_agent_DeleteFlowAlias_RequestSyntax) **
The unique identifier of the alias to be deleted.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(TSTALIASID|[0-9a-zA-Z]{10})`
Required: Yes
** [flowIdentifier](#API_agent_DeleteFlowAlias_RequestSyntax) **
The unique identifier of the flow that the alias belongs to.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flowId": "string",
"id": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flowId](#API_agent_DeleteFlowAlias_ResponseSyntax) **
The unique identifier of the flow that the alias belongs to.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [id](#API_agent_DeleteFlowAlias_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteFlowAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteFlowAlias)
# DeleteFlowVersion
Deletes a version of a flow.
## Request Syntax
```
DELETE /flows/flowIdentifier/versions/flowVersion/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_DeleteFlowVersion_RequestSyntax) **
The unique identifier of the flow whose version that you want to delete
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
** [flowVersion](#API_agent_DeleteFlowVersion_RequestSyntax) **
The version of the flow that you want to delete.
Pattern: `[0-9]{1,5}`
Required: Yes
** [skipResourceInUseCheck](#API_agent_DeleteFlowVersion_RequestSyntax) **
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.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"id": "string",
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [id](#API_agent_DeleteFlowVersion_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [version](#API_agent_DeleteFlowVersion_ResponseSyntax) **
The version of the flow being deleted.
Type: String
Pattern: `[0-9]{1,5}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteFlowVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteFlowVersion)
# DeleteKnowledgeBase
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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DisassociateAgentKnowledgeBase.html) request.
## Request Syntax
```
DELETE /knowledgebases/knowledgeBaseId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [knowledgeBaseId](#API_agent_DeleteKnowledgeBase_RequestSyntax) **
The unique identifier of the knowledge base to delete.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"knowledgeBaseId": "string",
"status": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [knowledgeBaseId](#API_agent_DeleteKnowledgeBase_ResponseSyntax) **
The unique identifier of the knowledge base that was deleted.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [status](#API_agent_DeleteKnowledgeBase_ResponseSyntax) **
The status of the knowledge base and whether it has been successfully deleted.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | UPDATING | FAILED | DELETE_UNSUCCESSFUL`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteKnowledgeBase)
# DeleteKnowledgeBaseDocuments
Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see [Ingest changes directly into a knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /knowledgebases/knowledgeBaseId/datasources/dataSourceId/documents/deleteDocuments HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"documentIdentifiers": [
{
"custom": {
"id": "string"
},
"dataSourceType": "string",
"s3": {
"uri": "string"
}
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_DeleteKnowledgeBaseDocuments_RequestSyntax) **
The unique identifier of the data source that contains the documents.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_DeleteKnowledgeBaseDocuments_RequestSyntax) **
The unique identifier of the knowledge base that is connected to the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_DeleteKnowledgeBaseDocuments_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [documentIdentifiers](#API_agent_DeleteKnowledgeBaseDocuments_RequestSyntax) **
A list of objects, each of which contains information to identify a document to delete.
Type: Array of [DocumentIdentifier](API_agent_DocumentIdentifier.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"documentDetails": [
{
"dataSourceId": "string",
"identifier": {
"custom": {
"id": "string"
},
"dataSourceType": "string",
"s3": {
"uri": "string"
}
},
"knowledgeBaseId": "string",
"status": "string",
"statusReason": "string",
"updatedAt": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [documentDetails](#API_agent_DeleteKnowledgeBaseDocuments_ResponseSyntax) **
A list of objects, each of which contains information about the documents that were deleted.
Type: Array of [KnowledgeBaseDocumentDetail](API_agent_KnowledgeBaseDocumentDetail.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocuments)
# DeletePrompt
Deletes a prompt or a version of it, depending on whether you include the `promptVersion` field or not. For more information, see [Delete prompts from the Prompt management tool](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-delete.html) and [Delete a version of a prompt from the Prompt management tool](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-delete.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
DELETE /prompts/promptIdentifier/?promptVersion=promptVersion HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [promptIdentifier](#API_agent_DeletePrompt_RequestSyntax) **
The unique identifier of the prompt.
Pattern: `([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?`
Required: Yes
** [promptVersion](#API_agent_DeletePrompt_RequestSyntax) **
The version of the prompt to delete. To delete the prompt, omit this field.
Pattern: `[0-9]{1,5}`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"id": "string",
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [id](#API_agent_DeletePrompt_ResponseSyntax) **
The unique identifier of the prompt that was deleted.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [version](#API_agent_DeletePrompt_ResponseSyntax) **
The version of the prompt that was deleted.
Type: String
Pattern: `[0-9]{1,5}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Delete a prompt
The following request deletes the prompt in the account with the identifier `PROMPT12345`:
```
DELETE /prompts/PROMPT12345/ HTTP/1.1
```
### Delete a version of a prompt
The following request deletes version `1` of the prompt in the account with the identifier `PROMPT12345`:
```
GET /prompts/PROMPT12345?promptVersion=1 HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DeletePrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DeletePrompt)
# DisassociateAgentCollaborator
Disassociates an agent collaborator.
## Request Syntax
```
DELETE /agents/agentId/agentversions/agentVersion/agentcollaborators/collaboratorId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_DisassociateAgentCollaborator_RequestSyntax) **
An agent ID.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_DisassociateAgentCollaborator_RequestSyntax) **
The agent's version.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
** [collaboratorId](#API_agent_DisassociateAgentCollaborator_RequestSyntax) **
The collaborator's ID.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DisassociateAgentCollaborator)
# DisassociateAgentKnowledgeBase
Disassociates a knowledge base from an agent.
## Request Syntax
```
DELETE /agents/agentId/agentversions/agentVersion/knowledgebases/knowledgeBaseId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_DisassociateAgentKnowledgeBase_RequestSyntax) **
The unique identifier of the agent from which to disassociate the knowledge base.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_DisassociateAgentKnowledgeBase_RequestSyntax) **
The version of the agent from which to disassociate the knowledge base.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
** [knowledgeBaseId](#API_agent_DisassociateAgentKnowledgeBase_RequestSyntax) **
The unique identifier of the knowledge base to disassociate.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 204
```
## Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBase)
# GetAgent
Gets information about an agent.
## Request Syntax
```
GET /agents/agentId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_GetAgent_RequestSyntax) **
The unique identifier of the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agent": {
"agentArn": "string",
"agentCollaboration": "string",
"agentId": "string",
"agentName": "string",
"agentResourceRoleArn": "string",
"agentStatus": "string",
"agentVersion": "string",
"clientToken": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"customOrchestration": {
"executor": { ... }
},
"description": "string",
"failureReasons": [ "string" ],
"foundationModel": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"idleSessionTTLInSeconds": number,
"instruction": "string",
"memoryConfiguration": {
"enabledMemoryTypes": [ "string" ],
"sessionSummaryConfiguration": {
"maxRecentSessions": number
},
"storageDays": number
},
"orchestrationType": "string",
"preparedAt": "string",
"promptOverrideConfiguration": {
"overrideLambda": "string",
"promptConfigurations": [
{
"additionalModelRequestFields": JSON value,
"basePromptTemplate": "string",
"foundationModel": "string",
"inferenceConfiguration": {
"maximumLength": number,
"stopSequences": [ "string" ],
"temperature": number,
"topK": number,
"topP": number
},
"parserMode": "string",
"promptCreationMode": "string",
"promptState": "string",
"promptType": "string"
}
]
},
"recommendedActions": [ "string" ],
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agent](#API_agent_GetAgent_ResponseSyntax) **
Contains details about the agent.
Type: [Agent](API_agent_Agent.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of GetAgent.
```
GET /agents/ABCDEFGHIJ/ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetAgent)
# GetAgentActionGroup
Gets information about an action group for an agent.
## Request Syntax
```
GET /agents/agentId/agentversions/agentVersion/actiongroups/actionGroupId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [actionGroupId](#API_agent_GetAgentActionGroup_RequestSyntax) **
The unique identifier of the action group for which to get information.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentId](#API_agent_GetAgentActionGroup_RequestSyntax) **
The unique identifier of the agent that the action group belongs to.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_GetAgentActionGroup_RequestSyntax) **
The version of the agent that the action group belongs to.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentActionGroup": {
"actionGroupExecutor": { ... },
"actionGroupId": "string",
"actionGroupName": "string",
"actionGroupState": "string",
"agentId": "string",
"agentVersion": "string",
"apiSchema": { ... },
"clientToken": "string",
"createdAt": "string",
"description": "string",
"functionSchema": { ... },
"parentActionGroupSignatureParams": {
"string" : "string"
},
"parentActionSignature": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentActionGroup](#API_agent_GetAgentActionGroup_ResponseSyntax) **
Contains details about the action group.
Type: [AgentActionGroup](API_agent_AgentActionGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of GetAgentActionGroup.
```
GET /agents/AGENT12345/agentversions/1/actiongroups/ACTION1234/ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetAgentActionGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetAgentActionGroup)
# GetAgentAlias
Gets information about an alias of an agent.
## Request Syntax
```
GET /agents/agentId/agentaliases/agentAliasId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentAliasId](#API_agent_GetAgentAlias_RequestSyntax) **
The unique identifier of the alias for which to get information.
Length Constraints: Fixed length of 10.
Pattern: `(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [agentId](#API_agent_GetAgentAlias_RequestSyntax) **
The unique identifier of the agent to which the alias to get information belongs.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentAlias": {
"agentAliasArn": "string",
"agentAliasHistoryEvents": [
{
"endDate": "string",
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
],
"startDate": "string"
}
],
"agentAliasId": "string",
"agentAliasName": "string",
"agentAliasStatus": "string",
"agentId": "string",
"aliasInvocationState": "string",
"clientToken": "string",
"createdAt": "string",
"description": "string",
"failureReasons": [ "string" ],
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
],
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentAlias](#API_agent_GetAgentAlias_ResponseSyntax) **
Contains information about the alias.
Type: [AgentAlias](API_agent_AgentAlias.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of GetAgentAlias.
```
GET /agents/ABCDEFGHIJ/agentaliases/ABCDEFGHIJ/ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetAgentAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetAgentAlias)
# GetAgentCollaborator
Retrieves information about an agent's collaborator.
## Request Syntax
```
GET /agents/agentId/agentversions/agentVersion/agentcollaborators/collaboratorId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_GetAgentCollaborator_RequestSyntax) **
The agent's ID.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_GetAgentCollaborator_RequestSyntax) **
The agent's version.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
** [collaboratorId](#API_agent_GetAgentCollaborator_RequestSyntax) **
The collaborator's ID.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentCollaborator": {
"agentDescriptor": {
"aliasArn": "string"
},
"agentId": "string",
"agentVersion": "string",
"clientToken": "string",
"collaborationInstruction": "string",
"collaboratorId": "string",
"collaboratorName": "string",
"createdAt": "string",
"lastUpdatedAt": "string",
"relayConversationHistory": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentCollaborator](#API_agent_GetAgentCollaborator_ResponseSyntax) **
Details about the collaborator.
Type: [AgentCollaborator](API_agent_AgentCollaborator.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetAgentCollaborator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetAgentCollaborator)
# GetAgentKnowledgeBase
Gets information about a knowledge base associated with an agent.
## Request Syntax
```
GET /agents/agentId/agentversions/agentVersion/knowledgebases/knowledgeBaseId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_GetAgentKnowledgeBase_RequestSyntax) **
The unique identifier of the agent with which the knowledge base is associated.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_GetAgentKnowledgeBase_RequestSyntax) **
The version of the agent with which the knowledge base is associated.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
** [knowledgeBaseId](#API_agent_GetAgentKnowledgeBase_RequestSyntax) **
The unique identifier of the knowledge base associated with the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentKnowledgeBase": {
"agentId": "string",
"agentVersion": "string",
"createdAt": "string",
"description": "string",
"knowledgeBaseId": "string",
"knowledgeBaseState": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentKnowledgeBase](#API_agent_GetAgentKnowledgeBase_ResponseSyntax) **
Contains details about a knowledge base attached to an agent.
Type: [AgentKnowledgeBase](API_agent_AgentKnowledgeBase.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetAgentKnowledgeBase)
# GetAgentVersion
Gets details about a version of an agent.
## Request Syntax
```
GET /agents/agentId/agentversions/agentVersion/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_GetAgentVersion_RequestSyntax) **
The unique identifier of the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_GetAgentVersion_RequestSyntax) **
The version of the agent.
Pattern: `[0-9]{1,5}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentVersion": {
"agentArn": "string",
"agentCollaboration": "string",
"agentId": "string",
"agentName": "string",
"agentResourceRoleArn": "string",
"agentStatus": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"description": "string",
"failureReasons": [ "string" ],
"foundationModel": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"idleSessionTTLInSeconds": number,
"instruction": "string",
"memoryConfiguration": {
"enabledMemoryTypes": [ "string" ],
"sessionSummaryConfiguration": {
"maxRecentSessions": number
},
"storageDays": number
},
"promptOverrideConfiguration": {
"overrideLambda": "string",
"promptConfigurations": [
{
"additionalModelRequestFields": JSON value,
"basePromptTemplate": "string",
"foundationModel": "string",
"inferenceConfiguration": {
"maximumLength": number,
"stopSequences": [ "string" ],
"temperature": number,
"topK": number,
"topP": number
},
"parserMode": "string",
"promptCreationMode": "string",
"promptState": "string",
"promptType": "string"
}
]
},
"recommendedActions": [ "string" ],
"updatedAt": "string",
"version": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentVersion](#API_agent_GetAgentVersion_ResponseSyntax) **
Contains details about the version of the agent.
Type: [AgentVersion](API_agent_AgentVersion.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of GetAgentVersion.
```
GET /agents/agentId/agentversions/agentVersion/ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetAgentVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetAgentVersion)
# GetDataSource
Gets information about a data source.
## Request Syntax
```
GET /knowledgebases/knowledgeBaseId/datasources/dataSourceId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_GetDataSource_RequestSyntax) **
The unique identifier of the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_GetDataSource_RequestSyntax) **
The unique identifier of the knowledge base for the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"dataSource": {
"createdAt": "string",
"dataDeletionPolicy": "string",
"dataSourceConfiguration": {
"confluenceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostType": "string",
"hostUrl": "string"
}
},
"s3Configuration": {
"bucketArn": "string",
"bucketOwnerAccountId": "string",
"inclusionPrefixes": [ "string" ]
},
"salesforceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostUrl": "string"
}
},
"sharePointConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"domain": "string",
"hostType": "string",
"siteUrls": [ "string" ],
"tenantId": "string"
}
},
"type": "string",
"webConfiguration": {
"crawlerConfiguration": {
"crawlerLimits": {
"maxPages": number,
"rateLimit": number
},
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"scope": "string",
"userAgent": "string",
"userAgentHeader": "string"
},
"sourceConfiguration": {
"urlConfiguration": {
"seedUrls": [
{
"url": "string"
}
]
}
}
}
},
"dataSourceId": "string",
"description": "string",
"failureReasons": [ "string" ],
"knowledgeBaseId": "string",
"name": "string",
"serverSideEncryptionConfiguration": {
"kmsKeyArn": "string"
},
"status": "string",
"updatedAt": "string",
"vectorIngestionConfiguration": {
"chunkingConfiguration": {
"chunkingStrategy": "string",
"fixedSizeChunkingConfiguration": {
"maxTokens": number,
"overlapPercentage": number
},
"hierarchicalChunkingConfiguration": {
"levelConfigurations": [
{
"maxTokens": number
}
],
"overlapTokens": number
},
"semanticChunkingConfiguration": {
"breakpointPercentileThreshold": number,
"bufferSize": number,
"maxTokens": number
}
},
"contextEnrichmentConfiguration": {
"bedrockFoundationModelConfiguration": {
"enrichmentStrategyConfiguration": {
"method": "string"
},
"modelArn": "string"
},
"type": "string"
},
"customTransformationConfiguration": {
"intermediateStorage": {
"s3Location": {
"uri": "string"
}
},
"transformations": [
{
"stepToApply": "string",
"transformationFunction": {
"transformationLambdaConfiguration": {
"lambdaArn": "string"
}
}
}
]
},
"parsingConfiguration": {
"bedrockDataAutomationConfiguration": {
"parsingModality": "string"
},
"bedrockFoundationModelConfiguration": {
"modelArn": "string",
"parsingModality": "string",
"parsingPrompt": {
"parsingPromptText": "string"
}
},
"parsingStrategy": "string"
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [dataSource](#API_agent_GetDataSource_ResponseSyntax) **
Contains details about the data source.
Type: [DataSource](API_agent_DataSource.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetDataSource)
# GetFlow
Retrieves information about a flow. For more information, see [Manage a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /flows/flowIdentifier/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_GetFlow_RequestSyntax) **
The unique identifier of the flow.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"category": "string",
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
},
"description": "string",
"executionRoleArn": "string",
"id": "string",
"name": "string",
"status": "string",
"updatedAt": "string",
"validations": [
{
"details": { ... },
"message": "string",
"severity": "string",
"type": "string"
}
],
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_GetFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}`
** [createdAt](#API_agent_GetFlow_ResponseSyntax) **
The time at which the flow was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_GetFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [definition](#API_agent_GetFlow_ResponseSyntax) **
The definition of the nodes and connections between the nodes in the flow.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
** [description](#API_agent_GetFlow_ResponseSyntax) **
The description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [executionRoleArn](#API_agent_GetFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see [Create a service row for flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+`
** [id](#API_agent_GetFlow_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_GetFlow_ResponseSyntax) **
The name of the flow.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [status](#API_agent_GetFlow_ResponseSyntax) **
The status of the flow. The following statuses are possible:
+ NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the `DRAFT` version won't contain the latest changes for testing. Send a [PrepareFlow](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html) request to package the latest changes into the `DRAFT` version.
+ Preparing – The flow is being prepared so that the `DRAFT` version contains the latest changes for testing.
+ Prepared – The flow is prepared and the `DRAFT` version contains the latest changes for testing.
+ Failed – The last API operation that you invoked on the flow failed. Send a [GetFlow](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html) request and check the error message in the `validations` field.
Type: String
Valid Values: `Failed | Prepared | Preparing | NotPrepared`
** [updatedAt](#API_agent_GetFlow_ResponseSyntax) **
The time at which the flow was last updated.
Type: Timestamp
** [validations](#API_agent_GetFlow_ResponseSyntax) **
A list of validation error messages related to the last failed operation on the flow.
Type: Array of [FlowValidation](API_agent_FlowValidation.md) objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
** [version](#API_agent_GetFlow_ResponseSyntax) **
The version of the flow for which information was retrieved.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetFlow)
# GetFlowAlias
Retrieves information about a flow. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /flows/flowIdentifier/aliases/aliasIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [aliasIdentifier](#API_agent_GetFlowAlias_RequestSyntax) **
The unique identifier of the alias for which to retrieve information.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(TSTALIASID|[0-9a-zA-Z]{10})`
Required: Yes
** [flowIdentifier](#API_agent_GetFlowAlias_RequestSyntax) **
The unique identifier of the flow that the alias belongs to.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"concurrencyConfiguration": {
"maxConcurrency": number,
"type": "string"
},
"createdAt": "string",
"description": "string",
"flowId": "string",
"id": "string",
"name": "string",
"routingConfiguration": [
{
"flowVersion": "string"
}
],
"updatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_GetFlowAlias_ResponseSyntax) **
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})`
** [concurrencyConfiguration](#API_agent_GetFlowAlias_ResponseSyntax) **
The configuration that specifies how nodes in the flow are executed in parallel.
Type: [FlowAliasConcurrencyConfiguration](API_agent_FlowAliasConcurrencyConfiguration.md) object
** [createdAt](#API_agent_GetFlowAlias_ResponseSyntax) **
The time at which the flow was created.
Type: Timestamp
** [description](#API_agent_GetFlowAlias_ResponseSyntax) **
The description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [flowId](#API_agent_GetFlowAlias_ResponseSyntax) **
The unique identifier of the flow that the alias belongs to.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [id](#API_agent_GetFlowAlias_ResponseSyntax) **
The unique identifier of the alias of the flow.
Type: String
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})`
** [name](#API_agent_GetFlowAlias_ResponseSyntax) **
The name of the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [routingConfiguration](#API_agent_GetFlowAlias_ResponseSyntax) **
Contains information about the version that the alias is mapped to.
Type: Array of [FlowAliasRoutingConfigurationListItem](API_agent_FlowAliasRoutingConfigurationListItem.md) objects
Array Members: Fixed number of 1 item.
** [updatedAt](#API_agent_GetFlowAlias_ResponseSyntax) **
The time at which the alias was last updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetFlowAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetFlowAlias)
# GetFlowVersion
Retrieves information about a version of a flow. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /flows/flowIdentifier/versions/flowVersion/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_GetFlowVersion_RequestSyntax) **
The unique identifier of the flow for which to get information.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
** [flowVersion](#API_agent_GetFlowVersion_RequestSyntax) **
The version of the flow for which to get information.
Pattern: `[0-9]{1,5}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"category": "string",
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
},
"description": "string",
"executionRoleArn": "string",
"id": "string",
"name": "string",
"status": "string",
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_GetFlowVersion_ResponseSyntax) **
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}`
** [createdAt](#API_agent_GetFlowVersion_ResponseSyntax) **
The time at which the flow was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_GetFlowVersion_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key that the version of the flow is encrypted with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [definition](#API_agent_GetFlowVersion_ResponseSyntax) **
The definition of the nodes and connections between nodes in the flow.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
** [description](#API_agent_GetFlowVersion_ResponseSyntax) **
The description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [executionRoleArn](#API_agent_GetFlowVersion_ResponseSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+`
** [id](#API_agent_GetFlowVersion_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_GetFlowVersion_ResponseSyntax) **
The name of the version.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [status](#API_agent_GetFlowVersion_ResponseSyntax) **
The status of the flow.
Type: String
Valid Values: `Failed | Prepared | Preparing | NotPrepared`
** [version](#API_agent_GetFlowVersion_ResponseSyntax) **
The version of the flow for which information was retrieved.
Type: String
Pattern: `[0-9]{1,5}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetFlowVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetFlowVersion)
# GetIngestionJob
Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
## Request Syntax
```
GET /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ingestionJobId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_GetIngestionJob_RequestSyntax) **
The unique identifier of the data source for the data ingestion job you want to get information on.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [ingestionJobId](#API_agent_GetIngestionJob_RequestSyntax) **
The unique identifier of the data ingestion job you want to get information on.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_GetIngestionJob_RequestSyntax) **
The unique identifier of the knowledge base for the data ingestion job you want to get information on.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ingestionJob": {
"dataSourceId": "string",
"description": "string",
"failureReasons": [ "string" ],
"ingestionJobId": "string",
"knowledgeBaseId": "string",
"startedAt": "string",
"statistics": {
"numberOfDocumentsDeleted": number,
"numberOfDocumentsFailed": number,
"numberOfDocumentsScanned": number,
"numberOfMetadataDocumentsModified": number,
"numberOfMetadataDocumentsScanned": number,
"numberOfModifiedDocumentsIndexed": number,
"numberOfNewDocumentsIndexed": number
},
"status": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ingestionJob](#API_agent_GetIngestionJob_ResponseSyntax) **
Contains details about the data ingestion job.
Type: [IngestionJob](API_agent_IngestionJob.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetIngestionJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetIngestionJob)
# GetKnowledgeBase
Gets information about a knowledge base.
## Request Syntax
```
GET /knowledgebases/knowledgeBaseId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [knowledgeBaseId](#API_agent_GetKnowledgeBase_RequestSyntax) **
The unique identifier of the knowledge base you want to get information on.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"knowledgeBase": {
"createdAt": "string",
"description": "string",
"failureReasons": [ "string" ],
"knowledgeBaseArn": "string",
"knowledgeBaseConfiguration": {
"kendraKnowledgeBaseConfiguration": {
"kendraIndexArn": "string"
},
"sqlKnowledgeBaseConfiguration": {
"redshiftConfiguration": {
"queryEngineConfiguration": {
"provisionedConfiguration": {
"authConfiguration": {
"databaseUser": "string",
"type": "string",
"usernamePasswordSecretArn": "string"
},
"clusterIdentifier": "string"
},
"serverlessConfiguration": {
"authConfiguration": {
"type": "string",
"usernamePasswordSecretArn": "string"
},
"workgroupArn": "string"
},
"type": "string"
},
"queryGenerationConfiguration": {
"executionTimeoutSeconds": number,
"generationContext": {
"curatedQueries": [
{
"naturalLanguage": "string",
"sql": "string"
}
],
"tables": [
{
"columns": [
{
"description": "string",
"inclusion": "string",
"name": "string"
}
],
"description": "string",
"inclusion": "string",
"name": "string"
}
]
}
},
"storageConfigurations": [
{
"awsDataCatalogConfiguration": {
"tableNames": [ "string" ]
},
"redshiftConfiguration": {
"databaseName": "string"
},
"type": "string"
}
]
},
"type": "string"
},
"type": "string",
"vectorKnowledgeBaseConfiguration": {
"embeddingModelArn": "string",
"embeddingModelConfiguration": {
"bedrockEmbeddingModelConfiguration": {
"audio": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
],
"dimensions": number,
"embeddingDataType": "string",
"video": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
]
}
},
"supplementalDataStorageConfiguration": {
"storageLocations": [
{
"s3Location": {
"uri": "string"
},
"type": "string"
}
]
}
}
},
"knowledgeBaseId": "string",
"name": "string",
"roleArn": "string",
"status": "string",
"storageConfiguration": {
"mongoDbAtlasConfiguration": {
"collectionName": "string",
"credentialsSecretArn": "string",
"databaseName": "string",
"endpoint": "string",
"endpointServiceName": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"textIndexName": "string",
"vectorIndexName": "string"
},
"neptuneAnalyticsConfiguration": {
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"graphArn": "string"
},
"opensearchManagedClusterConfiguration": {
"domainArn": "string",
"domainEndpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"opensearchServerlessConfiguration": {
"collectionArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"pineconeConfiguration": {
"connectionString": "string",
"credentialsSecretArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"namespace": "string"
},
"rdsConfiguration": {
"credentialsSecretArn": "string",
"databaseName": "string",
"fieldMapping": {
"customMetadataField": "string",
"metadataField": "string",
"primaryKeyField": "string",
"textField": "string",
"vectorField": "string"
},
"resourceArn": "string",
"tableName": "string"
},
"redisEnterpriseCloudConfiguration": {
"credentialsSecretArn": "string",
"endpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"s3VectorsConfiguration": {
"indexArn": "string",
"indexName": "string",
"vectorBucketArn": "string"
},
"type": "string"
},
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [knowledgeBase](#API_agent_GetKnowledgeBase_ResponseSyntax) **
Contains details about the knowledge base.
Type: [KnowledgeBase](API_agent_KnowledgeBase.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetKnowledgeBase)
# GetKnowledgeBaseDocuments
Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see [Ingest changes directly into a knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /knowledgebases/knowledgeBaseId/datasources/dataSourceId/documents/getDocuments HTTP/1.1
Content-type: application/json
{
"documentIdentifiers": [
{
"custom": {
"id": "string"
},
"dataSourceType": "string",
"s3": {
"uri": "string"
}
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_GetKnowledgeBaseDocuments_RequestSyntax) **
The unique identifier of the data source that contains the documents.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_GetKnowledgeBaseDocuments_RequestSyntax) **
The unique identifier of the knowledge base that is connected to the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [documentIdentifiers](#API_agent_GetKnowledgeBaseDocuments_RequestSyntax) **
A list of objects, each of which contains information to identify a document for which to retrieve information.
Type: Array of [DocumentIdentifier](API_agent_DocumentIdentifier.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"documentDetails": [
{
"dataSourceId": "string",
"identifier": {
"custom": {
"id": "string"
},
"dataSourceType": "string",
"s3": {
"uri": "string"
}
},
"knowledgeBaseId": "string",
"status": "string",
"statusReason": "string",
"updatedAt": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [documentDetails](#API_agent_GetKnowledgeBaseDocuments_ResponseSyntax) **
A list of objects, each of which contains information about the documents that were retrieved.
Type: Array of [KnowledgeBaseDocumentDetail](API_agent_KnowledgeBaseDocumentDetail.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetKnowledgeBaseDocuments)
# GetPrompt
Retrieves information about the working draft (`DRAFT` version) of a prompt or a version of it, depending on whether you include the `promptVersion` field or not. For more information, see [View information about prompts using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html) and [View information about a version of your prompt](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html#prompt-management-versions-view.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /prompts/promptIdentifier/?promptVersion=promptVersion HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [promptIdentifier](#API_agent_GetPrompt_RequestSyntax) **
The unique identifier of the prompt.
Pattern: `([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?`
Required: Yes
** [promptVersion](#API_agent_GetPrompt_RequestSyntax) **
The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"defaultVariant": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string",
"variants": [
{
"additionalModelRequestFields": JSON value,
"genAiResource": { ... },
"inferenceConfiguration": { ... },
"metadata": [
{
"key": "string",
"value": "string"
}
],
"modelId": "string",
"name": "string",
"templateConfiguration": { ... },
"templateType": "string"
}
],
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_GetPrompt_ResponseSyntax) **
The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
Type: String
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)`
** [createdAt](#API_agent_GetPrompt_ResponseSyntax) **
The time at which the prompt was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_GetPrompt_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [defaultVariant](#API_agent_GetPrompt_ResponseSyntax) **
The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [description](#API_agent_GetPrompt_ResponseSyntax) **
The descriptino of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [id](#API_agent_GetPrompt_ResponseSyntax) **
The unique identifier of the prompt.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_GetPrompt_ResponseSyntax) **
The name of the prompt.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [updatedAt](#API_agent_GetPrompt_ResponseSyntax) **
The time at which the prompt was last updated.
Type: Timestamp
** [variants](#API_agent_GetPrompt_ResponseSyntax) **
A list of objects, each containing details about a variant of the prompt.
Type: Array of [PromptVariant](API_agent_PromptVariant.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
** [version](#API_agent_GetPrompt_ResponseSyntax) **
The version of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Get information about the working draft of a prompt
The following request returns information about the working draft of the prompt in the account with the identifier `PROMPT12345`:
```
GET /prompts/PROMPT12345 HTTP/1.1
```
### List information about all the versions of a prompt
The following request returns information about version `2` of the prompt in the account with the identifier `PROMPT12345`:
```
GET /prompts/PROMPT12345?promptVersion=2 HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/GetPrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GetPrompt)
# IngestKnowledgeBaseDocuments
Ingests documents directly into the knowledge base that is connected to the data source. The `dataSourceType` specified in the content for each document must match the type of the data source that you specify in the header. For more information, see [Ingest changes directly into a knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
PUT /knowledgebases/knowledgeBaseId/datasources/dataSourceId/documents HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"documents": [
{
"content": {
"custom": {
"customDocumentIdentifier": {
"id": "string"
},
"inlineContent": {
"byteContent": {
"data": blob,
"mimeType": "string"
},
"textContent": {
"data": "string"
},
"type": "string"
},
"s3Location": {
"bucketOwnerAccountId": "string",
"uri": "string"
},
"sourceType": "string"
},
"dataSourceType": "string",
"s3": {
"s3Location": {
"uri": "string"
}
}
},
"metadata": {
"inlineAttributes": [
{
"key": "string",
"value": {
"booleanValue": boolean,
"numberValue": number,
"stringListValue": [ "string" ],
"stringValue": "string",
"type": "string"
}
}
],
"s3Location": {
"bucketOwnerAccountId": "string",
"uri": "string"
},
"type": "string"
}
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_IngestKnowledgeBaseDocuments_RequestSyntax) **
The unique identifier of the data source connected to the knowledge base that you're adding documents to.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_IngestKnowledgeBaseDocuments_RequestSyntax) **
The unique identifier of the knowledge base to ingest the documents into.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_IngestKnowledgeBaseDocuments_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [documents](#API_agent_IngestKnowledgeBaseDocuments_RequestSyntax) **
A list of objects, each of which contains information about the documents to add.
Type: Array of [KnowledgeBaseDocument](API_agent_KnowledgeBaseDocument.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"documentDetails": [
{
"dataSourceId": "string",
"identifier": {
"custom": {
"id": "string"
},
"dataSourceType": "string",
"s3": {
"uri": "string"
}
},
"knowledgeBaseId": "string",
"status": "string",
"statusReason": "string",
"updatedAt": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [documentDetails](#API_agent_IngestKnowledgeBaseDocuments_ResponseSyntax) **
A list of objects, each of which contains information about the documents that were ingested.
Type: Array of [KnowledgeBaseDocumentDetail](API_agent_KnowledgeBaseDocumentDetail.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocuments)
# ListAgentActionGroups
Lists the action groups for an agent and information about each one.
## Request Syntax
```
POST /agents/agentId/agentversions/agentVersion/actiongroups/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_ListAgentActionGroups_RequestSyntax) **
The unique identifier of the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_ListAgentActionGroups_RequestSyntax) **
The version of the agent.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListAgentActionGroups_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListAgentActionGroups_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"actionGroupSummaries": [
{
"actionGroupId": "string",
"actionGroupName": "string",
"actionGroupState": "string",
"description": "string",
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [actionGroupSummaries](#API_agent_ListAgentActionGroups_ResponseSyntax) **
A list of objects, each of which contains information about an action group.
Type: Array of [ActionGroupSummary](API_agent_ActionGroupSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListAgentActionGroups_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListAgentActionGroups.
```
POST /agents/AGENT12345/agentversions/1/actiongroups/ HTTP/1.1
Content-type: application/json
{
"maxResults": 10
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListAgentActionGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListAgentActionGroups)
# ListAgentAliases
Lists the aliases of an agent and information about each one.
## Request Syntax
```
POST /agents/agentId/agentaliases/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_ListAgentAliases_RequestSyntax) **
The unique identifier of the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListAgentAliases_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListAgentAliases_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentAliasSummaries": [
{
"agentAliasId": "string",
"agentAliasName": "string",
"agentAliasStatus": "string",
"aliasInvocationState": "string",
"createdAt": "string",
"description": "string",
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
],
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentAliasSummaries](#API_agent_ListAgentAliases_ResponseSyntax) **
A list of objects, each of which contains information about an alias of the agent.
Type: Array of [AgentAliasSummary](API_agent_AgentAliasSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListAgentAliases_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListAgentAliases.
```
POST /agents/ABCDEFGHIJ/agentaliases/ HTTP/1.1
Content-type: application/json
{
"maxResults": 10
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListAgentAliases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListAgentAliases)
# ListAgentCollaborators
Retrieve a list of an agent's collaborators.
## Request Syntax
```
POST /agents/agentId/agentversions/agentVersion/agentcollaborators/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_ListAgentCollaborators_RequestSyntax) **
The agent's ID.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_ListAgentCollaborators_RequestSyntax) **
The agent's version.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListAgentCollaborators_RequestSyntax) **
The maximum number of agent collaborators to return in one page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListAgentCollaborators_RequestSyntax) **
Specify the pagination token from a previous request to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentCollaboratorSummaries": [
{
"agentDescriptor": {
"aliasArn": "string"
},
"agentId": "string",
"agentVersion": "string",
"collaborationInstruction": "string",
"collaboratorId": "string",
"collaboratorName": "string",
"createdAt": "string",
"lastUpdatedAt": "string",
"relayConversationHistory": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentCollaboratorSummaries](#API_agent_ListAgentCollaborators_ResponseSyntax) **
A list of collaborator summaries.
Type: Array of [AgentCollaboratorSummary](API_agent_AgentCollaboratorSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListAgentCollaborators_ResponseSyntax) **
Specify the pagination token from a previous request to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListAgentCollaborators)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListAgentCollaborators)
# ListAgentKnowledgeBases
Lists knowledge bases associated with an agent and information about each one.
## Request Syntax
```
POST /agents/agentId/agentversions/agentVersion/knowledgebases/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_ListAgentKnowledgeBases_RequestSyntax) **
The unique identifier of the agent for which to return information about knowledge bases associated with it.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_ListAgentKnowledgeBases_RequestSyntax) **
The version of the agent for which to return information about knowledge bases associated with it.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListAgentKnowledgeBases_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListAgentKnowledgeBases_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentKnowledgeBaseSummaries": [
{
"description": "string",
"knowledgeBaseId": "string",
"knowledgeBaseState": "string",
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentKnowledgeBaseSummaries](#API_agent_ListAgentKnowledgeBases_ResponseSyntax) **
A list of objects, each of which contains information about a knowledge base associated with the agent.
Type: Array of [AgentKnowledgeBaseSummary](API_agent_AgentKnowledgeBaseSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListAgentKnowledgeBases_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListAgentKnowledgeBases)
# ListAgents
Lists the agents belonging to an account and information about each agent.
## Request Syntax
```
POST /agents/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListAgents_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListAgents_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentSummaries": [
{
"agentId": "string",
"agentName": "string",
"agentStatus": "string",
"description": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"latestAgentVersion": "string",
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentSummaries](#API_agent_ListAgents_ResponseSyntax) **
A list of objects, each of which contains information about an agent.
Type: Array of [AgentSummary](API_agent_AgentSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListAgents_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListAgents.
```
POST /agents/ HTTP/1.1
Content-type: application/json
{
"maxResults": 10
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListAgents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListAgents)
# ListAgentVersions
Lists the versions of an agent and information about each version.
## Request Syntax
```
POST /agents/agentId/agentversions/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_ListAgentVersions_RequestSyntax) **
The unique identifier of the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListAgentVersions_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListAgentVersions_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentVersionSummaries": [
{
"agentName": "string",
"agentStatus": "string",
"agentVersion": "string",
"createdAt": "string",
"description": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentVersionSummaries](#API_agent_ListAgentVersions_ResponseSyntax) **
A list of objects, each of which contains information about a version of the agent.
Type: Array of [AgentVersionSummary](API_agent_AgentVersionSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListAgentVersions_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListAgentVersions.
```
POST /agents/agentId/agentversions/ HTTP/1.1
Content-type: application/json
{
"maxResults": 10
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListAgentVersions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListAgentVersions)
# ListDataSources
Lists the data sources in a knowledge base and information about each one.
## Request Syntax
```
POST /knowledgebases/knowledgeBaseId/datasources/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [knowledgeBaseId](#API_agent_ListDataSources_RequestSyntax) **
The unique identifier of the knowledge base for which to return a list of information.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListDataSources_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListDataSources_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"dataSourceSummaries": [
{
"dataSourceId": "string",
"description": "string",
"knowledgeBaseId": "string",
"name": "string",
"status": "string",
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [dataSourceSummaries](#API_agent_ListDataSources_ResponseSyntax) **
A list of objects, each of which contains information about a data source.
Type: Array of [DataSourceSummary](API_agent_DataSourceSummary.md) objects
** [nextToken](#API_agent_ListDataSources_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListDataSources)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListDataSources)
# ListFlowAliases
Returns a list of aliases for a flow.
## Request Syntax
```
GET /flows/flowIdentifier/aliases?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_ListFlowAliases_RequestSyntax) **
The unique identifier of the flow for which aliases are being returned.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
** [maxResults](#API_agent_ListFlowAliases_RequestSyntax) **
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.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_agent_ListFlowAliases_RequestSyntax) **
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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flowAliasSummaries": [
{
"arn": "string",
"concurrencyConfiguration": {
"maxConcurrency": number,
"type": "string"
},
"createdAt": "string",
"description": "string",
"flowId": "string",
"id": "string",
"name": "string",
"routingConfiguration": [
{
"flowVersion": "string"
}
],
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flowAliasSummaries](#API_agent_ListFlowAliases_ResponseSyntax) **
A list, each member of which contains information about an alias.
Type: Array of [FlowAliasSummary](API_agent_FlowAliasSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListFlowAliases_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListFlowAliases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListFlowAliases)
# ListFlows
Returns a list of flows and information about each flow. For more information, see [Manage a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-manage.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /flows/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_agent_ListFlows_RequestSyntax) **
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.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_agent_ListFlows_RequestSyntax) **
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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flowSummaries": [
{
"arn": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"status": "string",
"updatedAt": "string",
"version": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flowSummaries](#API_agent_ListFlows_ResponseSyntax) **
A list, each member of which contains information about a flow.
Type: Array of [FlowSummary](API_agent_FlowSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListFlows_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListFlows)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListFlows)
# ListFlowVersions
Returns a list of information about each flow. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /flows/flowIdentifier/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_ListFlowVersions_RequestSyntax) **
The unique identifier of the flow.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
** [maxResults](#API_agent_ListFlowVersions_RequestSyntax) **
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.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_agent_ListFlowVersions_RequestSyntax) **
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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"flowVersionSummaries": [
{
"arn": "string",
"createdAt": "string",
"id": "string",
"status": "string",
"version": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [flowVersionSummaries](#API_agent_ListFlowVersions_ResponseSyntax) **
A list, each member of which contains information about a flow.
Type: Array of [FlowVersionSummary](API_agent_FlowVersionSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent_ListFlowVersions_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListFlowVersions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListFlowVersions)
# ListIngestionJobs
Lists the data ingestion jobs for a data source. The list also includes information about each job.
## Request Syntax
```
POST /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ HTTP/1.1
Content-type: application/json
{
"filters": [
{
"attribute": "string",
"operator": "string",
"values": [ "string" ]
}
],
"maxResults": number,
"nextToken": "string",
"sortBy": {
"attribute": "string",
"order": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_ListIngestionJobs_RequestSyntax) **
The unique identifier of the data source for the list of data ingestion jobs.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_ListIngestionJobs_RequestSyntax) **
The unique identifier of the knowledge base for the list of data ingestion jobs.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [filters](#API_agent_ListIngestionJobs_RequestSyntax) **
Contains information about the filters for filtering the data.
Type: Array of [IngestionJobFilter](API_agent_IngestionJobFilter.md) objects
Array Members: Fixed number of 1 item.
Required: No
** [maxResults](#API_agent_ListIngestionJobs_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListIngestionJobs_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
** [sortBy](#API_agent_ListIngestionJobs_RequestSyntax) **
Contains details about how to sort the data.
Type: [IngestionJobSortBy](API_agent_IngestionJobSortBy.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"ingestionJobSummaries": [
{
"dataSourceId": "string",
"description": "string",
"ingestionJobId": "string",
"knowledgeBaseId": "string",
"startedAt": "string",
"statistics": {
"numberOfDocumentsDeleted": number,
"numberOfDocumentsFailed": number,
"numberOfDocumentsScanned": number,
"numberOfMetadataDocumentsModified": number,
"numberOfMetadataDocumentsScanned": number,
"numberOfModifiedDocumentsIndexed": number,
"numberOfNewDocumentsIndexed": number
},
"status": "string",
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [ingestionJobSummaries](#API_agent_ListIngestionJobs_ResponseSyntax) **
A list of data ingestion jobs with information about each job.
Type: Array of [IngestionJobSummary](API_agent_IngestionJobSummary.md) objects
** [nextToken](#API_agent_ListIngestionJobs_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListIngestionJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListIngestionJobs)
# ListKnowledgeBaseDocuments
Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see [Ingest changes directly into a knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-direct-ingestion.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /knowledgebases/knowledgeBaseId/datasources/dataSourceId/documents HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_ListKnowledgeBaseDocuments_RequestSyntax) **
The unique identifier of the data source that contains the documents.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_ListKnowledgeBaseDocuments_RequestSyntax) **
The unique identifier of the knowledge base that is connected to the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListKnowledgeBaseDocuments_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListKnowledgeBaseDocuments_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"documentDetails": [
{
"dataSourceId": "string",
"identifier": {
"custom": {
"id": "string"
},
"dataSourceType": "string",
"s3": {
"uri": "string"
}
},
"knowledgeBaseId": "string",
"status": "string",
"statusReason": "string",
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [documentDetails](#API_agent_ListKnowledgeBaseDocuments_ResponseSyntax) **
A list of objects, each of which contains information about the documents that were retrieved.
Type: Array of [KnowledgeBaseDocumentDetail](API_agent_KnowledgeBaseDocumentDetail.md) objects
** [nextToken](#API_agent_ListKnowledgeBaseDocuments_ResponseSyntax) **
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.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListKnowledgeBaseDocuments)
# ListKnowledgeBases
Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.
## Request Syntax
```
POST /knowledgebases/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_agent_ListKnowledgeBases_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_agent_ListKnowledgeBases_RequestSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"knowledgeBaseSummaries": [
{
"description": "string",
"knowledgeBaseId": "string",
"name": "string",
"status": "string",
"updatedAt": "string"
}
],
"nextToken": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [knowledgeBaseSummaries](#API_agent_ListKnowledgeBases_ResponseSyntax) **
A list of knowledge bases with information about each knowledge base.
Type: Array of [KnowledgeBaseSummary](API_agent_KnowledgeBaseSummary.md) objects
** [nextToken](#API_agent_ListKnowledgeBases_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListKnowledgeBases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListKnowledgeBases)
# ListPrompts
Returns either information about the working draft (`DRAFT` version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the `promptIdentifier` field or not. For more information, see [View information about prompts using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-view.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /prompts/?maxResults=maxResults&nextToken=nextToken&promptIdentifier=promptIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_agent_ListPrompts_RequestSyntax) **
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.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_agent_ListPrompts_RequestSyntax) **
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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [promptIdentifier](#API_agent_ListPrompts_RequestSyntax) **
The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.
Pattern: `([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"promptSummaries": [
{
"arn": "string",
"createdAt": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string",
"version": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [nextToken](#API_agent_ListPrompts_ResponseSyntax) **
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [promptSummaries](#API_agent_ListPrompts_ResponseSyntax) **
A list, each member of which contains information about a prompt using Prompt management.
Type: Array of [PromptSummary](API_agent_PromptSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### List information about all prompts in an account
The following request returns information about the working draft of each prompt in the account:
```
GET /prompts/ HTTP/1.1
```
### List information about all the versions of a prompt
The following request returns information about all versions of the prompt in the account with the identifier `PROMPT12345`:
```
GET /prompts?promptIdentifier=PROMPT12345 HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListPrompts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListPrompts)
# ListTagsForResource
List all the tags for the resource you specify.
## Request Syntax
```
GET /tags/resourceArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_agent_ListTagsForResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource for which to list tags.
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `.*(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$).*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [tags](#API_agent_ListTagsForResource_ResponseSyntax) **
The key-value pairs for the tags associated with the resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListTagsForResource.
```
GET /tags/arn:aws:bedrock:us-west-2:123456789012:agent/ABCDEFGHIJ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ListTagsForResource)
# PrepareAgent
Creates a `DRAFT` version of the agent that can be used for internal testing.
## Request Syntax
```
POST /agents/agentId/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_PrepareAgent_RequestSyntax) **
The unique identifier of the agent for which to create a `DRAFT` version.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"agentId": "string",
"agentStatus": "string",
"agentVersion": "string",
"preparedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [agentId](#API_agent_PrepareAgent_ResponseSyntax) **
The unique identifier of the agent for which the `DRAFT` version was created.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [agentStatus](#API_agent_PrepareAgent_ResponseSyntax) **
The status of the `DRAFT` version and whether it is ready for use.
Type: String
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING`
** [agentVersion](#API_agent_PrepareAgent_ResponseSyntax) **
The version of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
** [preparedAt](#API_agent_PrepareAgent_ResponseSyntax) **
The time at which the `DRAFT` version of the agent was last prepared.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of PrepareAgent.
```
POST /agents/ABCDEFGHIJ/ HTTP/1.1
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/PrepareAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PrepareAgent)
# PrepareFlow
Prepares the `DRAFT` version of a flow so that it can be invoked. For more information, see [Test a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /flows/flowIdentifier/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_PrepareFlow_RequestSyntax) **
The unique identifier of the flow.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"id": "string",
"status": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [id](#API_agent_PrepareFlow_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [status](#API_agent_PrepareFlow_ResponseSyntax) **
The status of the flow. When you submit this request, the status will be `NotPrepared`. If preparation succeeds, the status becomes `Prepared`. If it fails, the status becomes `FAILED`.
Type: String
Valid Values: `Failed | Prepared | Preparing | NotPrepared`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/PrepareFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PrepareFlow)
# StartIngestionJob
Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
## Request Syntax
```
PUT /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"description": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_StartIngestionJob_RequestSyntax) **
The unique identifier of the data source you want to ingest into your knowledge base.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_StartIngestionJob_RequestSyntax) **
The unique identifier of the knowledge base for the data ingestion job.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_agent_StartIngestionJob_RequestSyntax) **
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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
Type: String
Length Constraints: Minimum length of 33. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}`
Required: No
** [description](#API_agent_StartIngestionJob_RequestSyntax) **
A description of the data ingestion job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"ingestionJob": {
"dataSourceId": "string",
"description": "string",
"failureReasons": [ "string" ],
"ingestionJobId": "string",
"knowledgeBaseId": "string",
"startedAt": "string",
"statistics": {
"numberOfDocumentsDeleted": number,
"numberOfDocumentsFailed": number,
"numberOfDocumentsScanned": number,
"numberOfMetadataDocumentsModified": number,
"numberOfMetadataDocumentsScanned": number,
"numberOfModifiedDocumentsIndexed": number,
"numberOfNewDocumentsIndexed": number
},
"status": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [ingestionJob](#API_agent_StartIngestionJob_ResponseSyntax) **
Contains information about the data ingestion job.
Type: [IngestionJob](API_agent_IngestionJob.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/StartIngestionJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/StartIngestionJob)
# StopIngestionJob
Stops a currently running data ingestion job. You can send a `StartIngestionJob` request again to ingest the rest of your data when you are ready.
## Request Syntax
```
POST /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ingestionJobId/stop HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_StopIngestionJob_RequestSyntax) **
The unique identifier of the data source for the data ingestion job you want to stop.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [ingestionJobId](#API_agent_StopIngestionJob_RequestSyntax) **
The unique identifier of the data ingestion job you want to stop.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_StopIngestionJob_RequestSyntax) **
The unique identifier of the knowledge base for the data ingestion job you want to stop.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"ingestionJob": {
"dataSourceId": "string",
"description": "string",
"failureReasons": [ "string" ],
"ingestionJobId": "string",
"knowledgeBaseId": "string",
"startedAt": "string",
"statistics": {
"numberOfDocumentsDeleted": number,
"numberOfDocumentsFailed": number,
"numberOfDocumentsScanned": number,
"numberOfMetadataDocumentsModified": number,
"numberOfMetadataDocumentsScanned": number,
"numberOfModifiedDocumentsIndexed": number,
"numberOfNewDocumentsIndexed": number
},
"status": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [ingestionJob](#API_agent_StopIngestionJob_ResponseSyntax) **
Contains information about the stopped data ingestion job.
Type: [IngestionJob](API_agent_IngestionJob.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/StopIngestionJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/StopIngestionJob)
# TagResource
Associate tags with a resource. For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_agent_TagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource to tag.
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `.*(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$).*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [tags](#API_agent_TagResource_RequestSyntax) **
An object containing key-value pairs that define the tags to attach to the resource.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of TagResource.
```
POST /tags/arn:aws:bedrock:us-west-2:123456789012:agent/ABCDEFGHIJ HTTP/1.1
Content-type: application/json
{
"tags": {
"cost-center" : "Tech"
}
}
```
### Example response
This example illustrates one usage of TagResource.
```
HTTP/1.1 200
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/TagResource)
# UntagResource
Remove tags from a resource.
## Request Syntax
```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_agent_UntagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource from which to remove tags.
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `.*(^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:(agent|agent-alias|knowledge-base|flow|prompt)/[A-Z0-9]{10}(?:/[A-Z0-9]{10})?$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:flow/([A-Z0-9]{10})/alias/([A-Z0-9]{10})$|^arn:aws:bedrock:[a-zA-Z0-9-]+:/d{12}:prompt/([A-Z0-9]{10})?(?::/d+)?$).*`
Required: Yes
** [tagKeys](#API_agent_UntagResource_RequestSyntax) **
A list of keys of the tags to remove from the resource.
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of UntagResource.
```
DELETE /tags/arn:aws:bedrock:us-west-2:123456789012:agent/ABCDEFGHIJ HTTP/1.1
```
### Example response
This example illustrates one usage of UntagResource.
```
HTTP/1.1 200
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UntagResource)
# UpdateAgent
Updates the configuration of an agent.
## Request Syntax
```
PUT /agents/agentId/ HTTP/1.1
Content-type: application/json
{
"agentCollaboration": "string",
"agentName": "string",
"agentResourceRoleArn": "string",
"customerEncryptionKeyArn": "string",
"customOrchestration": {
"executor": { ... }
},
"description": "string",
"foundationModel": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"idleSessionTTLInSeconds": number,
"instruction": "string",
"memoryConfiguration": {
"enabledMemoryTypes": [ "string" ],
"sessionSummaryConfiguration": {
"maxRecentSessions": number
},
"storageDays": number
},
"orchestrationType": "string",
"promptOverrideConfiguration": {
"overrideLambda": "string",
"promptConfigurations": [
{
"additionalModelRequestFields": JSON value,
"basePromptTemplate": "string",
"foundationModel": "string",
"inferenceConfiguration": {
"maximumLength": number,
"stopSequences": [ "string" ],
"temperature": number,
"topK": number,
"topP": number
},
"parserMode": "string",
"promptCreationMode": "string",
"promptState": "string",
"promptType": "string"
}
]
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_UpdateAgent_RequestSyntax) **
The unique identifier of the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [agentCollaboration](#API_agent_UpdateAgent_RequestSyntax) **
The agent's collaboration role.
Type: String
Valid Values: `SUPERVISOR | SUPERVISOR_ROUTER | DISABLED`
Required: No
** [agentName](#API_agent_UpdateAgent_RequestSyntax) **
Specifies a new name for the agent.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [agentResourceRoleArn](#API_agent_UpdateAgent_RequestSyntax) **
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** [customerEncryptionKeyArn](#API_agent_UpdateAgent_RequestSyntax) **
The Amazon Resource Name (ARN) of the AWS KMS key with which to encrypt the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
Required: No
** [customOrchestration](#API_agent_UpdateAgent_RequestSyntax) **
Contains details of the custom orchestration configured for the agent.
Type: [CustomOrchestration](API_agent_CustomOrchestration.md) object
Required: No
** [description](#API_agent_UpdateAgent_RequestSyntax) **
Specifies a new description of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [foundationModel](#API_agent_UpdateAgent_RequestSyntax) **
The identifier for the model that you want to be used for orchestration by the agent you create.
The `modelId` to provide depends on the type of model or throughput that you use:
+ If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see [Amazon Bedrock base model IDs (on-demand throughput)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide.
+ If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see [Supported Regions and models for cross-region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide.
+ If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see [Run inference using a Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide.
+ If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see [Use a custom model in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide.
+ If you use an [imported model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html), specify the ARN of the imported model. You can get the model ARN from a successful call to [CreateModelImportJob](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html) or from the Imported models page in the Amazon Bedrock console.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?`
Required: Yes
** [guardrailConfiguration](#API_agent_UpdateAgent_RequestSyntax) **
The unique Guardrail configuration assigned to the agent when it is updated.
Type: [GuardrailConfiguration](API_agent_GuardrailConfiguration.md) object
Required: No
** [idleSessionTTLInSeconds](#API_agent_UpdateAgent_RequestSyntax) **
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.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 5400.
Required: No
** [instruction](#API_agent_UpdateAgent_RequestSyntax) **
Specifies new instructions that tell the agent what it should do and how it should interact with users.
Type: String
Length Constraints: Minimum length of 40. Maximum length of 4000.
Required: No
** [memoryConfiguration](#API_agent_UpdateAgent_RequestSyntax) **
Specifies the new memory configuration for the agent.
Type: [MemoryConfiguration](API_agent_MemoryConfiguration.md) object
Required: No
** [orchestrationType](#API_agent_UpdateAgent_RequestSyntax) **
Specifies the type of orchestration strategy for the agent. This is set to `DEFAULT` orchestration type, by default.
Type: String
Valid Values: `DEFAULT | CUSTOM_ORCHESTRATION`
Required: No
** [promptOverrideConfiguration](#API_agent_UpdateAgent_RequestSyntax) **
Contains configurations to override prompts in different parts of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
Type: [PromptOverrideConfiguration](API_agent_PromptOverrideConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"agent": {
"agentArn": "string",
"agentCollaboration": "string",
"agentId": "string",
"agentName": "string",
"agentResourceRoleArn": "string",
"agentStatus": "string",
"agentVersion": "string",
"clientToken": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"customOrchestration": {
"executor": { ... }
},
"description": "string",
"failureReasons": [ "string" ],
"foundationModel": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"idleSessionTTLInSeconds": number,
"instruction": "string",
"memoryConfiguration": {
"enabledMemoryTypes": [ "string" ],
"sessionSummaryConfiguration": {
"maxRecentSessions": number
},
"storageDays": number
},
"orchestrationType": "string",
"preparedAt": "string",
"promptOverrideConfiguration": {
"overrideLambda": "string",
"promptConfigurations": [
{
"additionalModelRequestFields": JSON value,
"basePromptTemplate": "string",
"foundationModel": "string",
"inferenceConfiguration": {
"maximumLength": number,
"stopSequences": [ "string" ],
"temperature": number,
"topK": number,
"topP": number
},
"parserMode": "string",
"promptCreationMode": "string",
"promptState": "string",
"promptType": "string"
}
]
},
"recommendedActions": [ "string" ],
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [agent](#API_agent_UpdateAgent_ResponseSyntax) **
Contains details about the agent that was updated.
Type: [Agent](API_agent_Agent.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of UpdateAgent.
```
PUT /agents/ABCDEFGHIJ/ HTTP/1.1
Content-type: application/json
{
"agentName": "TestName",
"agentResourceRoleArn": "arn:aws:iam::123456789012:role/AmazonBedrockExecutionRoleForAgents_user",
"instruction": "You are an IT agent who solves customer's problems",
"description": "Description is here",
"idleSessionTTLInSeconds": 900,
"foundationModel": "anthropic.claude-v2"
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateAgent)
# UpdateAgentActionGroup
Updates the configuration for an action group for an agent.
## Request Syntax
```
PUT /agents/agentId/agentversions/agentVersion/actiongroups/actionGroupId/ HTTP/1.1
Content-type: application/json
{
"actionGroupExecutor": { ... },
"actionGroupName": "string",
"actionGroupState": "string",
"apiSchema": { ... },
"description": "string",
"functionSchema": { ... },
"parentActionGroupSignature": "string",
"parentActionGroupSignatureParams": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [actionGroupId](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
The unique identifier of the action group.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentId](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
The unique identifier of the agent for which to update the action group.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
The unique identifier of the agent version for which to update the action group.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [actionGroupExecutor](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
Type: [ActionGroupExecutor](API_agent_ActionGroupExecutor.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [actionGroupName](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
Specifies a new name for the action group.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [actionGroupState](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
Specifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
** [apiSchema](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
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](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html).
Type: [APISchema](API_agent_APISchema.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [description](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
Specifies a new name for the action group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [functionSchema](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
Type: [FunctionSchema](API_agent_FunctionSchema.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [parentActionGroupSignature](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
Update the built-in or computer use action for this action group. If you specify a value, you must leave the `description`, `apiSchema`, and `actionGroupExecutor` fields empty for this action group.
+ To allow your agent to request the user for additional information when trying to complete a task, set this field to `AMAZON.UserInput`.
+ To allow your agent to generate, run, and troubleshoot code when trying to complete a task, set this field to `AMAZON.CodeInterpreter`.
+ To allow your agent to use an Anthropic computer use tool, specify one of the following values.
**Important**
Computer use is a new Anthropic Claude model capability (in beta) available with Anthropic Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. When operating computer use functionality, we recommend taking additional security precautions, such as executing computer actions in virtual environments with restricted data access and limited internet connectivity. For more information, see [Configure an Amazon Bedrock Agent to complete tasks with computer use tools](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html).
+ `ANTHROPIC.Computer` - Gives the agent permission to use the mouse and keyboard and take screenshots.
+ `ANTHROPIC.TextEditor` - Gives the agent permission to view, create and edit files.
+ `ANTHROPIC.Bash` - Gives the agent permission to run commands in a bash shell.
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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) reprompting the user for more information.
Type: String
Valid Values: `AMAZON.UserInput | AMAZON.CodeInterpreter | ANTHROPIC.Computer | ANTHROPIC.Bash | ANTHROPIC.TextEditor`
Required: No
** [parentActionGroupSignatureParams](#API_agent_UpdateAgentActionGroup_RequestSyntax) **
The configuration settings for a computer use action.
Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see [Configure an Amazon Bedrock Agent to complete tasks with computer use tools](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html).
Type: String to string map
Key Length Constraints: Minimum length of 0. Maximum length of 100.
Value Length Constraints: Minimum length of 0. Maximum length of 100.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentActionGroup": {
"actionGroupExecutor": { ... },
"actionGroupId": "string",
"actionGroupName": "string",
"actionGroupState": "string",
"agentId": "string",
"agentVersion": "string",
"apiSchema": { ... },
"clientToken": "string",
"createdAt": "string",
"description": "string",
"functionSchema": { ... },
"parentActionGroupSignatureParams": {
"string" : "string"
},
"parentActionSignature": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentActionGroup](#API_agent_UpdateAgentActionGroup_ResponseSyntax) **
Contains details about the action group that was updated.
Type: [AgentActionGroup](API_agent_AgentActionGroup.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of UpdateAgentActionGroup.
```
PUT /agents/AGENT12345/agentversions/1/actiongroups/ACTION1234/ HTTP/1.1
Content-type: application/json
{
"actionGroupName": "bedrock-temp-actions",
"actionGroupState": "ENABLED",
"description": "Testing = latest IT Management action",
"apiSchema": {
"s3": {
"s3BucketName": "apischema-s3",
"s3ObjectKey": "it_agent_openapi.json"
}
},
"actionGroupExecutor": {
"lambda": "arn:aws:lambda:us-west-2:123456789012:function:ItAgentLambda"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateAgentActionGroup)
# UpdateAgentAlias
Updates configurations for an alias of an agent.
## Request Syntax
```
PUT /agents/agentId/agentaliases/agentAliasId/ HTTP/1.1
Content-type: application/json
{
"agentAliasName": "string",
"aliasInvocationState": "string",
"description": "string",
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentAliasId](#API_agent_UpdateAgentAlias_RequestSyntax) **
The unique identifier of the alias.
Length Constraints: Fixed length of 10.
Pattern: `(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [agentId](#API_agent_UpdateAgentAlias_RequestSyntax) **
The unique identifier of the agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [agentAliasName](#API_agent_UpdateAgentAlias_RequestSyntax) **
Specifies a new name for the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [aliasInvocationState](#API_agent_UpdateAgentAlias_RequestSyntax) **
The invocation state for the agent alias. To pause the agent alias, set the value to `REJECT_INVOCATIONS`. To start the agent alias running again, set the value to `ACCEPT_INVOCATIONS`. Use the `GetAgentAlias`, or `ListAgentAliases`, operation to get the invocation state of an agent alias.
Type: String
Valid Values: `ACCEPT_INVOCATIONS | REJECT_INVOCATIONS`
Required: No
** [description](#API_agent_UpdateAgentAlias_RequestSyntax) **
Specifies a new description for the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [routingConfiguration](#API_agent_UpdateAgentAlias_RequestSyntax) **
Contains details about the routing configuration of the alias.
Type: Array of [AgentAliasRoutingConfigurationListItem](API_agent_AgentAliasRoutingConfigurationListItem.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"agentAlias": {
"agentAliasArn": "string",
"agentAliasHistoryEvents": [
{
"endDate": "string",
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
],
"startDate": "string"
}
],
"agentAliasId": "string",
"agentAliasName": "string",
"agentAliasStatus": "string",
"agentId": "string",
"aliasInvocationState": "string",
"clientToken": "string",
"createdAt": "string",
"description": "string",
"failureReasons": [ "string" ],
"routingConfiguration": [
{
"agentVersion": "string",
"provisionedThroughput": "string"
}
],
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [agentAlias](#API_agent_UpdateAgentAlias_ResponseSyntax) **
Contains details about the alias that was updated.
Type: [AgentAlias](API_agent_AgentAlias.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of UpdateAgentAlias.
```
PUT /agents/ABCDEFGHIJ/agentaliases/ABCDEFGHIJ/ HTTP/1.1
Content-type: application/json
{
"agentAliasName": "TestName",
"description": "Updated description",
"routingConfiguration": [
{
"agentVersion": "2"
}
]
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateAgentAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateAgentAlias)
# UpdateAgentCollaborator
Updates an agent's collaborator.
## Request Syntax
```
PUT /agents/agentId/agentversions/agentVersion/agentcollaborators/collaboratorId/ HTTP/1.1
Content-type: application/json
{
"agentDescriptor": {
"aliasArn": "string"
},
"collaborationInstruction": "string",
"collaboratorName": "string",
"relayConversationHistory": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_UpdateAgentCollaborator_RequestSyntax) **
The agent's ID.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_UpdateAgentCollaborator_RequestSyntax) **
The agent's version.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
** [collaboratorId](#API_agent_UpdateAgentCollaborator_RequestSyntax) **
The collaborator's ID.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [agentDescriptor](#API_agent_UpdateAgentCollaborator_RequestSyntax) **
An agent descriptor for the agent collaborator.
Type: [AgentDescriptor](API_agent_AgentDescriptor.md) object
Required: Yes
** [collaborationInstruction](#API_agent_UpdateAgentCollaborator_RequestSyntax) **
Instruction for the collaborator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Required: Yes
** [collaboratorName](#API_agent_UpdateAgentCollaborator_RequestSyntax) **
The collaborator's name.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [relayConversationHistory](#API_agent_UpdateAgentCollaborator_RequestSyntax) **
A relay conversation history for the collaborator.
Type: String
Valid Values: `TO_COLLABORATOR | DISABLED`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentCollaborator": {
"agentDescriptor": {
"aliasArn": "string"
},
"agentId": "string",
"agentVersion": "string",
"clientToken": "string",
"collaborationInstruction": "string",
"collaboratorId": "string",
"collaboratorName": "string",
"createdAt": "string",
"lastUpdatedAt": "string",
"relayConversationHistory": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentCollaborator](#API_agent_UpdateAgentCollaborator_ResponseSyntax) **
Details about the collaborator.
Type: [AgentCollaborator](API_agent_AgentCollaborator.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateAgentCollaborator)
# UpdateAgentKnowledgeBase
Updates the configuration for a knowledge base that has been associated with an agent.
## Request Syntax
```
PUT /agents/agentId/agentversions/agentVersion/knowledgebases/knowledgeBaseId/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"knowledgeBaseState": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentId](#API_agent_UpdateAgentKnowledgeBase_RequestSyntax) **
The unique identifier of the agent associated with the knowledge base that you want to update.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [agentVersion](#API_agent_UpdateAgentKnowledgeBase_RequestSyntax) **
The version of the agent associated with the knowledge base that you want to update.
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
** [knowledgeBaseId](#API_agent_UpdateAgentKnowledgeBase_RequestSyntax) **
The unique identifier of the knowledge base that has been associated with an agent.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_agent_UpdateAgentKnowledgeBase_RequestSyntax) **
Specifies a new description for the knowledge base associated with an agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [knowledgeBaseState](#API_agent_UpdateAgentKnowledgeBase_RequestSyntax) **
Specifies whether the agent uses the knowledge base or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agentKnowledgeBase": {
"agentId": "string",
"agentVersion": "string",
"createdAt": "string",
"description": "string",
"knowledgeBaseId": "string",
"knowledgeBaseState": "string",
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [agentKnowledgeBase](#API_agent_UpdateAgentKnowledgeBase_ResponseSyntax) **
Contains details about the knowledge base that has been associated with an agent.
Type: [AgentKnowledgeBase](API_agent_AgentKnowledgeBase.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase)
# UpdateDataSource
Updates the configurations for a data source connector.
**Important**
You can't change the `chunkingConfiguration` after you create the data source connector. Specify the existing `chunkingConfiguration`.
## Request Syntax
```
PUT /knowledgebases/knowledgeBaseId/datasources/dataSourceId HTTP/1.1
Content-type: application/json
{
"dataDeletionPolicy": "string",
"dataSourceConfiguration": {
"confluenceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostType": "string",
"hostUrl": "string"
}
},
"s3Configuration": {
"bucketArn": "string",
"bucketOwnerAccountId": "string",
"inclusionPrefixes": [ "string" ]
},
"salesforceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostUrl": "string"
}
},
"sharePointConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"domain": "string",
"hostType": "string",
"siteUrls": [ "string" ],
"tenantId": "string"
}
},
"type": "string",
"webConfiguration": {
"crawlerConfiguration": {
"crawlerLimits": {
"maxPages": number,
"rateLimit": number
},
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"scope": "string",
"userAgent": "string",
"userAgentHeader": "string"
},
"sourceConfiguration": {
"urlConfiguration": {
"seedUrls": [
{
"url": "string"
}
]
}
}
}
},
"description": "string",
"name": "string",
"serverSideEncryptionConfiguration": {
"kmsKeyArn": "string"
},
"vectorIngestionConfiguration": {
"chunkingConfiguration": {
"chunkingStrategy": "string",
"fixedSizeChunkingConfiguration": {
"maxTokens": number,
"overlapPercentage": number
},
"hierarchicalChunkingConfiguration": {
"levelConfigurations": [
{
"maxTokens": number
}
],
"overlapTokens": number
},
"semanticChunkingConfiguration": {
"breakpointPercentileThreshold": number,
"bufferSize": number,
"maxTokens": number
}
},
"contextEnrichmentConfiguration": {
"bedrockFoundationModelConfiguration": {
"enrichmentStrategyConfiguration": {
"method": "string"
},
"modelArn": "string"
},
"type": "string"
},
"customTransformationConfiguration": {
"intermediateStorage": {
"s3Location": {
"uri": "string"
}
},
"transformations": [
{
"stepToApply": "string",
"transformationFunction": {
"transformationLambdaConfiguration": {
"lambdaArn": "string"
}
}
}
]
},
"parsingConfiguration": {
"bedrockDataAutomationConfiguration": {
"parsingModality": "string"
},
"bedrockFoundationModelConfiguration": {
"modelArn": "string",
"parsingModality": "string",
"parsingPrompt": {
"parsingPromptText": "string"
}
},
"parsingStrategy": "string"
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [dataSourceId](#API_agent_UpdateDataSource_RequestSyntax) **
The unique identifier of the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** [knowledgeBaseId](#API_agent_UpdateDataSource_RequestSyntax) **
The unique identifier of the knowledge base for the data source.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [dataDeletionPolicy](#API_agent_UpdateDataSource_RequestSyntax) **
The data deletion policy for the data source that you want to update.
Type: String
Valid Values: `RETAIN | DELETE`
Required: No
** [dataSourceConfiguration](#API_agent_UpdateDataSource_RequestSyntax) **
The connection configuration for the data source that you want to update.
Type: [DataSourceConfiguration](API_agent_DataSourceConfiguration.md) object
Required: Yes
** [description](#API_agent_UpdateDataSource_RequestSyntax) **
Specifies a new description for the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [name](#API_agent_UpdateDataSource_RequestSyntax) **
Specifies a new name for the data source.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [serverSideEncryptionConfiguration](#API_agent_UpdateDataSource_RequestSyntax) **
Contains details about server-side encryption of the data source.
Type: [ServerSideEncryptionConfiguration](API_agent_ServerSideEncryptionConfiguration.md) object
Required: No
** [vectorIngestionConfiguration](#API_agent_UpdateDataSource_RequestSyntax) **
Contains details about how to ingest the documents in the data source.
Type: [VectorIngestionConfiguration](API_agent_VectorIngestionConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"dataSource": {
"createdAt": "string",
"dataDeletionPolicy": "string",
"dataSourceConfiguration": {
"confluenceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostType": "string",
"hostUrl": "string"
}
},
"s3Configuration": {
"bucketArn": "string",
"bucketOwnerAccountId": "string",
"inclusionPrefixes": [ "string" ]
},
"salesforceConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"hostUrl": "string"
}
},
"sharePointConfiguration": {
"crawlerConfiguration": {
"filterConfiguration": {
"patternObjectFilter": {
"filters": [
{
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"objectType": "string"
}
]
},
"type": "string"
}
},
"sourceConfiguration": {
"authType": "string",
"credentialsSecretArn": "string",
"domain": "string",
"hostType": "string",
"siteUrls": [ "string" ],
"tenantId": "string"
}
},
"type": "string",
"webConfiguration": {
"crawlerConfiguration": {
"crawlerLimits": {
"maxPages": number,
"rateLimit": number
},
"exclusionFilters": [ "string" ],
"inclusionFilters": [ "string" ],
"scope": "string",
"userAgent": "string",
"userAgentHeader": "string"
},
"sourceConfiguration": {
"urlConfiguration": {
"seedUrls": [
{
"url": "string"
}
]
}
}
}
},
"dataSourceId": "string",
"description": "string",
"failureReasons": [ "string" ],
"knowledgeBaseId": "string",
"name": "string",
"serverSideEncryptionConfiguration": {
"kmsKeyArn": "string"
},
"status": "string",
"updatedAt": "string",
"vectorIngestionConfiguration": {
"chunkingConfiguration": {
"chunkingStrategy": "string",
"fixedSizeChunkingConfiguration": {
"maxTokens": number,
"overlapPercentage": number
},
"hierarchicalChunkingConfiguration": {
"levelConfigurations": [
{
"maxTokens": number
}
],
"overlapTokens": number
},
"semanticChunkingConfiguration": {
"breakpointPercentileThreshold": number,
"bufferSize": number,
"maxTokens": number
}
},
"contextEnrichmentConfiguration": {
"bedrockFoundationModelConfiguration": {
"enrichmentStrategyConfiguration": {
"method": "string"
},
"modelArn": "string"
},
"type": "string"
},
"customTransformationConfiguration": {
"intermediateStorage": {
"s3Location": {
"uri": "string"
}
},
"transformations": [
{
"stepToApply": "string",
"transformationFunction": {
"transformationLambdaConfiguration": {
"lambdaArn": "string"
}
}
}
]
},
"parsingConfiguration": {
"bedrockDataAutomationConfiguration": {
"parsingModality": "string"
},
"bedrockFoundationModelConfiguration": {
"modelArn": "string",
"parsingModality": "string",
"parsingPrompt": {
"parsingPromptText": "string"
}
},
"parsingStrategy": "string"
}
}
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [dataSource](#API_agent_UpdateDataSource_ResponseSyntax) **
Contains details about the data source.
Type: [DataSource](API_agent_DataSource.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateDataSource)
# UpdateFlow
Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see [How it works](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html) and [Create a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
PUT /flows/flowIdentifier/ HTTP/1.1
Content-type: application/json
{
"customerEncryptionKeyArn": "string",
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"category": "string",
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
},
"description": "string",
"executionRoleArn": "string",
"name": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowIdentifier](#API_agent_UpdateFlow_RequestSyntax) **
The unique identifier of the flow.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [customerEncryptionKeyArn](#API_agent_UpdateFlow_RequestSyntax) **
The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
Required: No
** [definition](#API_agent_UpdateFlow_RequestSyntax) **
A definition of the nodes and the connections between the nodes in the flow.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
Required: No
** [description](#API_agent_UpdateFlow_RequestSyntax) **
A description for the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [executionRoleArn](#API_agent_UpdateFlow_RequestSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+`
Required: Yes
** [name](#API_agent_UpdateFlow_RequestSyntax) **
A name for the flow.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"category": "string",
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
},
"description": "string",
"executionRoleArn": "string",
"id": "string",
"name": "string",
"status": "string",
"updatedAt": "string",
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_UpdateFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}`
** [createdAt](#API_agent_UpdateFlow_ResponseSyntax) **
The time at which the flow was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_UpdateFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key that the flow was encrypted with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [definition](#API_agent_UpdateFlow_ResponseSyntax) **
A definition of the nodes and the connections between nodes in the flow.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
** [description](#API_agent_UpdateFlow_ResponseSyntax) **
The description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [executionRoleArn](#API_agent_UpdateFlow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to create a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+`
** [id](#API_agent_UpdateFlow_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_UpdateFlow_ResponseSyntax) **
The name of the flow.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [status](#API_agent_UpdateFlow_ResponseSyntax) **
The status of the flow. When you submit this request, the status will be `NotPrepared`. If updating fails, the status becomes `Failed`.
Type: String
Valid Values: `Failed | Prepared | Preparing | NotPrepared`
** [updatedAt](#API_agent_UpdateFlow_ResponseSyntax) **
The time at which the flow was last updated.
Type: Timestamp
** [version](#API_agent_UpdateFlow_ResponseSyntax) **
The version of the flow. When you update a flow, the version updated is the `DRAFT` version.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateFlow)
# UpdateFlowAlias
Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
PUT /flows/flowIdentifier/aliases/aliasIdentifier HTTP/1.1
Content-type: application/json
{
"concurrencyConfiguration": {
"maxConcurrency": number,
"type": "string"
},
"description": "string",
"name": "string",
"routingConfiguration": [
{
"flowVersion": "string"
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [aliasIdentifier](#API_agent_UpdateFlowAlias_RequestSyntax) **
The unique identifier of the alias.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(TSTALIASID|[0-9a-zA-Z]{10})`
Required: Yes
** [flowIdentifier](#API_agent_UpdateFlowAlias_RequestSyntax) **
The unique identifier of the flow.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [concurrencyConfiguration](#API_agent_UpdateFlowAlias_RequestSyntax) **
The configuration that specifies how nodes in the flow are executed in parallel.
Type: [FlowAliasConcurrencyConfiguration](API_agent_FlowAliasConcurrencyConfiguration.md) object
Required: No
** [description](#API_agent_UpdateFlowAlias_RequestSyntax) **
A description for the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [name](#API_agent_UpdateFlowAlias_RequestSyntax) **
The name of the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [routingConfiguration](#API_agent_UpdateFlowAlias_RequestSyntax) **
Contains information about the version to which to map the alias.
Type: Array of [FlowAliasRoutingConfigurationListItem](API_agent_FlowAliasRoutingConfigurationListItem.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"concurrencyConfiguration": {
"maxConcurrency": number,
"type": "string"
},
"createdAt": "string",
"description": "string",
"flowId": "string",
"id": "string",
"name": "string",
"routingConfiguration": [
{
"flowVersion": "string"
}
],
"updatedAt": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_UpdateFlowAlias_ResponseSyntax) **
The Amazon Resource Name (ARN) of the flow.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/(TSTALIASID|[0-9a-zA-Z]{10})`
** [concurrencyConfiguration](#API_agent_UpdateFlowAlias_ResponseSyntax) **
The configuration that specifies how nodes in the flow are executed in parallel.
Type: [FlowAliasConcurrencyConfiguration](API_agent_FlowAliasConcurrencyConfiguration.md) object
** [createdAt](#API_agent_UpdateFlowAlias_ResponseSyntax) **
The time at which the flow was created.
Type: Timestamp
** [description](#API_agent_UpdateFlowAlias_ResponseSyntax) **
The description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [flowId](#API_agent_UpdateFlowAlias_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [id](#API_agent_UpdateFlowAlias_ResponseSyntax) **
The unique identifier of the alias.
Type: String
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})`
** [name](#API_agent_UpdateFlowAlias_ResponseSyntax) **
The name of the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [routingConfiguration](#API_agent_UpdateFlowAlias_ResponseSyntax) **
Contains information about the version that the alias is mapped to.
Type: Array of [FlowAliasRoutingConfigurationListItem](API_agent_FlowAliasRoutingConfigurationListItem.md) objects
Array Members: Fixed number of 1 item.
** [updatedAt](#API_agent_UpdateFlowAlias_ResponseSyntax) **
The time at which the alias was last updated.
Type: Timestamp
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateFlowAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateFlowAlias)
# UpdateKnowledgeBase
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:
+ `name`
+ `description`
+ `roleArn`
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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html) request and copy the same configurations.
## Request Syntax
```
PUT /knowledgebases/knowledgeBaseId HTTP/1.1
Content-type: application/json
{
"description": "string",
"knowledgeBaseConfiguration": {
"kendraKnowledgeBaseConfiguration": {
"kendraIndexArn": "string"
},
"sqlKnowledgeBaseConfiguration": {
"redshiftConfiguration": {
"queryEngineConfiguration": {
"provisionedConfiguration": {
"authConfiguration": {
"databaseUser": "string",
"type": "string",
"usernamePasswordSecretArn": "string"
},
"clusterIdentifier": "string"
},
"serverlessConfiguration": {
"authConfiguration": {
"type": "string",
"usernamePasswordSecretArn": "string"
},
"workgroupArn": "string"
},
"type": "string"
},
"queryGenerationConfiguration": {
"executionTimeoutSeconds": number,
"generationContext": {
"curatedQueries": [
{
"naturalLanguage": "string",
"sql": "string"
}
],
"tables": [
{
"columns": [
{
"description": "string",
"inclusion": "string",
"name": "string"
}
],
"description": "string",
"inclusion": "string",
"name": "string"
}
]
}
},
"storageConfigurations": [
{
"awsDataCatalogConfiguration": {
"tableNames": [ "string" ]
},
"redshiftConfiguration": {
"databaseName": "string"
},
"type": "string"
}
]
},
"type": "string"
},
"type": "string",
"vectorKnowledgeBaseConfiguration": {
"embeddingModelArn": "string",
"embeddingModelConfiguration": {
"bedrockEmbeddingModelConfiguration": {
"audio": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
],
"dimensions": number,
"embeddingDataType": "string",
"video": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
]
}
},
"supplementalDataStorageConfiguration": {
"storageLocations": [
{
"s3Location": {
"uri": "string"
},
"type": "string"
}
]
}
}
},
"name": "string",
"roleArn": "string",
"storageConfiguration": {
"mongoDbAtlasConfiguration": {
"collectionName": "string",
"credentialsSecretArn": "string",
"databaseName": "string",
"endpoint": "string",
"endpointServiceName": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"textIndexName": "string",
"vectorIndexName": "string"
},
"neptuneAnalyticsConfiguration": {
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"graphArn": "string"
},
"opensearchManagedClusterConfiguration": {
"domainArn": "string",
"domainEndpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"opensearchServerlessConfiguration": {
"collectionArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"pineconeConfiguration": {
"connectionString": "string",
"credentialsSecretArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"namespace": "string"
},
"rdsConfiguration": {
"credentialsSecretArn": "string",
"databaseName": "string",
"fieldMapping": {
"customMetadataField": "string",
"metadataField": "string",
"primaryKeyField": "string",
"textField": "string",
"vectorField": "string"
},
"resourceArn": "string",
"tableName": "string"
},
"redisEnterpriseCloudConfiguration": {
"credentialsSecretArn": "string",
"endpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"s3VectorsConfiguration": {
"indexArn": "string",
"indexName": "string",
"vectorBucketArn": "string"
},
"type": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [knowledgeBaseId](#API_agent_UpdateKnowledgeBase_RequestSyntax) **
The unique identifier of the knowledge base to update.
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_agent_UpdateKnowledgeBase_RequestSyntax) **
Specifies a new description for the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [knowledgeBaseConfiguration](#API_agent_UpdateKnowledgeBase_RequestSyntax) **
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.
Type: [KnowledgeBaseConfiguration](API_agent_KnowledgeBaseConfiguration.md) object
Required: Yes
** [name](#API_agent_UpdateKnowledgeBase_RequestSyntax) **
Specifies a new name for the knowledge base.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [roleArn](#API_agent_UpdateKnowledgeBase_RequestSyntax) **
Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** [storageConfiguration](#API_agent_UpdateKnowledgeBase_RequestSyntax) **
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.
Type: [StorageConfiguration](API_agent_StorageConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"knowledgeBase": {
"createdAt": "string",
"description": "string",
"failureReasons": [ "string" ],
"knowledgeBaseArn": "string",
"knowledgeBaseConfiguration": {
"kendraKnowledgeBaseConfiguration": {
"kendraIndexArn": "string"
},
"sqlKnowledgeBaseConfiguration": {
"redshiftConfiguration": {
"queryEngineConfiguration": {
"provisionedConfiguration": {
"authConfiguration": {
"databaseUser": "string",
"type": "string",
"usernamePasswordSecretArn": "string"
},
"clusterIdentifier": "string"
},
"serverlessConfiguration": {
"authConfiguration": {
"type": "string",
"usernamePasswordSecretArn": "string"
},
"workgroupArn": "string"
},
"type": "string"
},
"queryGenerationConfiguration": {
"executionTimeoutSeconds": number,
"generationContext": {
"curatedQueries": [
{
"naturalLanguage": "string",
"sql": "string"
}
],
"tables": [
{
"columns": [
{
"description": "string",
"inclusion": "string",
"name": "string"
}
],
"description": "string",
"inclusion": "string",
"name": "string"
}
]
}
},
"storageConfigurations": [
{
"awsDataCatalogConfiguration": {
"tableNames": [ "string" ]
},
"redshiftConfiguration": {
"databaseName": "string"
},
"type": "string"
}
]
},
"type": "string"
},
"type": "string",
"vectorKnowledgeBaseConfiguration": {
"embeddingModelArn": "string",
"embeddingModelConfiguration": {
"bedrockEmbeddingModelConfiguration": {
"audio": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
],
"dimensions": number,
"embeddingDataType": "string",
"video": [
{
"segmentationConfiguration": {
"fixedLengthDuration": number
}
}
]
}
},
"supplementalDataStorageConfiguration": {
"storageLocations": [
{
"s3Location": {
"uri": "string"
},
"type": "string"
}
]
}
}
},
"knowledgeBaseId": "string",
"name": "string",
"roleArn": "string",
"status": "string",
"storageConfiguration": {
"mongoDbAtlasConfiguration": {
"collectionName": "string",
"credentialsSecretArn": "string",
"databaseName": "string",
"endpoint": "string",
"endpointServiceName": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"textIndexName": "string",
"vectorIndexName": "string"
},
"neptuneAnalyticsConfiguration": {
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"graphArn": "string"
},
"opensearchManagedClusterConfiguration": {
"domainArn": "string",
"domainEndpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"opensearchServerlessConfiguration": {
"collectionArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"pineconeConfiguration": {
"connectionString": "string",
"credentialsSecretArn": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string"
},
"namespace": "string"
},
"rdsConfiguration": {
"credentialsSecretArn": "string",
"databaseName": "string",
"fieldMapping": {
"customMetadataField": "string",
"metadataField": "string",
"primaryKeyField": "string",
"textField": "string",
"vectorField": "string"
},
"resourceArn": "string",
"tableName": "string"
},
"redisEnterpriseCloudConfiguration": {
"credentialsSecretArn": "string",
"endpoint": "string",
"fieldMapping": {
"metadataField": "string",
"textField": "string",
"vectorField": "string"
},
"vectorIndexName": "string"
},
"s3VectorsConfiguration": {
"indexArn": "string",
"indexName": "string",
"vectorBucketArn": "string"
},
"type": "string"
},
"updatedAt": "string"
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
** [knowledgeBase](#API_agent_UpdateKnowledgeBase_ResponseSyntax) **
Contains details about the knowledge base.
Type: [KnowledgeBase](API_agent_KnowledgeBase.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdateKnowledgeBase)
# UpdatePrompt
Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see [Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html) and [Edit prompts in your prompt library](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-manage.html#prompt-management-edit) in the Amazon Bedrock User Guide.
## Request Syntax
```
PUT /prompts/promptIdentifier/ HTTP/1.1
Content-type: application/json
{
"customerEncryptionKeyArn": "string",
"defaultVariant": "string",
"description": "string",
"name": "string",
"variants": [
{
"additionalModelRequestFields": JSON value,
"genAiResource": { ... },
"inferenceConfiguration": { ... },
"metadata": [
{
"key": "string",
"value": "string"
}
],
"modelId": "string",
"name": "string",
"templateConfiguration": { ... },
"templateType": "string"
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [promptIdentifier](#API_agent_UpdatePrompt_RequestSyntax) **
The unique identifier of the prompt.
Pattern: `([0-9a-zA-Z]{10})|(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})(?::[0-9]{1,5})?`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [customerEncryptionKeyArn](#API_agent_UpdatePrompt_RequestSyntax) **
The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
Required: No
** [defaultVariant](#API_agent_UpdatePrompt_RequestSyntax) **
The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** [description](#API_agent_UpdatePrompt_RequestSyntax) **
A description for the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [name](#API_agent_UpdatePrompt_RequestSyntax) **
A name for the prompt.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** [variants](#API_agent_UpdatePrompt_RequestSyntax) **
A list of objects, each containing details about a variant of the prompt.
Type: Array of [PromptVariant](API_agent_PromptVariant.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"createdAt": "string",
"customerEncryptionKeyArn": "string",
"defaultVariant": "string",
"description": "string",
"id": "string",
"name": "string",
"updatedAt": "string",
"variants": [
{
"additionalModelRequestFields": JSON value,
"genAiResource": { ... },
"inferenceConfiguration": { ... },
"metadata": [
{
"key": "string",
"value": "string"
}
],
"modelId": "string",
"name": "string",
"templateConfiguration": { ... },
"templateType": "string"
}
],
"version": "string"
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [arn](#API_agent_UpdatePrompt_ResponseSyntax) **
The Amazon Resource Name (ARN) of the prompt.
Type: String
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)`
** [createdAt](#API_agent_UpdatePrompt_ResponseSyntax) **
The time at which the prompt was created.
Type: Timestamp
** [customerEncryptionKeyArn](#API_agent_UpdatePrompt_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [defaultVariant](#API_agent_UpdatePrompt_ResponseSyntax) **
The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [description](#API_agent_UpdatePrompt_ResponseSyntax) **
The description of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [id](#API_agent_UpdatePrompt_ResponseSyntax) **
The unique identifier of the prompt.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
** [name](#API_agent_UpdatePrompt_ResponseSyntax) **
The name of the prompt.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
** [updatedAt](#API_agent_UpdatePrompt_ResponseSyntax) **
The time at which the prompt was last updated.
Type: Timestamp
** [variants](#API_agent_UpdatePrompt_ResponseSyntax) **
A list of objects, each containing details about a variant of the prompt.
Type: Array of [PromptVariant](API_agent_PromptVariant.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
** [version](#API_agent_UpdatePrompt_ResponseSyntax) **
The version of the prompt. When you update a prompt, the version updated is the `DRAFT` version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 402
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/UpdatePrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UpdatePrompt)
# ValidateFlowDefinition
Validates the definition of a flow.
## Request Syntax
```
POST /flows/validate-definition HTTP/1.1
Content-type: application/json
{
"definition": {
"connections": [
{
"configuration": { ... },
"name": "string",
"source": "string",
"target": "string",
"type": "string"
}
],
"nodes": [
{
"configuration": { ... },
"inputs": [
{
"category": "string",
"expression": "string",
"name": "string",
"type": "string"
}
],
"name": "string",
"outputs": [
{
"name": "string",
"type": "string"
}
],
"type": "string"
}
]
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [definition](#API_agent_ValidateFlowDefinition_RequestSyntax) **
The definition of a flow to validate.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"validations": [
{
"details": { ... },
"message": "string",
"severity": "string",
"type": "string"
}
]
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
** [validations](#API_agent_ValidateFlowDefinition_ResponseSyntax) **
Contains an array of objects, each of which contains an error identified by validation.
Type: Array of [FlowValidation](API_agent_FlowValidation.md) objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because of missing access permissions.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
** fieldList **
A list of objects containing fields that caused validation errors and their corresponding validation error messages.
HTTP Status Code: 400
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-2023-06-05/ValidateFlowDefinition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ValidateFlowDefinition)