# Amazon Bedrock API Reference
This document provides detailed information about the Bedrock API actions and their parameters. For more information about setting up the Amazon Bedrock APIs, see [Set up the Amazon Bedrock API](https://docs.aws.amazon.com/bedrock/latest/userguide/api-setup.html).
## Amazon Bedrock endpoints
To connect programmatically to an AWS service, you use an endpoint. Refer to the [Amazon Bedrock endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/bedrock.html) chapter in the AWS General Reference for information about the endpoints that you can use for Amazon Bedrock.
Amazon Bedrock provides the following service endpoints.
+ `bedrock` – Contains control plane APIs for managing, training, and deploying models. For more information, see [Amazon Bedrock Actions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Operations_Amazon_Bedrock.html) and [Amazon Bedrock Data Types](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Types_Amazon_Bedrock.html).
+ `bedrock-runtime` – Contains data plane APIs for making inference requests for models hosted in Amazon Bedrock. For more information, see [Amazon Bedrock Runtime Actions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Operations_Amazon_Bedrock_Runtime.html) and [Amazon Bedrock Runtime Data Types](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Types_Amazon_Bedrock_Runtime.html).
+ `bedrock-agent` – Contains control plane APIs for creating and managing agents, knowledge bases, prompt management, and prompt flows. For more information, see [Amazon Bedrock Agents Actions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Operations_Amazon_Bedrock_Agents.html) and [Amazon Bedrock Agents Data Types](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Types_Amazon_Bedrock_Agents.html).
+ `bedrock-agent-runtime` – Contains data plane APIs for invoking agents and flows, and querying knowledge bases. For more information, see [Amazon Bedrock Agents Runtime Actions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Operations_Amazon_Bedrock_Agents_Runtime.html) and [Amazon Bedrock Agents Runtime Data Types](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_Types_Amazon_Bedrock_Agents_Runtime.html).
**Note**
Check that you're using the correct endpoint when making an API request.
## AWS Command Line Interface references
Refer to the following references for AWS CLI commands and operations:
+ [Amazon Bedrock CLI commands](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/bedrock/index.html)
+ [Amazon Bedrock Runtime CLI commands](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/bedrock-runtime/index.html)
+ [Amazon Bedrock Agents CLI commands](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/bedrock-agent/index.html)
+ [Amazon Bedrock Agents Runtime CLI commands](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/bedrock-agent-runtime/index.html)
## AWS SDK references
AWS software development kits (SDKs) are available for many popular programming languages. Each SDK provides an API, code examples, and documentation that make it easier for developers to build applications in their preferred language. SDKs automatically perform useful tasks for you, such as:
+ Cryptographically sign your service requests
+ Retry requests
+ Handle error responses
Refer to the following table to find general information about and code examples for each SDK, as well as the Amazon Bedrock API references for each SDK. You can also find code examples at [Code examples for Amazon Bedrock using AWS SDKs](https://docs.aws.amazon.com/bedrock/latest/userguide/service_code_examples.html).
****
| SDK documentation | Code examples | Amazon Bedrock prefix | Amazon Bedrock runtime prefix | Amazon Bedrock Agents prefix | Amazon Bedrock Agents runtime prefix |
| --- | --- | --- | --- | --- | --- |
| [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/sdk-for-cpp) | [AWS SDK for C\$1\$1 code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/cpp) | [bedrock](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-bedrock/html/annotated.html) | [bedrock-runtime](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-bedrock-runtime/html/annotated.html) | [bedrock-agent](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-bedrock-agent/html/annotated.html) | [bedrock-agent-runtime](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-bedrock-agent-runtime/html/annotated.html) |
| [AWS SDK for Go](https://docs.aws.amazon.com/sdk-for-go) | [AWS SDK for Go code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/gov2) | [bedrock](https://docs.aws.amazon.com/sdk-for-go/api/service/bedrock/) | [bedrockruntime](https://docs.aws.amazon.com/sdk-for-go/api/service/bedrockruntime/) | [bedrockagent](https://docs.aws.amazon.com/sdk-for-go/api/service/bedrockagent/) | [bedrockagentruntime](https://docs.aws.amazon.com/sdk-for-go/api/service/bedrockagentruntime/) |
| [AWS SDK for Java](https://docs.aws.amazon.com/sdk-for-java) | [AWS SDK for Java code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2) | [bedrock](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrock/package-summary.html) | [bedrockruntime](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockruntime/package-summary.html) | [bedrockagent](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagent/package-summary.html) | [bedrockagentruntime](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/bedrockagentruntime/package-summary.html) |
| [AWS SDK for JavaScript](https://docs.aws.amazon.com/sdk-for-javascript) | [AWS SDK for JavaScript code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3) | [bedrock](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock/) | [bedrock-runtime](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-runtime/) | [bedrock-agent](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/) | [bedrock-agent-runtime](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent-runtime/) |
| [AWS SDK for Kotlin](https://docs.aws.amazon.com/sdk-for-kotlin) | [AWS SDK for Kotlin code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin) | [bedrock](https://sdk.amazonaws.com/kotlin/api/latest/bedrock/index.html) | [bedrockruntime](https://sdk.amazonaws.com/kotlin/api/latest/bedrockruntime/index.html) | [bedrockagent](https://sdk.amazonaws.com/kotlin/api/latest/bedrockagent/index.html) | [bedrockagentruntime](https://sdk.amazonaws.com/kotlin/api/latest/bedrockagentruntime/index.html) |
| [AWS SDK for .NET](https://docs.aws.amazon.com/sdk-for-net) | [AWS SDK for .NET code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv3) | [Bedrock](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/Bedrock/NBedrock.html) | [BedrockRuntime](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/BedrockRuntime/NBedrockRuntime.html) | [BedrockAgent](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/BedrockAgent/NBedrockAgent.html) | [BedrockAgentRuntime](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/BedrockAgentRuntime/NBedrockAgentRuntime.html) |
| [AWS SDK for PHP](https://docs.aws.amazon.com/sdk-for-php) | [AWS SDK for PHP code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/php) | [Bedrock](https://docs.aws.amazon.com/aws-sdk-php/v3/api/namespace-Aws.Bedrock.html) | [BedrockRuntime](https://docs.aws.amazon.com/aws-sdk-php/v3/api/namespace-Aws.BedrockRuntime.html) | [BedrockAgent](https://docs.aws.amazon.com/aws-sdk-php/v3/api/namespace-Aws.BedrockAgent.html) | [BedrockAgentRuntime](https://docs.aws.amazon.com/aws-sdk-php/v3/api/namespace-Aws.BedrockAgentRuntime.html) |
| [AWS SDK for Python (Boto3)](https://docs.aws.amazon.com/pythonsdk) | [AWS SDK for Python (Boto3) code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python) | [bedrock](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/bedrock.html) | [bedrock-runtime](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/bedrock-runtime.html) | [bedrock-agent](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/bedrock-agent.html) | [bedrock-agent-runtime](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/bedrock-agent-runtime.html) |
| [AWS SDK for Ruby](https://docs.aws.amazon.com/sdk-for-ruby) | [AWS SDK for Ruby code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby) | [Bedrock](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Bedrock.html) | [BedrockRuntime](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockRuntime.html) | [BedrockAgent](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent.html) | [BedrockAgentRuntime](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent.html) |
| [AWS SDK for Rust](https://docs.aws.amazon.com/sdk-for-rust) | [AWS SDK for Rust code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/rust_dev_preview) | [aws-sdk-bedrock](https://docs.rs/aws-sdk-bedrock/latest/aws_sdk_bedrock/) | [aws-sdk-bedrockruntime](https://docs.rs/aws-sdk-bedrockruntime/latest/aws_sdk_bedrockruntime/) | [aws-sdk-bedrockagent](https://docs.rs/aws-sdk-bedrockagent/latest/aws_sdk_bedrockagent/) | [aws-sdk-bedrockagentruntime](https://docs.rs/aws-sdk-bedrockagentruntime/latest/aws_sdk_bedrockagentruntime/) |
| [AWS SDK for SAP ABAP](https://docs.aws.amazon.com/sdk-for-sapabap) | [AWS SDK for SAP ABAP code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap) | [BDK](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/bdk/index.html) | [BDR](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/bdr/index.html) | [BDA](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/bda/index.html) | [BDZ](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/bdz/index.html) |
| [AWS SDK for Swift](https://docs.aws.amazon.com/sdk-for-swift) | [AWS SDK for Swift code examples](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/swift) | [AWSBedrock](https://sdk.amazonaws.com/swift/api/awsbedrock/0.34.0/documentation/awsbedrock) | [AWSBedrockRuntime](https://sdk.amazonaws.com/swift/api/awsbedrockruntime/0.34.0/documentation/awsbedrockruntime) | [AWSBedrockAgent](https://sdk.amazonaws.com/swift/api/awsbedrockagent/0.34.0/documentation/awsbedrockagent) | [AWSBedrockAgentRuntime](https://sdk.amazonaws.com/swift/api/awsbedrockagentruntime/0.34.0/documentation/awsbedrockagentruntime) |
**Topics**
# Actions
The following actions are supported by Amazon Bedrock:
+ [BatchDeleteEvaluationJob](API_BatchDeleteEvaluationJob.md)
+ [CancelAutomatedReasoningPolicyBuildWorkflow](API_CancelAutomatedReasoningPolicyBuildWorkflow.md)
+ [CreateAutomatedReasoningPolicy](API_CreateAutomatedReasoningPolicy.md)
+ [CreateAutomatedReasoningPolicyTestCase](API_CreateAutomatedReasoningPolicyTestCase.md)
+ [CreateAutomatedReasoningPolicyVersion](API_CreateAutomatedReasoningPolicyVersion.md)
+ [CreateCustomModel](API_CreateCustomModel.md)
+ [CreateCustomModelDeployment](API_CreateCustomModelDeployment.md)
+ [CreateEvaluationJob](API_CreateEvaluationJob.md)
+ [CreateFoundationModelAgreement](API_CreateFoundationModelAgreement.md)
+ [CreateGuardrail](API_CreateGuardrail.md)
+ [CreateGuardrailVersion](API_CreateGuardrailVersion.md)
+ [CreateInferenceProfile](API_CreateInferenceProfile.md)
+ [CreateMarketplaceModelEndpoint](API_CreateMarketplaceModelEndpoint.md)
+ [CreateModelCopyJob](API_CreateModelCopyJob.md)
+ [CreateModelCustomizationJob](API_CreateModelCustomizationJob.md)
+ [CreateModelImportJob](API_CreateModelImportJob.md)
+ [CreateModelInvocationJob](API_CreateModelInvocationJob.md)
+ [CreatePromptRouter](API_CreatePromptRouter.md)
+ [CreateProvisionedModelThroughput](API_CreateProvisionedModelThroughput.md)
+ [DeleteAutomatedReasoningPolicy](API_DeleteAutomatedReasoningPolicy.md)
+ [DeleteAutomatedReasoningPolicyBuildWorkflow](API_DeleteAutomatedReasoningPolicyBuildWorkflow.md)
+ [DeleteAutomatedReasoningPolicyTestCase](API_DeleteAutomatedReasoningPolicyTestCase.md)
+ [DeleteCustomModel](API_DeleteCustomModel.md)
+ [DeleteCustomModelDeployment](API_DeleteCustomModelDeployment.md)
+ [DeleteEnforcedGuardrailConfiguration](API_DeleteEnforcedGuardrailConfiguration.md)
+ [DeleteFoundationModelAgreement](API_DeleteFoundationModelAgreement.md)
+ [DeleteGuardrail](API_DeleteGuardrail.md)
+ [DeleteImportedModel](API_DeleteImportedModel.md)
+ [DeleteInferenceProfile](API_DeleteInferenceProfile.md)
+ [DeleteMarketplaceModelEndpoint](API_DeleteMarketplaceModelEndpoint.md)
+ [DeleteModelInvocationLoggingConfiguration](API_DeleteModelInvocationLoggingConfiguration.md)
+ [DeletePromptRouter](API_DeletePromptRouter.md)
+ [DeleteProvisionedModelThroughput](API_DeleteProvisionedModelThroughput.md)
+ [DeleteResourcePolicy](API_DeleteResourcePolicy.md)
+ [DeregisterMarketplaceModelEndpoint](API_DeregisterMarketplaceModelEndpoint.md)
+ [ExportAutomatedReasoningPolicyVersion](API_ExportAutomatedReasoningPolicyVersion.md)
+ [GetAutomatedReasoningPolicy](API_GetAutomatedReasoningPolicy.md)
+ [GetAutomatedReasoningPolicyAnnotations](API_GetAutomatedReasoningPolicyAnnotations.md)
+ [GetAutomatedReasoningPolicyBuildWorkflow](API_GetAutomatedReasoningPolicyBuildWorkflow.md)
+ [GetAutomatedReasoningPolicyBuildWorkflowResultAssets](API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets.md)
+ [GetAutomatedReasoningPolicyNextScenario](API_GetAutomatedReasoningPolicyNextScenario.md)
+ [GetAutomatedReasoningPolicyTestCase](API_GetAutomatedReasoningPolicyTestCase.md)
+ [GetAutomatedReasoningPolicyTestResult](API_GetAutomatedReasoningPolicyTestResult.md)
+ [GetCustomModel](API_GetCustomModel.md)
+ [GetCustomModelDeployment](API_GetCustomModelDeployment.md)
+ [GetEvaluationJob](API_GetEvaluationJob.md)
+ [GetFoundationModel](API_GetFoundationModel.md)
+ [GetFoundationModelAvailability](API_GetFoundationModelAvailability.md)
+ [GetGuardrail](API_GetGuardrail.md)
+ [GetImportedModel](API_GetImportedModel.md)
+ [GetInferenceProfile](API_GetInferenceProfile.md)
+ [GetMarketplaceModelEndpoint](API_GetMarketplaceModelEndpoint.md)
+ [GetModelCopyJob](API_GetModelCopyJob.md)
+ [GetModelCustomizationJob](API_GetModelCustomizationJob.md)
+ [GetModelImportJob](API_GetModelImportJob.md)
+ [GetModelInvocationJob](API_GetModelInvocationJob.md)
+ [GetModelInvocationLoggingConfiguration](API_GetModelInvocationLoggingConfiguration.md)
+ [GetPromptRouter](API_GetPromptRouter.md)
+ [GetProvisionedModelThroughput](API_GetProvisionedModelThroughput.md)
+ [GetResourcePolicy](API_GetResourcePolicy.md)
+ [GetUseCaseForModelAccess](API_GetUseCaseForModelAccess.md)
+ [ListAutomatedReasoningPolicies](API_ListAutomatedReasoningPolicies.md)
+ [ListAutomatedReasoningPolicyBuildWorkflows](API_ListAutomatedReasoningPolicyBuildWorkflows.md)
+ [ListAutomatedReasoningPolicyTestCases](API_ListAutomatedReasoningPolicyTestCases.md)
+ [ListAutomatedReasoningPolicyTestResults](API_ListAutomatedReasoningPolicyTestResults.md)
+ [ListCustomModelDeployments](API_ListCustomModelDeployments.md)
+ [ListCustomModels](API_ListCustomModels.md)
+ [ListEnforcedGuardrailsConfiguration](API_ListEnforcedGuardrailsConfiguration.md)
+ [ListEvaluationJobs](API_ListEvaluationJobs.md)
+ [ListFoundationModelAgreementOffers](API_ListFoundationModelAgreementOffers.md)
+ [ListFoundationModels](API_ListFoundationModels.md)
+ [ListGuardrails](API_ListGuardrails.md)
+ [ListImportedModels](API_ListImportedModels.md)
+ [ListInferenceProfiles](API_ListInferenceProfiles.md)
+ [ListMarketplaceModelEndpoints](API_ListMarketplaceModelEndpoints.md)
+ [ListModelCopyJobs](API_ListModelCopyJobs.md)
+ [ListModelCustomizationJobs](API_ListModelCustomizationJobs.md)
+ [ListModelImportJobs](API_ListModelImportJobs.md)
+ [ListModelInvocationJobs](API_ListModelInvocationJobs.md)
+ [ListPromptRouters](API_ListPromptRouters.md)
+ [ListProvisionedModelThroughputs](API_ListProvisionedModelThroughputs.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [PutEnforcedGuardrailConfiguration](API_PutEnforcedGuardrailConfiguration.md)
+ [PutModelInvocationLoggingConfiguration](API_PutModelInvocationLoggingConfiguration.md)
+ [PutResourcePolicy](API_PutResourcePolicy.md)
+ [PutUseCaseForModelAccess](API_PutUseCaseForModelAccess.md)
+ [RegisterMarketplaceModelEndpoint](API_RegisterMarketplaceModelEndpoint.md)
+ [StartAutomatedReasoningPolicyBuildWorkflow](API_StartAutomatedReasoningPolicyBuildWorkflow.md)
+ [StartAutomatedReasoningPolicyTestWorkflow](API_StartAutomatedReasoningPolicyTestWorkflow.md)
+ [StopEvaluationJob](API_StopEvaluationJob.md)
+ [StopModelCustomizationJob](API_StopModelCustomizationJob.md)
+ [StopModelInvocationJob](API_StopModelInvocationJob.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateAutomatedReasoningPolicy](API_UpdateAutomatedReasoningPolicy.md)
+ [UpdateAutomatedReasoningPolicyAnnotations](API_UpdateAutomatedReasoningPolicyAnnotations.md)
+ [UpdateAutomatedReasoningPolicyTestCase](API_UpdateAutomatedReasoningPolicyTestCase.md)
+ [UpdateCustomModelDeployment](API_UpdateCustomModelDeployment.md)
+ [UpdateGuardrail](API_UpdateGuardrail.md)
+ [UpdateMarketplaceModelEndpoint](API_UpdateMarketplaceModelEndpoint.md)
+ [UpdateProvisionedModelThroughput](API_UpdateProvisionedModelThroughput.md)
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)
The following actions are supported by Agents for Amazon Bedrock Runtime:
+ [CreateInvocation](API_agent-runtime_CreateInvocation.md)
+ [CreateSession](API_agent-runtime_CreateSession.md)
+ [DeleteAgentMemory](API_agent-runtime_DeleteAgentMemory.md)
+ [DeleteSession](API_agent-runtime_DeleteSession.md)
+ [EndSession](API_agent-runtime_EndSession.md)
+ [GenerateQuery](API_agent-runtime_GenerateQuery.md)
+ [GetAgentMemory](API_agent-runtime_GetAgentMemory.md)
+ [GetExecutionFlowSnapshot](API_agent-runtime_GetExecutionFlowSnapshot.md)
+ [GetFlowExecution](API_agent-runtime_GetFlowExecution.md)
+ [GetInvocationStep](API_agent-runtime_GetInvocationStep.md)
+ [GetSession](API_agent-runtime_GetSession.md)
+ [InvokeAgent](API_agent-runtime_InvokeAgent.md)
+ [InvokeFlow](API_agent-runtime_InvokeFlow.md)
+ [InvokeInlineAgent](API_agent-runtime_InvokeInlineAgent.md)
+ [ListFlowExecutionEvents](API_agent-runtime_ListFlowExecutionEvents.md)
+ [ListFlowExecutions](API_agent-runtime_ListFlowExecutions.md)
+ [ListInvocations](API_agent-runtime_ListInvocations.md)
+ [ListInvocationSteps](API_agent-runtime_ListInvocationSteps.md)
+ [ListSessions](API_agent-runtime_ListSessions.md)
+ [ListTagsForResource](API_agent-runtime_ListTagsForResource.md)
+ [OptimizePrompt](API_agent-runtime_OptimizePrompt.md)
+ [PutInvocationStep](API_agent-runtime_PutInvocationStep.md)
+ [Rerank](API_agent-runtime_Rerank.md)
+ [Retrieve](API_agent-runtime_Retrieve.md)
+ [RetrieveAndGenerate](API_agent-runtime_RetrieveAndGenerate.md)
+ [RetrieveAndGenerateStream](API_agent-runtime_RetrieveAndGenerateStream.md)
+ [StartFlowExecution](API_agent-runtime_StartFlowExecution.md)
+ [StopFlowExecution](API_agent-runtime_StopFlowExecution.md)
+ [TagResource](API_agent-runtime_TagResource.md)
+ [UntagResource](API_agent-runtime_UntagResource.md)
+ [UpdateSession](API_agent-runtime_UpdateSession.md)
The following actions are supported by Data Automation for Amazon Bedrock:
+ [CopyBlueprintStage](API_data-automation_CopyBlueprintStage.md)
+ [CreateBlueprint](API_data-automation_CreateBlueprint.md)
+ [CreateBlueprintVersion](API_data-automation_CreateBlueprintVersion.md)
+ [CreateDataAutomationLibrary](API_data-automation_CreateDataAutomationLibrary.md)
+ [CreateDataAutomationProject](API_data-automation_CreateDataAutomationProject.md)
+ [DeleteBlueprint](API_data-automation_DeleteBlueprint.md)
+ [DeleteDataAutomationLibrary](API_data-automation_DeleteDataAutomationLibrary.md)
+ [DeleteDataAutomationProject](API_data-automation_DeleteDataAutomationProject.md)
+ [GetBlueprint](API_data-automation_GetBlueprint.md)
+ [GetBlueprintOptimizationStatus](API_data-automation_GetBlueprintOptimizationStatus.md)
+ [GetDataAutomationLibrary](API_data-automation_GetDataAutomationLibrary.md)
+ [GetDataAutomationLibraryEntity](API_data-automation_GetDataAutomationLibraryEntity.md)
+ [GetDataAutomationLibraryIngestionJob](API_data-automation_GetDataAutomationLibraryIngestionJob.md)
+ [GetDataAutomationProject](API_data-automation_GetDataAutomationProject.md)
+ [InvokeBlueprintOptimizationAsync](API_data-automation_InvokeBlueprintOptimizationAsync.md)
+ [InvokeDataAutomationLibraryIngestionJob](API_data-automation_InvokeDataAutomationLibraryIngestionJob.md)
+ [ListBlueprints](API_data-automation_ListBlueprints.md)
+ [ListDataAutomationLibraries](API_data-automation_ListDataAutomationLibraries.md)
+ [ListDataAutomationLibraryEntities](API_data-automation_ListDataAutomationLibraryEntities.md)
+ [ListDataAutomationLibraryIngestionJobs](API_data-automation_ListDataAutomationLibraryIngestionJobs.md)
+ [ListDataAutomationProjects](API_data-automation_ListDataAutomationProjects.md)
+ [ListTagsForResource](API_data-automation_ListTagsForResource.md)
+ [TagResource](API_data-automation_TagResource.md)
+ [UntagResource](API_data-automation_UntagResource.md)
+ [UpdateBlueprint](API_data-automation_UpdateBlueprint.md)
+ [UpdateDataAutomationLibrary](API_data-automation_UpdateDataAutomationLibrary.md)
+ [UpdateDataAutomationProject](API_data-automation_UpdateDataAutomationProject.md)
The following actions are supported by Runtime for Amazon Bedrock Data Automation:
+ [GetDataAutomationStatus](API_data-automation-runtime_GetDataAutomationStatus.md)
+ [InvokeDataAutomation](API_data-automation-runtime_InvokeDataAutomation.md)
+ [InvokeDataAutomationAsync](API_data-automation-runtime_InvokeDataAutomationAsync.md)
+ [ListTagsForResource](API_data-automation-runtime_ListTagsForResource.md)
+ [TagResource](API_data-automation-runtime_TagResource.md)
+ [UntagResource](API_data-automation-runtime_UntagResource.md)
The following actions are supported by Amazon Bedrock Runtime:
+ [ApplyGuardrail](API_runtime_ApplyGuardrail.md)
+ [Converse](API_runtime_Converse.md)
+ [ConverseStream](API_runtime_ConverseStream.md)
+ [CountTokens](API_runtime_CountTokens.md)
+ [GetAsyncInvoke](API_runtime_GetAsyncInvoke.md)
+ [InvokeModel](API_runtime_InvokeModel.md)
+ [InvokeModelWithBidirectionalStream](API_runtime_InvokeModelWithBidirectionalStream.md)
+ [InvokeModelWithResponseStream](API_runtime_InvokeModelWithResponseStream.md)
+ [ListAsyncInvokes](API_runtime_ListAsyncInvokes.md)
+ [StartAsyncInvoke](API_runtime_StartAsyncInvoke.md)
# Amazon Bedrock
The following actions are supported by Amazon Bedrock:
+ [BatchDeleteEvaluationJob](API_BatchDeleteEvaluationJob.md)
+ [CancelAutomatedReasoningPolicyBuildWorkflow](API_CancelAutomatedReasoningPolicyBuildWorkflow.md)
+ [CreateAutomatedReasoningPolicy](API_CreateAutomatedReasoningPolicy.md)
+ [CreateAutomatedReasoningPolicyTestCase](API_CreateAutomatedReasoningPolicyTestCase.md)
+ [CreateAutomatedReasoningPolicyVersion](API_CreateAutomatedReasoningPolicyVersion.md)
+ [CreateCustomModel](API_CreateCustomModel.md)
+ [CreateCustomModelDeployment](API_CreateCustomModelDeployment.md)
+ [CreateEvaluationJob](API_CreateEvaluationJob.md)
+ [CreateFoundationModelAgreement](API_CreateFoundationModelAgreement.md)
+ [CreateGuardrail](API_CreateGuardrail.md)
+ [CreateGuardrailVersion](API_CreateGuardrailVersion.md)
+ [CreateInferenceProfile](API_CreateInferenceProfile.md)
+ [CreateMarketplaceModelEndpoint](API_CreateMarketplaceModelEndpoint.md)
+ [CreateModelCopyJob](API_CreateModelCopyJob.md)
+ [CreateModelCustomizationJob](API_CreateModelCustomizationJob.md)
+ [CreateModelImportJob](API_CreateModelImportJob.md)
+ [CreateModelInvocationJob](API_CreateModelInvocationJob.md)
+ [CreatePromptRouter](API_CreatePromptRouter.md)
+ [CreateProvisionedModelThroughput](API_CreateProvisionedModelThroughput.md)
+ [DeleteAutomatedReasoningPolicy](API_DeleteAutomatedReasoningPolicy.md)
+ [DeleteAutomatedReasoningPolicyBuildWorkflow](API_DeleteAutomatedReasoningPolicyBuildWorkflow.md)
+ [DeleteAutomatedReasoningPolicyTestCase](API_DeleteAutomatedReasoningPolicyTestCase.md)
+ [DeleteCustomModel](API_DeleteCustomModel.md)
+ [DeleteCustomModelDeployment](API_DeleteCustomModelDeployment.md)
+ [DeleteEnforcedGuardrailConfiguration](API_DeleteEnforcedGuardrailConfiguration.md)
+ [DeleteFoundationModelAgreement](API_DeleteFoundationModelAgreement.md)
+ [DeleteGuardrail](API_DeleteGuardrail.md)
+ [DeleteImportedModel](API_DeleteImportedModel.md)
+ [DeleteInferenceProfile](API_DeleteInferenceProfile.md)
+ [DeleteMarketplaceModelEndpoint](API_DeleteMarketplaceModelEndpoint.md)
+ [DeleteModelInvocationLoggingConfiguration](API_DeleteModelInvocationLoggingConfiguration.md)
+ [DeletePromptRouter](API_DeletePromptRouter.md)
+ [DeleteProvisionedModelThroughput](API_DeleteProvisionedModelThroughput.md)
+ [DeleteResourcePolicy](API_DeleteResourcePolicy.md)
+ [DeregisterMarketplaceModelEndpoint](API_DeregisterMarketplaceModelEndpoint.md)
+ [ExportAutomatedReasoningPolicyVersion](API_ExportAutomatedReasoningPolicyVersion.md)
+ [GetAutomatedReasoningPolicy](API_GetAutomatedReasoningPolicy.md)
+ [GetAutomatedReasoningPolicyAnnotations](API_GetAutomatedReasoningPolicyAnnotations.md)
+ [GetAutomatedReasoningPolicyBuildWorkflow](API_GetAutomatedReasoningPolicyBuildWorkflow.md)
+ [GetAutomatedReasoningPolicyBuildWorkflowResultAssets](API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets.md)
+ [GetAutomatedReasoningPolicyNextScenario](API_GetAutomatedReasoningPolicyNextScenario.md)
+ [GetAutomatedReasoningPolicyTestCase](API_GetAutomatedReasoningPolicyTestCase.md)
+ [GetAutomatedReasoningPolicyTestResult](API_GetAutomatedReasoningPolicyTestResult.md)
+ [GetCustomModel](API_GetCustomModel.md)
+ [GetCustomModelDeployment](API_GetCustomModelDeployment.md)
+ [GetEvaluationJob](API_GetEvaluationJob.md)
+ [GetFoundationModel](API_GetFoundationModel.md)
+ [GetFoundationModelAvailability](API_GetFoundationModelAvailability.md)
+ [GetGuardrail](API_GetGuardrail.md)
+ [GetImportedModel](API_GetImportedModel.md)
+ [GetInferenceProfile](API_GetInferenceProfile.md)
+ [GetMarketplaceModelEndpoint](API_GetMarketplaceModelEndpoint.md)
+ [GetModelCopyJob](API_GetModelCopyJob.md)
+ [GetModelCustomizationJob](API_GetModelCustomizationJob.md)
+ [GetModelImportJob](API_GetModelImportJob.md)
+ [GetModelInvocationJob](API_GetModelInvocationJob.md)
+ [GetModelInvocationLoggingConfiguration](API_GetModelInvocationLoggingConfiguration.md)
+ [GetPromptRouter](API_GetPromptRouter.md)
+ [GetProvisionedModelThroughput](API_GetProvisionedModelThroughput.md)
+ [GetResourcePolicy](API_GetResourcePolicy.md)
+ [GetUseCaseForModelAccess](API_GetUseCaseForModelAccess.md)
+ [ListAutomatedReasoningPolicies](API_ListAutomatedReasoningPolicies.md)
+ [ListAutomatedReasoningPolicyBuildWorkflows](API_ListAutomatedReasoningPolicyBuildWorkflows.md)
+ [ListAutomatedReasoningPolicyTestCases](API_ListAutomatedReasoningPolicyTestCases.md)
+ [ListAutomatedReasoningPolicyTestResults](API_ListAutomatedReasoningPolicyTestResults.md)
+ [ListCustomModelDeployments](API_ListCustomModelDeployments.md)
+ [ListCustomModels](API_ListCustomModels.md)
+ [ListEnforcedGuardrailsConfiguration](API_ListEnforcedGuardrailsConfiguration.md)
+ [ListEvaluationJobs](API_ListEvaluationJobs.md)
+ [ListFoundationModelAgreementOffers](API_ListFoundationModelAgreementOffers.md)
+ [ListFoundationModels](API_ListFoundationModels.md)
+ [ListGuardrails](API_ListGuardrails.md)
+ [ListImportedModels](API_ListImportedModels.md)
+ [ListInferenceProfiles](API_ListInferenceProfiles.md)
+ [ListMarketplaceModelEndpoints](API_ListMarketplaceModelEndpoints.md)
+ [ListModelCopyJobs](API_ListModelCopyJobs.md)
+ [ListModelCustomizationJobs](API_ListModelCustomizationJobs.md)
+ [ListModelImportJobs](API_ListModelImportJobs.md)
+ [ListModelInvocationJobs](API_ListModelInvocationJobs.md)
+ [ListPromptRouters](API_ListPromptRouters.md)
+ [ListProvisionedModelThroughputs](API_ListProvisionedModelThroughputs.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [PutEnforcedGuardrailConfiguration](API_PutEnforcedGuardrailConfiguration.md)
+ [PutModelInvocationLoggingConfiguration](API_PutModelInvocationLoggingConfiguration.md)
+ [PutResourcePolicy](API_PutResourcePolicy.md)
+ [PutUseCaseForModelAccess](API_PutUseCaseForModelAccess.md)
+ [RegisterMarketplaceModelEndpoint](API_RegisterMarketplaceModelEndpoint.md)
+ [StartAutomatedReasoningPolicyBuildWorkflow](API_StartAutomatedReasoningPolicyBuildWorkflow.md)
+ [StartAutomatedReasoningPolicyTestWorkflow](API_StartAutomatedReasoningPolicyTestWorkflow.md)
+ [StopEvaluationJob](API_StopEvaluationJob.md)
+ [StopModelCustomizationJob](API_StopModelCustomizationJob.md)
+ [StopModelInvocationJob](API_StopModelInvocationJob.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateAutomatedReasoningPolicy](API_UpdateAutomatedReasoningPolicy.md)
+ [UpdateAutomatedReasoningPolicyAnnotations](API_UpdateAutomatedReasoningPolicyAnnotations.md)
+ [UpdateAutomatedReasoningPolicyTestCase](API_UpdateAutomatedReasoningPolicyTestCase.md)
+ [UpdateCustomModelDeployment](API_UpdateCustomModelDeployment.md)
+ [UpdateGuardrail](API_UpdateGuardrail.md)
+ [UpdateMarketplaceModelEndpoint](API_UpdateMarketplaceModelEndpoint.md)
+ [UpdateProvisionedModelThroughput](API_UpdateProvisionedModelThroughput.md)
# BatchDeleteEvaluationJob
Deletes a batch of evaluation jobs. An evaluation job can only be deleted if it has following status `FAILED`, `COMPLETED`, and `STOPPED`. You can request up to 25 model evaluation jobs be deleted in a single request.
## Request Syntax
```
POST /evaluation-jobs/batch-delete HTTP/1.1
Content-type: application/json
{
"jobIdentifiers": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [jobIdentifiers](#API_BatchDeleteEvaluationJob_RequestSyntax) **
A list of one or more evaluation job Amazon Resource Names (ARNs) you want to delete.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})`
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"errors": [
{
"code": "string",
"jobIdentifier": "string",
"message": "string"
}
],
"evaluationJobs": [
{
"jobIdentifier": "string",
"jobStatus": "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.
** [errors](#API_BatchDeleteEvaluationJob_ResponseSyntax) **
A JSON object containing the HTTP status codes and the ARNs of evaluation jobs that failed to be deleted.
Type: Array of [BatchDeleteEvaluationJobError](API_BatchDeleteEvaluationJobError.md) objects
Array Members: Minimum number of 0 items. Maximum number of 25 items.
** [evaluationJobs](#API_BatchDeleteEvaluationJob_ResponseSyntax) **
The list of evaluation jobs for deletion.
Type: Array of [BatchDeleteEvaluationJobItem](API_BatchDeleteEvaluationJobItem.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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/BatchDeleteEvaluationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/BatchDeleteEvaluationJob)
# CancelAutomatedReasoningPolicyBuildWorkflow
Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.
## Request Syntax
```
POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/cancel HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_CancelAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The unique identifier of the build workflow to cancel. You can get this ID from the StartAutomatedReasoningPolicyBuildWorkflow response or by listing build workflows.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [policyArn](#API_CancelAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to cancel.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 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.
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-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CancelAutomatedReasoningPolicyBuildWorkflow)
# CreateAutomatedReasoningPolicy
Creates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated Reasoning policies use mathematical techniques to detect hallucinations, suggest corrections, and highlight unstated assumptions in the responses of your GenAI application.
To create a policy, you upload a source document that describes the rules that you're encoding. Automated Reasoning extracts important concepts from the source document that will become variables in the policy and infers policy rules.
## Request Syntax
```
POST /automated-reasoning-policies HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"description": "string",
"kmsKeyId": "string",
"name": "string",
"policyDefinition": {
"rules": [
{
"alternateExpression": "string",
"expression": "string",
"id": "string"
}
],
"types": [
{
"description": "string",
"name": "string",
"values": [
{
"description": "string",
"value": "string"
}
]
}
],
"variables": [
{
"description": "string",
"name": "string",
"type": "string"
}
],
"version": "string"
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateAutomatedReasoningPolicy_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [description](#API_CreateAutomatedReasoningPolicy_RequestSyntax) **
A description of the Automated Reasoning policy. Use this to provide context about the policy's purpose and the types of validations it performs.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
** [kmsKeyId](#API_CreateAutomatedReasoningPolicy_RequestSyntax) **
The identifier of the AWS KMS key to use for encrypting the automated reasoning policy and its associated artifacts. If you don't specify a AWS KMS key, Amazon Bedrock uses an AWS KMS managed key for encryption. For enhanced security and control, you can specify a customer managed AWS KMS key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
** [name](#API_CreateAutomatedReasoningPolicy_RequestSyntax) **
A unique name for the Automated Reasoning policy. The name must be between 1 and 63 characters and can contain letters, numbers, hyphens, and underscores.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[0-9a-zA-Z-_ ]+`
Required: Yes
** [policyDefinition](#API_CreateAutomatedReasoningPolicy_RequestSyntax) **
The policy definition that contains the formal logic rules, variables, and custom variable types used to validate foundation model responses in your application.
Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object
Required: No
** [tags](#API_CreateAutomatedReasoningPolicy_RequestSyntax) **
A list of tags to associate with the Automated Reasoning policy. Tags help you organize and manage your policies.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"definitionHash": "string",
"description": "string",
"name": "string",
"policyArn": "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.
** [createdAt](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **
The timestamp when the policy was created.
Type: Timestamp
** [definitionHash](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **
The hash of the policy definition. This is used as a concurrency token for creating policy versions that you can use in your application.
Type: String
Length Constraints: Fixed length of 128.
Pattern: `[0-9a-z]{128}`
** [description](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **
The description of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
** [name](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **
The name of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[0-9a-zA-Z-_ ]+`
** [policyArn](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy that you created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [updatedAt](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **
The timestamp when the policy was last updated.
Type: Timestamp
** [version](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **
The version number of the newly created Automated Reasoning policy. The initial version is always DRAFT.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `([1-9][0-9]{0,11})`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
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-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicy)
# CreateAutomatedReasoningPolicyTestCase
Creates a test for an Automated Reasoning policy. Tests validate that your policy works as expected by providing sample inputs and expected outcomes. Use tests to verify policy behavior before deploying to production.
## Request Syntax
```
POST /automated-reasoning-policies/policyArn/test-cases HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"confidenceThreshold": number,
"expectedAggregatedFindingsResult": "string",
"guardContent": "string",
"queryContent": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [policyArn](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create the test.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [confidenceThreshold](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The minimum confidence level for logic validation. Content that meets the threshold is considered a high-confidence finding that can be validated.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** [expectedAggregatedFindingsResult](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The expected result of the Automated Reasoning check. Valid values include: , TOO\$1COMPLEX, and NO\$1TRANSLATIONS.
+ `VALID` - The claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false. In other words, there are no alternative answers that are true that contradict the claims.
+ `INVALID` - The claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exists different claims that are consistent with the premises and Automated Reasoning policy.
+ `SATISFIABLE` - The claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.
+ `IMPOSSIBLE` - Automated Reasoning can’t make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.
+ `TRANSLATION_AMBIGUOUS` - Detected an ambiguity in the translation meant it would be unsound to continue with validity checking. Additional context or follow-up questions might be needed to get translation to succeed.
+ `TOO_COMPLEX` - The input contains too much information for Automated Reasoning to process within its latency limits.
+ `NO_TRANSLATIONS` - Identifies that some or all of the input prompt wasn't translated into logic. This can happen if the input isn't relevant to the Automated Reasoning policy, or if the policy doesn't have variables to model relevant input. If Automated Reasoning can't translate anything, you get a single `NO_TRANSLATIONS` finding. You might also see a `NO_TRANSLATIONS` (along with other findings) if some part of the validation isn't translated.
Type: String
Valid Values: `VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION`
Required: Yes
** [guardContent](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The output content that's validated by the Automated Reasoning policy. This represents the foundation model response that will be checked for accuracy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
** [queryContent](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The input query or prompt that generated the content. This provides context for the validation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"policyArn": "string",
"testCaseId": "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.
** [policyArn](#API_CreateAutomatedReasoningPolicyTestCase_ResponseSyntax) **
The Amazon Resource Name (ARN) of the policy for which the test was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [testCaseId](#API_CreateAutomatedReasoningPolicyTestCase_ResponseSyntax) **
The unique identifier of the created test.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[0-9A-Z]{12}`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** 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.
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-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyTestCase)
# CreateAutomatedReasoningPolicyVersion
Creates a new version of an existing Automated Reasoning policy. This allows you to iterate on your policy rules while maintaining previous versions for rollback or comparison purposes.
## Request Syntax
```
POST /automated-reasoning-policies/policyArn/versions HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"lastUpdatedDefinitionHash": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [policyArn](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to create a version.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [lastUpdatedDefinitionHash](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) **
The hash of the current policy definition used as a concurrency token to ensure the policy hasn't been modified since you last retrieved it.
Type: String
Length Constraints: Fixed length of 128.
Pattern: `[0-9a-z]{128}`
Required: Yes
** [tags](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) **
A list of tags to associate with the policy version.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"definitionHash": "string",
"description": "string",
"name": "string",
"policyArn": "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.
** [createdAt](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) **
The timestamp when the policy version was created.
Type: Timestamp
** [definitionHash](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) **
The hash of the policy definition for this version.
Type: String
Length Constraints: Fixed length of 128.
Pattern: `[0-9a-z]{128}`
** [description](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) **
The description of the policy version.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
** [name](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) **
The name of the policy version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[0-9a-zA-Z-_ ]+`
** [policyArn](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) **
The versioned Amazon Resource Name (ARN) of the policy version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [version](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) **
The version number of the policy version.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `([1-9][0-9]{0,11})`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
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-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateAutomatedReasoningPolicyVersion)
# CreateCustomModel
Creates a new custom model in Amazon Bedrock from an existing SageMaker AI-trained Amazon Nova model stored in an Amazon-managed Amazon S3 bucket. To track the status of the new model, you use the `GetCustomModel` API operation. The model can be in the following states:
+ `Creating` - Initial state during validation and registration
+ `Active` - Model is ready for use in inference
+ `Failed` - Creation process encountered an error
The model appears in `ListCustomModels` with a `customizationType` of `imported`. After the model is active, you can use it for inference. For information about setting up inference for custom models, see [Set up inference for a custom model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html). For more information about importing SageMaker AI trained Amazon Nova models, including specific model requirements, see [Import a SageMaker AI-trained Amazon Nova model](https://docs.aws.amazon.com/bedrock/latest/userguide/import-with-create-custom-model.html) in the Amazon Bedrock User Guide.
**Note**
You use the `CreateCustomModel` API to import only SageMaker AI-trained Amazon Nova models. To import open-source models, you use the [CreateModelImportJob](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html).
**Related APIs**
+ [GetCustomModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModel.html)
+ [ListCustomModels](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModels.html)
+ [DeleteCustomModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModel.html)
## Request Syntax
```
POST /custom-models/create-custom-model HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"modelKmsKeyArn": "string",
"modelName": "string",
"modelSourceConfig": { ... },
"modelTags": [
{
"key": "string",
"value": "string"
}
],
"roleArn": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateCustomModel_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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [modelKmsKeyArn](#API_CreateCustomModel_RequestSyntax) **
The Amazon Resource Name (ARN) of the customer managed AWS KMS key to encrypt the custom model. If you don't provide a AWS KMS key, Amazon Bedrock uses an AWS-managed AWS KMS key to encrypt the model.
If you provide a customer managed AWS KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see [Encryption of imported models](https://docs.aws.amazon.com/bedrock/latest/userguide/encryption-import-model.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
Required: No
** [modelName](#API_CreateCustomModel_RequestSyntax) **
A unique name for the custom model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: Yes
** [modelSourceConfig](#API_CreateCustomModel_RequestSyntax) **
The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts. SageMaker AI creates this bucket when you run your first SageMaker AI training job.
Type: [ModelDataSource](API_ModelDataSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [modelTags](#API_CreateCustomModel_RequestSyntax) **
A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.
For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [roleArn](#API_CreateCustomModel_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the AWS KMS key (if specified). For more information, see [Setting up an IAM service role for importing models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-import-iam-role.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/.+`
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"modelArn": "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.
** [modelArn](#API_CreateCustomModel_ResponseSyntax) **
The Amazon Resource Name (ARN) of the new custom model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of CreateCustomModel.
```
POST /custom-models/create-custom-model HTTP/1.1
Content-type: application/json
{
"modelName": "my-custom-nova-model",
"modelSourceConfig": {
"s3Uri": "s3://amzn-s3-demo-bucket/"
},
"roleArn": "arn:aws:iam::123456789012:role/BedrockCustomModelRole",
"modelKmsKeyArn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
"clientRequestToken": "unique-request-token-123",
"modelTags": [
{
"key": "Environment",
"value": "Production"
},
{
"key": "Project",
"value": "CustomNova"
},
{
"key": "Team",
"value": "MLEngineering"
}
]
}
```
## 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-2023-04-20/CreateCustomModel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateCustomModel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateCustomModel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateCustomModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateCustomModel)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateCustomModel)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateCustomModel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateCustomModel)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateCustomModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateCustomModel)
# CreateCustomModelDeployment
Deploys a custom model for on-demand inference in Amazon Bedrock. After you deploy your custom model, you use the deployment's Amazon Resource Name (ARN) as the `modelId` parameter when you submit prompts and generate responses with model inference.
For more information about setting up on-demand inference for custom models, see [Set up inference for a custom model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html).
The following actions are related to the `CreateCustomModelDeployment` operation:
+ [GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html)
+ [ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html)
+ [DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html)
## Request Syntax
```
POST /model-customization/custom-model-deployments HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"description": "string",
"modelArn": "string",
"modelDeploymentName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateCustomModelDeployment_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the operation 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/bedrock/latest/userguide/model-customization-idempotency.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [description](#API_CreateCustomModelDeployment_RequestSyntax) **
A description for the custom model deployment to help you identify its purpose.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `.*`
Required: No
** [modelArn](#API_CreateCustomModelDeployment_RequestSyntax) **
The Amazon Resource Name (ARN) of the custom model to deploy for on-demand inference. The custom model must be in the `Active` state.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
Required: Yes
** [modelDeploymentName](#API_CreateCustomModelDeployment_RequestSyntax) **
The name for the custom model deployment. The name must be unique within your AWS account and Region.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: Yes
** [tags](#API_CreateCustomModelDeployment_RequestSyntax) **
Tags to assign to the custom model deployment. You can use tags to organize and track your AWS resources for cost allocation and management purposes.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"customModelDeploymentArn": "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.
** [customModelDeploymentArn](#API_CreateCustomModelDeployment_ResponseSyntax) **
The Amazon Resource Name (ARN) of the custom model deployment. Use this ARN as the `modelId` parameter when invoking the model with the `InvokeModel` or `Converse` operations.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}`
## 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of CreateCustomModelDeployment.
```
POST /model-customization/custom-model-deployments HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "unique-deployment-token-456",
"description": "Production deployment of my custom model for customer support chatbot",
"modelArn": "arn:aws:bedrock:us-west-2:123456789012:custom-model-deployment/abc123def456",
"modelDeploymentName": "customer-support-model-deployment",
"tags": [
{
"key": "Environment",
"value": "Production"
},
{
"key": "Application",
"value": "CustomerSupport"
},
{
"key": "CostCenter",
"value": "Engineering"
}
]
}
```
## 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-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateCustomModelDeployment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateCustomModelDeployment)
# CreateEvaluationJob
Creates an evaluation job.
For code examples that demonstrate how to create evaluation jobs, see [Create a model evaluation job in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-jobs-management-create.html#model-evaluation-jobs-management-create-auto).
## Request Syntax
```
POST /evaluation-jobs HTTP/1.1
Content-type: application/json
{
"applicationType": "string",
"clientRequestToken": "string",
"customerEncryptionKeyId": "string",
"evaluationConfig": { ... },
"inferenceConfig": { ... },
"jobDescription": "string",
"jobName": "string",
"jobTags": [
{
"key": "string",
"value": "string"
}
],
"outputDataConfig": {
"s3Uri": "string"
},
"roleArn": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [applicationType](#API_CreateEvaluationJob_RequestSyntax) **
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Type: String
Valid Values: `ModelEvaluation | RagEvaluation`
Required: No
** [clientRequestToken](#API_CreateEvaluationJob_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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [customerEncryptionKeyId](#API_CreateEvaluationJob_RequestSyntax) **
Specify your customer managed encryption key Amazon Resource Name (ARN) that will be used to encrypt your evaluation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
** [evaluationConfig](#API_CreateEvaluationJob_RequestSyntax) **
Contains the configuration details of either an automated or human-based evaluation job.
Type: [EvaluationConfig](API_EvaluationConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [inferenceConfig](#API_CreateEvaluationJob_RequestSyntax) **
Contains the configuration details of the inference model for the evaluation job.
For model evaluation jobs, automated jobs support a single model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html), and jobs that use human workers support two models or inference profiles.
Type: [EvaluationInferenceConfig](API_EvaluationInferenceConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [jobDescription](#API_CreateEvaluationJob_RequestSyntax) **
A description of the evaluation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `.+`
Required: No
** [jobName](#API_CreateEvaluationJob_RequestSyntax) **
A name for the evaluation job. Names must unique with your AWS account, and your account's AWS region.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-z0-9](-*[a-z0-9]){0,62}`
Required: Yes
** [jobTags](#API_CreateEvaluationJob_RequestSyntax) **
Tags to attach to the model evaluation job.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [outputDataConfig](#API_CreateEvaluationJob_RequestSyntax) **
Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.
Type: [EvaluationOutputDataConfig](API_EvaluationOutputDataConfig.md) object
Required: Yes
** [roleArn](#API_CreateEvaluationJob_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. To learn more about the required permissions, see [Required permissions for model evaluations](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"jobArn": "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.
** [jobArn](#API_CreateEvaluationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the evaluation job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** 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.
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-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateEvaluationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateEvaluationJob)
# CreateFoundationModelAgreement
Request a model access agreement for the specified model.
## Request Syntax
```
POST /create-foundation-model-agreement HTTP/1.1
Content-type: application/json
{
"modelId": "string",
"offerToken": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [modelId](#API_CreateFoundationModelAgreement_RequestSyntax) **
Model Id of the model for the access request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: Yes
** [offerToken](#API_CreateFoundationModelAgreement_RequestSyntax) **
An offer token encapsulates the information for an offer.
Type: String
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"modelId": "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.
** [modelId](#API_CreateFoundationModelAgreement_ResponseSyntax) **
Model Id of the model for the access request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateFoundationModelAgreement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateFoundationModelAgreement)
# CreateGuardrail
Creates a guardrail to detect and filter harmful content in your generative AI application.
Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content:
+ **Content filters** - Detect and filter harmful text or image content in input prompts or model responses. Filtering is done based on detection of certain predefined harmful content categories: Hate, Insults, Sexual, Violence, Misconduct and Prompt Attack. You also can adjust the filter strength for each of these categories.
+ **Denied topics** - Define a set of topics that are undesirable in the context of your application. The filter will help block them if detected in user queries or model responses.
+ **Word filters** - Configure filters to help block undesirable words, phrases, and profanity (exact match). Such words can include offensive terms, competitor names, etc.
+ **Sensitive information filters** - Configure filters to help block or mask sensitive information, such as personally identifiable information (PII), or custom regex in user inputs and model responses. Blocking or masking is done based on probabilistic detection of sensitive information in standard formats in entities such as SSN number, Date of Birth, address, etc. This also allows configuring regular expression based detection of patterns for identifiers.
+ **Contextual grounding check** - Help detect and filter hallucinations in model responses based on grounding in a source and relevance to the user query.
For more information, see [How Amazon Bedrock Guardrails works](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-how.html).
## Request Syntax
```
POST /guardrails HTTP/1.1
Content-type: application/json
{
"automatedReasoningPolicyConfig": {
"confidenceThreshold": number,
"policies": [ "string" ]
},
"blockedInputMessaging": "string",
"blockedOutputsMessaging": "string",
"clientRequestToken": "string",
"contentPolicyConfig": {
"filtersConfig": [
{
"inputAction": "string",
"inputEnabled": boolean,
"inputModalities": [ "string" ],
"inputStrength": "string",
"outputAction": "string",
"outputEnabled": boolean,
"outputModalities": [ "string" ],
"outputStrength": "string",
"type": "string"
}
],
"tierConfig": {
"tierName": "string"
}
},
"contextualGroundingPolicyConfig": {
"filtersConfig": [
{
"action": "string",
"enabled": boolean,
"threshold": number,
"type": "string"
}
]
},
"crossRegionConfig": {
"guardrailProfileIdentifier": "string"
},
"description": "string",
"kmsKeyId": "string",
"name": "string",
"sensitiveInformationPolicyConfig": {
"piiEntitiesConfig": [
{
"action": "string",
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
],
"regexesConfig": [
{
"action": "string",
"description": "string",
"inputAction": "string",
"inputEnabled": boolean,
"name": "string",
"outputAction": "string",
"outputEnabled": boolean,
"pattern": "string"
}
]
},
"tags": [
{
"key": "string",
"value": "string"
}
],
"topicPolicyConfig": {
"tierConfig": {
"tierName": "string"
},
"topicsConfig": [
{
"definition": "string",
"examples": [ "string" ],
"inputAction": "string",
"inputEnabled": boolean,
"name": "string",
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
]
},
"wordPolicyConfig": {
"managedWordListsConfig": [
{
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
],
"wordsConfig": [
{
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"text": "string"
}
]
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [automatedReasoningPolicyConfig](#API_CreateGuardrail_RequestSyntax) **
Optional configuration for integrating Automated Reasoning policies with the new guardrail.
Type: [GuardrailAutomatedReasoningPolicyConfig](API_GuardrailAutomatedReasoningPolicyConfig.md) object
Required: No
** [blockedInputMessaging](#API_CreateGuardrail_RequestSyntax) **
The message to return when the guardrail blocks a prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
** [blockedOutputsMessaging](#API_CreateGuardrail_RequestSyntax) **
The message to return when the guardrail blocks a model response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
** [clientRequestToken](#API_CreateGuardrail_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the API request completes no more than once. 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) in the *Amazon S3 User Guide*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [contentPolicyConfig](#API_CreateGuardrail_RequestSyntax) **
The content filter policies to configure for the guardrail.
Type: [GuardrailContentPolicyConfig](API_GuardrailContentPolicyConfig.md) object
Required: No
** [contextualGroundingPolicyConfig](#API_CreateGuardrail_RequestSyntax) **
The contextual grounding policy configuration used to create a guardrail.
Type: [GuardrailContextualGroundingPolicyConfig](API_GuardrailContextualGroundingPolicyConfig.md) object
Required: No
** [crossRegionConfig](#API_CreateGuardrail_RequestSyntax) **
The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed.
For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).
Type: [GuardrailCrossRegionConfig](API_GuardrailCrossRegionConfig.md) object
Required: No
** [description](#API_CreateGuardrail_RequestSyntax) **
A description of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [kmsKeyId](#API_CreateGuardrail_RequestSyntax) **
The ARN of the AWS KMS key that you use to encrypt the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
** [name](#API_CreateGuardrail_RequestSyntax) **
The name to give the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: `[0-9a-zA-Z-_]+`
Required: Yes
** [sensitiveInformationPolicyConfig](#API_CreateGuardrail_RequestSyntax) **
The sensitive information policy to configure for the guardrail.
Type: [GuardrailSensitiveInformationPolicyConfig](API_GuardrailSensitiveInformationPolicyConfig.md) object
Required: No
** [tags](#API_CreateGuardrail_RequestSyntax) **
The tags that you want to attach to the guardrail.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [topicPolicyConfig](#API_CreateGuardrail_RequestSyntax) **
The topic policies to configure for the guardrail.
Type: [GuardrailTopicPolicyConfig](API_GuardrailTopicPolicyConfig.md) object
Required: No
** [wordPolicyConfig](#API_CreateGuardrail_RequestSyntax) **
The word policy you configure for the guardrail.
Type: [GuardrailWordPolicyConfig](API_GuardrailWordPolicyConfig.md) object
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"createdAt": "string",
"guardrailArn": "string",
"guardrailId": "string",
"version": "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.
** [createdAt](#API_CreateGuardrail_ResponseSyntax) **
The time at which the guardrail was created.
Type: Timestamp
** [guardrailArn](#API_CreateGuardrail_ResponseSyntax) **
The ARN of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+`
** [guardrailId](#API_CreateGuardrail_ResponseSyntax) **
The unique identifier of the guardrail that was created.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: `[a-z0-9]+`
** [version](#API_CreateGuardrail_ResponseSyntax) **
The version of the guardrail that was created. This value will always be `DRAFT`.
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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
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-2023-04-20/CreateGuardrail)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateGuardrail)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateGuardrail)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateGuardrail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateGuardrail)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateGuardrail)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateGuardrail)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateGuardrail)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateGuardrail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateGuardrail)
# CreateGuardrailVersion
Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
## Request Syntax
```
POST /guardrails/guardrailIdentifier HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"description": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [guardrailIdentifier](#API_CreateGuardrailVersion_RequestSyntax) **
The unique identifier of the guardrail. This can be an ID or the ARN.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateGuardrailVersion_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the API request completes no more than once. 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) in the *Amazon S3 User Guide*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [description](#API_CreateGuardrailVersion_RequestSyntax) **
A description of the guardrail version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"guardrailId": "string",
"version": "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.
** [guardrailId](#API_CreateGuardrailVersion_ResponseSyntax) **
The unique identifier of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: `[a-z0-9]+`
** [version](#API_CreateGuardrailVersion_ResponseSyntax) **
The number of the version of the guardrail.
Type: String
Pattern: `[1-9][0-9]{0,7}`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** 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.
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-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateGuardrailVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateGuardrailVersion)
# CreateInferenceProfile
Creates an application inference profile to track metrics and costs when invoking a model. To create an application inference profile for a foundation model in one region, specify the ARN of the model in that region. To create an application inference profile for a foundation model across multiple regions, specify the ARN of the system-defined inference profile that contains the regions that you want to route requests to. For more information, see [Increase throughput and resilience with cross-region inference in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /inference-profiles HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"description": "string",
"inferenceProfileName": "string",
"modelSource": { ... },
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateInferenceProfile_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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [description](#API_CreateInferenceProfile_RequestSyntax) **
A description for the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `([0-9a-zA-Z:.][ _-]?)+`
Required: No
** [inferenceProfileName](#API_CreateInferenceProfile_RequestSyntax) **
A name for the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `([0-9a-zA-Z][ _-]?)+`
Required: Yes
** [modelSource](#API_CreateInferenceProfile_RequestSyntax) **
The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.
Type: [InferenceProfileModelSource](API_InferenceProfileModelSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [tags](#API_CreateInferenceProfile_RequestSyntax) **
An array of objects, each of which contains a tag and its value. For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"inferenceProfileArn": "string",
"status": "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.
** [inferenceProfileArn](#API_CreateInferenceProfile_ResponseSyntax) **
The ARN of the inference profile that you created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+`
** [status](#API_CreateInferenceProfile_ResponseSyntax) **
The status of the inference profile. `ACTIVE` means that the inference profile is ready to be used.
Type: String
Valid Values: `ACTIVE`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
## Examples
### Create an application inference profile from a foundation model
Run the following example to create an application inference profile from the Anthropic Claude 3 Sonnet model in the `us-west-2` region, replacing `${AccountId}` with your AWS account ID:
#### Sample Request
```
POST /inference-profiles HTTP/1.1
Content-type: application/json
{
"inferenceProfileName": "USClaudeSonnetApplicationIP",
"modelSource": {
"copyFrom": "arn:aws:bedrock:us-west-2::foundation-model/anthropic.claude-3-sonnet-20240229-v1:0"
},
"tags": [
{
"key": "projectId",
"value": "abcdef123456"
}
]
}
```
### Create an application inference profile from a cross-region (system-defined) inference profile
Run the following example to create an application inference profile from the US Anthropic Claude 3 Sonnet inference profile in the `us-west-2` region, replacing `${AccountId}` with your AWS account ID:
#### Sample Request
```
POST /inference-profiles HTTP/1.1
Content-type: application/json
{
"inferenceProfileName": "USClaudeSonnetApplicationIP",
"modelSource": {
"copyFrom": "arn:aws:bedrock:us-west-2:${AccountId}:inference-profile/us.anthropic.claude-3-sonnet-20240229-v1:0"
},
"tags": [
{
"key": "projectId",
"value": "abcdef123456"
}
]
}
```
## 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-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateInferenceProfile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateInferenceProfile)
# CreateMarketplaceModelEndpoint
Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.
## Request Syntax
```
POST /marketplace-model/endpoints HTTP/1.1
Content-type: application/json
{
"acceptEula": boolean,
"clientRequestToken": "string",
"endpointConfig": { ... },
"endpointName": "string",
"modelSourceIdentifier": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [acceptEula](#API_CreateMarketplaceModelEndpoint_RequestSyntax) **
Indicates whether you accept the end-user license agreement (EULA) for the model. Set to `true` to accept the EULA.
Type: Boolean
Required: No
** [clientRequestToken](#API_CreateMarketplaceModelEndpoint_RequestSyntax) **
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because AWS SDKs automatically generate it for you and set this parameter. If you're not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [endpointConfig](#API_CreateMarketplaceModelEndpoint_RequestSyntax) **
The configuration for the endpoint, including the number and type of instances to use.
Type: [EndpointConfig](API_EndpointConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [endpointName](#API_CreateMarketplaceModelEndpoint_RequestSyntax) **
The name of the endpoint. This name must be unique within your AWS account and region.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 30.
Required: Yes
** [modelSourceIdentifier](#API_CreateMarketplaceModelEndpoint_RequestSyntax) **
The ARN of the model from Amazon Bedrock Marketplace that you want to deploy to the endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*`
Required: Yes
** [tags](#API_CreateMarketplaceModelEndpoint_RequestSyntax) **
An array of key-value pairs to apply to the underlying Amazon SageMaker endpoint. You can use these tags to organize and identify your AWS resources.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"marketplaceModelEndpoint": {
"createdAt": "string",
"endpointArn": "string",
"endpointConfig": { ... },
"endpointStatus": "string",
"endpointStatusMessage": "string",
"modelSourceIdentifier": "string",
"status": "string",
"statusMessage": "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.
** [marketplaceModelEndpoint](#API_CreateMarketplaceModelEndpoint_ResponseSyntax) **
Details about the created endpoint.
Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** 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.
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-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateMarketplaceModelEndpoint)
# CreateModelCopyJob
Copies a model to another region so that it can be used there. For more information, see [Copy models to be used in other regions](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
POST /model-copy-jobs HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"modelKmsKeyId": "string",
"sourceModelArn": "string",
"targetModelName": "string",
"targetModelTags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateModelCopyJob_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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [modelKmsKeyId](#API_CreateModelCopyJob_RequestSyntax) **
The ARN of the AWS KMS key that you use to encrypt the model copy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
** [sourceModelArn](#API_CreateModelCopyJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the model to be copied.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
Required: Yes
** [targetModelName](#API_CreateModelCopyJob_RequestSyntax) **
A name for the copied model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: Yes
** [targetModelTags](#API_CreateModelCopyJob_RequestSyntax) **
Tags to associate with the target model. For more information, see [Tag resources](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"jobArn": "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.
** [jobArn](#API_CreateModelCopyJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the model copy job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}`
## 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
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
## Examples
### Create a model copy job (CLI)
The following example shows how to copy a custom model from `us-west-2` into the region from which the request is made, using the AWS CLI.
```
aws bedrock create-model-copy-job --source-model-arn arn:aws:bedrock:us-west-2:123456789012:custom-model/amazon.titan-text-lite-v1:0:4k/MyCustomModel --target-model-name MyCustomModelCopy
```
## 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-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateModelCopyJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateModelCopyJob)
# CreateModelCustomizationJob
Creates a fine-tuning job to customize a base model.
You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Amazon Bedrock returns validation loss metrics and output generations after the job completes.
For information on the format of training and validation data, see [Prepare the datasets](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-prepare.html).
Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the `GetModelCustomizationJob` operation to retrieve the job status.
For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
POST /model-customization-jobs HTTP/1.1
Content-type: application/json
{
"baseModelIdentifier": "string",
"clientRequestToken": "string",
"customizationConfig": { ... },
"customizationType": "string",
"customModelKmsKeyId": "string",
"customModelName": "string",
"customModelTags": [
{
"key": "string",
"value": "string"
}
],
"hyperParameters": {
"string" : "string"
},
"jobName": "string",
"jobTags": [
{
"key": "string",
"value": "string"
}
],
"outputDataConfig": {
"s3Uri": "string"
},
"roleArn": "string",
"trainingDataConfig": {
"invocationLogsConfig": {
"invocationLogSource": { ... },
"requestMetadataFilters": { ... },
"usePromptResponse": boolean
},
"s3Uri": "string"
},
"validationDataConfig": {
"validators": [
{
"s3Uri": "string"
}
]
},
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ]
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [baseModelIdentifier](#API_CreateModelCustomizationJob_RequestSyntax) **
Name of the base model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)`
Required: Yes
** [clientRequestToken](#API_CreateModelCustomizationJob_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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [customizationConfig](#API_CreateModelCustomizationJob_RequestSyntax) **
The customization configuration for the model customization job.
Type: [CustomizationConfig](API_CustomizationConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** [customizationType](#API_CreateModelCustomizationJob_RequestSyntax) **
The customization type.
Type: String
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION`
Required: No
** [customModelKmsKeyId](#API_CreateModelCustomizationJob_RequestSyntax) **
The custom model is encrypted at rest using this key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
** [customModelName](#API_CreateModelCustomizationJob_RequestSyntax) **
A name for the resulting custom model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: Yes
** [customModelTags](#API_CreateModelCustomizationJob_RequestSyntax) **
Tags to attach to the resulting custom model.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [hyperParameters](#API_CreateModelCustomizationJob_RequestSyntax) **
Parameters related to tuning the model. For details on the format for different models, see [Custom model hyperparameters](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html).
Type: String to string map
Required: No
** [jobName](#API_CreateModelCustomizationJob_RequestSyntax) **
A name for the fine-tuning job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
Required: Yes
** [jobTags](#API_CreateModelCustomizationJob_RequestSyntax) **
Tags to attach to the job.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [outputDataConfig](#API_CreateModelCustomizationJob_RequestSyntax) **
S3 location for the output data.
Type: [OutputDataConfig](API_OutputDataConfig.md) object
Required: Yes
** [roleArn](#API_CreateModelCustomizationJob_RequestSyntax) **
The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3 bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must have the `iam:PassRole` permission.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** [trainingDataConfig](#API_CreateModelCustomizationJob_RequestSyntax) **
Information about the training dataset.
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object
Required: Yes
** [validationDataConfig](#API_CreateModelCustomizationJob_RequestSyntax) **
Information about the validation dataset.
Type: [ValidationDataConfig](API_ValidationDataConfig.md) object
Required: No
** [vpcConfig](#API_CreateModelCustomizationJob_RequestSyntax) **
The configuration of the Virtual Private Cloud (VPC) that contains the resources that you're using for this job. For more information, see [Protect your model customization jobs using a VPC](https://docs.aws.amazon.com/bedrock/latest/userguide/vpc-model-customization.html).
Type: [VpcConfig](API_VpcConfig.md) object
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"jobArn": "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.
** [jobArn](#API_CreateModelCustomizationJob_ResponseSyntax) **
Amazon Resource Name (ARN) of the fine tuning job
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
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-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateModelCustomizationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateModelCustomizationJob)
# CreateModelImportJob
Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker. For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html)
## Request Syntax
```
POST /model-import-jobs HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"importedModelKmsKeyId": "string",
"importedModelName": "string",
"importedModelTags": [
{
"key": "string",
"value": "string"
}
],
"jobName": "string",
"jobTags": [
{
"key": "string",
"value": "string"
}
],
"modelDataSource": { ... },
"roleArn": "string",
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ]
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateModelImportJob_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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [importedModelKmsKeyId](#API_CreateModelImportJob_RequestSyntax) **
The imported model is encrypted at rest using this key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
** [importedModelName](#API_CreateModelImportJob_RequestSyntax) **
The name of the imported model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
Required: Yes
** [importedModelTags](#API_CreateModelImportJob_RequestSyntax) **
Tags to attach to the imported model.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [jobName](#API_CreateModelImportJob_RequestSyntax) **
The name of the import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
Required: Yes
** [jobTags](#API_CreateModelImportJob_RequestSyntax) **
Tags to attach to this import job.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [modelDataSource](#API_CreateModelImportJob_RequestSyntax) **
The data source for the imported model.
Type: [ModelDataSource](API_ModelDataSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [roleArn](#API_CreateModelImportJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the service role with the proper custom model import permissions. You can use the console to automatically create a service role with the proper permissions or create a custom service role. For more information about creating a custom service role, see [Create a service role for model import](https://docs.aws.amazon.com/bedrock/latest/userguide/model-import-iam-role.html).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** [vpcConfig](#API_CreateModelImportJob_RequestSyntax) **
VPC configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for the import job.
Type: [VpcConfig](API_VpcConfig.md) object
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"jobArn": "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.
** [jobArn](#API_CreateModelImportJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the model import job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
## Examples
### Create a model import job
Creates a model import job.
```
POST /model-import-jobs/ HTTP/1.1
Content-type: application/json
{
"importedModelName": "ImportedModelName",
"jobName": "MyImportedModelJobName",
"modelDataSource": {
"s3DataSource": {
"s3Uri": "S3://amzn-s3-demo-bucket/key-name"
}
},
"roleArn": "arn:aws:iam::111122223333:role/Role_Name"
}
```
### Example response
Response for the above request.
```
HTTP/1.1 200
Content-type: application/json
{
"jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/yggb47n4xlml"
}
```
## 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-2023-04-20/CreateModelImportJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateModelImportJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateModelImportJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateModelImportJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateModelImportJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateModelImportJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateModelImportJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateModelImportJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateModelImportJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateModelImportJob)
# CreateModelInvocationJob
Creates a batch inference job to invoke a model on multiple prompts. Format your data according to [Format your inference data](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data) and upload it to an Amazon S3 bucket. For more information, see [Process multiple prompts with batch inference](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference.html).
The response returns a `jobArn` that you can use to stop or get details about the job.
## Request Syntax
```
POST /model-invocation-job HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"inputDataConfig": { ... },
"jobName": "string",
"modelId": "string",
"modelInvocationType": "string",
"outputDataConfig": { ... },
"roleArn": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"timeoutDurationInHours": number,
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ]
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateModelInvocationJob_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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}`
Required: No
** [inputDataConfig](#API_CreateModelInvocationJob_RequestSyntax) **
Details about the location of the input to the batch inference job.
Type: [ModelInvocationJobInputDataConfig](API_ModelInvocationJobInputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [jobName](#API_CreateModelInvocationJob_RequestSyntax) **
A name to give the batch inference job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\+\-\.]){0,63}`
Required: Yes
** [modelId](#API_CreateModelInvocationJob_RequestSyntax) **
The unique identifier of the foundation model to use for the batch inference job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-:]{1,63}/[a-z0-9]{12}$)|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)`
Required: Yes
** [modelInvocationType](#API_CreateModelInvocationJob_RequestSyntax) **
The invocation endpoint for ModelInvocationJob
Type: String
Valid Values: `InvokeModel | Converse`
Required: No
** [outputDataConfig](#API_CreateModelInvocationJob_RequestSyntax) **
Details about the location of the output of the batch inference job.
Type: [ModelInvocationJobOutputDataConfig](API_ModelInvocationJobOutputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [roleArn](#API_CreateModelInvocationJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at [Create a service role for batch inference](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** [tags](#API_CreateModelInvocationJob_RequestSyntax) **
Any tags to associate with the batch inference job. For more information, see [Tagging Amazon Bedrock resources](https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html).
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [timeoutDurationInHours](#API_CreateModelInvocationJob_RequestSyntax) **
The number of hours after which to force the batch inference job to time out.
Type: Integer
Valid Range: Minimum value of 24. Maximum value of 168.
Required: No
** [vpcConfig](#API_CreateModelInvocationJob_RequestSyntax) **
The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see [Protect batch inference jobs using a VPC](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc).
Type: [VpcConfig](API_VpcConfig.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"jobArn": "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.
** [jobArn](#API_CreateModelInvocationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the batch inference job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** 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.
HTTP Status Code: 400
## Examples
### Create a batch inference job
This example illustrates one usage of CreateModelInvocationJob.
```
POST /model-invocation-job HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"inputDataConfig": {
"s3InputDataConfig": {
"s3Uri": "s3://input-bucket/abc.jsonl"
}
},
"jobName": "my-batch-job",
"modelId": "anthropic.claude-3-haiku-20240307-v1:0",
"outputDataConfig": {
"s3OutputDataConfig": {
"s3Uri": "s3://output-bucket/"
}
},
"roleArn": "arn:aws:iam::123456789012:role/MyBatchInferenceRole"
}
```
## 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-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateModelInvocationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateModelInvocationJob)
# CreatePromptRouter
Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.
## Request Syntax
```
POST /prompt-routers HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"description": "string",
"fallbackModel": {
"modelArn": "string"
},
"models": [
{
"modelArn": "string"
}
],
"promptRouterName": "string",
"routingCriteria": {
"responseQualityDifference": number
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreatePromptRouter_RequestSyntax) **
A unique, case-sensitive identifier that you provide to ensure idempotency of your requests. If not specified, the AWS SDK automatically generates one for you.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [description](#API_CreatePromptRouter_RequestSyntax) **
An optional description of the prompt router to help identify its purpose.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `([0-9a-zA-Z:.][ _-]?)+`
Required: No
** [fallbackModel](#API_CreatePromptRouter_RequestSyntax) **
The default model to use when the routing criteria is not met.
Type: [PromptRouterTargetModel](API_PromptRouterTargetModel.md) object
Required: Yes
** [models](#API_CreatePromptRouter_RequestSyntax) **
A list of foundation models that the prompt router can route requests to. At least one model must be specified.
Type: Array of [PromptRouterTargetModel](API_PromptRouterTargetModel.md) objects
Required: Yes
** [promptRouterName](#API_CreatePromptRouter_RequestSyntax) **
The name of the prompt router. The name must be unique within your AWS account in the current region.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `([0-9a-zA-Z][ _-]?)+`
Required: Yes
** [routingCriteria](#API_CreatePromptRouter_RequestSyntax) **
The criteria, which is the response quality difference, used to determine how incoming requests are routed to different models.
Type: [RoutingCriteria](API_RoutingCriteria.md) object
Required: Yes
** [tags](#API_CreatePromptRouter_RequestSyntax) **
An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your AWS resources.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"promptRouterArn": "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.
** [promptRouterArn](#API_CreatePromptRouter_ResponseSyntax) **
The Amazon Resource Name (ARN) that uniquely identifies the prompt router.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
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-2023-04-20/CreatePromptRouter)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreatePromptRouter)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreatePromptRouter)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreatePromptRouter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreatePromptRouter)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreatePromptRouter)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreatePromptRouter)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreatePromptRouter)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreatePromptRouter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreatePromptRouter)
# CreateProvisionedModelThroughput
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see [Amazon Bedrock Pricing](http://aws.amazon.com/bedrock/pricing/). For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
POST /provisioned-model-throughput HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"commitmentDuration": "string",
"modelId": "string",
"modelUnits": number,
"provisionedModelName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_CreateProvisionedModelThroughput_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) in the Amazon S3 User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [commitmentDuration](#API_CreateProvisionedModelThroughput_RequestSyntax) **
The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.
Custom models support all levels of commitment. To see which base models support no commitment, see [Supported regions and models for Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html)
Type: String
Valid Values: `OneMonth | SixMonths`
Required: No
** [modelId](#API_CreateProvisionedModelThroughput_RequestSyntax) **
The model ID (for a foundation model), name (for a custom model), or Amazon Resource Name (ARN) of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see [Amazon Bedrock model IDs for purchasing Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)`
Required: Yes
** [modelUnits](#API_CreateProvisionedModelThroughput_RequestSyntax) **
Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the [AWS support center](https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase) to request MUs.
For model unit quotas, see [Provisioned Throughput quotas](https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
For more information about what an MU specifies, contact your AWS account manager.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
** [provisionedModelName](#API_CreateProvisionedModelThroughput_RequestSyntax) **
The name for this Provisioned Throughput.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
Required: Yes
** [tags](#API_CreateProvisionedModelThroughput_RequestSyntax) **
Tags to associate with this Provisioned Throughput.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"provisionedModelArn": "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.
** [provisionedModelArn](#API_CreateProvisionedModelThroughput_ResponseSyntax) **
The Amazon Resource Name (ARN) for this Provisioned Throughput.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}`
## 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: 400
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
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-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/CreateProvisionedModelThroughput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CreateProvisionedModelThroughput)
# DeleteAutomatedReasoningPolicy
Deletes an Automated Reasoning policy or policy version. This operation is idempotent. If you delete a policy more than once, each call succeeds. Deleting a policy removes it permanently and cannot be undone.
## Request Syntax
```
DELETE /automated-reasoning-policies/policyArn?force=force HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [force](#API_DeleteAutomatedReasoningPolicy_RequestSyntax) **
Specifies whether to force delete the automated reasoning policy even if it has active resources. When `false`, Amazon Bedrock validates if all artifacts have been deleted (e.g. policy version, test case, test result) for a policy before deletion. When `true`, Amazon Bedrock will delete the policy and all its artifacts without validation. Default is `false`.
** [policyArn](#API_DeleteAutomatedReasoningPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy to delete.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceInUseException **
Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
HTTP Status Code: 400
** 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.
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-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicy)
# DeleteAutomatedReasoningPolicyBuildWorkflow
Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.
## Request Syntax
```
DELETE /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId?updatedAt=lastUpdatedAt HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The unique identifier of the build workflow to delete.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [lastUpdatedAt](#API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The timestamp when the build workflow was last updated. This is used for optimistic concurrency control to prevent accidental deletion of workflows that have been modified.
Required: Yes
** [policyArn](#API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to delete.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceInUseException **
Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
HTTP Status Code: 400
** 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.
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-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyBuildWorkflow)
# DeleteAutomatedReasoningPolicyTestCase
Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.
## Request Syntax
```
DELETE /automated-reasoning-policies/policyArn/test-cases/testCaseId?updatedAt=lastUpdatedAt HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [lastUpdatedAt](#API_DeleteAutomatedReasoningPolicyTestCase_RequestSyntax) **
The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications.
Required: Yes
** [policyArn](#API_DeleteAutomatedReasoningPolicyTestCase_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** [testCaseId](#API_DeleteAutomatedReasoningPolicyTestCase_RequestSyntax) **
The unique identifier of the test to delete.
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[0-9A-Z]{12}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceInUseException **
Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
HTTP Status Code: 400
** 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.
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-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteAutomatedReasoningPolicyTestCase)
# DeleteCustomModel
Deletes a custom model that you created earlier. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
DELETE /custom-models/modelIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelIdentifier](#API_DeleteCustomModel_RequestSyntax) **
Name of the model to delete.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)`
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/DeleteCustomModel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteCustomModel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteCustomModel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteCustomModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteCustomModel)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteCustomModel)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteCustomModel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteCustomModel)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteCustomModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteCustomModel)
# DeleteCustomModelDeployment
Deletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests.
The following actions are related to the `DeleteCustomModelDeployment` operation:
+ [CreateCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html)
+ [GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html)
+ [ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html)
## Request Syntax
```
DELETE /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [customModelDeploymentIdentifier](#API_DeleteCustomModelDeployment_RequestSyntax) **
The Amazon Resource Name (ARN) or name of the custom model deployment to delete.
Length Constraints: Minimum length of 1. Maximum length of 93.
Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12})|^([0-9a-zA-Z][_-]?){1,63}`
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteCustomModelDeployment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteCustomModelDeployment)
# DeleteEnforcedGuardrailConfiguration
Deletes the account-level enforced guardrail configuration.
## Request Syntax
```
DELETE /enforcedGuardrailsConfiguration/configId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [configId](#API_DeleteEnforcedGuardrailConfiguration_RequestSyntax) **
Unique ID for the account enforced configuration.
Pattern: `[a-z0-9]+`
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.
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-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteEnforcedGuardrailConfiguration)
# DeleteFoundationModelAgreement
Delete the model access agreement for the specified model.
## Request Syntax
```
POST /delete-foundation-model-agreement HTTP/1.1
Content-type: application/json
{
"modelId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [modelId](#API_DeleteFoundationModelAgreement_RequestSyntax) **
Model Id of the model access to delete.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: Yes
## Response Syntax
```
HTTP/1.1 202
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteFoundationModelAgreement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteFoundationModelAgreement)
# DeleteGuardrail
Deletes a guardrail.
+ To delete a guardrail, only specify the ARN of the guardrail in the `guardrailIdentifier` field. If you delete a guardrail, all of its versions will be deleted.
+ To delete a version of a guardrail, specify the ARN of the guardrail in the `guardrailIdentifier` field and the version in the `guardrailVersion` field.
## Request Syntax
```
DELETE /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [guardrailIdentifier](#API_DeleteGuardrail_RequestSyntax) **
The unique identifier of the guardrail. This can be an ID or the ARN.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: Yes
** [guardrailVersion](#API_DeleteGuardrail_RequestSyntax) **
The version of the guardrail.
Pattern: `[1-9][0-9]{0,7}`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceInUseException **
Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
HTTP Status Code: 400
** 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.
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-2023-04-20/DeleteGuardrail)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteGuardrail)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteGuardrail)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteGuardrail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteGuardrail)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteGuardrail)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteGuardrail)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteGuardrail)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteGuardrail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteGuardrail)
# DeleteImportedModel
Deletes a custom model that you imported earlier. For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
DELETE /imported-models/modelIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelIdentifier](#API_DeleteImportedModel_RequestSyntax) **
Name of the imported model to delete.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12})|(([0-9a-zA-Z][_-]?)+)`
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
## Examples
### Delete an imported model
Deletes a model that you have previously imported.
```
DELETE /imported-models/{modelIdentifier} HTTP/1.1
Content-type: application/json
```
### Example response
Response for the above request.
```
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-2023-04-20/DeleteImportedModel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteImportedModel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteImportedModel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteImportedModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteImportedModel)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteImportedModel)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteImportedModel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteImportedModel)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteImportedModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteImportedModel)
# DeleteInferenceProfile
Deletes an application inference profile. For more information, see [Increase throughput and resilience with cross-region inference in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). in the Amazon Bedrock User Guide.
## Request Syntax
```
DELETE /inference-profiles/inferenceProfileIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [inferenceProfileIdentifier](#API_DeleteInferenceProfile_RequestSyntax) **
The Amazon Resource Name (ARN) or ID of the application inference profile to delete.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/)?[a-zA-Z0-9-:.]+`
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
## Examples
### Delete an application inference profile
Assuming you've created an application inference profile called `USClaudeSonnetApplicationIP`, run the following example to delete it:
#### Sample Request
```
DELETE /inference-profiles/USClaudeSonnetApplicationIP 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-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteInferenceProfile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteInferenceProfile)
# DeleteMarketplaceModelEndpoint
Deletes an endpoint for a model from Amazon Bedrock Marketplace.
## Request Syntax
```
DELETE /marketplace-model/endpoints/endpointArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [endpointArn](#API_DeleteMarketplaceModelEndpoint_RequestSyntax) **
The Amazon Resource Name (ARN) of the endpoint you want to delete.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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.
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-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteMarketplaceModelEndpoint)
# DeleteModelInvocationLoggingConfiguration
Delete the invocation logging.
## Request Syntax
```
DELETE /logging/modelinvocations HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## 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
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
## 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-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteModelInvocationLoggingConfiguration)
# DeletePromptRouter
Deletes a specified prompt router. This action cannot be undone.
## Request Syntax
```
DELETE /prompt-routers/promptRouterArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [promptRouterArn](#API_DeletePromptRouter_RequestSyntax) **
The Amazon Resource Name (ARN) of the prompt router to delete.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+`
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.
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-2023-04-20/DeletePromptRouter)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeletePromptRouter)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeletePromptRouter)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeletePromptRouter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeletePromptRouter)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeletePromptRouter)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeletePromptRouter)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeletePromptRouter)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeletePromptRouter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeletePromptRouter)
# DeleteProvisionedModelThroughput
Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
DELETE /provisioned-model-throughput/provisionedModelId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [provisionedModelId](#API_DeleteProvisionedModelThroughput_RequestSyntax) **
The Amazon Resource Name (ARN) or ID of the Provisioned Throughput.
Pattern: `((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))`
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteProvisionedModelThroughput)
# DeleteResourcePolicy
Deletes a previously created Bedrock resource policy.
## Request Syntax
```
DELETE /resource-policy/resourceArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_DeleteResourcePolicy_RequestSyntax) **
The ARN of the Bedrock resource to which this resource policy applies.
Length Constraints: Minimum length of 1. Maximum length of 255.
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.
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-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeleteResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeleteResourcePolicy)
# DeregisterMarketplaceModelEndpoint
Deregisters an endpoint for a model from Amazon Bedrock Marketplace. This operation removes the endpoint's association with Amazon Bedrock but does not delete the underlying Amazon SageMaker endpoint.
## Request Syntax
```
DELETE /marketplace-model/endpoints/endpointArn/registration HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [endpointArn](#API_DeregisterMarketplaceModelEndpoint_RequestSyntax) **
The Amazon Resource Name (ARN) of the endpoint you want to deregister.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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
** ServiceUnavailableException **
Returned if the service cannot complete the request.
HTTP Status Code: 503
** 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.
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-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DeregisterMarketplaceModelEndpoint)
# ExportAutomatedReasoningPolicyVersion
Exports the policy definition for an Automated Reasoning policy version. Returns the complete policy definition including rules, variables, and custom variable types in a structured format.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/export HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [policyArn](#API_ExportAutomatedReasoningPolicyVersion_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy to export. Can be either the unversioned ARN for the draft policy or a versioned ARN for a specific policy version.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"rules": [
{
"alternateExpression": "string",
"expression": "string",
"id": "string"
}
],
"types": [
{
"description": "string",
"name": "string",
"values": [
{
"description": "string",
"value": "string"
}
]
}
],
"variables": [
{
"description": "string",
"name": "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.
** [rules](#API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax) **
The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable.
Type: Array of [AutomatedReasoningPolicyDefinitionRule](API_AutomatedReasoningPolicyDefinitionRule.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1500 items.
** [types](#API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax) **
The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types.
Type: Array of [AutomatedReasoningPolicyDefinitionType](API_AutomatedReasoningPolicyDefinitionType.md) objects
Array Members: Minimum number of 0 items. Maximum number of 150 items.
** [variables](#API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax) **
The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation.
Type: Array of [AutomatedReasoningPolicyDefinitionVariable](API_AutomatedReasoningPolicyDefinitionVariable.md) objects
Array Members: Minimum number of 0 items. Maximum number of 600 items.
** [version](#API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax) **
The version of the policy definition format.
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
** 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.
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-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ExportAutomatedReasoningPolicyVersion)
# GetAutomatedReasoningPolicy
Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [policyArn](#API_GetAutomatedReasoningPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy to retrieve. Can be either the unversioned ARN for the draft policy or an ARN for a specific policy version.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"definitionHash": "string",
"description": "string",
"kmsKeyArn": "string",
"name": "string",
"policyArn": "string",
"policyId": "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.
** [createdAt](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The timestamp when the policy was created.
Type: Timestamp
** [definitionHash](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The hash of the policy definition used as a concurrency token.
Type: String
Length Constraints: Fixed length of 128.
Pattern: `[0-9a-z]{128}`
** [description](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The description of the policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
** [kmsKeyArn](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the automated reasoning policy and its associated artifacts. If a AWS KMS key is not provided during the initial CreateAutomatedReasoningPolicyRequest, the kmsKeyArn won't be included in the GetAutomatedReasoningPolicyResponse.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [name](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The name of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[0-9a-zA-Z-_ ]+`
** [policyArn](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [policyId](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The unique identifier of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `[a-z0-9]{12}`
** [updatedAt](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The timestamp when the policy was last updated.
Type: Timestamp
** [version](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **
The version of the policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `([1-9][0-9]{0,11})`
## 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.
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-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicy)
# GetAutomatedReasoningPolicyAnnotations
Retrieves the current annotations for an Automated Reasoning policy build workflow. Annotations contain corrections to the rules, variables and types to be applied to the policy.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/annotations HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_GetAutomatedReasoningPolicyAnnotations_RequestSyntax) **
The unique identifier of the build workflow whose annotations you want to retrieve.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [policyArn](#API_GetAutomatedReasoningPolicyAnnotations_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"annotations": [
{ ... }
],
"annotationSetHash": "string",
"buildWorkflowId": "string",
"name": "string",
"policyArn": "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.
** [annotations](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The current set of annotations containing rules, variables, and types extracted from the source documents. These can be modified before finalizing the policy.
Type: Array of [AutomatedReasoningPolicyAnnotation](API_AutomatedReasoningPolicyAnnotation.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [annotationSetHash](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
A hash value representing the current state of the annotations. This is used for optimistic concurrency control when updating annotations.
Type: String
Length Constraints: Fixed length of 128.
Pattern: `[0-9a-z]{128}`
** [buildWorkflowId](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The unique identifier of the build workflow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
** [name](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The name of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[0-9a-zA-Z-_ ]+`
** [policyArn](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [updatedAt](#API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The timestamp when the annotations were 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.
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-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyAnnotations)
# GetAutomatedReasoningPolicyBuildWorkflow
Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The unique identifier of the build workflow to retrieve.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [policyArn](#API_GetAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow you want to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"buildWorkflowId": "string",
"buildWorkflowType": "string",
"createdAt": "string",
"documentContentType": "string",
"documentDescription": "string",
"documentName": "string",
"policyArn": "string",
"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.
** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The unique identifier of the build workflow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
** [buildWorkflowType](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The type of build workflow being executed (e.g., DOCUMENT\$1INGESTION, POLICY\$1REPAIR).
Type: String
Valid Values: `INGEST_CONTENT | REFINE_POLICY | IMPORT_POLICY | GENERATE_FIDELITY_REPORT`
** [createdAt](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The timestamp when the build workflow was created.
Type: Timestamp
** [documentContentType](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The content type of the source document (e.g., text/plain, application/pdf).
Type: String
Valid Values: `pdf | txt`
** [documentDescription](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
A detailed description of the document's content and how it should be used in the policy generation process.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4000.
** [documentName](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The name of the source document used in the build workflow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
** [policyArn](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [status](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED).
Type: String
Valid Values: `SCHEDULED | CANCEL_REQUESTED | PREPROCESSING | BUILDING | TESTING | COMPLETED | FAILED | CANCELLED`
** [updatedAt](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The timestamp when the build workflow 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.
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-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflow)
# GetAutomatedReasoningPolicyBuildWorkflowResultAssets
Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/result-assets?assetId=assetId&assetType=assetType HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [assetId](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) **
The unique identifier of the specific asset to retrieve when multiple assets of the same type exist. This is required when retrieving SOURCE\$1DOCUMENT assets, as multiple source documents may have been used in the workflow. The asset ID can be obtained from the asset manifest.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[0-9a-fA-F\-]+`
** [assetType](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) **
The type of asset to retrieve (e.g., BUILD\$1LOG, QUALITY\$1REPORT, POLICY\$1DEFINITION, GENERATED\$1TEST\$1CASES, POLICY\$1SCENARIOS, FIDELITY\$1REPORT, ASSET\$1MANIFEST, SOURCE\$1DOCUMENT).
Valid Values: `BUILD_LOG | QUALITY_REPORT | POLICY_DEFINITION | GENERATED_TEST_CASES | POLICY_SCENARIOS | FIDELITY_REPORT | ASSET_MANIFEST | SOURCE_DOCUMENT`
Required: Yes
** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) **
The unique identifier of the build workflow whose result assets you want to retrieve.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [policyArn](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflow assets you want to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"buildWorkflowAssets": { ... },
"buildWorkflowId": "string",
"policyArn": "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.
** [buildWorkflowAssets](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_ResponseSyntax) **
The requested build workflow asset. This is a union type that returns only one of the available asset types (logs, reports, or generated artifacts) based on the specific asset type requested in the API call.
Type: [AutomatedReasoningPolicyBuildResultAssets](API_AutomatedReasoningPolicyBuildResultAssets.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_ResponseSyntax) **
The unique identifier of the build workflow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
** [policyArn](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_ResponseSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
## 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.
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-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyBuildWorkflowResultAssets)
# GetAutomatedReasoningPolicyNextScenario
Retrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/scenarios HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_GetAutomatedReasoningPolicyNextScenario_RequestSyntax) **
The unique identifier of the build workflow associated with the test scenarios.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [policyArn](#API_GetAutomatedReasoningPolicyNextScenario_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy for which you want to get the next test scenario.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"policyArn": "string",
"scenario": {
"alternateExpression": "string",
"expectedResult": "string",
"expression": "string",
"ruleIds": [ "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.
** [policyArn](#API_GetAutomatedReasoningPolicyNextScenario_ResponseSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [scenario](#API_GetAutomatedReasoningPolicyNextScenario_ResponseSyntax) **
The next test scenario to validate, including the test expression and expected results.
Type: [AutomatedReasoningPolicyScenario](API_AutomatedReasoningPolicyScenario.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.
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-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyNextScenario)
# GetAutomatedReasoningPolicyTestCase
Retrieves details about a specific Automated Reasoning policy test.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/test-cases/testCaseId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [policyArn](#API_GetAutomatedReasoningPolicyTestCase_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** [testCaseId](#API_GetAutomatedReasoningPolicyTestCase_RequestSyntax) **
The unique identifier of the test to retrieve.
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[0-9A-Z]{12}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"policyArn": "string",
"testCase": {
"confidenceThreshold": number,
"createdAt": "string",
"expectedAggregatedFindingsResult": "string",
"guardContent": "string",
"queryContent": "string",
"testCaseId": "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.
** [policyArn](#API_GetAutomatedReasoningPolicyTestCase_ResponseSyntax) **
The Amazon Resource Name (ARN) of the policy that contains the test.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [testCase](#API_GetAutomatedReasoningPolicyTestCase_ResponseSyntax) **
The test details including the content, query, expected result, and metadata.
Type: [AutomatedReasoningPolicyTestCase](API_AutomatedReasoningPolicyTestCase.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.
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-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestCase)
# GetAutomatedReasoningPolicyTestResult
Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-cases/testCaseId/test-results HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_GetAutomatedReasoningPolicyTestResult_RequestSyntax) **
The build workflow identifier. The build workflow must display a `COMPLETED` status to get results.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [policyArn](#API_GetAutomatedReasoningPolicyTestResult_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** [testCaseId](#API_GetAutomatedReasoningPolicyTestResult_RequestSyntax) **
The unique identifier of the test for which to retrieve results.
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[0-9A-Z]{12}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"testResult": {
"aggregatedTestFindingsResult": "string",
"policyArn": "string",
"testCase": {
"confidenceThreshold": number,
"createdAt": "string",
"expectedAggregatedFindingsResult": "string",
"guardContent": "string",
"queryContent": "string",
"testCaseId": "string",
"updatedAt": "string"
},
"testFindings": [
{ ... }
],
"testRunResult": "string",
"testRunStatus": "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.
** [testResult](#API_GetAutomatedReasoningPolicyTestResult_ResponseSyntax) **
The test result containing validation findings, execution status, and detailed analysis.
Type: [AutomatedReasoningPolicyTestResult](API_AutomatedReasoningPolicyTestResult.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.
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-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetAutomatedReasoningPolicyTestResult)
# GetCustomModel
Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /custom-models/modelIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelIdentifier](#API_GetCustomModel_RequestSyntax) **
Name or Amazon Resource Name (ARN) of the custom model.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"baseModelArn": "string",
"creationTime": "string",
"customizationConfig": { ... },
"customizationType": "string",
"failureMessage": "string",
"hyperParameters": {
"string" : "string"
},
"jobArn": "string",
"jobName": "string",
"modelArn": "string",
"modelKmsKeyArn": "string",
"modelName": "string",
"modelStatus": "string",
"outputDataConfig": {
"s3Uri": "string"
},
"trainingDataConfig": {
"invocationLogsConfig": {
"invocationLogSource": { ... },
"requestMetadataFilters": { ... },
"usePromptResponse": boolean
},
"s3Uri": "string"
},
"trainingMetrics": {
"trainingLoss": number
},
"validationDataConfig": {
"validators": [
{
"s3Uri": "string"
}
]
},
"validationMetrics": [
{
"validationLoss": number
}
]
}
```
## 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.
** [baseModelArn](#API_GetCustomModel_ResponseSyntax) **
Amazon Resource Name (ARN) of the base model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
** [creationTime](#API_GetCustomModel_ResponseSyntax) **
Creation time of the model.
Type: Timestamp
** [customizationConfig](#API_GetCustomModel_ResponseSyntax) **
The customization configuration for the custom model.
Type: [CustomizationConfig](API_CustomizationConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [customizationType](#API_GetCustomModel_ResponseSyntax) **
The type of model customization.
Type: String
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION | REINFORCEMENT_FINE_TUNING | IMPORTED`
** [failureMessage](#API_GetCustomModel_ResponseSyntax) **
A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [hyperParameters](#API_GetCustomModel_ResponseSyntax) **
Hyperparameter values associated with this model. For details on the format for different models, see [Custom model hyperparameters](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html).
Type: String to string map
** [jobArn](#API_GetCustomModel_ResponseSyntax) **
Job Amazon Resource Name (ARN) associated with this model. For models that you create with the [CreateCustomModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html) API operation, this is `NULL`.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}`
** [jobName](#API_GetCustomModel_ResponseSyntax) **
Job name associated with this model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
** [modelArn](#API_GetCustomModel_ResponseSyntax) **
Amazon Resource Name (ARN) associated with this model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
** [modelKmsKeyArn](#API_GetCustomModel_ResponseSyntax) **
The custom model is encrypted at rest using this key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [modelName](#API_GetCustomModel_ResponseSyntax) **
Model name associated with this model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
** [modelStatus](#API_GetCustomModel_ResponseSyntax) **
The current status of the custom model. Possible values include:
+ `Creating` - The model is being created and validated.
+ `Active` - The model has been successfully created and is ready for use.
+ `Failed` - The model creation process failed. Check the `failureMessage` field for details.
Type: String
Valid Values: `Active | Creating | Failed`
** [outputDataConfig](#API_GetCustomModel_ResponseSyntax) **
Output data configuration associated with this custom model.
Type: [OutputDataConfig](API_OutputDataConfig.md) object
** [trainingDataConfig](#API_GetCustomModel_ResponseSyntax) **
Contains information about the training dataset.
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object
** [trainingMetrics](#API_GetCustomModel_ResponseSyntax) **
Contains training metrics from the job creation.
Type: [TrainingMetrics](API_TrainingMetrics.md) object
** [validationDataConfig](#API_GetCustomModel_ResponseSyntax) **
Contains information about the validation dataset.
Type: [ValidationDataConfig](API_ValidationDataConfig.md) object
** [validationMetrics](#API_GetCustomModel_ResponseSyntax) **
The validation metrics from the job creation.
Type: Array of [ValidatorMetric](API_ValidatorMetric.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
** 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.
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-2023-04-20/GetCustomModel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetCustomModel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetCustomModel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetCustomModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetCustomModel)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetCustomModel)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetCustomModel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetCustomModel)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetCustomModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetCustomModel)
# GetCustomModelDeployment
Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.
The following actions are related to the `GetCustomModelDeployment` operation:
+ [CreateCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html)
+ [ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html)
+ [DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html)
## Request Syntax
```
GET /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [customModelDeploymentIdentifier](#API_GetCustomModelDeployment_RequestSyntax) **
The Amazon Resource Name (ARN) or name of the custom model deployment to retrieve information about.
Length Constraints: Minimum length of 1. Maximum length of 93.
Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12})|^([0-9a-zA-Z][_-]?){1,63}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"customModelDeploymentArn": "string",
"description": "string",
"failureMessage": "string",
"lastUpdatedAt": "string",
"modelArn": "string",
"modelDeploymentName": "string",
"status": "string",
"updateDetails": {
"modelArn": "string",
"updateStatus": "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.
** [createdAt](#API_GetCustomModelDeployment_ResponseSyntax) **
The date and time when the custom model deployment was created.
Type: Timestamp
** [customModelDeploymentArn](#API_GetCustomModelDeployment_ResponseSyntax) **
The Amazon Resource Name (ARN) of the custom model deployment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}`
** [description](#API_GetCustomModelDeployment_ResponseSyntax) **
The description of the custom model deployment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `.*`
** [failureMessage](#API_GetCustomModelDeployment_ResponseSyntax) **
If the deployment status is `FAILED`, this field contains a message describing the failure reason.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [lastUpdatedAt](#API_GetCustomModelDeployment_ResponseSyntax) **
The date and time when the custom model deployment was last updated.
Type: Timestamp
** [modelArn](#API_GetCustomModelDeployment_ResponseSyntax) **
The Amazon Resource Name (ARN) of the custom model associated with this deployment.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
** [modelDeploymentName](#API_GetCustomModelDeployment_ResponseSyntax) **
The name of the custom model deployment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
** [status](#API_GetCustomModelDeployment_ResponseSyntax) **
The status of the custom model deployment. Possible values are:
+ `CREATING` - The deployment is being set up and prepared for inference.
+ `ACTIVE` - The deployment is ready and available for inference requests.
+ `FAILED` - The deployment failed to be created or became unavailable.
Type: String
Valid Values: `Creating | Active | Failed`
** [updateDetails](#API_GetCustomModelDeployment_ResponseSyntax) **
Details about any pending or completed updates to the custom model deployment, including the new model ARN and update status.
Type: [CustomModelDeploymentUpdateDetails](API_CustomModelDeploymentUpdateDetails.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.
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-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetCustomModelDeployment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetCustomModelDeployment)
# GetEvaluationJob
Gets information about an evaluation job, such as the status of the job.
## Request Syntax
```
GET /evaluation-jobs/jobIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobIdentifier](#API_GetEvaluationJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the evaluation job you want get information on.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"applicationType": "string",
"creationTime": "string",
"customerEncryptionKeyId": "string",
"evaluationConfig": { ... },
"failureMessages": [ "string" ],
"inferenceConfig": { ... },
"jobArn": "string",
"jobDescription": "string",
"jobName": "string",
"jobType": "string",
"lastModifiedTime": "string",
"outputDataConfig": {
"s3Uri": "string"
},
"roleArn": "string",
"status": "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.
** [applicationType](#API_GetEvaluationJob_ResponseSyntax) **
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Type: String
Valid Values: `ModelEvaluation | RagEvaluation`
** [creationTime](#API_GetEvaluationJob_ResponseSyntax) **
The time the evaluation job was created.
Type: Timestamp
** [customerEncryptionKeyId](#API_GetEvaluationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
** [evaluationConfig](#API_GetEvaluationJob_ResponseSyntax) **
Contains the configuration details of either an automated or human-based evaluation job.
Type: [EvaluationConfig](API_EvaluationConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [failureMessages](#API_GetEvaluationJob_ResponseSyntax) **
A list of strings that specify why the evaluation job failed to create.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [inferenceConfig](#API_GetEvaluationJob_ResponseSyntax) **
Contains the configuration details of the inference model used for the evaluation job.
Type: [EvaluationInferenceConfig](API_EvaluationInferenceConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [jobArn](#API_GetEvaluationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the evaluation job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}`
** [jobDescription](#API_GetEvaluationJob_ResponseSyntax) **
The description of the evaluation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `.+`
** [jobName](#API_GetEvaluationJob_ResponseSyntax) **
The name for the evaluation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-z0-9](-*[a-z0-9]){0,62}`
** [jobType](#API_GetEvaluationJob_ResponseSyntax) **
Specifies whether the evaluation job is automated or human-based.
Type: String
Valid Values: `Human | Automated`
** [lastModifiedTime](#API_GetEvaluationJob_ResponseSyntax) **
The time the evaluation job was last modified.
Type: Timestamp
** [outputDataConfig](#API_GetEvaluationJob_ResponseSyntax) **
Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.
Type: [EvaluationOutputDataConfig](API_EvaluationOutputDataConfig.md) object
** [roleArn](#API_GetEvaluationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
** [status](#API_GetEvaluationJob_ResponseSyntax) **
The current status of the evaluation job.
Type: String
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting`
## 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.
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-2023-04-20/GetEvaluationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetEvaluationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetEvaluationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetEvaluationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetEvaluationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetEvaluationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetEvaluationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetEvaluationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetEvaluationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetEvaluationJob)
# GetFoundationModel
Get details about a Amazon Bedrock foundation model.
## Request Syntax
```
GET /foundation-models/modelIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelIdentifier](#API_GetFoundationModel_RequestSyntax) **
The model identifier.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelDetails": {
"customizationsSupported": [ "string" ],
"inferenceTypesSupported": [ "string" ],
"inputModalities": [ "string" ],
"modelArn": "string",
"modelId": "string",
"modelLifecycle": {
"endOfLifeTime": "string",
"legacyTime": "string",
"publicExtendedAccessTime": "string",
"startOfLifeTime": "string",
"status": "string"
},
"modelName": "string",
"outputModalities": [ "string" ],
"providerName": "string",
"responseStreamingSupported": boolean
}
}
```
## 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.
** [modelDetails](#API_GetFoundationModel_ResponseSyntax) **
Information about the foundation model.
Type: [FoundationModelDetails](API_FoundationModelDetails.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.
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-2023-04-20/GetFoundationModel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetFoundationModel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetFoundationModel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetFoundationModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetFoundationModel)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetFoundationModel)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetFoundationModel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetFoundationModel)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetFoundationModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetFoundationModel)
# GetFoundationModelAvailability
Get information about the Foundation model availability.
## Request Syntax
```
GET /foundation-model-availability/modelId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelId](#API_GetFoundationModelAvailability_RequestSyntax) **
The model Id of the foundation model.
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"agreementAvailability": {
"errorMessage": "string",
"status": "string"
},
"authorizationStatus": "string",
"entitlementAvailability": "string",
"modelId": "string",
"regionAvailability": "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.
** [agreementAvailability](#API_GetFoundationModelAvailability_ResponseSyntax) **
Agreement availability.
Type: [AgreementAvailability](API_AgreementAvailability.md) object
** [authorizationStatus](#API_GetFoundationModelAvailability_ResponseSyntax) **
Authorization status.
Type: String
Valid Values: `AUTHORIZED | NOT_AUTHORIZED`
** [entitlementAvailability](#API_GetFoundationModelAvailability_ResponseSyntax) **
Entitlement availability.
Type: String
Valid Values: `AVAILABLE | NOT_AVAILABLE`
** [modelId](#API_GetFoundationModelAvailability_ResponseSyntax) **
The model Id of the foundation model.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
** [regionAvailability](#API_GetFoundationModelAvailability_ResponseSyntax) **
Region availability.
Type: String
Valid Values: `AVAILABLE | NOT_AVAILABLE`
## 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.
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-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetFoundationModelAvailability)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetFoundationModelAvailability)
# GetGuardrail
Gets details about a guardrail. If you don't specify a version, the response returns details for the `DRAFT` version.
## Request Syntax
```
GET /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [guardrailIdentifier](#API_GetGuardrail_RequestSyntax) **
The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: Yes
** [guardrailVersion](#API_GetGuardrail_RequestSyntax) **
The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the `DRAFT` version.
Pattern: `(([1-9][0-9]{0,7})|(DRAFT))`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"automatedReasoningPolicy": {
"confidenceThreshold": number,
"policies": [ "string" ]
},
"blockedInputMessaging": "string",
"blockedOutputsMessaging": "string",
"contentPolicy": {
"filters": [
{
"inputAction": "string",
"inputEnabled": boolean,
"inputModalities": [ "string" ],
"inputStrength": "string",
"outputAction": "string",
"outputEnabled": boolean,
"outputModalities": [ "string" ],
"outputStrength": "string",
"type": "string"
}
],
"tier": {
"tierName": "string"
}
},
"contextualGroundingPolicy": {
"filters": [
{
"action": "string",
"enabled": boolean,
"threshold": number,
"type": "string"
}
]
},
"createdAt": "string",
"crossRegionDetails": {
"guardrailProfileArn": "string",
"guardrailProfileId": "string"
},
"description": "string",
"failureRecommendations": [ "string" ],
"guardrailArn": "string",
"guardrailId": "string",
"kmsKeyArn": "string",
"name": "string",
"sensitiveInformationPolicy": {
"piiEntities": [
{
"action": "string",
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
],
"regexes": [
{
"action": "string",
"description": "string",
"inputAction": "string",
"inputEnabled": boolean,
"name": "string",
"outputAction": "string",
"outputEnabled": boolean,
"pattern": "string"
}
]
},
"status": "string",
"statusReasons": [ "string" ],
"topicPolicy": {
"tier": {
"tierName": "string"
},
"topics": [
{
"definition": "string",
"examples": [ "string" ],
"inputAction": "string",
"inputEnabled": boolean,
"name": "string",
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
]
},
"updatedAt": "string",
"version": "string",
"wordPolicy": {
"managedWordLists": [
{
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
],
"words": [
{
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"text": "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.
** [automatedReasoningPolicy](#API_GetGuardrail_ResponseSyntax) **
The current Automated Reasoning policy configuration for the guardrail, if any is configured.
Type: [GuardrailAutomatedReasoningPolicy](API_GuardrailAutomatedReasoningPolicy.md) object
** [blockedInputMessaging](#API_GetGuardrail_ResponseSyntax) **
The message that the guardrail returns when it blocks a prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
** [blockedOutputsMessaging](#API_GetGuardrail_ResponseSyntax) **
The message that the guardrail returns when it blocks a model response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
** [contentPolicy](#API_GetGuardrail_ResponseSyntax) **
The content policy that was configured for the guardrail.
Type: [GuardrailContentPolicy](API_GuardrailContentPolicy.md) object
** [contextualGroundingPolicy](#API_GetGuardrail_ResponseSyntax) **
The contextual grounding policy used in the guardrail.
Type: [GuardrailContextualGroundingPolicy](API_GuardrailContextualGroundingPolicy.md) object
** [createdAt](#API_GetGuardrail_ResponseSyntax) **
The date and time at which the guardrail was created.
Type: Timestamp
** [crossRegionDetails](#API_GetGuardrail_ResponseSyntax) **
Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
Type: [GuardrailCrossRegionDetails](API_GuardrailCrossRegionDetails.md) object
** [description](#API_GetGuardrail_ResponseSyntax) **
The description of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
** [failureRecommendations](#API_GetGuardrail_ResponseSyntax) **
Appears if the `status` of the guardrail is `FAILED`. A list of recommendations to carry out before retrying the request.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
** [guardrailArn](#API_GetGuardrail_ResponseSyntax) **
The ARN of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+`
** [guardrailId](#API_GetGuardrail_ResponseSyntax) **
The unique identifier of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: `[a-z0-9]+`
** [kmsKeyArn](#API_GetGuardrail_ResponseSyntax) **
The ARN of the AWS KMS key that encrypts the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [name](#API_GetGuardrail_ResponseSyntax) **
The name of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: `[0-9a-zA-Z-_]+`
** [sensitiveInformationPolicy](#API_GetGuardrail_ResponseSyntax) **
The sensitive information policy that was configured for the guardrail.
Type: [GuardrailSensitiveInformationPolicy](API_GuardrailSensitiveInformationPolicy.md) object
** [status](#API_GetGuardrail_ResponseSyntax) **
The status of the guardrail.
Type: String
Valid Values: `CREATING | UPDATING | VERSIONING | READY | FAILED | DELETING`
** [statusReasons](#API_GetGuardrail_ResponseSyntax) **
Appears if the `status` is `FAILED`. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
** [topicPolicy](#API_GetGuardrail_ResponseSyntax) **
The topic policy that was configured for the guardrail.
Type: [GuardrailTopicPolicy](API_GuardrailTopicPolicy.md) object
** [updatedAt](#API_GetGuardrail_ResponseSyntax) **
The date and time at which the guardrail was updated.
Type: Timestamp
** [version](#API_GetGuardrail_ResponseSyntax) **
The version of the guardrail.
Type: String
Pattern: `(([1-9][0-9]{0,7})|(DRAFT))`
** [wordPolicy](#API_GetGuardrail_ResponseSyntax) **
The word policy that was configured for the guardrail.
Type: [GuardrailWordPolicy](API_GuardrailWordPolicy.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.
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-2023-04-20/GetGuardrail)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetGuardrail)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetGuardrail)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetGuardrail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetGuardrail)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetGuardrail)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetGuardrail)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetGuardrail)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetGuardrail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetGuardrail)
# GetImportedModel
Gets properties associated with a customized model you imported.
## Request Syntax
```
GET /imported-models/modelIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelIdentifier](#API_GetImportedModel_RequestSyntax) **
Name or Amazon Resource Name (ARN) of the imported model.
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12})|(([0-9a-zA-Z][_-]?)+)`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationTime": "string",
"customModelUnits": {
"customModelUnitsPerModelCopy": number,
"customModelUnitsVersion": "string"
},
"instructSupported": boolean,
"jobArn": "string",
"jobName": "string",
"modelArchitecture": "string",
"modelArn": "string",
"modelDataSource": { ... },
"modelKmsKeyArn": "string",
"modelName": "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.
** [creationTime](#API_GetImportedModel_ResponseSyntax) **
Creation time of the imported model.
Type: Timestamp
** [customModelUnits](#API_GetImportedModel_ResponseSyntax) **
Information about the hardware utilization for a single copy of the model.
Type: [CustomModelUnits](API_CustomModelUnits.md) object
** [instructSupported](#API_GetImportedModel_ResponseSyntax) **
Specifies if the imported model supports converse.
Type: Boolean
** [jobArn](#API_GetImportedModel_ResponseSyntax) **
Job Amazon Resource Name (ARN) associated with the imported model.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}`
** [jobName](#API_GetImportedModel_ResponseSyntax) **
Job name associated with the imported model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
** [modelArchitecture](#API_GetImportedModel_ResponseSyntax) **
The architecture of the imported model.
Type: String
** [modelArn](#API_GetImportedModel_ResponseSyntax) **
The Amazon Resource Name (ARN) associated with this imported model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}`
** [modelDataSource](#API_GetImportedModel_ResponseSyntax) **
The data source for this imported model.
Type: [ModelDataSource](API_ModelDataSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [modelKmsKeyArn](#API_GetImportedModel_ResponseSyntax) **
The imported model is encrypted at rest using this key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [modelName](#API_GetImportedModel_ResponseSyntax) **
The name of the imported model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
## 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.
HTTP Status Code: 400
## Examples
### Get model properties
Get the properties associated with a customized model that you imported.
```
GET /imported-models/{modelIdentifier} HTTP/1.1
Content-type: application/json
```
### Example response
Response for the above request.
```
HTTP/1.1 200
Content-type: application/json
{
"modelArn": "arn:aws:bedrock:us-east-1:111122223333:imported-model/s4dt0wly5gud",
"modelName": "SomeImportedModelName",
"jobName": "importJob-20240713T121942",
"jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/dchh9ny8e0dv",
"modelDataSource": {
"s3DataSource": {
"s3Uri": "S3://amzn-s3-demo-bucket/key-name"
}
},
"creationTime": "2024-08-13T19:20:14.058Z",
"modelArchitecture": "mistral",
"customModelUnits": {
"customModelUnitsPerModelCopy": 8,
"customModelUnitsVersion": "v1.0"
}
}
```
## 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-2023-04-20/GetImportedModel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetImportedModel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetImportedModel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetImportedModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetImportedModel)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetImportedModel)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetImportedModel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetImportedModel)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetImportedModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetImportedModel)
# GetInferenceProfile
Gets information about an inference profile. For more information, see [Increase throughput and resilience with cross-region inference in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /inference-profiles/inferenceProfileIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [inferenceProfileIdentifier](#API_GetInferenceProfile_RequestSyntax) **
The ID or Amazon Resource Name (ARN) of the inference profile.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/)?[a-zA-Z0-9-:.]+`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"description": "string",
"inferenceProfileArn": "string",
"inferenceProfileId": "string",
"inferenceProfileName": "string",
"models": [
{
"modelArn": "string"
}
],
"status": "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.
** [createdAt](#API_GetInferenceProfile_ResponseSyntax) **
The time at which the inference profile was created.
Type: Timestamp
** [description](#API_GetInferenceProfile_ResponseSyntax) **
The description of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `([0-9a-zA-Z:.][ _-]?)+`
** [inferenceProfileArn](#API_GetInferenceProfile_ResponseSyntax) **
The Amazon Resource Name (ARN) of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+`
** [inferenceProfileId](#API_GetInferenceProfile_ResponseSyntax) **
The unique identifier of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9-:.]+`
** [inferenceProfileName](#API_GetInferenceProfile_ResponseSyntax) **
The name of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `([0-9a-zA-Z][ _-]?)+`
** [models](#API_GetInferenceProfile_ResponseSyntax) **
A list of information about each model in the inference profile.
Type: Array of [InferenceProfileModel](API_InferenceProfileModel.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
** [status](#API_GetInferenceProfile_ResponseSyntax) **
The status of the inference profile. `ACTIVE` means that the inference profile is ready to be used.
Type: String
Valid Values: `ACTIVE`
** [type](#API_GetInferenceProfile_ResponseSyntax) **
The type of the inference profile. The following types are possible:
+ `SYSTEM_DEFINED` – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.
+ `APPLICATION` – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.
Type: String
Valid Values: `SYSTEM_DEFINED | APPLICATION`
** [updatedAt](#API_GetInferenceProfile_ResponseSyntax) **
The time at which the inference profile 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.
HTTP Status Code: 400
## Examples
### Get information about an inference profile
Run the following example to get information about the US Anthropic Claude 3 Sonnet inference profile:
#### Sample Request
```
GET /inference-profiles/us.anthropic.claude-3-sonnet-20240229-v1:0 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-2023-04-20/GetInferenceProfile)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetInferenceProfile)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetInferenceProfile)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetInferenceProfile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetInferenceProfile)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetInferenceProfile)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetInferenceProfile)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetInferenceProfile)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetInferenceProfile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetInferenceProfile)
# GetMarketplaceModelEndpoint
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
## Request Syntax
```
GET /marketplace-model/endpoints/endpointArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [endpointArn](#API_GetMarketplaceModelEndpoint_RequestSyntax) **
The Amazon Resource Name (ARN) of the endpoint you want to get information about.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"marketplaceModelEndpoint": {
"createdAt": "string",
"endpointArn": "string",
"endpointConfig": { ... },
"endpointStatus": "string",
"endpointStatusMessage": "string",
"modelSourceIdentifier": "string",
"status": "string",
"statusMessage": "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.
** [marketplaceModelEndpoint](#API_GetMarketplaceModelEndpoint_ResponseSyntax) **
Details about the requested endpoint.
Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.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.
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-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetMarketplaceModelEndpoint)
# GetModelCopyJob
Retrieves information about a model copy job. For more information, see [Copy models to be used in other regions](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /model-copy-jobs/jobArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobArn](#API_GetModelCopyJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the model copy job.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationTime": "string",
"failureMessage": "string",
"jobArn": "string",
"sourceAccountId": "string",
"sourceModelArn": "string",
"sourceModelName": "string",
"status": "string",
"targetModelArn": "string",
"targetModelKmsKeyArn": "string",
"targetModelName": "string",
"targetModelTags": [
{
"key": "string",
"value": "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.
** [creationTime](#API_GetModelCopyJob_ResponseSyntax) **
The time at which the model copy job was created.
Type: Timestamp
** [failureMessage](#API_GetModelCopyJob_ResponseSyntax) **
An error message for why the model copy job failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [jobArn](#API_GetModelCopyJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the model copy job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}`
** [sourceAccountId](#API_GetModelCopyJob_ResponseSyntax) **
The unique identifier of the account that the model being copied originated from.
Type: String
Pattern: `[0-9]{12}`
** [sourceModelArn](#API_GetModelCopyJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the original model being copied.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
** [sourceModelName](#API_GetModelCopyJob_ResponseSyntax) **
The name of the original model being copied.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
** [status](#API_GetModelCopyJob_ResponseSyntax) **
The status of the model copy job.
Type: String
Valid Values: `InProgress | Completed | Failed`
** [targetModelArn](#API_GetModelCopyJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the copied model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
** [targetModelKmsKeyArn](#API_GetModelCopyJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the KMS key encrypting the copied model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [targetModelName](#API_GetModelCopyJob_ResponseSyntax) **
The name of the copied model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
** [targetModelTags](#API_GetModelCopyJob_ResponseSyntax) **
The tags associated with the copied model.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 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.
HTTP Status Code: 400
## Examples
### Get a model copy job (CLI)
The following example shows how to get information about a model copy job using the AWS CLI.
```
aws bedrock get-model-copy-job --job-arn arn:aws:bedrock:us-east-1:123456789012:model-copy-job/amazon.titan-text-lite-v1:0:4k/abcdef123456
```
## 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-2023-04-20/GetModelCopyJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelCopyJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelCopyJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelCopyJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelCopyJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelCopyJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelCopyJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelCopyJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelCopyJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelCopyJob)
# GetModelCustomizationJob
Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /model-customization-jobs/jobIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobIdentifier](#API_GetModelCustomizationJob_RequestSyntax) **
Identifier for the customization job.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*)`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"baseModelArn": "string",
"clientRequestToken": "string",
"creationTime": "string",
"customizationConfig": { ... },
"customizationType": "string",
"endTime": "string",
"failureMessage": "string",
"hyperParameters": {
"string" : "string"
},
"jobArn": "string",
"jobName": "string",
"lastModifiedTime": "string",
"outputDataConfig": {
"s3Uri": "string"
},
"outputModelArn": "string",
"outputModelKmsKeyArn": "string",
"outputModelName": "string",
"roleArn": "string",
"status": "string",
"statusDetails": {
"dataProcessingDetails": {
"creationTime": "string",
"lastModifiedTime": "string",
"status": "string"
},
"trainingDetails": {
"creationTime": "string",
"lastModifiedTime": "string",
"status": "string"
},
"validationDetails": {
"creationTime": "string",
"lastModifiedTime": "string",
"status": "string"
}
},
"trainingDataConfig": {
"invocationLogsConfig": {
"invocationLogSource": { ... },
"requestMetadataFilters": { ... },
"usePromptResponse": boolean
},
"s3Uri": "string"
},
"trainingMetrics": {
"trainingLoss": number
},
"validationDataConfig": {
"validators": [
{
"s3Uri": "string"
}
]
},
"validationMetrics": [
{
"validationLoss": number
}
],
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "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.
** [baseModelArn](#API_GetModelCustomizationJob_ResponseSyntax) **
Amazon Resource Name (ARN) of the base model.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}`
** [clientRequestToken](#API_GetModelCustomizationJob_ResponseSyntax) **
The token that you specified in the `CreateCustomizationJob` request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
** [creationTime](#API_GetModelCustomizationJob_ResponseSyntax) **
Time that the resource was created.
Type: Timestamp
** [customizationConfig](#API_GetModelCustomizationJob_ResponseSyntax) **
The customization configuration for the model customization job.
Type: [CustomizationConfig](API_CustomizationConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [customizationType](#API_GetModelCustomizationJob_ResponseSyntax) **
The type of model customization.
Type: String
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION | REINFORCEMENT_FINE_TUNING | IMPORTED`
** [endTime](#API_GetModelCustomizationJob_ResponseSyntax) **
Time that the resource transitioned to terminal state.
Type: Timestamp
** [failureMessage](#API_GetModelCustomizationJob_ResponseSyntax) **
Information about why the job failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [hyperParameters](#API_GetModelCustomizationJob_ResponseSyntax) **
The hyperparameter values for the job. For details on the format for different models, see [Custom model hyperparameters](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html).
Type: String to string map
** [jobArn](#API_GetModelCustomizationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the customization job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}`
** [jobName](#API_GetModelCustomizationJob_ResponseSyntax) **
The name of the customization job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
** [lastModifiedTime](#API_GetModelCustomizationJob_ResponseSyntax) **
Time that the resource was last modified.
Type: Timestamp
** [outputDataConfig](#API_GetModelCustomizationJob_ResponseSyntax) **
Output data configuration
Type: [OutputDataConfig](API_OutputDataConfig.md) object
** [outputModelArn](#API_GetModelCustomizationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the output model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
** [outputModelKmsKeyArn](#API_GetModelCustomizationJob_ResponseSyntax) **
The custom model is encrypted at rest using this key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [outputModelName](#API_GetModelCustomizationJob_ResponseSyntax) **
The name of the output model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
** [roleArn](#API_GetModelCustomizationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM role.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
** [status](#API_GetModelCustomizationJob_ResponseSyntax) **
The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.
Type: String
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped`
** [statusDetails](#API_GetModelCustomizationJob_ResponseSyntax) **
For a Distillation job, the details about the statuses of the sub-tasks of the customization job.
Type: [StatusDetails](API_StatusDetails.md) object
** [trainingDataConfig](#API_GetModelCustomizationJob_ResponseSyntax) **
Contains information about the training dataset.
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object
** [trainingMetrics](#API_GetModelCustomizationJob_ResponseSyntax) **
Contains training metrics from the job creation.
Type: [TrainingMetrics](API_TrainingMetrics.md) object
** [validationDataConfig](#API_GetModelCustomizationJob_ResponseSyntax) **
Contains information about the validation dataset.
Type: [ValidationDataConfig](API_ValidationDataConfig.md) object
** [validationMetrics](#API_GetModelCustomizationJob_ResponseSyntax) **
The loss metric for each validator that you provided in the createjob request.
Type: Array of [ValidatorMetric](API_ValidatorMetric.md) objects
** [vpcConfig](#API_GetModelCustomizationJob_ResponseSyntax) **
VPC configuration for the custom model job.
Type: [VpcConfig](API_VpcConfig.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.
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-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelCustomizationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelCustomizationJob)
# GetModelImportJob
Retrieves the properties associated with import model job, including the status of the job. For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /model-import-jobs/jobIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobIdentifier](#API_GetModelImportJob_RequestSyntax) **
The identifier of the import job.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*)`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"creationTime": "string",
"endTime": "string",
"failureMessage": "string",
"importedModelArn": "string",
"importedModelKmsKeyArn": "string",
"importedModelName": "string",
"jobArn": "string",
"jobName": "string",
"lastModifiedTime": "string",
"modelDataSource": { ... },
"roleArn": "string",
"status": "string",
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "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.
** [creationTime](#API_GetModelImportJob_ResponseSyntax) **
The time the resource was created.
Type: Timestamp
** [endTime](#API_GetModelImportJob_ResponseSyntax) **
Time that the resource transitioned to terminal state.
Type: Timestamp
** [failureMessage](#API_GetModelImportJob_ResponseSyntax) **
Information about why the import job failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [importedModelArn](#API_GetModelImportJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the imported model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}`
** [importedModelKmsKeyArn](#API_GetModelImportJob_ResponseSyntax) **
The imported model is encrypted at rest using this key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
** [importedModelName](#API_GetModelImportJob_ResponseSyntax) **
The name of the imported model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
** [jobArn](#API_GetModelImportJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the import job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}`
** [jobName](#API_GetModelImportJob_ResponseSyntax) **
The name of the import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
** [lastModifiedTime](#API_GetModelImportJob_ResponseSyntax) **
Time the resource was last modified.
Type: Timestamp
** [modelDataSource](#API_GetModelImportJob_ResponseSyntax) **
The data source for the imported model.
Type: [ModelDataSource](API_ModelDataSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [roleArn](#API_GetModelImportJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM role associated with this job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
** [status](#API_GetModelImportJob_ResponseSyntax) **
The status of the job. A successful job transitions from in-progress to completed when the imported model is ready to use. If the job failed, the failure message contains information about why the job failed.
Type: String
Valid Values: `InProgress | Completed | Failed`
** [vpcConfig](#API_GetModelImportJob_ResponseSyntax) **
The Virtual Private Cloud (VPC) configuration of the import model job.
Type: [VpcConfig](API_VpcConfig.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.
HTTP Status Code: 400
## Examples
### Get model import job
Gets the properties of a model import job.
```
GET /model-import-jobs/{jobIdentifier} HTTP/1.1
Content-type: application/json
```
### Example response
Response for the above request.
```
HTTP/1.1 200
Content-type: application/json
{
"jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/yggb47n4xlml",
"jobName": "MyImportedModelJobName",
"importedModelName": "ImportedModelName",
"roleArn": "arn:aws:iam::111122223333:role/Role_Name",
"modelDataSource": {
"s3DataSource": {
"s3Uri": "S3://amzn-s3-demo-bucket/key-name"
}
},
"status": "InProgress",
"creationTime": "2024-08-13T23:38:42.457Z",
"lastModifiedTime": "2024-08-13T23:39:25.158Z"
}
```
## 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-2023-04-20/GetModelImportJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelImportJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelImportJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelImportJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelImportJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelImportJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelImportJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelImportJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelImportJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelImportJob)
# GetModelInvocationJob
Gets details about a batch inference job. For more information, see [Monitor batch inference jobs](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-monitor)
## Request Syntax
```
GET /model-invocation-job/jobIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobIdentifier](#API_GetModelInvocationJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the batch inference job.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"clientRequestToken": "string",
"endTime": "string",
"errorRecordCount": number,
"inputDataConfig": { ... },
"jobArn": "string",
"jobExpirationTime": "string",
"jobName": "string",
"lastModifiedTime": "string",
"message": "string",
"modelId": "string",
"modelInvocationType": "string",
"outputDataConfig": { ... },
"processedRecordCount": number,
"roleArn": "string",
"status": "string",
"submitTime": "string",
"successRecordCount": number,
"timeoutDurationInHours": number,
"totalRecordCount": number,
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "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.
** [clientRequestToken](#API_GetModelInvocationJob_ResponseSyntax) **
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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}`
** [endTime](#API_GetModelInvocationJob_ResponseSyntax) **
The time at which the batch inference job ended.
Type: Timestamp
** [errorRecordCount](#API_GetModelInvocationJob_ResponseSyntax) **
The number of records that failed to process in the batch inference job.
Type: Long
Valid Range: Minimum value of 0.
** [inputDataConfig](#API_GetModelInvocationJob_ResponseSyntax) **
Details about the location of the input to the batch inference job.
Type: [ModelInvocationJobInputDataConfig](API_ModelInvocationJobInputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [jobArn](#API_GetModelInvocationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the batch inference job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})`
** [jobExpirationTime](#API_GetModelInvocationJob_ResponseSyntax) **
The time at which the batch inference job times or timed out.
Type: Timestamp
** [jobName](#API_GetModelInvocationJob_ResponseSyntax) **
The name of the batch inference job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\+\-\.]){0,63}`
** [lastModifiedTime](#API_GetModelInvocationJob_ResponseSyntax) **
The time at which the batch inference job was last modified.
Type: Timestamp
** [message](#API_GetModelInvocationJob_ResponseSyntax) **
If the batch inference job failed, this field contains a message describing why the job failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [modelId](#API_GetModelInvocationJob_ResponseSyntax) **
The unique identifier of the foundation model used for model inference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-:]{1,63}/[a-z0-9]{12}$)|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)`
** [modelInvocationType](#API_GetModelInvocationJob_ResponseSyntax) **
The invocation endpoint for ModelInvocationJob
Type: String
Valid Values: `InvokeModel | Converse`
** [outputDataConfig](#API_GetModelInvocationJob_ResponseSyntax) **
Details about the location of the output of the batch inference job.
Type: [ModelInvocationJobOutputDataConfig](API_ModelInvocationJobOutputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [processedRecordCount](#API_GetModelInvocationJob_ResponseSyntax) **
The number of records that have been processed in the batch inference job.
Type: Long
Valid Range: Minimum value of 0.
** [roleArn](#API_GetModelInvocationJob_ResponseSyntax) **
The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at [Create a service role for batch inference](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
** [status](#API_GetModelInvocationJob_ResponseSyntax) **
The status of the batch inference job.
The following statuses are possible:
+ Submitted – This job has been submitted to a queue for validation.
+ Validating – This job is being validated for the requirements described in [Format and upload your batch inference data](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html). The criteria include the following:
+ Your IAM service role has access to the Amazon S3 buckets containing your files.
+ Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the `modelInput` value matches the request body for the model.
+ Your files fulfill the requirements for file size and number of records. For more information, see [Quotas for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html).
+ Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
+ Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
+ InProgress – This job has begun. You can start viewing the results in the output S3 location.
+ Completed – This job has successfully completed. View the output files in the output S3 location.
+ PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
+ Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the [Support Center](https://console.aws.amazon.com/support/home/).
+ Stopped – This job was stopped by a user.
+ Stopping – This job is being stopped by a user.
Type: String
Valid Values: `Submitted | InProgress | Completed | Failed | Stopping | Stopped | PartiallyCompleted | Expired | Validating | Scheduled`
** [submitTime](#API_GetModelInvocationJob_ResponseSyntax) **
The time at which the batch inference job was submitted.
Type: Timestamp
** [successRecordCount](#API_GetModelInvocationJob_ResponseSyntax) **
The number of records that were successfully processed in the batch inference job.
Type: Long
Valid Range: Minimum value of 0.
** [timeoutDurationInHours](#API_GetModelInvocationJob_ResponseSyntax) **
The number of hours after which batch inference job was set to time out.
Type: Integer
Valid Range: Minimum value of 24. Maximum value of 168.
** [totalRecordCount](#API_GetModelInvocationJob_ResponseSyntax) **
The total number of records in the batch inference job.
Type: Long
Valid Range: Minimum value of 0.
** [vpcConfig](#API_GetModelInvocationJob_ResponseSyntax) **
The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see [Protect batch inference jobs using a VPC](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc).
Type: [VpcConfig](API_VpcConfig.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.
HTTP Status Code: 400
## Examples
### Get a batch inference job
This example illustrates one usage of GetModelInvocationJob.
```
GET /model-invocation-job/BATCHJOB1234 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-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelInvocationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelInvocationJob)
# GetModelInvocationLoggingConfiguration
Get the current configuration values for model invocation logging.
## Request Syntax
```
GET /logging/modelinvocations HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"loggingConfig": {
"audioDataDeliveryEnabled": boolean,
"cloudWatchConfig": {
"largeDataDeliveryS3Config": {
"bucketName": "string",
"keyPrefix": "string"
},
"logGroupName": "string",
"roleArn": "string"
},
"embeddingDataDeliveryEnabled": boolean,
"imageDataDeliveryEnabled": boolean,
"s3Config": {
"bucketName": "string",
"keyPrefix": "string"
},
"textDataDeliveryEnabled": boolean,
"videoDataDeliveryEnabled": boolean
}
}
```
## 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.
** [loggingConfig](#API_GetModelInvocationLoggingConfiguration_ResponseSyntax) **
The current configuration values.
Type: [LoggingConfig](API_LoggingConfig.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
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
## 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-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetModelInvocationLoggingConfiguration)
# GetPromptRouter
Retrieves details about a prompt router.
## Request Syntax
```
GET /prompt-routers/promptRouterArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [promptRouterArn](#API_GetPromptRouter_RequestSyntax) **
The prompt router's ARN
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"description": "string",
"fallbackModel": {
"modelArn": "string"
},
"models": [
{
"modelArn": "string"
}
],
"promptRouterArn": "string",
"promptRouterName": "string",
"routingCriteria": {
"responseQualityDifference": number
},
"status": "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.
** [createdAt](#API_GetPromptRouter_ResponseSyntax) **
When the router was created.
Type: Timestamp
** [description](#API_GetPromptRouter_ResponseSyntax) **
The router's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `([0-9a-zA-Z:.][ _-]?)+`
** [fallbackModel](#API_GetPromptRouter_ResponseSyntax) **
The router's fallback model.
Type: [PromptRouterTargetModel](API_PromptRouterTargetModel.md) object
** [models](#API_GetPromptRouter_ResponseSyntax) **
The router's models.
Type: Array of [PromptRouterTargetModel](API_PromptRouterTargetModel.md) objects
** [promptRouterArn](#API_GetPromptRouter_ResponseSyntax) **
The prompt router's ARN
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+`
** [promptRouterName](#API_GetPromptRouter_ResponseSyntax) **
The router's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `([0-9a-zA-Z][ _-]?)+`
** [routingCriteria](#API_GetPromptRouter_ResponseSyntax) **
The router's routing criteria.
Type: [RoutingCriteria](API_RoutingCriteria.md) object
** [status](#API_GetPromptRouter_ResponseSyntax) **
The router's status.
Type: String
Valid Values: `AVAILABLE`
** [type](#API_GetPromptRouter_ResponseSyntax) **
The router's type.
Type: String
Valid Values: `custom | default`
** [updatedAt](#API_GetPromptRouter_ResponseSyntax) **
When the router was 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.
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-2023-04-20/GetPromptRouter)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetPromptRouter)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetPromptRouter)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetPromptRouter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetPromptRouter)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetPromptRouter)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetPromptRouter)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetPromptRouter)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetPromptRouter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetPromptRouter)
# GetProvisionedModelThroughput
Returns details for a Provisioned Throughput. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /provisioned-model-throughput/provisionedModelId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [provisionedModelId](#API_GetProvisionedModelThroughput_RequestSyntax) **
The Amazon Resource Name (ARN) or ID of the Provisioned Throughput.
Pattern: `((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"commitmentDuration": "string",
"commitmentExpirationTime": "string",
"creationTime": "string",
"desiredModelArn": "string",
"desiredModelUnits": number,
"failureMessage": "string",
"foundationModelArn": "string",
"lastModifiedTime": "string",
"modelArn": "string",
"modelUnits": number,
"provisionedModelArn": "string",
"provisionedModelName": "string",
"status": "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.
** [commitmentDuration](#API_GetProvisionedModelThroughput_ResponseSyntax) **
Commitment duration of the Provisioned Throughput.
Type: String
Valid Values: `OneMonth | SixMonths`
** [commitmentExpirationTime](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The timestamp for when the commitment term for the Provisioned Throughput expires.
Type: Timestamp
** [creationTime](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The timestamp of the creation time for this Provisioned Throughput.
Type: Timestamp
** [desiredModelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the `modelArn` if updating hasn't completed.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
** [desiredModelUnits](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The number of model units that was requested for this Provisioned Throughput.
Type: Integer
Valid Range: Minimum value of 1.
** [failureMessage](#API_GetProvisionedModelThroughput_ResponseSyntax) **
A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [foundationModelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}`
** [lastModifiedTime](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The timestamp of the last time that this Provisioned Throughput was modified.
Type: Timestamp
** [modelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
** [modelUnits](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The number of model units allocated to this Provisioned Throughput.
Type: Integer
Valid Range: Minimum value of 1.
** [provisionedModelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The Amazon Resource Name (ARN) of the Provisioned Throughput.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}`
** [provisionedModelName](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The name of the Provisioned Throughput.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
** [status](#API_GetProvisionedModelThroughput_ResponseSyntax) **
The status of the Provisioned Throughput.
Type: String
Valid Values: `Creating | InService | Updating | Failed`
## 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.
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-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetProvisionedModelThroughput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetProvisionedModelThroughput)
# GetResourcePolicy
Gets the resource policy document for a Bedrock resource
## Request Syntax
```
GET /resource-policy/resourceArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [resourceArn](#API_GetResourcePolicy_RequestSyntax) **
The ARN of the Bedrock resource to which this resource policy applies.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"resourcePolicy": "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.
** [resourcePolicy](#API_GetResourcePolicy_ResponseSyntax) **
The JSON string representing the Bedrock resource policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20480.
Pattern: `[ -ÿ]+`
## 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.
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-2023-04-20/GetResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetResourcePolicy)
# GetUseCaseForModelAccess
Returns the use case for requesting access to Anthropic models.
## Request Syntax
```
GET /use-case-for-model-access HTTP/1.1
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"formData": blob
}
```
## 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.
** [formData](#API_GetUseCaseForModelAccess_ResponseSyntax) **
Returns form data from the Anthropic first time user request.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 10. Maximum length of 16384.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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.
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-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/GetUseCaseForModelAccess)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GetUseCaseForModelAccess)
# ListAutomatedReasoningPolicies
Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.
## Request Syntax
```
GET /automated-reasoning-policies?maxResults=maxResults&nextToken=nextToken&policyArn=policyArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_ListAutomatedReasoningPolicies_RequestSyntax) **
The maximum number of policies to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_ListAutomatedReasoningPolicies_RequestSyntax) **
The pagination token from a previous request to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [policyArn](#API_ListAutomatedReasoningPolicies_RequestSyntax) **
Optional filter to list only the policy versions with the specified Amazon Resource Name (ARN). If not provided, the DRAFT versions for all policies are listed.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"automatedReasoningPolicySummaries": [
{
"createdAt": "string",
"description": "string",
"name": "string",
"policyArn": "string",
"policyId": "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.
** [automatedReasoningPolicySummaries](#API_ListAutomatedReasoningPolicies_ResponseSyntax) **
A list of Automated Reasoning policy summaries.
Type: Array of [AutomatedReasoningPolicySummary](API_AutomatedReasoningPolicySummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
** [nextToken](#API_ListAutomatedReasoningPolicies_ResponseSyntax) **
The pagination token to use in a subsequent 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.
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-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListAutomatedReasoningPolicies)
# ListAutomatedReasoningPolicyBuildWorkflows
Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/build-workflows?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_ListAutomatedReasoningPolicyBuildWorkflows_RequestSyntax) **
The maximum number of build workflows to return in a single response. Valid range is 1-100.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_ListAutomatedReasoningPolicyBuildWorkflows_RequestSyntax) **
A pagination token from a previous request to continue listing build workflows from where the previous request left off.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [policyArn](#API_ListAutomatedReasoningPolicyBuildWorkflows_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy whose build workflows you want to list.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"automatedReasoningPolicyBuildWorkflowSummaries": [
{
"buildWorkflowId": "string",
"buildWorkflowType": "string",
"createdAt": "string",
"policyArn": "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.
** [automatedReasoningPolicyBuildWorkflowSummaries](#API_ListAutomatedReasoningPolicyBuildWorkflows_ResponseSyntax) **
A list of build workflow summaries, each containing key information about a build workflow including its status and timestamps.
Type: Array of [AutomatedReasoningPolicyBuildWorkflowSummary](API_AutomatedReasoningPolicyBuildWorkflowSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
** [nextToken](#API_ListAutomatedReasoningPolicyBuildWorkflows_ResponseSyntax) **
A pagination token to use in subsequent requests to retrieve additional build workflows.
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.
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-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyBuildWorkflows)
# ListAutomatedReasoningPolicyTestCases
Lists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/test-cases?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_ListAutomatedReasoningPolicyTestCases_RequestSyntax) **
The maximum number of tests to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_ListAutomatedReasoningPolicyTestCases_RequestSyntax) **
The pagination token from a previous request to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [policyArn](#API_ListAutomatedReasoningPolicyTestCases_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to list tests.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"testCases": [
{
"confidenceThreshold": number,
"createdAt": "string",
"expectedAggregatedFindingsResult": "string",
"guardContent": "string",
"queryContent": "string",
"testCaseId": "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.
** [nextToken](#API_ListAutomatedReasoningPolicyTestCases_ResponseSyntax) **
The pagination token to use in a subsequent request to retrieve the next page of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [testCases](#API_ListAutomatedReasoningPolicyTestCases_ResponseSyntax) **
A list of tests for the specified policy.
Type: Array of [AutomatedReasoningPolicyTestCase](API_AutomatedReasoningPolicyTestCase.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1000 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.
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-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestCases)
# ListAutomatedReasoningPolicyTestResults
Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.
## Request Syntax
```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-results?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) **
The unique identifier of the build workflow whose test results you want to list.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [maxResults](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) **
The maximum number of test results to return in a single response. Valid range is 1-100.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) **
A pagination token from a previous request to continue listing test results from where the previous request left off.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [policyArn](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy whose test results you want to list.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"testResults": [
{
"aggregatedTestFindingsResult": "string",
"policyArn": "string",
"testCase": {
"confidenceThreshold": number,
"createdAt": "string",
"expectedAggregatedFindingsResult": "string",
"guardContent": "string",
"queryContent": "string",
"testCaseId": "string",
"updatedAt": "string"
},
"testFindings": [
{ ... }
],
"testRunResult": "string",
"testRunStatus": "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.
** [nextToken](#API_ListAutomatedReasoningPolicyTestResults_ResponseSyntax) **
A pagination token to use in subsequent requests to retrieve additional test results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [testResults](#API_ListAutomatedReasoningPolicyTestResults_ResponseSyntax) **
A list of test results, each containing information about how the policy performed on specific test scenarios.
Type: Array of [AutomatedReasoningPolicyTestResult](API_AutomatedReasoningPolicyTestResult.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5000 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
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 400
** 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.
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-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListAutomatedReasoningPolicyTestResults)
# ListCustomModelDeployments
Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.
We recommend using pagination to ensure that the operation returns quickly and successfully.
The following actions are related to the `ListCustomModelDeployments` operation:
+ [CreateCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html)
+ [GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html)
+ [DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html)
## Request Syntax
```
GET /model-customization/custom-model-deployments?createdAfter=createdAfter&createdBefore=createdBefore&maxResults=maxResults&modelArnEquals=modelArnEquals&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [createdAfter](#API_ListCustomModelDeployments_RequestSyntax) **
Filters deployments created after the specified date and time.
** [createdBefore](#API_ListCustomModelDeployments_RequestSyntax) **
Filters deployments created before the specified date and time.
** [maxResults](#API_ListCustomModelDeployments_RequestSyntax) **
The maximum number of results to return in a single call.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [modelArnEquals](#API_ListCustomModelDeployments_RequestSyntax) **
Filters deployments by the Amazon Resource Name (ARN) of the associated custom model.
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
** [nameContains](#API_ListCustomModelDeployments_RequestSyntax) **
Filters deployments whose names contain the specified string.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
** [nextToken](#API_ListCustomModelDeployments_RequestSyntax) **
The token for the next set of results. Use this token to retrieve additional results when the response is truncated.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [sortBy](#API_ListCustomModelDeployments_RequestSyntax) **
The field to sort the results by. The only supported value is `CreationTime`.
Valid Values: `CreationTime`
** [sortOrder](#API_ListCustomModelDeployments_RequestSyntax) **
The sort order for the results. Valid values are `Ascending` and `Descending`. Default is `Descending`.
Valid Values: `Ascending | Descending`
** [statusEquals](#API_ListCustomModelDeployments_RequestSyntax) **
Filters deployments by status. Valid values are `CREATING`, `ACTIVE`, and `FAILED`.
Valid Values: `Creating | Active | Failed`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelDeploymentSummaries": [
{
"createdAt": "string",
"customModelDeploymentArn": "string",
"customModelDeploymentName": "string",
"failureMessage": "string",
"lastUpdatedAt": "string",
"modelArn": "string",
"status": "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.
** [modelDeploymentSummaries](#API_ListCustomModelDeployments_ResponseSyntax) **
A list of custom model deployment summaries.
Type: Array of [CustomModelDeploymentSummary](API_CustomModelDeploymentSummary.md) objects
** [nextToken](#API_ListCustomModelDeployments_ResponseSyntax) **
The token for the next set of results. This value is null when there are no more results to return.
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.
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-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListCustomModelDeployments)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListCustomModelDeployments)
# ListCustomModels
Returns a list of the custom models that you have created with the `CreateModelCustomizationJob` operation.
For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /custom-models?baseModelArnEquals=baseModelArnEquals&creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&foundationModelArnEquals=foundationModelArnEquals&isOwned=isOwned&maxResults=maxResults&modelStatus=modelStatus&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [baseModelArnEquals](#API_ListCustomModels_RequestSyntax) **
Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
** [creationTimeAfter](#API_ListCustomModels_RequestSyntax) **
Return custom models created after the specified time.
** [creationTimeBefore](#API_ListCustomModels_RequestSyntax) **
Return custom models created before the specified time.
** [foundationModelArnEquals](#API_ListCustomModels_RequestSyntax) **
Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}`
** [isOwned](#API_ListCustomModels_RequestSyntax) **
Return custom models depending on if the current account owns them (`true`) or if they were shared with the current account (`false`).
** [maxResults](#API_ListCustomModels_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.
** [modelStatus](#API_ListCustomModels_RequestSyntax) **
The status of them model to filter results by. Possible values include:
+ `Creating` - Include only models that are currently being created and validated.
+ `Active` - Include only models that have been successfully created and are ready for use.
+ `Failed` - Include only models where the creation process failed.
If you don't specify a status, the API returns models in all states.
Valid Values: `Active | Creating | Failed`
** [nameContains](#API_ListCustomModels_RequestSyntax) **
Return custom models only if the job name contains these characters.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
** [nextToken](#API_ListCustomModels_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*`
** [sortBy](#API_ListCustomModels_RequestSyntax) **
The field to sort by in the returned list of models.
Valid Values: `CreationTime`
** [sortOrder](#API_ListCustomModels_RequestSyntax) **
The sort order of the results.
Valid Values: `Ascending | Descending`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelSummaries": [
{
"baseModelArn": "string",
"baseModelName": "string",
"creationTime": "string",
"customizationType": "string",
"modelArn": "string",
"modelName": "string",
"modelStatus": "string",
"ownerAccountId": "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.
** [modelSummaries](#API_ListCustomModels_ResponseSyntax) **
Model summaries.
Type: Array of [CustomModelSummary](API_CustomModelSummary.md) objects
** [nextToken](#API_ListCustomModels_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.
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-2023-04-20/ListCustomModels)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListCustomModels)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListCustomModels)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListCustomModels)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListCustomModels)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListCustomModels)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListCustomModels)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListCustomModels)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListCustomModels)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListCustomModels)
# ListEnforcedGuardrailsConfiguration
Lists the account-level enforced guardrail configurations.
## Request Syntax
```
GET /enforcedGuardrailsConfiguration?nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [nextToken](#API_ListEnforcedGuardrailsConfiguration_RequestSyntax) **
Opaque continuation token of previous paginated response.
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
{
"guardrailsConfig": [
{
"configId": "string",
"createdAt": "string",
"createdBy": "string",
"guardrailArn": "string",
"guardrailId": "string",
"guardrailVersion": "string",
"inputTags": "string",
"modelEnforcement": {
"excludedModels": [ "string" ],
"includedModels": [ "string" ]
},
"owner": "string",
"selectiveContentGuarding": {
"messages": "string",
"system": "string"
},
"updatedAt": "string",
"updatedBy": "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.
** [guardrailsConfig](#API_ListEnforcedGuardrailsConfiguration_ResponseSyntax) **
Array of AccountEnforcedGuardrailOutputConfiguration objects.
Type: Array of [AccountEnforcedGuardrailOutputConfiguration](API_AccountEnforcedGuardrailOutputConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
** [nextToken](#API_ListEnforcedGuardrailsConfiguration_ResponseSyntax) **
Opaque continuation token of previous paginated response.
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.
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-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListEnforcedGuardrailsConfiguration)
# ListEvaluationJobs
Lists all existing evaluation jobs.
## Request Syntax
```
GET /evaluation-jobs?applicationTypeEquals=applicationTypeEquals&creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [applicationTypeEquals](#API_ListEvaluationJobs_RequestSyntax) **
A filter to only list evaluation jobs that are either model evaluations or knowledge base evaluations.
Valid Values: `ModelEvaluation | RagEvaluation`
** [creationTimeAfter](#API_ListEvaluationJobs_RequestSyntax) **
A filter to only list evaluation jobs created after a specified time.
** [creationTimeBefore](#API_ListEvaluationJobs_RequestSyntax) **
A filter to only list evaluation jobs created before a specified time.
** [maxResults](#API_ListEvaluationJobs_RequestSyntax) **
The maximum number of results to return.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nameContains](#API_ListEvaluationJobs_RequestSyntax) **
A filter to only list evaluation jobs that contain a specified string in the job name.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-z0-9](-*[a-z0-9]){0,62}`
** [nextToken](#API_ListEvaluationJobs_RequestSyntax) **
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [sortBy](#API_ListEvaluationJobs_RequestSyntax) **
Specifies a creation time to sort the list of evaluation jobs by when they were created.
Valid Values: `CreationTime`
** [sortOrder](#API_ListEvaluationJobs_RequestSyntax) **
Specifies whether to sort the list of evaluation jobs by either ascending or descending order.
Valid Values: `Ascending | Descending`
** [statusEquals](#API_ListEvaluationJobs_RequestSyntax) **
A filter to only list evaluation jobs that are of a certain status.
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"jobSummaries": [
{
"applicationType": "string",
"creationTime": "string",
"customMetricsEvaluatorModelIdentifiers": [ "string" ],
"evaluationTaskTypes": [ "string" ],
"evaluatorModelIdentifiers": [ "string" ],
"inferenceConfigSummary": {
"modelConfigSummary": {
"bedrockModelIdentifiers": [ "string" ],
"precomputedInferenceSourceIdentifiers": [ "string" ]
},
"ragConfigSummary": {
"bedrockKnowledgeBaseIdentifiers": [ "string" ],
"precomputedRagSourceIdentifiers": [ "string" ]
}
},
"jobArn": "string",
"jobName": "string",
"jobType": "string",
"modelIdentifiers": [ "string" ],
"ragIdentifiers": [ "string" ],
"status": "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.
** [jobSummaries](#API_ListEvaluationJobs_ResponseSyntax) **
A list of summaries of the evaluation jobs.
Type: Array of [EvaluationSummary](API_EvaluationSummary.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
** [nextToken](#API_ListEvaluationJobs_ResponseSyntax) **
Continuation token from the previous response, for Amazon Bedrock to list the next set 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.
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-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListEvaluationJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListEvaluationJobs)
# ListFoundationModelAgreementOffers
Get the offers associated with the specified model.
## Request Syntax
```
GET /list-foundation-model-agreement-offers/modelId?offerType=offerType HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelId](#API_ListFoundationModelAgreementOffers_RequestSyntax) **
Model Id of the foundation model.
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: Yes
** [offerType](#API_ListFoundationModelAgreementOffers_RequestSyntax) **
Type of offer associated with the model.
Valid Values: `ALL | PUBLIC`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelId": "string",
"offers": [
{
"offerId": "string",
"offerToken": "string",
"termDetails": {
"legalTerm": {
"url": "string"
},
"supportTerm": {
"refundPolicyDescription": "string"
},
"usageBasedPricingTerm": {
"rateCard": [
{
"description": "string",
"dimension": "string",
"price": "string",
"unit": "string"
}
]
},
"validityTerm": {
"agreementDuration": "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.
** [modelId](#API_ListFoundationModelAgreementOffers_ResponseSyntax) **
Model Id of the foundation model.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
** [offers](#API_ListFoundationModelAgreementOffers_ResponseSyntax) **
List of the offers associated with the specified model.
Type: Array of [Offer](API_Offer.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
** 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.
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-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListFoundationModelAgreementOffers)
# ListFoundationModels
Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see [Foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /foundation-models?byCustomizationType=byCustomizationType&byInferenceType=byInferenceType&byOutputModality=byOutputModality&byProvider=byProvider HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [byCustomizationType](#API_ListFoundationModels_RequestSyntax) **
Return models that support the customization type that you specify. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION`
** [byInferenceType](#API_ListFoundationModels_RequestSyntax) **
Return models that support the inference type that you specify. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
Valid Values: `ON_DEMAND | PROVISIONED`
** [byOutputModality](#API_ListFoundationModels_RequestSyntax) **
Return models that support the output modality that you specify.
Valid Values: `TEXT | IMAGE | EMBEDDING`
** [byProvider](#API_ListFoundationModels_RequestSyntax) **
Return models belonging to the model provider that you specify.
Pattern: `[A-Za-z0-9- ]{1,63}`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelSummaries": [
{
"customizationsSupported": [ "string" ],
"inferenceTypesSupported": [ "string" ],
"inputModalities": [ "string" ],
"modelArn": "string",
"modelId": "string",
"modelLifecycle": {
"endOfLifeTime": "string",
"legacyTime": "string",
"publicExtendedAccessTime": "string",
"startOfLifeTime": "string",
"status": "string"
},
"modelName": "string",
"outputModalities": [ "string" ],
"providerName": "string",
"responseStreamingSupported": boolean
}
]
}
```
## 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.
** [modelSummaries](#API_ListFoundationModels_ResponseSyntax) **
A list of Amazon Bedrock foundation models.
Type: Array of [FoundationModelSummary](API_FoundationModelSummary.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
** 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.
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-2023-04-20/ListFoundationModels)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListFoundationModels)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListFoundationModels)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListFoundationModels)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListFoundationModels)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListFoundationModels)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListFoundationModels)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListFoundationModels)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListFoundationModels)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListFoundationModels)
# ListGuardrails
Lists details about all the guardrails in an account. To list the `DRAFT` version of all your guardrails, don't specify the `guardrailIdentifier` field. To list all versions of a guardrail, specify the ARN of the guardrail in the `guardrailIdentifier` field.
You can set the maximum number of results to return in a response in the `maxResults` field. If there are more results than the number you set, the response returns a `nextToken` that you can send in another `ListGuardrails` request to see the next batch of results.
## Request Syntax
```
GET /guardrails?guardrailIdentifier=guardrailIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [guardrailIdentifier](#API_ListGuardrails_RequestSyntax) **
The unique identifier of the guardrail. This can be an ID or the ARN.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
** [maxResults](#API_ListGuardrails_RequestSyntax) **
The maximum number of results to return in the response.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_ListGuardrails_RequestSyntax) **
If there are more results than were returned in the response, the response returns a `nextToken` that you can send in another `ListGuardrails` request to see 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
{
"guardrails": [
{
"arn": "string",
"createdAt": "string",
"crossRegionDetails": {
"guardrailProfileArn": "string",
"guardrailProfileId": "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.
** [guardrails](#API_ListGuardrails_ResponseSyntax) **
A list of objects, each of which contains details about a guardrail.
Type: Array of [GuardrailSummary](API_GuardrailSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
** [nextToken](#API_ListGuardrails_ResponseSyntax) **
If there are more results than were returned in the response, the response returns a `nextToken` that you can send in another `ListGuardrails` request to see 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.
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-2023-04-20/ListGuardrails)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListGuardrails)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListGuardrails)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListGuardrails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListGuardrails)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListGuardrails)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListGuardrails)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListGuardrails)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListGuardrails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListGuardrails)
# ListImportedModels
Returns a list of models you've imported. You can filter the results to return based on one or more criteria. For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /imported-models?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [creationTimeAfter](#API_ListImportedModels_RequestSyntax) **
Return imported models that were created after the specified time.
** [creationTimeBefore](#API_ListImportedModels_RequestSyntax) **
Return imported models that created before the specified time.
** [maxResults](#API_ListImportedModels_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.
** [nameContains](#API_ListImportedModels_RequestSyntax) **
Return imported models only if the model name contains these characters.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
** [nextToken](#API_ListImportedModels_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*`
** [sortBy](#API_ListImportedModels_RequestSyntax) **
The field to sort by in the returned list of imported models.
Valid Values: `CreationTime`
** [sortOrder](#API_ListImportedModels_RequestSyntax) **
Specifies whetehr to sort the results in ascending or descending order.
Valid Values: `Ascending | Descending`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelSummaries": [
{
"creationTime": "string",
"instructSupported": boolean,
"modelArchitecture": "string",
"modelArn": "string",
"modelName": "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.
** [modelSummaries](#API_ListImportedModels_ResponseSyntax) **
Model summaries.
Type: Array of [ImportedModelSummary](API_ImportedModelSummary.md) objects
** [nextToken](#API_ListImportedModels_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.
HTTP Status Code: 400
## Examples
### List the imported models
Lists the models that you have imported.
```
GET /imported-models/ HTTP/1.1
Content-type: application/json
```
### Example response
Response for the above request.
```
HTTP/1.1 200
Content-type: application/json
{
"modelSummaries": [
{
"modelArn": "arn:aws:bedrock:us-east-1:111122223333:imported-model/s4dt0wly5gud",
"modelName": "SomeImportedModelName",
"creationTime": "2024-08-13T19:20:14.058Z"
}
]
}
```
## 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-2023-04-20/ListImportedModels)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListImportedModels)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListImportedModels)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListImportedModels)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListImportedModels)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListImportedModels)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListImportedModels)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListImportedModels)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListImportedModels)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListImportedModels)
# ListInferenceProfiles
Returns a list of inference profiles that you can use. For more information, see [Increase throughput and resilience with cross-region inference in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). in the Amazon Bedrock User Guide.
## Request Syntax
```
GET /inference-profiles?maxResults=maxResults&nextToken=nextToken&type=typeEquals HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_ListInferenceProfiles_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_ListInferenceProfiles_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*`
** [typeEquals](#API_ListInferenceProfiles_RequestSyntax) **
Filters for inference profiles that match the type you specify.
+ `SYSTEM_DEFINED` – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.
+ `APPLICATION` – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.
Valid Values: `SYSTEM_DEFINED | APPLICATION`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"inferenceProfileSummaries": [
{
"createdAt": "string",
"description": "string",
"inferenceProfileArn": "string",
"inferenceProfileId": "string",
"inferenceProfileName": "string",
"models": [
{
"modelArn": "string"
}
],
"status": "string",
"type": "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.
** [inferenceProfileSummaries](#API_ListInferenceProfiles_ResponseSyntax) **
A list of information about each inference profile that you can use.
Type: Array of [InferenceProfileSummary](API_InferenceProfileSummary.md) objects
** [nextToken](#API_ListInferenceProfiles_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.
HTTP Status Code: 400
## Examples
### List information about inference profiles in your Region
Run the following example to list information for up to 5 inference profiles in your region:
#### Sample Request
```
GET /inference-profiles?maxResults=5 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-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListInferenceProfiles)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListInferenceProfiles)
# ListMarketplaceModelEndpoints
Lists the endpoints for models from Amazon Bedrock Marketplace in your AWS account.
## Request Syntax
```
GET /marketplace-model/endpoints?maxResults=maxResults&modelSourceIdentifier=modelSourceEquals&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_ListMarketplaceModelEndpoints_RequestSyntax) **
The maximum number of results to return in a single call. If more results are available, the operation returns a `NextToken` value.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [modelSourceEquals](#API_ListMarketplaceModelEndpoints_RequestSyntax) **
If specified, only endpoints for the given model source identifier are returned.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*`
** [nextToken](#API_ListMarketplaceModelEndpoints_RequestSyntax) **
The token for the next set of results. You receive this token from a previous `ListMarketplaceModelEndpoints` call.
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
{
"marketplaceModelEndpoints": [
{
"createdAt": "string",
"endpointArn": "string",
"modelSourceIdentifier": "string",
"status": "string",
"statusMessage": "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.
** [marketplaceModelEndpoints](#API_ListMarketplaceModelEndpoints_ResponseSyntax) **
An array of endpoint summaries.
Type: Array of [MarketplaceModelEndpointSummary](API_MarketplaceModelEndpointSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1000 items.
** [nextToken](#API_ListMarketplaceModelEndpoints_ResponseSyntax) **
The token for the next set of results. Use this token to get the next set 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.
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-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListMarketplaceModelEndpoints)
# ListModelCopyJobs
Returns a list of model copy jobs that you have submitted. You can filter the jobs to return based on one or more criteria. For more information, see [Copy models to be used in other regions](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /model-copy-jobs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nextToken=nextToken&outputModelNameContains=targetModelNameContains&sortBy=sortBy&sortOrder=sortOrder&sourceAccountEquals=sourceAccountEquals&sourceModelArnEquals=sourceModelArnEquals&statusEquals=statusEquals HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [creationTimeAfter](#API_ListModelCopyJobs_RequestSyntax) **
Filters for model copy jobs created after the specified time.
** [creationTimeBefore](#API_ListModelCopyJobs_RequestSyntax) **
Filters for model copy jobs created before the specified time.
** [maxResults](#API_ListModelCopyJobs_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_ListModelCopyJobs_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*`
** [sortBy](#API_ListModelCopyJobs_RequestSyntax) **
The field to sort by in the returned list of model copy jobs.
Valid Values: `CreationTime`
** [sortOrder](#API_ListModelCopyJobs_RequestSyntax) **
Specifies whether to sort the results in ascending or descending order.
Valid Values: `Ascending | Descending`
** [sourceAccountEquals](#API_ListModelCopyJobs_RequestSyntax) **
Filters for model copy jobs in which the account that the source model belongs to is equal to the value that you specify.
Pattern: `[0-9]{12}`
** [sourceModelArnEquals](#API_ListModelCopyJobs_RequestSyntax) **
Filters for model copy jobs in which the Amazon Resource Name (ARN) of the source model to is equal to the value that you specify.
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
** [statusEquals](#API_ListModelCopyJobs_RequestSyntax) **
Filters for model copy jobs whose status matches the value that you specify.
Valid Values: `InProgress | Completed | Failed`
** [targetModelNameContains](#API_ListModelCopyJobs_RequestSyntax) **
Filters for model copy jobs in which the name of the copied model contains the string that you specify.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelCopyJobSummaries": [
{
"creationTime": "string",
"failureMessage": "string",
"jobArn": "string",
"sourceAccountId": "string",
"sourceModelArn": "string",
"sourceModelName": "string",
"status": "string",
"targetModelArn": "string",
"targetModelKmsKeyArn": "string",
"targetModelName": "string",
"targetModelTags": [
{
"key": "string",
"value": "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.
** [modelCopyJobSummaries](#API_ListModelCopyJobs_ResponseSyntax) **
A list of information about each model copy job.
Type: Array of [ModelCopyJobSummary](API_ModelCopyJobSummary.md) objects
** [nextToken](#API_ListModelCopyJobs_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.
HTTP Status Code: 400
## Examples
### List model copy jobs (CLI)
The following example shows how to return information about ten model copy jobs in an account, using the AWS CLI.
```
aws bedrock list-model-copy-jobs --max-results 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-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListModelCopyJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListModelCopyJobs)
# ListModelCustomizationJobs
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /model-customization-jobs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [creationTimeAfter](#API_ListModelCustomizationJobs_RequestSyntax) **
Return customization jobs created after the specified time.
** [creationTimeBefore](#API_ListModelCustomizationJobs_RequestSyntax) **
Return customization jobs created before the specified time.
** [maxResults](#API_ListModelCustomizationJobs_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.
** [nameContains](#API_ListModelCustomizationJobs_RequestSyntax) **
Return customization jobs only if the job name contains these characters.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
** [nextToken](#API_ListModelCustomizationJobs_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*`
** [sortBy](#API_ListModelCustomizationJobs_RequestSyntax) **
The field to sort by in the returned list of jobs.
Valid Values: `CreationTime`
** [sortOrder](#API_ListModelCustomizationJobs_RequestSyntax) **
The sort order of the results.
Valid Values: `Ascending | Descending`
** [statusEquals](#API_ListModelCustomizationJobs_RequestSyntax) **
Return customization jobs with the specified status.
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelCustomizationJobSummaries": [
{
"baseModelArn": "string",
"creationTime": "string",
"customizationType": "string",
"customModelArn": "string",
"customModelName": "string",
"endTime": "string",
"jobArn": "string",
"jobName": "string",
"lastModifiedTime": "string",
"status": "string",
"statusDetails": {
"dataProcessingDetails": {
"creationTime": "string",
"lastModifiedTime": "string",
"status": "string"
},
"trainingDetails": {
"creationTime": "string",
"lastModifiedTime": "string",
"status": "string"
},
"validationDetails": {
"creationTime": "string",
"lastModifiedTime": "string",
"status": "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.
** [modelCustomizationJobSummaries](#API_ListModelCustomizationJobs_ResponseSyntax) **
Job summaries.
Type: Array of [ModelCustomizationJobSummary](API_ModelCustomizationJobSummary.md) objects
** [nextToken](#API_ListModelCustomizationJobs_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.
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-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListModelCustomizationJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListModelCustomizationJobs)
# ListModelImportJobs
Returns a list of import jobs you've submitted. You can filter the results to return based on one or more criteria. For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /model-import-jobs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [creationTimeAfter](#API_ListModelImportJobs_RequestSyntax) **
Return import jobs that were created after the specified time.
** [creationTimeBefore](#API_ListModelImportJobs_RequestSyntax) **
Return import jobs that were created before the specified time.
** [maxResults](#API_ListModelImportJobs_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.
** [nameContains](#API_ListModelImportJobs_RequestSyntax) **
Return imported jobs only if the job name contains these characters.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
** [nextToken](#API_ListModelImportJobs_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*`
** [sortBy](#API_ListModelImportJobs_RequestSyntax) **
The field to sort by in the returned list of imported jobs.
Valid Values: `CreationTime`
** [sortOrder](#API_ListModelImportJobs_RequestSyntax) **
Specifies whether to sort the results in ascending or descending order.
Valid Values: `Ascending | Descending`
** [statusEquals](#API_ListModelImportJobs_RequestSyntax) **
Return imported jobs with the specified status.
Valid Values: `InProgress | Completed | Failed`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"modelImportJobSummaries": [
{
"creationTime": "string",
"endTime": "string",
"importedModelArn": "string",
"importedModelName": "string",
"jobArn": "string",
"jobName": "string",
"lastModifiedTime": "string",
"status": "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.
** [modelImportJobSummaries](#API_ListModelImportJobs_ResponseSyntax) **
Import job summaries.
Type: Array of [ModelImportJobSummary](API_ModelImportJobSummary.md) objects
** [nextToken](#API_ListModelImportJobs_ResponseSyntax) **
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*`
## 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.
HTTP Status Code: 400
## Examples
### List model import jobs
Gets a list of the import jobs that you have submitted.
```
GET /model-import-jobs/ HTTP/1.1
Content-type: application/json
```
### Example response
Response for the above request.
```
HTTP/1.1 200
Content-type: application/json
{
"modelImportJobSummaries": [
{
"jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/yggb47n4xlml",
"jobName": "MyImportedModelJobName",
"status": "InProgress",
"lastModifiedTime": "2024-08-13T23:40:47.517Z",
"creationTime": "2024-08-13T23:38:42.457Z",
"importedModelName": "ImportedModelName"
},
{
"jobArn": "arn:aws:bedrock:us-east-1:111122223333:model-import-job/dchh9ny8e0dv",
"jobName": "SomeJobName",
"status": "Completed",
"lastModifiedTime": "2024-08-13T19:36:33.674Z",
"creationTime": "2024-08-13T19:20:14.058Z",
"endTime": "2024-08-13T19:36:33.492Z",
"importedModelArn": "arn:aws:bedrock:us-east-1:111122223333:imported-model/s4dt0wly5gud",
"importedModelName": "SomeImportedModelName"
}
]
}
```
## 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-2023-04-20/ListModelImportJobs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListModelImportJobs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListModelImportJobs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListModelImportJobs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListModelImportJobs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListModelImportJobs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListModelImportJobs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListModelImportJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListModelImportJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListModelImportJobs)
# ListModelInvocationJobs
Lists all batch inference jobs in the account. For more information, see [View details about a batch inference job](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-view.html).
## Request Syntax
```
GET /model-invocation-jobs?maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals&submitTimeAfter=submitTimeAfter&submitTimeBefore=submitTimeBefore HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_ListModelInvocationJobs_RequestSyntax) **
The maximum number of results to return. If there are more results than the number that you specify, a `nextToken` value is returned. Use the `nextToken` in a request to return the next batch of results.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nameContains](#API_ListModelInvocationJobs_RequestSyntax) **
Specify a string to filter for batch inference jobs whose names contain the string.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\+\-\.]){0,63}`
** [nextToken](#API_ListModelInvocationJobs_RequestSyntax) **
If there were more results than the value you specified in the `maxResults` field in a previous `ListModelInvocationJobs` request, the response would have returned a `nextToken` value. To see the next batch of results, send the `nextToken` value in another request.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [sortBy](#API_ListModelInvocationJobs_RequestSyntax) **
An attribute by which to sort the results.
Valid Values: `CreationTime`
** [sortOrder](#API_ListModelInvocationJobs_RequestSyntax) **
Specifies whether to sort the results by ascending or descending order.
Valid Values: `Ascending | Descending`
** [statusEquals](#API_ListModelInvocationJobs_RequestSyntax) **
Specify a status to filter for batch inference jobs whose statuses match the string you specify.
The following statuses are possible:
+ Submitted – This job has been submitted to a queue for validation.
+ Validating – This job is being validated for the requirements described in [Format and upload your batch inference data](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html). The criteria include the following:
+ Your IAM service role has access to the Amazon S3 buckets containing your files.
+ Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the `modelInput` value matches the request body for the model.
+ Your files fulfill the requirements for file size and number of records. For more information, see [Quotas for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html).
+ Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
+ Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
+ InProgress – This job has begun. You can start viewing the results in the output S3 location.
+ Completed – This job has successfully completed. View the output files in the output S3 location.
+ PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
+ Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the [Support Center](https://console.aws.amazon.com/support/home/).
+ Stopped – This job was stopped by a user.
+ Stopping – This job is being stopped by a user.
Valid Values: `Submitted | InProgress | Completed | Failed | Stopping | Stopped | PartiallyCompleted | Expired | Validating | Scheduled`
** [submitTimeAfter](#API_ListModelInvocationJobs_RequestSyntax) **
Specify a time to filter for batch inference jobs that were submitted after the time you specify.
** [submitTimeBefore](#API_ListModelInvocationJobs_RequestSyntax) **
Specify a time to filter for batch inference jobs that were submitted before the time you specify.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"invocationJobSummaries": [
{
"clientRequestToken": "string",
"endTime": "string",
"errorRecordCount": number,
"inputDataConfig": { ... },
"jobArn": "string",
"jobExpirationTime": "string",
"jobName": "string",
"lastModifiedTime": "string",
"message": "string",
"modelId": "string",
"modelInvocationType": "string",
"outputDataConfig": { ... },
"processedRecordCount": number,
"roleArn": "string",
"status": "string",
"submitTime": "string",
"successRecordCount": number,
"timeoutDurationInHours": number,
"totalRecordCount": number,
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnetIds": [ "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.
** [invocationJobSummaries](#API_ListModelInvocationJobs_ResponseSyntax) **
A list of items, each of which contains a summary about a batch inference job.
Type: Array of [ModelInvocationJobSummary](API_ModelInvocationJobSummary.md) objects
** [nextToken](#API_ListModelInvocationJobs_ResponseSyntax) **
If there are more results than can fit in the response, a `nextToken` is returned. Use the `nextToken` in a request 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.
HTTP Status Code: 400
## Examples
### List up to ten model invocation jobs
This example illustrates one usage of ListModelInvocationJobs.
```
GET /model-invocation-jobs?maxResults=10&sortBy=CreationTime&sortOrder=Descending 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-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListModelInvocationJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListModelInvocationJobs)
# ListPromptRouters
Retrieves a list of prompt routers.
## Request Syntax
```
GET /prompt-routers?maxResults=maxResults&nextToken=nextToken&type=type HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_ListPromptRouters_RequestSyntax) **
The maximum number of prompt routers to return in one page of results.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_ListPromptRouters_RequestSyntax) **
Specify the pagination token from a previous request to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [type](#API_ListPromptRouters_RequestSyntax) **
The type of the prompt routers, such as whether it's default or custom.
Valid Values: `custom | default`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"promptRouterSummaries": [
{
"createdAt": "string",
"description": "string",
"fallbackModel": {
"modelArn": "string"
},
"models": [
{
"modelArn": "string"
}
],
"promptRouterArn": "string",
"promptRouterName": "string",
"routingCriteria": {
"responseQualityDifference": number
},
"status": "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.
** [nextToken](#API_ListPromptRouters_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*`
** [promptRouterSummaries](#API_ListPromptRouters_ResponseSyntax) **
A list of prompt router summaries.
Type: Array of [PromptRouterSummary](API_PromptRouterSummary.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
** 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.
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-2023-04-20/ListPromptRouters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListPromptRouters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListPromptRouters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListPromptRouters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListPromptRouters)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListPromptRouters)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListPromptRouters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListPromptRouters)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListPromptRouters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListPromptRouters)
# ListProvisionedModelThroughputs
Lists the Provisioned Throughputs in the account. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
GET /provisioned-model-throughputs?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&modelArnEquals=modelArnEquals&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [creationTimeAfter](#API_ListProvisionedModelThroughputs_RequestSyntax) **
A filter that returns Provisioned Throughputs created after the specified time.
** [creationTimeBefore](#API_ListProvisionedModelThroughputs_RequestSyntax) **
A filter that returns Provisioned Throughputs created before the specified time.
** [maxResults](#API_ListProvisionedModelThroughputs_RequestSyntax) **
THe maximum number of results to return in the response. If there are more results than the number you specified, the response returns a `nextToken` value. To see the next batch of results, send the `nextToken` value in another list request.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [modelArnEquals](#API_ListProvisionedModelThroughputs_RequestSyntax) **
A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
** [nameContains](#API_ListProvisionedModelThroughputs_RequestSyntax) **
A filter that returns Provisioned Throughputs if their name contains the expression that you specify.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
** [nextToken](#API_ListProvisionedModelThroughputs_RequestSyntax) **
If there are more results than the number you specified in the `maxResults` field, the response returns a `nextToken` value. To see the next batch of results, specify the `nextToken` value in this field.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [sortBy](#API_ListProvisionedModelThroughputs_RequestSyntax) **
The field by which to sort the returned list of Provisioned Throughputs.
Valid Values: `CreationTime`
** [sortOrder](#API_ListProvisionedModelThroughputs_RequestSyntax) **
The sort order of the results.
Valid Values: `Ascending | Descending`
** [statusEquals](#API_ListProvisionedModelThroughputs_RequestSyntax) **
A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.
Valid Values: `Creating | InService | Updating | Failed`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"provisionedModelSummaries": [
{
"commitmentDuration": "string",
"commitmentExpirationTime": "string",
"creationTime": "string",
"desiredModelArn": "string",
"desiredModelUnits": number,
"foundationModelArn": "string",
"lastModifiedTime": "string",
"modelArn": "string",
"modelUnits": number,
"provisionedModelArn": "string",
"provisionedModelName": "string",
"status": "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_ListProvisionedModelThroughputs_ResponseSyntax) **
If there are more results than the number you specified in the `maxResults` field, this value is returned. To see the next batch of results, include this value in the `nextToken` field in another list request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [provisionedModelSummaries](#API_ListProvisionedModelThroughputs_ResponseSyntax) **
A list of summaries, one for each Provisioned Throughput in the response.
Type: Array of [ProvisionedModelSummary](API_ProvisionedModelSummary.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
** 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.
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-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListProvisionedModelThroughputs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListProvisionedModelThroughputs)
# ListTagsForResource
List the tags associated with the specified 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](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
POST /listTagsForResource HTTP/1.1
Content-type: application/json
{
"resourceARN": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [resourceARN](#API_ListTagsForResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `.*(^[a-zA-Z0-9][a-zA-Z0-9\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$))).*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"tags": [
{
"key": "string",
"value": "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_ListTagsForResource_ResponseSyntax) **
An array of the tags associated with this resource.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 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.
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-2023-04-20/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ListTagsForResource)
# PutEnforcedGuardrailConfiguration
Sets the account-level enforced guardrail configuration.
## Request Syntax
```
PUT /enforcedGuardrailsConfiguration HTTP/1.1
Content-type: application/json
{
"configId": "string",
"guardrailInferenceConfig": {
"guardrailIdentifier": "string",
"guardrailVersion": "string",
"modelEnforcement": {
"excludedModels": [ "string" ],
"includedModels": [ "string" ]
},
"selectiveContentGuarding": {
"messages": "string",
"system": "string"
}
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [configId](#API_PutEnforcedGuardrailConfiguration_RequestSyntax) **
Unique ID for the account enforced configuration.
Type: String
Pattern: `[a-z0-9]+`
Required: No
** [guardrailInferenceConfig](#API_PutEnforcedGuardrailConfiguration_RequestSyntax) **
Account-level enforced guardrail input configuration.
Type: [AccountEnforcedGuardrailInferenceInputConfiguration](API_AccountEnforcedGuardrailInferenceInputConfiguration.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"configId": "string",
"updatedAt": "string",
"updatedBy": "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.
** [configId](#API_PutEnforcedGuardrailConfiguration_ResponseSyntax) **
Unique ID for the account enforced configuration.
Type: String
Pattern: `[a-z0-9]+`
** [updatedAt](#API_PutEnforcedGuardrailConfiguration_ResponseSyntax) **
Timestamp.
Type: Timestamp
** [updatedBy](#API_PutEnforcedGuardrailConfiguration_ResponseSyntax) **
The ARN of the role used to update the configuration.
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PutEnforcedGuardrailConfiguration)
# PutModelInvocationLoggingConfiguration
Set the configuration values for model invocation logging.
## Request Syntax
```
PUT /logging/modelinvocations HTTP/1.1
Content-type: application/json
{
"loggingConfig": {
"audioDataDeliveryEnabled": boolean,
"cloudWatchConfig": {
"largeDataDeliveryS3Config": {
"bucketName": "string",
"keyPrefix": "string"
},
"logGroupName": "string",
"roleArn": "string"
},
"embeddingDataDeliveryEnabled": boolean,
"imageDataDeliveryEnabled": boolean,
"s3Config": {
"bucketName": "string",
"keyPrefix": "string"
},
"textDataDeliveryEnabled": boolean,
"videoDataDeliveryEnabled": boolean
}
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [loggingConfig](#API_PutModelInvocationLoggingConfiguration_RequestSyntax) **
The logging configuration values to set.
Type: [LoggingConfig](API_LoggingConfig.md) object
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
** 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.
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-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PutModelInvocationLoggingConfiguration)
# PutResourcePolicy
Adds a resource policy for a Bedrock resource.
## Request Syntax
```
POST /resource-policy HTTP/1.1
Content-type: application/json
{
"resourceArn": "string",
"resourcePolicy": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [resourceArn](#API_PutResourcePolicy_RequestSyntax) **
The ARN of the Bedrock resource to which this resource policy applies.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
** [resourcePolicy](#API_PutResourcePolicy_RequestSyntax) **
The JSON string representing the Bedrock resource policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20480.
Pattern: `[ -ÿ]+`
Required: Yes
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"resourceArn": "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.
** [resourceArn](#API_PutResourcePolicy_ResponseSyntax) **
The ARN of the Bedrock resource to which this resource policy applies.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/PutResourcePolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/PutResourcePolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PutResourcePolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/PutResourcePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PutResourcePolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/PutResourcePolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/PutResourcePolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/PutResourcePolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/PutResourcePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PutResourcePolicy)
# PutUseCaseForModelAccess
Returns the use case for model access. The example shown below under *Examples* shows the form data json configuration.
## Request Syntax
```
POST /use-case-for-model-access HTTP/1.1
Content-type: application/json
{
"formData": blob
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [formData](#API_PutUseCaseForModelAccess_RequestSyntax) **
Returns the form data from the Anthropic first time user request.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 10. Maximum length of 16384.
Required: Yes
## Response Syntax
```
HTTP/1.1 201
```
## Response Elements
If the action is successful, the service sends back an HTTP 201 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
** 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.
HTTP Status Code: 400
## Examples
### Example
This example illustrates one usage of PutUseCaseForModelAccess.
```
form_data = {
"companyName": COMPANY_NAME,
"companyWebsite": COMPANY_WEBSITE,
"intendedUsers": INTENDED_USERS,
"industryOption": INDUSTRY_OPTION,
"otherIndustryOption": OTHER_INDUSTRY_OPTION,
"useCases": USE_CASES
}
```
## 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-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/PutUseCaseForModelAccess)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PutUseCaseForModelAccess)
# RegisterMarketplaceModelEndpoint
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
## Request Syntax
```
POST /marketplace-model/endpoints/endpointIdentifier/registration HTTP/1.1
Content-type: application/json
{
"modelSourceIdentifier": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [endpointIdentifier](#API_RegisterMarketplaceModelEndpoint_RequestSyntax) **
The ARN of the Amazon SageMaker endpoint you want to register with Amazon Bedrock Marketplace.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [modelSourceIdentifier](#API_RegisterMarketplaceModelEndpoint_RequestSyntax) **
The ARN of the model from Amazon Bedrock Marketplace that is deployed on the endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"marketplaceModelEndpoint": {
"createdAt": "string",
"endpointArn": "string",
"endpointConfig": { ... },
"endpointStatus": "string",
"endpointStatusMessage": "string",
"modelSourceIdentifier": "string",
"status": "string",
"statusMessage": "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.
** [marketplaceModelEndpoint](#API_RegisterMarketplaceModelEndpoint_ResponseSyntax) **
Details about the registered endpoint.
Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.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
** ServiceUnavailableException **
Returned if the service cannot complete the request.
HTTP Status Code: 503
** 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.
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-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RegisterMarketplaceModelEndpoint)
# StartAutomatedReasoningPolicyBuildWorkflow
Starts a new build workflow for an Automated Reasoning policy. This initiates the process of analyzing source documents and generating policy rules, variables, and types.
## Request Syntax
```
POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowType/start HTTP/1.1
x-amz-client-token: clientRequestToken
Content-type: application/json
{
"policyDefinition": {
"rules": [
{
"alternateExpression": "string",
"expression": "string",
"id": "string"
}
],
"types": [
{
"description": "string",
"name": "string",
"values": [
{
"description": "string",
"value": "string"
}
]
}
],
"variables": [
{
"description": "string",
"name": "string",
"type": "string"
}
],
"version": "string"
},
"workflowContent": { ... }
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowType](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The type of build workflow to start (e.g., DOCUMENT\$1INGESTION for processing new documents, POLICY\$1REPAIR for fixing existing policies).
Valid Values: `INGEST_CONTENT | REFINE_POLICY | IMPORT_POLICY | GENERATE_FIDELITY_REPORT`
Required: Yes
** [clientRequestToken](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the operation completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
** [policyArn](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy for which to start the build workflow.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [policyDefinition](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
An existing policy definition that serves as the starting point for the build workflow, typically used in policy repair or update scenarios.
Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object
Required: No
** [workflowContent](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **
The actual content to be processed in the build workflow, such as documents to analyze or repair instructions to apply.
Type: [AutomatedReasoningPolicyWorkflowTypeContent](API_AutomatedReasoningPolicyWorkflowTypeContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"buildWorkflowId": "string",
"policyArn": "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.
** [buildWorkflowId](#API_StartAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The unique identifier of the newly started build workflow. Use this ID to track the workflow's progress and retrieve its results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
** [policyArn](#API_StartAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceInUseException **
Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
HTTP Status Code: 400
** 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: 400
** 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.
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-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyBuildWorkflow)
# StartAutomatedReasoningPolicyTestWorkflow
Initiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results.
## Request Syntax
```
POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-workflows HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"testCaseIds": [ "string" ]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) **
The build workflow identifier. The build workflow must show a `COMPLETED` status before running tests.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [policyArn](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy to test.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request but doesn't return an error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [testCaseIds](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) **
The list of test identifiers to run. If not provided, all tests for the policy are run.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[0-9A-Z]{12}`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"policyArn": "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.
** [policyArn](#API_StartAutomatedReasoningPolicyTestWorkflow_ResponseSyntax) **
The Amazon Resource Name (ARN) of the policy for which the test workflow was started.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
## 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
** ResourceInUseException **
Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
HTTP Status Code: 400
** 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.
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-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StartAutomatedReasoningPolicyTestWorkflow)
# StopEvaluationJob
Stops an evaluation job that is current being created or running.
## Request Syntax
```
POST /evaluation-job/jobIdentifier/stop HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobIdentifier](#API_StopEvaluationJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the evaluation job you want to stop.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})`
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/StopEvaluationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StopEvaluationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StopEvaluationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StopEvaluationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StopEvaluationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StopEvaluationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StopEvaluationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StopEvaluationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StopEvaluationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StopEvaluationJob)
# StopModelCustomizationJob
Stops an active model customization job. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
POST /model-customization-jobs/jobIdentifier/stop HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobIdentifier](#API_StopModelCustomizationJob_RequestSyntax) **
Job identifier of the job to stop.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12})|([a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*)`
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StopModelCustomizationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StopModelCustomizationJob)
# StopModelInvocationJob
Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see [Stop a batch inference job](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-stop.html).
## Request Syntax
```
POST /model-invocation-job/jobIdentifier/stop HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobIdentifier](#API_StopModelInvocationJob_RequestSyntax) **
The Amazon Resource Name (ARN) of the batch inference job to stop.
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `((arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/)?[a-z0-9]{12})`
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
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
## Examples
### Stop a model invocation job
This example illustrates one usage of StopModelInvocationJob.
```
POST /model-invocation-job/BATCHJOB1234/stop 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-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/StopModelInvocationJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StopModelInvocationJob)
# 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](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
POST /tagResource HTTP/1.1
Content-type: application/json
{
"resourceARN": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [resourceARN](#API_TagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource to tag.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `.*(^[a-zA-Z0-9][a-zA-Z0-9\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$))).*`
Required: Yes
** [tags](#API_TagResource_RequestSyntax) **
Tags to associate with the resource.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
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
** ThrottlingException **
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
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-2023-04-20/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/TagResource)
# UntagResource
Remove one or more tags from 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](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
POST /untagResource HTTP/1.1
Content-type: application/json
{
"resourceARN": "string",
"tagKeys": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [resourceARN](#API_UntagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource to untag.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `.*(^[a-zA-Z0-9][a-zA-Z0-9\-]*$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported)/[a-z0-9]{12}$)|(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:([0-9]{12}|)((:(fine-tuning-job|model-customization-job|custom-model)/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12})$)|(:guardrail/[a-z0-9]+$)|(:automated-reasoning-policy/[a-zA-Z0-9]+(:[a-zA-Z0-9]+)?$)|(:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)|(:(provisioned-model|model-invocation-job|model-evaluation-job|evaluation-job|model-import-job|imported-model|async-invoke|provisioned-model-v2|provisioned-model-reservation|prompt-router|custom-model-deployment)/[a-z0-9]{12}$))).*`
Required: Yes
** [tagKeys](#API_UntagResource_RequestSyntax) **
Tag keys of the tags to remove from the resource.
Type: Array of strings
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
## 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.
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-2023-04-20/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UntagResource)
# UpdateAutomatedReasoningPolicy
Updates an existing Automated Reasoning policy with new rules, variables, or configuration. This creates a new version of the policy while preserving the previous version.
## Request Syntax
```
PATCH /automated-reasoning-policies/policyArn HTTP/1.1
Content-type: application/json
{
"description": "string",
"name": "string",
"policyDefinition": {
"rules": [
{
"alternateExpression": "string",
"expression": "string",
"id": "string"
}
],
"types": [
{
"description": "string",
"name": "string",
"values": [
{
"description": "string",
"value": "string"
}
]
}
],
"variables": [
{
"description": "string",
"name": "string",
"type": "string"
}
],
"version": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [policyArn](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy to update. This must be the ARN of a draft policy.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) **
The updated description for the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
** [name](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) **
The updated name for the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[0-9a-zA-Z-_ ]+`
Required: No
** [policyDefinition](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) **
The updated policy definition containing the formal logic rules, variables, and types.
Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"definitionHash": "string",
"name": "string",
"policyArn": "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.
** [definitionHash](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) **
The hash of the updated policy definition.
Type: String
Length Constraints: Fixed length of 128.
Pattern: `[0-9a-z]{128}`
** [name](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) **
The updated name of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[0-9a-zA-Z-_ ]+`
** [policyArn](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) **
The Amazon Resource Name (ARN) of the updated policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [updatedAt](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) **
The timestamp when the policy 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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
** TooManyTagsException **
The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
** resourceName **
The name of the resource with too many tags.
HTTP Status Code: 400
** ValidationException **
Input validation failed. Check your request parameters and retry the request.
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-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicy)
# UpdateAutomatedReasoningPolicyAnnotations
Updates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy.
## Request Syntax
```
PATCH /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/annotations HTTP/1.1
Content-type: application/json
{
"annotations": [
{ ... }
],
"lastUpdatedAnnotationSetHash": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [buildWorkflowId](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) **
The unique identifier of the build workflow whose annotations you want to update.
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** [policyArn](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy whose annotations you want to update.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [annotations](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) **
The updated annotations containing modified rules, variables, and types for the policy.
Type: Array of [AutomatedReasoningPolicyAnnotation](API_AutomatedReasoningPolicyAnnotation.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
** [lastUpdatedAnnotationSetHash](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) **
The hash value of the annotation set that you're updating. This is used for optimistic concurrency control to prevent conflicting updates.
Type: String
Length Constraints: Fixed length of 128.
Pattern: `[0-9a-z]{128}`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"annotationSetHash": "string",
"buildWorkflowId": "string",
"policyArn": "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.
** [annotationSetHash](#API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The new hash value representing the updated state of the annotations.
Type: String
Length Constraints: Fixed length of 128.
Pattern: `[0-9a-z]{128}`
** [buildWorkflowId](#API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The unique identifier of the build workflow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
** [policyArn](#API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [updatedAt](#API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax) **
The timestamp when the annotations were 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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.
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-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyAnnotations)
# UpdateAutomatedReasoningPolicyTestCase
Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.
## Request Syntax
```
PATCH /automated-reasoning-policies/policyArn/test-cases/testCaseId HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"confidenceThreshold": number,
"expectedAggregatedFindingsResult": "string",
"guardContent": "string",
"lastUpdatedAt": "string",
"queryContent": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [policyArn](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The Amazon Resource Name (ARN) of the Automated Reasoning policy that contains the test.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** [testCaseId](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The unique identifier of the test to update.
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[0-9A-Z]{12}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [confidenceThreshold](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The updated minimum confidence level for logic validation. If null is provided, the threshold will be removed.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** [expectedAggregatedFindingsResult](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The updated expected result of the Automated Reasoning check.
Type: String
Valid Values: `VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION`
Required: Yes
** [guardContent](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The updated content to be validated by the Automated Reasoning policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
** [lastUpdatedAt](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The timestamp when the test was last updated. This is used as a concurrency token to prevent conflicting modifications.
Type: Timestamp
Required: Yes
** [queryContent](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **
The updated input query or prompt that generated the content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"policyArn": "string",
"testCaseId": "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.
** [policyArn](#API_UpdateAutomatedReasoningPolicyTestCase_ResponseSyntax) **
The Amazon Resource Name (ARN) of the policy that contains the updated test.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
** [testCaseId](#API_UpdateAutomatedReasoningPolicyTestCase_ResponseSyntax) **
The unique identifier of the updated test.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[0-9A-Z]{12}`
## 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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** InternalServerException **
An internal server error occurred. Retry your request.
HTTP Status Code: 500
** ResourceInUseException **
Thrown when attempting to delete or modify a resource that is currently being used by other resources or operations. For example, trying to delete an Automated Reasoning policy that is referenced by an active guardrail.
HTTP Status Code: 400
** 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.
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-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateAutomatedReasoningPolicyTestCase)
# UpdateCustomModelDeployment
Updates a custom model deployment with a new custom model. This allows you to deploy updated models without creating new deployment endpoints.
## Request Syntax
```
PATCH /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1
Content-type: application/json
{
"modelArn": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [customModelDeploymentIdentifier](#API_UpdateCustomModelDeployment_RequestSyntax) **
Identifier of the custom model deployment to update with the new custom model.
Length Constraints: Minimum length of 1. Maximum length of 93.
Pattern: `(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12})|^([0-9a-zA-Z][_-]?){1,63}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [modelArn](#API_UpdateCustomModelDeployment_RequestSyntax) **
ARN of the new custom model to deploy. This replaces the currently deployed model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
Required: Yes
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"customModelDeploymentArn": "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.
** [customModelDeploymentArn](#API_UpdateCustomModelDeployment_ResponseSyntax) **
ARN of the custom model deployment being updated.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}`
## 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.
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-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateCustomModelDeployment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateCustomModelDeployment)
# UpdateGuardrail
Updates a guardrail with the values you specify.
+ Specify a `name` and optional `description`.
+ Specify messages for when the guardrail successfully blocks a prompt or a model response in the `blockedInputMessaging` and `blockedOutputsMessaging` fields.
+ Specify topics for the guardrail to deny in the `topicPolicyConfig` object. Each [GuardrailTopicConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailTopicConfig.html) object in the `topicsConfig` list pertains to one topic.
+ Give a `name` and `description` so that the guardrail can properly identify the topic.
+ Specify `DENY` in the `type` field.
+ (Optional) Provide up to five prompts that you would categorize as belonging to the topic in the `examples` list.
+ Specify filter strengths for the harmful categories defined in Amazon Bedrock in the `contentPolicyConfig` object. Each [GuardrailContentFilterConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html) object in the `filtersConfig` list pertains to a harmful category. For more information, see [Content filters](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-content-filters). For more information about the fields in a content filter, see [GuardrailContentFilterConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html).
+ Specify the category in the `type` field.
+ Specify the strength of the filter for prompts in the `inputStrength` field and for model responses in the `strength` field of the [GuardrailContentFilterConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html).
+ (Optional) For security, include the ARN of a AWS KMS key in the `kmsKeyId` field.
## Request Syntax
```
PUT /guardrails/guardrailIdentifier HTTP/1.1
Content-type: application/json
{
"automatedReasoningPolicyConfig": {
"confidenceThreshold": number,
"policies": [ "string" ]
},
"blockedInputMessaging": "string",
"blockedOutputsMessaging": "string",
"contentPolicyConfig": {
"filtersConfig": [
{
"inputAction": "string",
"inputEnabled": boolean,
"inputModalities": [ "string" ],
"inputStrength": "string",
"outputAction": "string",
"outputEnabled": boolean,
"outputModalities": [ "string" ],
"outputStrength": "string",
"type": "string"
}
],
"tierConfig": {
"tierName": "string"
}
},
"contextualGroundingPolicyConfig": {
"filtersConfig": [
{
"action": "string",
"enabled": boolean,
"threshold": number,
"type": "string"
}
]
},
"crossRegionConfig": {
"guardrailProfileIdentifier": "string"
},
"description": "string",
"kmsKeyId": "string",
"name": "string",
"sensitiveInformationPolicyConfig": {
"piiEntitiesConfig": [
{
"action": "string",
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
],
"regexesConfig": [
{
"action": "string",
"description": "string",
"inputAction": "string",
"inputEnabled": boolean,
"name": "string",
"outputAction": "string",
"outputEnabled": boolean,
"pattern": "string"
}
]
},
"topicPolicyConfig": {
"tierConfig": {
"tierName": "string"
},
"topicsConfig": [
{
"definition": "string",
"examples": [ "string" ],
"inputAction": "string",
"inputEnabled": boolean,
"name": "string",
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
]
},
"wordPolicyConfig": {
"managedWordListsConfig": [
{
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"type": "string"
}
],
"wordsConfig": [
{
"inputAction": "string",
"inputEnabled": boolean,
"outputAction": "string",
"outputEnabled": boolean,
"text": "string"
}
]
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [guardrailIdentifier](#API_UpdateGuardrail_RequestSyntax) **
The unique identifier of the guardrail. This can be an ID or the ARN.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [automatedReasoningPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **
Updated configuration for Automated Reasoning policies associated with the guardrail.
Type: [GuardrailAutomatedReasoningPolicyConfig](API_GuardrailAutomatedReasoningPolicyConfig.md) object
Required: No
** [blockedInputMessaging](#API_UpdateGuardrail_RequestSyntax) **
The message to return when the guardrail blocks a prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
** [blockedOutputsMessaging](#API_UpdateGuardrail_RequestSyntax) **
The message to return when the guardrail blocks a model response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
** [contentPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **
The content policy to configure for the guardrail.
Type: [GuardrailContentPolicyConfig](API_GuardrailContentPolicyConfig.md) object
Required: No
** [contextualGroundingPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **
The contextual grounding policy configuration used to update a guardrail.
Type: [GuardrailContextualGroundingPolicyConfig](API_GuardrailContextualGroundingPolicyConfig.md) object
Required: No
** [crossRegionConfig](#API_UpdateGuardrail_RequestSyntax) **
The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed.
For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).
Type: [GuardrailCrossRegionConfig](API_GuardrailCrossRegionConfig.md) object
Required: No
** [description](#API_UpdateGuardrail_RequestSyntax) **
A description of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [kmsKeyId](#API_UpdateGuardrail_RequestSyntax) **
The ARN of the AWS KMS key with which to encrypt the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
** [name](#API_UpdateGuardrail_RequestSyntax) **
A name for the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: `[0-9a-zA-Z-_]+`
Required: Yes
** [sensitiveInformationPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **
The sensitive information policy to configure for the guardrail.
Type: [GuardrailSensitiveInformationPolicyConfig](API_GuardrailSensitiveInformationPolicyConfig.md) object
Required: No
** [topicPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **
The topic policy to configure for the guardrail.
Type: [GuardrailTopicPolicyConfig](API_GuardrailTopicPolicyConfig.md) object
Required: No
** [wordPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **
The word policy to configure for the guardrail.
Type: [GuardrailWordPolicyConfig](API_GuardrailWordPolicyConfig.md) object
Required: No
## Response Syntax
```
HTTP/1.1 202
Content-type: application/json
{
"guardrailArn": "string",
"guardrailId": "string",
"updatedAt": "string",
"version": "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.
** [guardrailArn](#API_UpdateGuardrail_ResponseSyntax) **
The ARN of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+`
** [guardrailId](#API_UpdateGuardrail_ResponseSyntax) **
The unique identifier of the guardrail
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: `[a-z0-9]+`
** [updatedAt](#API_UpdateGuardrail_ResponseSyntax) **
The date and time at which the guardrail was updated.
Type: Timestamp
** [version](#API_UpdateGuardrail_ResponseSyntax) **
The version of the guardrail.
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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** 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.
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-2023-04-20/UpdateGuardrail)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateGuardrail)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateGuardrail)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateGuardrail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateGuardrail)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateGuardrail)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateGuardrail)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateGuardrail)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateGuardrail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateGuardrail)
# UpdateMarketplaceModelEndpoint
Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
## Request Syntax
```
PATCH /marketplace-model/endpoints/endpointArn HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"endpointConfig": { ... }
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [endpointArn](#API_UpdateMarketplaceModelEndpoint_RequestSyntax) **
The Amazon Resource Name (ARN) of the endpoint you want to update.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_UpdateMarketplaceModelEndpoint_RequestSyntax) **
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is listed as not required because AWS SDKs automatically generate it for you and set this parameter. If you're not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([-a-zA-Z0-9]{0,254}[a-zA-Z0-9])?`
Required: No
** [endpointConfig](#API_UpdateMarketplaceModelEndpoint_RequestSyntax) **
The new configuration for the endpoint, including the number and type of instances to use.
Type: [EndpointConfig](API_EndpointConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"marketplaceModelEndpoint": {
"createdAt": "string",
"endpointArn": "string",
"endpointConfig": { ... },
"endpointStatus": "string",
"endpointStatusMessage": "string",
"modelSourceIdentifier": "string",
"status": "string",
"statusMessage": "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.
** [marketplaceModelEndpoint](#API_UpdateMarketplaceModelEndpoint_ResponseSyntax) **
Details about the updated endpoint.
Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.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 **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** 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: 400
** 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.
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-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateMarketplaceModelEndpoint)
# UpdateProvisionedModelThroughput
Updates the name or associated model for a Provisioned Throughput. For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
PATCH /provisioned-model-throughput/provisionedModelId HTTP/1.1
Content-type: application/json
{
"desiredModelId": "string",
"desiredProvisionedModelName": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [provisionedModelId](#API_UpdateProvisionedModelThroughput_RequestSyntax) **
The Amazon Resource Name (ARN) or ID of the Provisioned Throughput to update.
Pattern: `((([0-9a-zA-Z][_-]?)+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [desiredModelId](#API_UpdateProvisionedModelThroughput_RequestSyntax) **
The model ID (for a foundation model), name (for a custom model), or Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model.
If this Provisioned Throughput is associated with a custom model, you can specify one of the following options:
+ The base model from which the custom model was customized.
+ Another custom model that was customized from the same base model as the custom model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)`
Required: No
** [desiredProvisionedModelName](#API_UpdateProvisionedModelThroughput_RequestSyntax) **
The new name for this Provisioned Throughput.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
Required: No
## 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.
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-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/UpdateProvisionedModelThroughput)
# 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)
# Agents for Amazon Bedrock Runtime
The following actions are supported by Agents for Amazon Bedrock Runtime:
+ [CreateInvocation](API_agent-runtime_CreateInvocation.md)
+ [CreateSession](API_agent-runtime_CreateSession.md)
+ [DeleteAgentMemory](API_agent-runtime_DeleteAgentMemory.md)
+ [DeleteSession](API_agent-runtime_DeleteSession.md)
+ [EndSession](API_agent-runtime_EndSession.md)
+ [GenerateQuery](API_agent-runtime_GenerateQuery.md)
+ [GetAgentMemory](API_agent-runtime_GetAgentMemory.md)
+ [GetExecutionFlowSnapshot](API_agent-runtime_GetExecutionFlowSnapshot.md)
+ [GetFlowExecution](API_agent-runtime_GetFlowExecution.md)
+ [GetInvocationStep](API_agent-runtime_GetInvocationStep.md)
+ [GetSession](API_agent-runtime_GetSession.md)
+ [InvokeAgent](API_agent-runtime_InvokeAgent.md)
+ [InvokeFlow](API_agent-runtime_InvokeFlow.md)
+ [InvokeInlineAgent](API_agent-runtime_InvokeInlineAgent.md)
+ [ListFlowExecutionEvents](API_agent-runtime_ListFlowExecutionEvents.md)
+ [ListFlowExecutions](API_agent-runtime_ListFlowExecutions.md)
+ [ListInvocations](API_agent-runtime_ListInvocations.md)
+ [ListInvocationSteps](API_agent-runtime_ListInvocationSteps.md)
+ [ListSessions](API_agent-runtime_ListSessions.md)
+ [ListTagsForResource](API_agent-runtime_ListTagsForResource.md)
+ [OptimizePrompt](API_agent-runtime_OptimizePrompt.md)
+ [PutInvocationStep](API_agent-runtime_PutInvocationStep.md)
+ [Rerank](API_agent-runtime_Rerank.md)
+ [Retrieve](API_agent-runtime_Retrieve.md)
+ [RetrieveAndGenerate](API_agent-runtime_RetrieveAndGenerate.md)
+ [RetrieveAndGenerateStream](API_agent-runtime_RetrieveAndGenerateStream.md)
+ [StartFlowExecution](API_agent-runtime_StartFlowExecution.md)
+ [StopFlowExecution](API_agent-runtime_StopFlowExecution.md)
+ [TagResource](API_agent-runtime_TagResource.md)
+ [UntagResource](API_agent-runtime_UntagResource.md)
+ [UpdateSession](API_agent-runtime_UpdateSession.md)
# CreateInvocation
Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
Related APIs
+ [ListInvocations](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html)
+ [ListSessions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListSessions.html)
+ [GetSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetSession.html)
## Request Syntax
```
PUT /sessions/sessionIdentifier/invocations/ HTTP/1.1
Content-type: application/json
{
"description": "string",
"invocationId": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [sessionIdentifier](#API_agent-runtime_CreateInvocation_RequestSyntax) **
The unique identifier for the associated session for the invocation. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [description](#API_agent-runtime_CreateInvocation_RequestSyntax) **
A description for the interactions in the invocation. For example, "User asking about weather in Seattle".
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** [invocationId](#API_agent-runtime_CreateInvocation_RequestSyntax) **
A unique identifier for the invocation in UUID format.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"createdAt": "string",
"invocationId": "string",
"sessionId": "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.
** [createdAt](#API_agent-runtime_CreateInvocation_ResponseSyntax) **
The timestamp for when the invocation was created.
Type: Timestamp
** [invocationId](#API_agent-runtime_CreateInvocation_ResponseSyntax) **
The unique identifier for the invocation.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionId](#API_agent-runtime_CreateInvocation_ResponseSyntax) **
The unique identifier for the session associated with the invocation.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
HTTP Status Code: 400
## Examples
### Request example
This example illustrates one usage of CreateInvocation.
```
PUT bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/invocations/ HTTP/1.1
Content-type: application/json
{
"description": "User asking about weather in Seattle",
"invocationId": "12345abc-1234-abcd-1234-abcdef123456"
}
```
## 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-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/CreateInvocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CreateInvocation)
# CreateSession
Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of AWS. For more information, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
By default, Amazon Bedrock uses AWS-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see [Amazon Bedrock session encryption](https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html).
**Note**
You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) API operation.
Related APIs:
+ [ListSessions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListSessions.html)
+ [GetSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetSession.html)
+ [EndSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_EndSession.html)
+ [DeleteSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_DeleteSession.html)
## Request Syntax
```
PUT /sessions/ HTTP/1.1
Content-type: application/json
{
"encryptionKeyArn": "string",
"sessionMetadata": {
"string" : "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.
** [encryptionKeyArn](#API_agent-runtime_CreateSession_RequestSyntax) **
The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see [Amazon Bedrock session encryption](https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html).
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
** [sessionMetadata](#API_agent-runtime_CreateSession_RequestSyntax) **
A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Value Length Constraints: Minimum length of 0. Maximum length of 5000.
Required: No
** [tags](#API_agent-runtime_CreateSession_RequestSyntax) **
Specify the key-value pairs for the tags that you want to attach to the session.
Type: String to string map
Map Entries: Maximum number of 200 items.
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
{
"createdAt": "string",
"sessionArn": "string",
"sessionId": "string",
"sessionStatus": "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.
** [createdAt](#API_agent-runtime_CreateSession_ResponseSyntax) **
The timestamp for when the session was created.
Type: Timestamp
** [sessionArn](#API_agent-runtime_CreateSession_ResponseSyntax) **
The Amazon Resource Name (ARN) of the created session.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionId](#API_agent-runtime_CreateSession_ResponseSyntax) **
The unique identifier for the session.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionStatus](#API_agent-runtime_CreateSession_ResponseSyntax) **
The current status of the session.
Type: String
Valid Values: `ACTIVE | EXPIRED | ENDED`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. Retry your request.
HTTP Status Code: 500
** ServiceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
HTTP Status Code: 400
** 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of CreateSession.
```
PUT bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/ HTTP/1.1
Content-type: application/json
{
"encryptionKeyArn": "key Amazon Resource Name (ARN)",
"sessionMetadata": {
"deviceType": "mobile",
"language": "english"
},
"tags": {
"Environment": "Production",
"Project": "Demo"
}
}
```
## 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-runtime-2023-07-26/CreateSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/CreateSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CreateSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/CreateSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CreateSession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/CreateSession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/CreateSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/CreateSession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/CreateSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CreateSession)
# DeleteAgentMemory
Deletes memory from the specified memory identifier.
## Request Syntax
```
DELETE /agents/agentId/agentAliases/agentAliasId/memories?memoryId=memoryId&sessionId=sessionId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentAliasId](#API_agent-runtime_DeleteAgentMemory_RequestSyntax) **
The unique identifier of an alias of an agent.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** [agentId](#API_agent-runtime_DeleteAgentMemory_RequestSyntax) **
The unique identifier of the agent to which the alias belongs.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** [memoryId](#API_agent-runtime_DeleteAgentMemory_RequestSyntax) **
The unique identifier of the memory.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
** [sessionId](#API_agent-runtime_DeleteAgentMemory_RequestSyntax) **
The unique session identifier of the memory.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 202
```
## Response Elements
If the action is successful, the service sends back an HTTP 202 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
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-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory)
# DeleteSession
Deletes a session that you ended. You can't delete a session with an `ACTIVE` status. To delete an active session, you must first end it with the [EndSession](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_EndSession.html) API operation. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Request Syntax
```
DELETE /sessions/sessionIdentifier/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [sessionIdentifier](#API_agent-runtime_DeleteSession_RequestSyntax) **
The unique identifier for the session to be deleted. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
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. Check your permissions and retry your request.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of DeleteSession.
```
DELETE bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/ 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-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/DeleteSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/DeleteSession)
# EndSession
Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Request Syntax
```
PATCH /sessions/sessionIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [sessionIdentifier](#API_agent-runtime_EndSession_RequestSyntax) **
The unique identifier for the session to end. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"sessionArn": "string",
"sessionId": "string",
"sessionStatus": "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.
** [sessionArn](#API_agent-runtime_EndSession_ResponseSyntax) **
The Amazon Resource Name (ARN) of the session you ended.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionId](#API_agent-runtime_EndSession_ResponseSyntax) **
The unique identifier of the session you ended.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionStatus](#API_agent-runtime_EndSession_ResponseSyntax) **
The current status of the session you ended.
Type: String
Valid Values: `ACTIVE | EXPIRED | ENDED`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of EndSession.
```
PATCH bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/ 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-runtime-2023-07-26/EndSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/EndSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/EndSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/EndSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/EndSession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/EndSession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/EndSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/EndSession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/EndSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/EndSession)
# GenerateQuery
Generates an SQL query from a natural language query. For more information, see [Generate a query for structured data](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-generate-query.html) in the Amazon Bedrock User Guide.
## Request Syntax
```
POST /generateQuery HTTP/1.1
Content-type: application/json
{
"queryGenerationInput": {
"text": "string",
"type": "string"
},
"transformationConfiguration": {
"mode": "string",
"textToSqlConfiguration": {
"knowledgeBaseConfiguration": {
"knowledgeBaseArn": "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.
** [queryGenerationInput](#API_agent-runtime_GenerateQuery_RequestSyntax) **
Specifies information about a natural language query to transform into SQL.
Type: [QueryGenerationInput](API_agent-runtime_QueryGenerationInput.md) object
Required: Yes
** [transformationConfiguration](#API_agent-runtime_GenerateQuery_RequestSyntax) **
Specifies configurations for transforming the natural language query into SQL.
Type: [TransformationConfiguration](API_agent-runtime_TransformationConfiguration.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"queries": [
{
"sql": "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.
** [queries](#API_agent-runtime_GenerateQuery_ResponseSyntax) **
A list of objects, each of which defines a generated query that can correspond to the natural language queries.
Type: Array of [GeneratedQuery](API_agent-runtime_GeneratedQuery.md) objects
Array Members: Minimum number of 0 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
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-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/GenerateQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GenerateQuery)
# GetAgentMemory
Gets the sessions stored in the memory of the agent.
## Request Syntax
```
GET /agents/agentId/agentAliases/agentAliasId/memories?maxItems=maxItems&memoryId=memoryId&memoryType=memoryType&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentAliasId](#API_agent-runtime_GetAgentMemory_RequestSyntax) **
The unique identifier of an alias of an agent.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** [agentId](#API_agent-runtime_GetAgentMemory_RequestSyntax) **
The unique identifier of the agent to which the alias belongs.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** [maxItems](#API_agent-runtime_GetAgentMemory_RequestSyntax) **
The maximum number of items 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.
** [memoryId](#API_agent-runtime_GetAgentMemory_RequestSyntax) **
The unique identifier of the memory.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: Yes
** [memoryType](#API_agent-runtime_GetAgentMemory_RequestSyntax) **
The type of memory.
Valid Values: `SESSION_SUMMARY`
Required: Yes
** [nextToken](#API_agent-runtime_GetAgentMemory_RequestSyntax) **
If the total number of results is greater than the maxItems 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
{
"memoryContents": [
{ ... }
],
"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.
** [memoryContents](#API_agent-runtime_GetAgentMemory_ResponseSyntax) **
Contains details of the sessions stored in the memory
Type: Array of [Memory](API_agent-runtime_Memory.md) objects
** [nextToken](#API_agent-runtime_GetAgentMemory_ResponseSyntax) **
If the total number of results is greater than the maxItems 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
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-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GetAgentMemory)
# GetExecutionFlowSnapshot
Retrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the execution was started. Note that even if the flow is edited after an execution starts, the snapshot connected to the execution remains unchanged.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Request Syntax
```
GET /flows/flowIdentifier/aliases/flowAliasIdentifier/executions/executionIdentifier/flowsnapshot HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [executionIdentifier](#API_agent-runtime_GetExecutionFlowSnapshot_RequestSyntax) **
The unique identifier of the flow execution.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})`
Required: Yes
** [flowAliasIdentifier](#API_agent-runtime_GetExecutionFlowSnapshot_RequestSyntax) **
The unique identifier of the flow alias used for the flow execution.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [flowIdentifier](#API_agent-runtime_GetExecutionFlowSnapshot_RequestSyntax) **
The unique identifier of the flow.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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
{
"customerEncryptionKeyArn": "string",
"definition": "string",
"executionRoleArn": "string",
"flowAliasIdentifier": "string",
"flowIdentifier": "string",
"flowVersion": "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.
** [customerEncryptionKeyArn](#API_agent-runtime_GetExecutionFlowSnapshot_ResponseSyntax) **
The Amazon Resource Name (ARN) of the customer managed AWS KMS key that's used to encrypt the flow snapshot.
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-runtime_GetExecutionFlowSnapshot_ResponseSyntax) **
The flow definition used for the flow execution, including the nodes, connections, and configuration at the time when the execution started.
The definition returns as a string that follows the structure of a [FlowDefinition](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_FlowDefinition.html) object.
Type: String
** [executionRoleArn](#API_agent-runtime_GetExecutionFlowSnapshot_ResponseSyntax) **
The Amazon Resource Name (ARN) of the IAM service role that's used by the flow execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+`
** [flowAliasIdentifier](#API_agent-runtime_GetExecutionFlowSnapshot_ResponseSyntax) **
The unique identifier of the flow alias used for the flow execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
** [flowIdentifier](#API_agent-runtime_GetExecutionFlowSnapshot_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
** [flowVersion](#API_agent-runtime_GetExecutionFlowSnapshot_ResponseSyntax) **
The version of the flow used for the flow execution.
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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
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-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GetExecutionFlowSnapshot)
# GetFlowExecution
Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
## Request Syntax
```
GET /flows/flowIdentifier/aliases/flowAliasIdentifier/executions/executionIdentifier HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [executionIdentifier](#API_agent-runtime_GetFlowExecution_RequestSyntax) **
The unique identifier of the flow execution to retrieve.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})`
Required: Yes
** [flowAliasIdentifier](#API_agent-runtime_GetFlowExecution_RequestSyntax) **
The unique identifier of the flow alias used for the execution.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [flowIdentifier](#API_agent-runtime_GetFlowExecution_RequestSyntax) **
The unique identifier of the flow.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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
{
"endedAt": "string",
"errors": [
{
"error": "string",
"message": "string",
"nodeName": "string"
}
],
"executionArn": "string",
"flowAliasIdentifier": "string",
"flowIdentifier": "string",
"flowVersion": "string",
"startedAt": "string",
"status": "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.
** [endedAt](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **
The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
Type: Timestamp
** [errors](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **
A list of errors that occurred during the flow execution. Each error includes an error code, message, and the node where the error occurred, if applicable.
Type: Array of [FlowExecutionError](API_agent-runtime_FlowExecutionError.md) objects
** [executionArn](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **
The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})`
** [flowAliasIdentifier](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **
The unique identifier of the flow alias used for the execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
** [flowIdentifier](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **
The unique identifier of the flow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10})|([0-9a-zA-Z]{10})`
** [flowVersion](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **
The version of the flow used for the execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
** [startedAt](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **
The timestamp when the flow execution started.
Type: Timestamp
** [status](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **
The current status of the flow execution.
Flow executions time out after 24 hours.
Type: String
Valid Values: `Running | Succeeded | Failed | TimedOut | Aborted`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
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-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GetFlowExecution)
# GetInvocationStep
Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Request Syntax
```
POST /sessions/sessionIdentifier/invocationSteps/invocationStepId HTTP/1.1
Content-type: application/json
{
"invocationIdentifier": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [invocationStepId](#API_agent-runtime_GetInvocationStep_RequestSyntax) **
The unique identifier (in UUID format) for the specific invocation step to retrieve.
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** [sessionIdentifier](#API_agent-runtime_GetInvocationStep_RequestSyntax) **
The unique identifier for the invocation step's associated session. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [invocationIdentifier](#API_agent-runtime_GetInvocationStep_RequestSyntax) **
The unique identifier for the invocation in UUID format.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"invocationStep": {
"invocationId": "string",
"invocationStepId": "string",
"invocationStepTime": "string",
"payload": { ... },
"sessionId": "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.
** [invocationStep](#API_agent-runtime_GetInvocationStep_ResponseSyntax) **
The complete details of the requested invocation step.
Type: [InvocationStep](API_agent-runtime_InvocationStep.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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of GetInvocationStep.
```
POST bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/invocationSteps/11111111-2222-3333-4444-555555555555 HTTP/1.1
Content-type: application/json
{
"invocationIdentifier": "abc-1234-abcd-1234-abcdef123456"
}
```
## 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-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GetInvocationStep)
# GetSession
Retrieves details about a specific session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Request Syntax
```
GET /sessions/sessionIdentifier/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [sessionIdentifier](#API_agent-runtime_GetSession_RequestSyntax) **
A unique identifier for the session to retrieve. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"encryptionKeyArn": "string",
"lastUpdatedAt": "string",
"sessionArn": "string",
"sessionId": "string",
"sessionMetadata": {
"string" : "string"
},
"sessionStatus": "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.
** [createdAt](#API_agent-runtime_GetSession_ResponseSyntax) **
The timestamp for when the session was created.
Type: Timestamp
** [encryptionKeyArn](#API_agent-runtime_GetSession_ResponseSyntax) **
The Amazon Resource Name (ARN) of the AWS Key Management Service key used to encrypt the session data. For more information, see [Amazon Bedrock session encryption](https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html).
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}`
** [lastUpdatedAt](#API_agent-runtime_GetSession_ResponseSyntax) **
The timestamp for when the session was last modified.
Type: Timestamp
** [sessionArn](#API_agent-runtime_GetSession_ResponseSyntax) **
The Amazon Resource Name (ARN) of the session.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionId](#API_agent-runtime_GetSession_ResponseSyntax) **
The unique identifier for the session in UUID format.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionMetadata](#API_agent-runtime_GetSession_ResponseSyntax) **
A map of key-value pairs containing attributes persisted across the session.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Value Length Constraints: Minimum length of 0. Maximum length of 5000.
** [sessionStatus](#API_agent-runtime_GetSession_ResponseSyntax) **
The current status of the session.
Type: String
Valid Values: `ACTIVE | EXPIRED | ENDED`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of GetSession.
```
GET bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/ 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-runtime-2023-07-26/GetSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/GetSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GetSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/GetSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GetSession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/GetSession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/GetSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/GetSession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/GetSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GetSession)
# InvokeAgent
**Note**
The AWS CLI doesn't support streaming operations in Amazon Bedrock, including `InvokeAgent`.
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
+ To continue the same conversation with an agent, use the same `sessionId` value in the request.
+ To activate trace enablement, turn `enableTrace` to `true`. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see [Trace enablement](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events).
+ End a conversation by setting `endSession` to `true`.
+ In the `sessionState` object, you can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group.
The response contains both **chunk** and **trace** attributes.
The final response is returned in the `bytes` field of the `chunk` object. The `InvokeAgent` returns one chunk for the entire interaction.
+ The `attribution` object contains citations for parts of the response.
+ If you set `enableTrace` to `true` in the request, you can trace the agent's steps and reasoning process that led it to the response.
+ If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the `returnControl` field.
+ Errors are also surfaced in the response.
## Request Syntax
```
POST /agents/agentId/agentAliases/agentAliasId/sessions/sessionId/text HTTP/1.1
x-amz-source-arn: sourceArn
Content-type: application/json
{
"bedrockModelConfigurations": {
"performanceConfig": {
"latency": "string"
}
},
"enableTrace": boolean,
"endSession": boolean,
"inputText": "string",
"memoryId": "string",
"promptCreationConfigurations": {
"excludePreviousThinkingSteps": boolean,
"previousConversationTurnsToInclude": number
},
"sessionState": {
"conversationHistory": {
"messages": [
{
"content": [
{ ... }
],
"role": "string"
}
]
},
"files": [
{
"name": "string",
"source": {
"byteContent": {
"data": blob,
"mediaType": "string"
},
"s3Location": {
"uri": "string"
},
"sourceType": "string"
},
"useCase": "string"
}
],
"invocationId": "string",
"knowledgeBaseConfigurations": [
{
"knowledgeBaseId": "string",
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"filter": { ... },
"implicitFilterConfiguration": {
"metadataAttributes": [
{
"description": "string",
"key": "string",
"type": "string"
}
],
"modelArn": "string"
},
"numberOfResults": number,
"overrideSearchType": "string",
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"metadataConfiguration": {
"selectionMode": "string",
"selectiveModeConfiguration": { ... }
},
"modelConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"modelArn": "string"
},
"numberOfRerankedResults": number
},
"type": "string"
}
}
}
}
],
"promptSessionAttributes": {
"string" : "string"
},
"returnControlInvocationResults": [
{ ... }
],
"sessionAttributes": {
"string" : "string"
}
},
"streamingConfigurations": {
"applyGuardrailInterval": number,
"streamFinalResponse": boolean
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [agentAliasId](#API_agent-runtime_InvokeAgent_RequestSyntax) **
The alias of the agent to use.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** [agentId](#API_agent-runtime_InvokeAgent_RequestSyntax) **
The unique identifier of the agent to use.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** [sessionId](#API_agent-runtime_InvokeAgent_RequestSyntax) **
The unique identifier of the session. Use the same value across requests to continue the same conversation.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: Yes
** [sourceArn](#API_agent-runtime_InvokeAgent_RequestSyntax) **
The ARN of the resource making the request.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}`
## Request Body
The request accepts the following data in JSON format.
** [bedrockModelConfigurations](#API_agent-runtime_InvokeAgent_RequestSyntax) **
Model performance settings for the request.
Type: [BedrockModelConfigurations](API_agent-runtime_BedrockModelConfigurations.md) object
Required: No
** [enableTrace](#API_agent-runtime_InvokeAgent_RequestSyntax) **
Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see [Trace enablement](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events).
Type: Boolean
Required: No
** [endSession](#API_agent-runtime_InvokeAgent_RequestSyntax) **
Specifies whether to end the session with the agent or not.
Type: Boolean
Required: No
** [inputText](#API_agent-runtime_InvokeAgent_RequestSyntax) **
The prompt text to send the agent.
If you include `returnControlInvocationResults` in the `sessionState` field, the `inputText` field will be ignored.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 25000000.
Required: No
** [memoryId](#API_agent-runtime_InvokeAgent_RequestSyntax) **
The unique identifier of the agent memory.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** [promptCreationConfigurations](#API_agent-runtime_InvokeAgent_RequestSyntax) **
Specifies parameters that control how the service populates the agent prompt for an `InvokeAgent` request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Type: [PromptCreationConfigurations](API_agent-runtime_PromptCreationConfigurations.md) object
Required: No
** [sessionState](#API_agent-runtime_InvokeAgent_RequestSyntax) **
Contains parameters that specify various attributes of the session. For more information, see [Control session context](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
If you include `returnControlInvocationResults` in the `sessionState` field, the `inputText` field will be ignored.
Type: [SessionState](API_agent-runtime_SessionState.md) object
Required: No
** [streamingConfigurations](#API_agent-runtime_InvokeAgent_RequestSyntax) **
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the `bedrock:InvokeModelWithResponseStream` action.
Type: [StreamingConfigurations](API_agent-runtime_StreamingConfigurations.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
x-amzn-bedrock-agent-content-type: contentType
x-amz-bedrock-agent-session-id: sessionId
x-amz-bedrock-agent-memory-id: memoryId
Content-type: application/json
{
"accessDeniedException": {
},
"badGatewayException": {
},
"chunk": {
"attribution": {
"citations": [
{
"generatedResponsePart": {
"textResponsePart": {
"span": {
"end": number,
"start": number
},
"text": "string"
}
},
"retrievedReferences": [
{
"content": {
"audio": {
"s3Uri": "string",
"transcription": "string"
},
"byteContent": "string",
"row": [
{
"columnName": "string",
"columnValue": "string",
"type": "string"
}
],
"text": "string",
"type": "string",
"video": {
"s3Uri": "string",
"summary": "string"
}
},
"location": {
"confluenceLocation": {
"url": "string"
},
"customDocumentLocation": {
"id": "string"
},
"kendraDocumentLocation": {
"uri": "string"
},
"s3Location": {
"uri": "string"
},
"salesforceLocation": {
"url": "string"
},
"sharePointLocation": {
"url": "string"
},
"sqlLocation": {
"query": "string"
},
"type": "string",
"webLocation": {
"url": "string"
}
},
"metadata": {
"string" : JSON value
}
}
]
}
]
},
"bytes": blob
},
"conflictException": {
},
"dependencyFailedException": {
},
"files": {
"files": [
{
"bytes": blob,
"name": "string",
"type": "string"
}
]
},
"internalServerException": {
},
"modelNotReadyException": {
},
"resourceNotFoundException": {
},
"returnControl": {
"invocationId": "string",
"invocationInputs": [
{ ... }
]
},
"serviceQuotaExceededException": {
},
"throttlingException": {
},
"trace": {
"agentAliasId": "string",
"agentId": "string",
"agentVersion": "string",
"callerChain": [
{ ... }
],
"collaboratorName": "string",
"eventTime": "string",
"sessionId": "string",
"trace": { ... }
},
"validationException": {
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [contentType](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
The MIME type of the input data in the request. The default value is `application/json`.
** [memoryId](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
The unique identifier of the agent memory.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
** [sessionId](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
The unique identifier of the session with the agent.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
The following data is returned in JSON format by the service.
** [accessDeniedException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403
** [badGatewayException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502
** [chunk](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
Contains a part of an agent response and citations for it.
Type: [PayloadPart](API_agent-runtime_PayloadPart.md) object
** [conflictException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
There was a conflict performing an operation. Resolve the conflict and retry your request.
Type: Exception
HTTP Status Code: 409
** [dependencyFailedException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424
** [files](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
Contains intermediate response for code interpreter if any files have been generated.
Type: [FilePart](API_agent-runtime_FilePart.md) object
** [internalServerException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
** [modelNotReadyException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see [Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide.
Type: Exception
HTTP Status Code: 424
** [resourceNotFoundException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
Type: Exception
HTTP Status Code: 404
** [returnControl](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
Type: [ReturnControlPayload](API_agent-runtime_ReturnControlPayload.md) object
** [serviceQuotaExceededException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
The number of requests exceeds the service quota. Resubmit your request later.
Type: Exception
HTTP Status Code: 400
** [throttlingException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
The number of requests exceeds the limit. Resubmit your request later.
Type: Exception
HTTP Status Code: 429
** [trace](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace events](https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html).
Type: [TracePart](API_agent-runtime_TracePart.md) object
** [validationException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. Retry your request.
HTTP Status Code: 500
** ModelNotReadyException **
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see [Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide.
HTTP Status Code: 424
** 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: 400
** 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.
HTTP Status Code: 400
## Examples
### Example simple request
The following example inquires the agent to get the weather for Seattle.
```
POST https://bedrock-agent-runtime.us-east-1.amazonaws.com/agents/AGENT12345/agentAliases/TSTALIASID/sessions/abb/text
{
"inputText": "give me the weather for seattle",
"enableTrace": true
}
```
### Example response (action group defined with OpenAPI schema, control returned)
The following example shows a response from an agent that has invoked an action group that was configured as follows:
+ Defined with an OpenAPI schema
+ Configured to return control to the agent developer
```
HTTP/1.1 200
x-amzn-bedrock-agent-content-type: application/json
x-amz-bedrock-agent-session-id: session0
Content-type: application/json
{
"invocationInputs": [{
"apiInvocationInput": {
"actionGroup": "WeatherAPIs",
"apiPath": "/get-weather",
"httpMethod": "get",
"parameters": [
{
"name": "location",
"type": "string",
"value": "seattle"
},
{
"name": "date",
"type": "string",
"value": "2024-09-15"
}
]
}
}],
"invocationId": "337cb2f6-ec74-4b49-8141-00b8091498ad"
}
```
### Example request using results from returned control (action group defined with OpenAPI schema)
The following example shows a request in which the results returned in the `InvokeAgent` response from an agent are passed to the `sessionState` of a new request. The results were returned from an agent that has invoked an action group that was configured as follows:
+ Defined with an OpenAPI schema
+ Configured to return control to the agent developer
The `invocationId` must match the `invocationId` that was returned in the response.
```
POST https: //bedrock-agent-runtime.us-east-1.amazonaws.com/agents/AGENT12345/agentAliases/TSTALIASID/sessions/abb/text
{
"enableTrace": true,
"sessionState": {
"invocationId": "337cb2f6-ec74-4b49-8141-00b8091498ad",
"returnControlInvocationResults": [{
"apiResult": {
"actionGroup": "WeatherAPIs",
"httpMethod": "get",
"apiPath": "/get-weather",
"responseBody": {
"application/json": {
"body": "It's rainy in Seattle today."
}
}
}
}]
}
}
```
### Example response (action group defined with function details, control returned)
The following example shows a response from an agent that has invoked an action group that was configured as follows:
+ Defined with function details
+ Configured to return control to the agent developer
```
HTTP/1.1 200
x-amzn-bedrock-agent-content-type: application/json
x-amz-bedrock-agent-session-id: session0
Content-type: application/json
{
"invocationInputs": [{
"functionInvocationInput": {
"actionGroup": "WeatherAPIs",
"function": "getWeather",
"parameters": [
{
"name": "location",
"type": "string",
"value": "seattle"
},
{
"name": "date",
"type": "string",
"value": "2024-09-15"
}
]
}
}],
"invocationId": "79e0feaa-c6f7-49bf-814d-b7c498505172"
}
```
### Example request using results from returned control (action group defined with function details)
The following example shows a request in which the results returned in the `InvokeAgent` response from an agent are passed to the `sessionState` of a new request. The results were returned from an agent that has invoked an action group that was configured as follows:
+ Defined with function details
+ Configured to return control to the agent developer
The `invocationId` must match the `invocationId` that was returned in the response.
```
POST https://bedrock-agent-runtime.us-east-1.amazonaws.com/agents/AGENT12345/agentAliases/TSTALIASID/sessions/abb/text
{
"enableTrace": true,
"sessionState": {
"invocationId": "79e0feaa-c6f7-49bf-814d-b7c498505172",
"returnControlInvocationResults": [{
"functionResult": {
"actionGroup": "WeatherAPIs",
"function": "getWeather",
"responseBody": {
"TEXT": {
"body": "It's rainy in Seattle today."
}
}
}
}]
}
}
```
## 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-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/InvokeAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvokeAgent)
# InvokeFlow
Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. 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](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
**Note**
The AWS CLI doesn't support streaming operations in Amazon Bedrock, including `InvokeFlow`.
## Request Syntax
```
POST /flows/flowIdentifier/aliases/flowAliasIdentifier HTTP/1.1
Content-type: application/json
{
"enableTrace": boolean,
"executionId": "string",
"inputs": [
{
"content": { ... },
"nodeInputName": "string",
"nodeName": "string",
"nodeOutputName": "string"
}
],
"modelPerformanceConfiguration": {
"performanceConfig": {
"latency": "string"
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowAliasIdentifier](#API_agent-runtime_InvokeFlow_RequestSyntax) **
The unique identifier of the flow alias.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [flowIdentifier](#API_agent-runtime_InvokeFlow_RequestSyntax) **
The unique identifier of the flow.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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.
** [enableTrace](#API_agent-runtime_InvokeFlow_RequestSyntax) **
Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
Type: Boolean
Required: No
** [executionId](#API_agent-runtime_InvokeFlow_RequestSyntax) **
The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** [inputs](#API_agent-runtime_InvokeFlow_RequestSyntax) **
A list of objects, each containing information about an input into the flow.
Type: Array of [FlowInput](API_agent-runtime_FlowInput.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** [modelPerformanceConfiguration](#API_agent-runtime_InvokeFlow_RequestSyntax) **
Model performance settings for the request.
Type: [ModelPerformanceConfiguration](API_agent-runtime_ModelPerformanceConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
x-amz-bedrock-flow-execution-id: executionId
Content-type: application/json
{
"accessDeniedException": {
},
"badGatewayException": {
},
"conflictException": {
},
"dependencyFailedException": {
},
"flowCompletionEvent": {
"completionReason": "string"
},
"flowMultiTurnInputRequestEvent": {
"content": { ... },
"nodeName": "string",
"nodeType": "string"
},
"flowOutputEvent": {
"content": { ... },
"nodeName": "string",
"nodeType": "string"
},
"flowTraceEvent": {
"trace": { ... }
},
"internalServerException": {
},
"resourceNotFoundException": {
},
"serviceQuotaExceededException": {
},
"throttlingException": {
},
"validationException": {
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [executionId](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
The unique identifier for the current flow execution.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
The following data is returned in JSON format by the service.
** [accessDeniedException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403
** [badGatewayException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502
** [conflictException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
There was a conflict performing an operation. Resolve the conflict and retry your request.
Type: Exception
HTTP Status Code: 409
** [dependencyFailedException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424
** [flowCompletionEvent](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
Contains information about why the flow completed.
Type: [FlowCompletionEvent](API_agent-runtime_FlowCompletionEvent.md) object
** [flowMultiTurnInputRequestEvent](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
The event stream containing the multi-turn input request information from the flow.
Type: [FlowMultiTurnInputRequestEvent](API_agent-runtime_FlowMultiTurnInputRequestEvent.md) object
** [flowOutputEvent](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
Contains information about an output from flow invocation.
Type: [FlowOutputEvent](API_agent-runtime_FlowOutputEvent.md) object
** [flowTraceEvent](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
Contains information about a trace, which tracks an input or output for a node in the flow.
Type: [FlowTraceEvent](API_agent-runtime_FlowTraceEvent.md) object
** [internalServerException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
** [resourceNotFoundException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
Type: Exception
HTTP Status Code: 404
** [serviceQuotaExceededException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
The number of requests exceeds the service quota. Resubmit your request later.
Type: Exception
HTTP Status Code: 400
** [throttlingException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
The number of requests exceeds the limit. Resubmit your request later.
Type: Exception
HTTP Status Code: 429
** [validationException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
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-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/InvokeFlow)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvokeFlow)
# InvokeInlineAgent
Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
+ Specify the following fields for security purposes.
+ (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 `InvokeInlineAgent` request begins a new session.
+ 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).
+ 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.
**Note**
The AWS CLI doesn't support streaming operations in Amazon Bedrock, including `InvokeInlineAgent`.
## Request Syntax
```
POST /agents/sessionId HTTP/1.1
Content-type: application/json
{
"actionGroups": [
{
"actionGroupExecutor": { ... },
"actionGroupName": "string",
"apiSchema": { ... },
"description": "string",
"functionSchema": { ... },
"parentActionGroupSignature": "string",
"parentActionGroupSignatureParams": {
"string" : "string"
}
}
],
"agentCollaboration": "string",
"agentName": "string",
"bedrockModelConfigurations": {
"performanceConfig": {
"latency": "string"
}
},
"collaboratorConfigurations": [
{
"agentAliasArn": "string",
"collaboratorInstruction": "string",
"collaboratorName": "string",
"relayConversationHistory": "string"
}
],
"collaborators": [
{
"actionGroups": [
{
"actionGroupExecutor": { ... },
"actionGroupName": "string",
"apiSchema": { ... },
"description": "string",
"functionSchema": { ... },
"parentActionGroupSignature": "string",
"parentActionGroupSignatureParams": {
"string" : "string"
}
}
],
"agentCollaboration": "string",
"agentName": "string",
"collaboratorConfigurations": [
{
"agentAliasArn": "string",
"collaboratorInstruction": "string",
"collaboratorName": "string",
"relayConversationHistory": "string"
}
],
"customerEncryptionKeyArn": "string",
"foundationModel": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"idleSessionTTLInSeconds": number,
"instruction": "string",
"knowledgeBases": [
{
"description": "string",
"knowledgeBaseId": "string",
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"filter": { ... },
"implicitFilterConfiguration": {
"metadataAttributes": [
{
"description": "string",
"key": "string",
"type": "string"
}
],
"modelArn": "string"
},
"numberOfResults": number,
"overrideSearchType": "string",
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"metadataConfiguration": {
"selectionMode": "string",
"selectiveModeConfiguration": { ... }
},
"modelConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"modelArn": "string"
},
"numberOfRerankedResults": number
},
"type": "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"
}
]
}
}
],
"customerEncryptionKeyArn": "string",
"customOrchestration": {
"executor": { ... }
},
"enableTrace": boolean,
"endSession": boolean,
"foundationModel": "string",
"guardrailConfiguration": {
"guardrailIdentifier": "string",
"guardrailVersion": "string"
},
"idleSessionTTLInSeconds": number,
"inlineSessionState": {
"conversationHistory": {
"messages": [
{
"content": [
{ ... }
],
"role": "string"
}
]
},
"files": [
{
"name": "string",
"source": {
"byteContent": {
"data": blob,
"mediaType": "string"
},
"s3Location": {
"uri": "string"
},
"sourceType": "string"
},
"useCase": "string"
}
],
"invocationId": "string",
"promptSessionAttributes": {
"string" : "string"
},
"returnControlInvocationResults": [
{ ... }
],
"sessionAttributes": {
"string" : "string"
}
},
"inputText": "string",
"instruction": "string",
"knowledgeBases": [
{
"description": "string",
"knowledgeBaseId": "string",
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"filter": { ... },
"implicitFilterConfiguration": {
"metadataAttributes": [
{
"description": "string",
"key": "string",
"type": "string"
}
],
"modelArn": "string"
},
"numberOfResults": number,
"overrideSearchType": "string",
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"metadataConfiguration": {
"selectionMode": "string",
"selectiveModeConfiguration": { ... }
},
"modelConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"modelArn": "string"
},
"numberOfRerankedResults": number
},
"type": "string"
}
}
}
}
],
"orchestrationType": "string",
"promptCreationConfigurations": {
"excludePreviousThinkingSteps": boolean,
"previousConversationTurnsToInclude": 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"
}
]
},
"streamingConfigurations": {
"applyGuardrailInterval": number,
"streamFinalResponse": boolean
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [sessionId](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
The unique identifier of the session. Use the same value across requests to continue the same conversation.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [actionGroups](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
A list of action groups with each action group defining the action the inline agent needs to carry out.
Type: Array of [AgentActionGroup](API_agent-runtime_AgentActionGroup.md) objects
Required: No
** [agentCollaboration](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
Type: String
Valid Values: `SUPERVISOR | SUPERVISOR_ROUTER | DISABLED`
Required: No
** [agentName](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
The name for the agent.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** [bedrockModelConfigurations](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Model settings for the request.
Type: [InlineBedrockModelConfigurations](API_agent-runtime_InlineBedrockModelConfigurations.md) object
Required: No
** [collaboratorConfigurations](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Settings for an inline agent collaborator called with [InvokeInlineAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeInlineAgent.html).
Type: Array of [CollaboratorConfiguration](API_agent-runtime_CollaboratorConfiguration.md) objects
Required: No
** [collaborators](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
List of collaborator inline agents.
Type: Array of [Collaborator](API_agent-runtime_Collaborator.md) objects
Required: No
** [customerEncryptionKeyArn](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
The Amazon Resource Name (ARN) of the AWS KMS key to use to encrypt your inline 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-runtime_InvokeInlineAgent_RequestSyntax) **
Contains details of the custom orchestration configured for the agent.
Type: [CustomOrchestration](API_agent-runtime_CustomOrchestration.md) object
Required: No
** [enableTrace](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see [Using trace](https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html).
Type: Boolean
Required: No
** [endSession](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Specifies whether to end the session with the inline agent or not.
Type: Boolean
Required: No
** [foundationModel](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
The [model identifier (ID)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) of the model to use for orchestration by the inline agent. For example, `meta.llama3-1-70b-instruct-v1:0`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `.*(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)`
Required: Yes
** [guardrailConfiguration](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
The [guardrails](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html) to assign to the inline agent.
Type: [GuardrailConfigurationWithArn](API_agent-runtime_GuardrailConfigurationWithArn.md) object
Required: No
** [idleSessionTTLInSeconds](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent `InvokeInlineAgent` request begins a new session.
A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 3600.
Required: No
** [inlineSessionState](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see [Control session context](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
If you include `returnControlInvocationResults` in the `sessionState` field, the `inputText` field will be ignored.
Type: [InlineSessionState](API_agent-runtime_InlineSessionState.md) object
Required: No
** [inputText](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
The prompt text to send to the agent.
If you include `returnControlInvocationResults` in the `sessionState` field, the `inputText` field will be ignored.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 25000000.
Required: No
** [instruction](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
The instructions that tell the inline agent what it should do and how it should interact with users.
Type: String
Length Constraints: Minimum length of 40.
Required: Yes
** [knowledgeBases](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Contains information of the knowledge bases to associate with.
Type: Array of [KnowledgeBase](API_agent-runtime_KnowledgeBase.md) objects
Required: No
** [orchestrationType](#API_agent-runtime_InvokeInlineAgent_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
** [promptCreationConfigurations](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Specifies parameters that control how the service populates the agent prompt for an `InvokeInlineAgent` request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
Type: [PromptCreationConfigurations](API_agent-runtime_PromptCreationConfigurations.md) object
Required: No
** [promptOverrideConfiguration](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
Type: [PromptOverrideConfiguration](API_agent-runtime_PromptOverrideConfiguration.md) object
Required: No
** [streamingConfigurations](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the `bedrock:InvokeModelWithResponseStream` action.
Type: [StreamingConfigurations](API_agent-runtime_StreamingConfigurations.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
x-amzn-bedrock-agent-content-type: contentType
x-amz-bedrock-agent-session-id: sessionId
Content-type: application/json
{
"accessDeniedException": {
},
"badGatewayException": {
},
"chunk": {
"attribution": {
"citations": [
{
"generatedResponsePart": {
"textResponsePart": {
"span": {
"end": number,
"start": number
},
"text": "string"
}
},
"retrievedReferences": [
{
"content": {
"audio": {
"s3Uri": "string",
"transcription": "string"
},
"byteContent": "string",
"row": [
{
"columnName": "string",
"columnValue": "string",
"type": "string"
}
],
"text": "string",
"type": "string",
"video": {
"s3Uri": "string",
"summary": "string"
}
},
"location": {
"confluenceLocation": {
"url": "string"
},
"customDocumentLocation": {
"id": "string"
},
"kendraDocumentLocation": {
"uri": "string"
},
"s3Location": {
"uri": "string"
},
"salesforceLocation": {
"url": "string"
},
"sharePointLocation": {
"url": "string"
},
"sqlLocation": {
"query": "string"
},
"type": "string",
"webLocation": {
"url": "string"
}
},
"metadata": {
"string" : JSON value
}
}
]
}
]
},
"bytes": blob
},
"conflictException": {
},
"dependencyFailedException": {
},
"files": {
"files": [
{
"bytes": blob,
"name": "string",
"type": "string"
}
]
},
"internalServerException": {
},
"resourceNotFoundException": {
},
"returnControl": {
"invocationId": "string",
"invocationInputs": [
{ ... }
]
},
"serviceQuotaExceededException": {
},
"throttlingException": {
},
"trace": {
"callerChain": [
{ ... }
],
"collaboratorName": "string",
"eventTime": "string",
"sessionId": "string",
"trace": { ... }
},
"validationException": {
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [contentType](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
The MIME type of the input data in the request. The default value is application/json.
** [sessionId](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
The unique identifier of the session with the agent.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
The following data is returned in JSON format by the service.
** [accessDeniedException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403
** [badGatewayException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502
** [chunk](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
Contains a part of an agent response and citations for it.
Type: [InlineAgentPayloadPart](API_agent-runtime_InlineAgentPayloadPart.md) object
** [conflictException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
There was a conflict performing an operation. Resolve the conflict and retry your request.
Type: Exception
HTTP Status Code: 409
** [dependencyFailedException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424
** [files](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
Contains intermediate response for code interpreter if any files have been generated.
Type: [InlineAgentFilePart](API_agent-runtime_InlineAgentFilePart.md) object
** [internalServerException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
** [resourceNotFoundException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
Type: Exception
HTTP Status Code: 404
** [returnControl](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
Type: [InlineAgentReturnControlPayload](API_agent-runtime_InlineAgentReturnControlPayload.md) object
** [serviceQuotaExceededException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
The number of requests exceeds the service quota. Resubmit your request later.
Type: Exception
HTTP Status Code: 400
** [throttlingException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
The number of requests exceeds the limit. Resubmit your request later.
Type: Exception
HTTP Status Code: 429
** [trace](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace events](https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html).
Type: [InlineAgentTracePart](API_agent-runtime_InlineAgentTracePart.md) object
** [validationException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
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-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvokeInlineAgent)
# ListFlowExecutionEvents
Lists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow inputs and outputs, condition results, and failure events.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Request Syntax
```
GET /flows/flowIdentifier/aliases/flowAliasIdentifier/executions/executionIdentifier/events?eventType=eventType&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [eventType](#API_agent-runtime_ListFlowExecutionEvents_RequestSyntax) **
The type of events to retrieve. Specify `Node` for node-level events or `Flow` for flow-level events.
Valid Values: `Node | Flow`
Required: Yes
** [executionIdentifier](#API_agent-runtime_ListFlowExecutionEvents_RequestSyntax) **
The unique identifier of the flow execution.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})`
Required: Yes
** [flowAliasIdentifier](#API_agent-runtime_ListFlowExecutionEvents_RequestSyntax) **
The unique identifier of the flow alias used for the execution.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [flowIdentifier](#API_agent-runtime_ListFlowExecutionEvents_RequestSyntax) **
The unique identifier of the flow.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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-runtime_ListFlowExecutionEvents_RequestSyntax) **
The maximum number of events to return in a single response. If more events exist than the specified maxResults value, a token is included in the response so that the remaining results can be retrieved.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_agent-runtime_ListFlowExecutionEvents_RequestSyntax) **
A token to retrieve the next set of results. This value is returned in the response if more results are available.
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
{
"flowExecutionEvents": [
{ ... }
],
"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.
** [flowExecutionEvents](#API_agent-runtime_ListFlowExecutionEvents_ResponseSyntax) **
A list of events that occurred during the flow execution. Events can include node inputs and outputs, flow inputs and outputs, condition results, and failure events.
Type: Array of [FlowExecutionEvent](API_agent-runtime_FlowExecutionEvent.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent-runtime_ListFlowExecutionEvents_ResponseSyntax) **
A token to retrieve the next set of results. This value is returned if more results are available.
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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
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-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ListFlowExecutionEvents)
# ListFlowExecutions
Lists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the execution's Amazon Resource Name (ARN).
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Request Syntax
```
GET /flows/flowIdentifier/executions?flowAliasIdentifier=flowAliasIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowAliasIdentifier](#API_agent-runtime_ListFlowExecutions_RequestSyntax) **
The unique identifier of the flow alias to list executions for.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
** [flowIdentifier](#API_agent-runtime_ListFlowExecutions_RequestSyntax) **
The unique identifier of the flow to list executions for.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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-runtime_ListFlowExecutions_RequestSyntax) **
The maximum number of flow executions to return in a single response. If more executions exist than the specified `maxResults` value, a token is included in the response so that the remaining results can be retrieved.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_agent-runtime_ListFlowExecutions_RequestSyntax) **
A token to retrieve the next set of results. This value is returned in the response if more results are available.
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
{
"flowExecutionSummaries": [
{
"createdAt": "string",
"endedAt": "string",
"executionArn": "string",
"flowAliasIdentifier": "string",
"flowIdentifier": "string",
"flowVersion": "string",
"status": "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.
** [flowExecutionSummaries](#API_agent-runtime_ListFlowExecutions_ResponseSyntax) **
A list of flow execution summaries. Each summary includes the execution ARN, flow identifier, flow alias identifier, flow version, status, and timestamps.
Type: Array of [FlowExecutionSummary](API_agent-runtime_FlowExecutionSummary.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
** [nextToken](#API_agent-runtime_ListFlowExecutions_ResponseSyntax) **
A token to retrieve the next set of results. This value is returned if more results are available.
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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
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-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ListFlowExecutions)
# ListInvocations
Lists all invocations associated with a specific session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Request Syntax
```
POST /sessions/sessionIdentifier/invocations/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_agent-runtime_ListInvocations_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-runtime_ListInvocations_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*`
** [sessionIdentifier](#API_agent-runtime_ListInvocations_RequestSyntax) **
The unique identifier for the session to list invocations for. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"invocationSummaries": [
{
"createdAt": "string",
"invocationId": "string",
"sessionId": "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.
** [invocationSummaries](#API_agent-runtime_ListInvocations_ResponseSyntax) **
A list of invocation summaries associated with the session.
Type: Array of [InvocationSummary](API_agent-runtime_InvocationSummary.md) objects
** [nextToken](#API_agent-runtime_ListInvocations_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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListInvocations.
```
POST bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/invocations/?maxResults=10&nextToken=abc123 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-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/ListInvocations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ListInvocations)
# ListInvocationSteps
Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Request Syntax
```
POST /sessions/sessionIdentifier/invocationSteps/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json
{
"invocationIdentifier": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_agent-runtime_ListInvocationSteps_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-runtime_ListInvocationSteps_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*`
** [sessionIdentifier](#API_agent-runtime_ListInvocationSteps_RequestSyntax) **
The unique identifier for the session associated with the invocation steps. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [invocationIdentifier](#API_agent-runtime_ListInvocationSteps_RequestSyntax) **
The unique identifier (in UUID format) for the invocation to list invocation steps for.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"invocationStepSummaries": [
{
"invocationId": "string",
"invocationStepId": "string",
"invocationStepTime": "string",
"sessionId": "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.
** [invocationStepSummaries](#API_agent-runtime_ListInvocationSteps_ResponseSyntax) **
A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.
Type: Array of [InvocationStepSummary](API_agent-runtime_InvocationStepSummary.md) objects
** [nextToken](#API_agent-runtime_ListInvocationSteps_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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListInvocationSteps.
```
POST bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/invocationSteps/?maxResults=10&nextToken=abc123 HTTP/1.1
Content-type: application/json
{
"invocationIdentifier": "abc-1234-abcd-1234-abcdef123456"
}
```
## 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-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ListInvocationSteps)
# ListSessions
Lists all sessions in your AWS account. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Request Syntax
```
POST /sessions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_agent-runtime_ListSessions_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-runtime_ListSessions_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
{
"nextToken": "string",
"sessionSummaries": [
{
"createdAt": "string",
"lastUpdatedAt": "string",
"sessionArn": "string",
"sessionId": "string",
"sessionStatus": "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-runtime_ListSessions_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*`
** [sessionSummaries](#API_agent-runtime_ListSessions_ResponseSyntax) **
A list of summaries for each session in your AWS account.
Type: Array of [SessionSummary](API_agent-runtime_SessionSummary.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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListSessions.
```
POST bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/?maxResults=10&nextToken=nextToken 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-runtime-2023-07-26/ListSessions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/ListSessions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ListSessions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/ListSessions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ListSessions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/ListSessions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/ListSessions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/ListSessions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/ListSessions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ListSessions)
# 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-runtime_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-]+:[0-9]{12}:(session)/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$).*`
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-runtime_ListTagsForResource_ResponseSyntax) **
The key-value pairs for the tags associated with the resource.
Type: String to string map
Map Entries: Maximum number of 200 items.
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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of ListTagsForResource.
```
GET /tags/arn:aws:bedrock:us-west-2:123456789012:session/12345abc-1234-abcd-1234-abcdef123456 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-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ListTagsForResource)
# OptimizePrompt
Optimizes a prompt for the task that you specify. For more information, see [Optimize a prompt](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-optimize.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Request Syntax
```
POST /optimize-prompt HTTP/1.1
Content-type: application/json
{
"input": { ... },
"targetModelId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [input](#API_agent-runtime_OptimizePrompt_RequestSyntax) **
Contains the prompt to optimize.
Type: [InputPrompt](API_agent-runtime_InputPrompt.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [targetModelId](#API_agent-runtime_OptimizePrompt_RequestSyntax) **
The unique identifier of the model that you want to optimize the prompt for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"accessDeniedException": {
},
"analyzePromptEvent": {
"message": "string"
},
"badGatewayException": {
},
"dependencyFailedException": {
},
"internalServerException": {
},
"optimizedPromptEvent": {
"optimizedPrompt": { ... }
},
"throttlingException": {
},
"validationException": {
}
}
```
## 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.
** [accessDeniedException](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403
** [analyzePromptEvent](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **
An event in which the prompt was analyzed in preparation for optimization.
Type: [AnalyzePromptEvent](API_agent-runtime_AnalyzePromptEvent.md) object
** [badGatewayException](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502
** [dependencyFailedException](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424
** [internalServerException](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
** [optimizedPromptEvent](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **
An event in which the prompt was optimized.
Type: [OptimizedPromptEvent](API_agent-runtime_OptimizedPromptEvent.md) object
** [throttlingException](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **
Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) to increase the rate or number of tokens you can process.
Type: Exception
HTTP Status Code: 429
** [validationException](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example
This example illustrates one usage of OptimizePrompt.
```
POST /optimize-prompt HTTP/1.1
Content-type: application/json
{
"input": {
"textPrompt": {
"text": "Please summarize this text: "
}
},
"targetModelId": "anthropic.claude-3-sonnet-20240229-v1:0"
}
```
## 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-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OptimizePrompt)
# PutInvocationStep
Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
Related APIs:
+ [GetInvocationStep](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetInvocationStep.html)
+ [ListInvocationSteps](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocationSteps.html)
+ [ListInvocations](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html)
+ [ListSessions](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_ListInvocations.html)
## Request Syntax
```
PUT /sessions/sessionIdentifier/invocationSteps/ HTTP/1.1
Content-type: application/json
{
"invocationIdentifier": "string",
"invocationStepId": "string",
"invocationStepTime": "string",
"payload": { ... }
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [sessionIdentifier](#API_agent-runtime_PutInvocationStep_RequestSyntax) **
The unique identifier for the session to add the invocation step to. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [invocationIdentifier](#API_agent-runtime_PutInvocationStep_RequestSyntax) **
The unique identifier (in UUID format) of the invocation to add the invocation step to.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** [invocationStepId](#API_agent-runtime_PutInvocationStep_RequestSyntax) **
The unique identifier of the invocation step in UUID format.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: No
** [invocationStepTime](#API_agent-runtime_PutInvocationStep_RequestSyntax) **
The timestamp for when the invocation step occurred.
Type: Timestamp
Required: Yes
** [payload](#API_agent-runtime_PutInvocationStep_RequestSyntax) **
The payload for the invocation step, including text and images for the interaction.
Type: [InvocationStepPayload](API_agent-runtime_InvocationStepPayload.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"invocationStepId": "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.
** [invocationStepId](#API_agent-runtime_PutInvocationStep_ResponseSyntax) **
The unique identifier of the invocation step in UUID format.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of PutInvocationStep.
```
PUT bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/invocationSteps/ HTTP/1.1
Content-type: application/json
{
"invocationIdentifier": "11111111-2222-3333-4444-555555555555",
"invocationStepId": "abc-1234-abcd-1234-abcdef123456",
"invocationStepTime": "2023-08-08T12:00:00Z",
"payload": {
"contentBlocks": [
{
"text": "What's the weather in Seattle?"
},
{
"image": {
"format": "png",
"source": {
"bytes": "base64_encoded_image_data"
}
}
}
]
}
}
```
## 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-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PutInvocationStep)
# Rerank
Reranks the relevance of sources based on queries. For more information, see [Improve the relevance of query responses with a reranker model](https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html).
## Request Syntax
```
POST /rerank HTTP/1.1
Content-type: application/json
{
"nextToken": "string",
"queries": [
{
"textQuery": {
"text": "string"
},
"type": "string"
}
],
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"modelConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"modelArn": "string"
},
"numberOfResults": number
},
"type": "string"
},
"sources": [
{
"inlineDocumentSource": {
"jsonDocument": JSON value,
"textDocument": {
"text": "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.
** [nextToken](#API_agent-runtime_Rerank_RequestSyntax) **
If the total number of results was greater than could fit in a response, a token is returned in the `nextToken` field. You can enter that token 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
** [queries](#API_agent-runtime_Rerank_RequestSyntax) **
An array of objects, each of which contains information about a query to submit to the reranker model.
Type: Array of [RerankQuery](API_agent-runtime_RerankQuery.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** [rerankingConfiguration](#API_agent-runtime_Rerank_RequestSyntax) **
Contains configurations for reranking.
Type: [RerankingConfiguration](API_agent-runtime_RerankingConfiguration.md) object
Required: Yes
** [sources](#API_agent-runtime_Rerank_RequestSyntax) **
An array of objects, each of which contains information about the sources to rerank.
Type: Array of [RerankSource](API_agent-runtime_RerankSource.md) objects
Array Members: Minimum number of 1 item. Maximum number of 1000 items.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"results": [
{
"document": {
"jsonDocument": JSON value,
"textDocument": {
"text": "string"
},
"type": "string"
},
"index": number,
"relevanceScore": number
}
]
}
```
## 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-runtime_Rerank_ResponseSyntax) **
If the total number of results is greater than can fit in the response, use this token in the `nextToken` field when making another request to return the next batch of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [results](#API_agent-runtime_Rerank_ResponseSyntax) **
An array of objects, each of which contains information about the results of reranking.
Type: Array of [RerankResult](API_agent-runtime_RerankResult.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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
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-runtime-2023-07-26/Rerank)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/Rerank)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Rerank)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/Rerank)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Rerank)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/Rerank)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/Rerank)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/Rerank)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/Rerank)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Rerank)
# Retrieve
Queries a knowledge base and retrieves information from it.
## Request Syntax
```
POST /knowledgebases/knowledgeBaseId/retrieve HTTP/1.1
Content-type: application/json
{
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"nextToken": "string",
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"filter": { ... },
"implicitFilterConfiguration": {
"metadataAttributes": [
{
"description": "string",
"key": "string",
"type": "string"
}
],
"modelArn": "string"
},
"numberOfResults": number,
"overrideSearchType": "string",
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"metadataConfiguration": {
"selectionMode": "string",
"selectiveModeConfiguration": { ... }
},
"modelConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"modelArn": "string"
},
"numberOfRerankedResults": number
},
"type": "string"
}
}
},
"retrievalQuery": {
"image": {
"format": "string",
"inlineContent": blob
},
"text": "string",
"type": "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [knowledgeBaseId](#API_agent-runtime_Retrieve_RequestSyntax) **
The unique identifier of the knowledge base to query.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [guardrailConfiguration](#API_agent-runtime_Retrieve_RequestSyntax) **
Guardrail settings.
Type: [GuardrailConfiguration](API_agent-runtime_GuardrailConfiguration.md) object
Required: No
** [nextToken](#API_agent-runtime_Retrieve_RequestSyntax) **
If there are more results than can fit in the response, the response returns a `nextToken`. Use this token in the `nextToken` field of another request to retrieve the next batch of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
Required: No
** [retrievalConfiguration](#API_agent-runtime_Retrieve_RequestSyntax) **
Contains configurations for the knowledge base query and retrieval process. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
Type: [KnowledgeBaseRetrievalConfiguration](API_agent-runtime_KnowledgeBaseRetrievalConfiguration.md) object
Required: No
** [retrievalQuery](#API_agent-runtime_Retrieve_RequestSyntax) **
Contains the query to send the knowledge base.
Type: [KnowledgeBaseQuery](API_agent-runtime_KnowledgeBaseQuery.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"guardrailAction": "string",
"nextToken": "string",
"retrievalResults": [
{
"content": {
"audio": {
"s3Uri": "string",
"transcription": "string"
},
"byteContent": "string",
"row": [
{
"columnName": "string",
"columnValue": "string",
"type": "string"
}
],
"text": "string",
"type": "string",
"video": {
"s3Uri": "string",
"summary": "string"
}
},
"location": {
"confluenceLocation": {
"url": "string"
},
"customDocumentLocation": {
"id": "string"
},
"kendraDocumentLocation": {
"uri": "string"
},
"s3Location": {
"uri": "string"
},
"salesforceLocation": {
"url": "string"
},
"sharePointLocation": {
"url": "string"
},
"sqlLocation": {
"query": "string"
},
"type": "string",
"webLocation": {
"url": "string"
}
},
"metadata": {
"string" : JSON value
},
"score": number
}
]
}
```
## 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.
** [guardrailAction](#API_agent-runtime_Retrieve_ResponseSyntax) **
Specifies if there is a guardrail intervention in the response.
Type: String
Valid Values: `INTERVENED | NONE`
** [nextToken](#API_agent-runtime_Retrieve_ResponseSyntax) **
If there are more results than can fit in the response, the response returns a `nextToken`. Use this token in the `nextToken` field of another request to retrieve the next batch of results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [retrievalResults](#API_agent-runtime_Retrieve_ResponseSyntax) **
A list of results from querying the knowledge base.
Type: Array of [KnowledgeBaseRetrievalResult](API_agent-runtime_KnowledgeBaseRetrievalResult.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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
HTTP Status Code: 400
## Examples
### Send a basic query
The following example queries a knowledge base.
#### Sample Request
```
POST /knowledgebases/KB12345678/retrieve HTTP/1.1
Content-type: application/json
{
"retrievalQuery": {
"text": "What is AWS?"
}
}
```
### Send a query and include filters
To include filters in a knowledge base query, at least one of the data source files must include a `.metadata.json` file. For example, if you had a data source of articles called `articles.pdf`, accompanied by a metadata file called `articles.pdf.metadata.json`, you could tag it for `genre`, `year`, and `author`. In the `Retrieve` request, you could apply the following filter to return all entertainment articles written after `2018`, in addition to `cooking` or `sports` articles written by authors starting with `C`.
#### Sample Request
```
POST /knowledgebases/KB12345678/retrieve HTTP/1.1
Content-type: application/json
{
"retrievalQuery": {
"text": "What is AWS?",
},
"vectorSearchConfiguration": {
"numberOfResults": 5,
"filter": {
"orAll": [
{
"andAll": [
{
"equals": {
"key": "genre",
"value": "entertainment"
}
},
{
"greaterThan": {
"key": "year",
"value": 2018
}
}
]
},
{
"andAll": [
{
"in": {
"key": "genre",
"value": ["cooking", "sports"]
}
},
{
"startsWith": {
"key": "author",
"value": "C"
}
}
]
}
]
}
}
}
```
## 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-runtime-2023-07-26/Retrieve)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/Retrieve)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Retrieve)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/Retrieve)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Retrieve)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/Retrieve)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/Retrieve)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/Retrieve)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/Retrieve)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Retrieve)
# RetrieveAndGenerate
Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). The response only cites sources that are relevant to the query.
## Request Syntax
```
POST /retrieveAndGenerate HTTP/1.1
Content-type: application/json
{
"input": {
"text": "string"
},
"retrieveAndGenerateConfiguration": {
"externalSourcesConfiguration": {
"generationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
}
},
"modelArn": "string",
"sources": [
{
"byteContent": {
"contentType": "string",
"data": blob,
"identifier": "string"
},
"s3Location": {
"uri": "string"
},
"sourceType": "string"
}
]
},
"knowledgeBaseConfiguration": {
"generationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
}
},
"knowledgeBaseId": "string",
"modelArn": "string",
"orchestrationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
},
"queryTransformationConfiguration": {
"type": "string"
}
},
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"filter": { ... },
"implicitFilterConfiguration": {
"metadataAttributes": [
{
"description": "string",
"key": "string",
"type": "string"
}
],
"modelArn": "string"
},
"numberOfResults": number,
"overrideSearchType": "string",
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"metadataConfiguration": {
"selectionMode": "string",
"selectiveModeConfiguration": { ... }
},
"modelConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"modelArn": "string"
},
"numberOfRerankedResults": number
},
"type": "string"
}
}
}
},
"type": "string"
},
"sessionConfiguration": {
"kmsKeyArn": "string"
},
"sessionId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [input](#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) **
Contains the query to be made to the knowledge base.
Type: [RetrieveAndGenerateInput](API_agent-runtime_RetrieveAndGenerateInput.md) object
Required: Yes
** [retrieveAndGenerateConfiguration](#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) **
Contains configurations for the knowledge base query and retrieval process. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
Type: [RetrieveAndGenerateConfiguration](API_agent-runtime_RetrieveAndGenerateConfiguration.md) object
Required: No
** [sessionConfiguration](#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) **
Contains details about the session with the knowledge base.
Type: [RetrieveAndGenerateSessionConfiguration](API_agent-runtime_RetrieveAndGenerateSessionConfiguration.md) object
Required: No
** [sessionId](#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) **
The unique identifier of the session. When you first make a `RetrieveAndGenerate` request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the `sessionId` yourself.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"citations": [
{
"generatedResponsePart": {
"textResponsePart": {
"span": {
"end": number,
"start": number
},
"text": "string"
}
},
"retrievedReferences": [
{
"content": {
"audio": {
"s3Uri": "string",
"transcription": "string"
},
"byteContent": "string",
"row": [
{
"columnName": "string",
"columnValue": "string",
"type": "string"
}
],
"text": "string",
"type": "string",
"video": {
"s3Uri": "string",
"summary": "string"
}
},
"location": {
"confluenceLocation": {
"url": "string"
},
"customDocumentLocation": {
"id": "string"
},
"kendraDocumentLocation": {
"uri": "string"
},
"s3Location": {
"uri": "string"
},
"salesforceLocation": {
"url": "string"
},
"sharePointLocation": {
"url": "string"
},
"sqlLocation": {
"query": "string"
},
"type": "string",
"webLocation": {
"url": "string"
}
},
"metadata": {
"string" : JSON value
}
}
]
}
],
"guardrailAction": "string",
"output": {
"text": "string"
},
"sessionId": "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.
** [citations](#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) **
A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.
Type: Array of [Citation](API_agent-runtime_Citation.md) objects
** [guardrailAction](#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) **
Specifies if there is a guardrail intervention in the response.
Type: String
Valid Values: `INTERVENED | NONE`
** [output](#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) **
Contains the response generated from querying the knowledge base.
Type: [RetrieveAndGenerateOutput](API_agent-runtime_RetrieveAndGenerateOutput.md) object
** [sessionId](#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) **
The unique identifier of the session. When you first make a `RetrieveAndGenerate` request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the `sessionId` yourself.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
HTTP Status Code: 400
## Examples
### Send a basic query
The following example uses the minimally required fields to generate a response after querying a knowledge base.
#### Sample Request
```
POST /retrieveAndGenerate HTTP/1.1
Content-type: application/json
{
"input": {
"text": "What is AWS?"
},
"retrieveAndGenerateConfiguration": {
"knowledgeBaseConfiguration": {
"knowledgeBaseId": "KB12345678",
"modelArn": "anthropic.claude-v2:1"
},
"type": "KNOWLEDGE_BASE"
}
}
```
### Send a query and include filters
To include filters in a knowledge base query, at least one of the data source files must include a `.metadata.json` file. For example, if you had a data source of articles called `articles.pdf`, accompanied by a metadata file called `articles.pdf.metadata.json`, you could tag it for `genre`, `year`, and `author`. In the `Retrieve` request, you could apply the following filter to return all entertainment articles written after `2018`, in addition to `cooking` or `sports` articles written by authors starting with `C`.
#### Sample Request
```
POST /retrieveAndGenerate HTTP/1.1
Content-type: application/json
{
"input": {
"text": "What is AWS?",
},
"retrieveAndGenerateConfiguration": {
"knowledgeBaseConfiguration": {
"knowledgeBaseId": "KB12345678",
"modelArn": "anthropic.claude-v2:1",
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"numberOfResults": 5,
"filter": {
"orAll": [
{
"andAll": [
{
"equals": {
"key": "genre",
"value": "entertainment"
}
},
{
"greaterThan": {
"key": "year",
"value": 2018
}
}
]
},
{
"andAll": [
{
"in": {
"key": "genre",
"value": ["cooking", "sports"]
}
},
{
"startsWith": {
"key": "author",
"value": "C"
}
}
]
}
]
}
}
}
},
"type": "KNOWLEDGE_BASE"
}
}
```
### Use an inference profile when generating a response
The following example uses an inference profile in generating a response after querying a knowledge base.
#### Sample Request
```
POST /retrieveAndGenerate HTTP/1.1
Content-type: application/json
{
"input": {
"text": "What is AWS?"
},
"retrieveAndGenerateConfiguration": {
"knowledgeBaseConfiguration": {
"knowledgeBaseId": "KB12345678",
"modelArn": "arn:aws:bedrock:us-west-2:123456789012:inference-profile/us.anthropic.claude-3-5-sonnet-20240620-v1:0"
},
"type": "KNOWLEDGE_BASE"
}
}
```
## 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-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerate)
# RetrieveAndGenerateStream
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
**Note**
The AWS CLI doesn't support streaming operations in Amazon Bedrock, including `InvokeModelWithResponseStream`.
This operation requires permission for the ` bedrock:RetrieveAndGenerate` action.
## Request Syntax
```
POST /retrieveAndGenerateStream HTTP/1.1
Content-type: application/json
{
"input": {
"text": "string"
},
"retrieveAndGenerateConfiguration": {
"externalSourcesConfiguration": {
"generationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
}
},
"modelArn": "string",
"sources": [
{
"byteContent": {
"contentType": "string",
"data": blob,
"identifier": "string"
},
"s3Location": {
"uri": "string"
},
"sourceType": "string"
}
]
},
"knowledgeBaseConfiguration": {
"generationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"guardrailConfiguration": {
"guardrailId": "string",
"guardrailVersion": "string"
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
}
},
"knowledgeBaseId": "string",
"modelArn": "string",
"orchestrationConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"inferenceConfig": {
"textInferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
}
},
"performanceConfig": {
"latency": "string"
},
"promptTemplate": {
"textPromptTemplate": "string"
},
"queryTransformationConfiguration": {
"type": "string"
}
},
"retrievalConfiguration": {
"vectorSearchConfiguration": {
"filter": { ... },
"implicitFilterConfiguration": {
"metadataAttributes": [
{
"description": "string",
"key": "string",
"type": "string"
}
],
"modelArn": "string"
},
"numberOfResults": number,
"overrideSearchType": "string",
"rerankingConfiguration": {
"bedrockRerankingConfiguration": {
"metadataConfiguration": {
"selectionMode": "string",
"selectiveModeConfiguration": { ... }
},
"modelConfiguration": {
"additionalModelRequestFields": {
"string" : JSON value
},
"modelArn": "string"
},
"numberOfRerankedResults": number
},
"type": "string"
}
}
}
},
"type": "string"
},
"sessionConfiguration": {
"kmsKeyArn": "string"
},
"sessionId": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [input](#API_agent-runtime_RetrieveAndGenerateStream_RequestSyntax) **
Contains the query to be made to the knowledge base.
Type: [RetrieveAndGenerateInput](API_agent-runtime_RetrieveAndGenerateInput.md) object
Required: Yes
** [retrieveAndGenerateConfiguration](#API_agent-runtime_RetrieveAndGenerateStream_RequestSyntax) **
Contains configurations for the knowledge base query and retrieval process. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
Type: [RetrieveAndGenerateConfiguration](API_agent-runtime_RetrieveAndGenerateConfiguration.md) object
Required: No
** [sessionConfiguration](#API_agent-runtime_RetrieveAndGenerateStream_RequestSyntax) **
Contains details about the session with the knowledge base.
Type: [RetrieveAndGenerateSessionConfiguration](API_agent-runtime_RetrieveAndGenerateSessionConfiguration.md) object
Required: No
** [sessionId](#API_agent-runtime_RetrieveAndGenerateStream_RequestSyntax) **
The unique identifier of the session. When you first make a `RetrieveAndGenerate` request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the `sessionId` yourself.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
## Response Syntax
```
HTTP/1.1 200
x-amzn-bedrock-knowledge-base-session-id: sessionId
Content-type: application/json
{
"accessDeniedException": {
},
"badGatewayException": {
},
"citation": {
"citation": {
"generatedResponsePart": {
"textResponsePart": {
"span": {
"end": number,
"start": number
},
"text": "string"
}
},
"retrievedReferences": [
{
"content": {
"audio": {
"s3Uri": "string",
"transcription": "string"
},
"byteContent": "string",
"row": [
{
"columnName": "string",
"columnValue": "string",
"type": "string"
}
],
"text": "string",
"type": "string",
"video": {
"s3Uri": "string",
"summary": "string"
}
},
"location": {
"confluenceLocation": {
"url": "string"
},
"customDocumentLocation": {
"id": "string"
},
"kendraDocumentLocation": {
"uri": "string"
},
"s3Location": {
"uri": "string"
},
"salesforceLocation": {
"url": "string"
},
"sharePointLocation": {
"url": "string"
},
"sqlLocation": {
"query": "string"
},
"type": "string",
"webLocation": {
"url": "string"
}
},
"metadata": {
"string" : JSON value
}
}
]
},
"generatedResponsePart": {
"textResponsePart": {
"span": {
"end": number,
"start": number
},
"text": "string"
}
},
"retrievedReferences": [
{
"content": {
"audio": {
"s3Uri": "string",
"transcription": "string"
},
"byteContent": "string",
"row": [
{
"columnName": "string",
"columnValue": "string",
"type": "string"
}
],
"text": "string",
"type": "string",
"video": {
"s3Uri": "string",
"summary": "string"
}
},
"location": {
"confluenceLocation": {
"url": "string"
},
"customDocumentLocation": {
"id": "string"
},
"kendraDocumentLocation": {
"uri": "string"
},
"s3Location": {
"uri": "string"
},
"salesforceLocation": {
"url": "string"
},
"sharePointLocation": {
"url": "string"
},
"sqlLocation": {
"query": "string"
},
"type": "string",
"webLocation": {
"url": "string"
}
},
"metadata": {
"string" : JSON value
}
}
]
},
"conflictException": {
},
"dependencyFailedException": {
},
"guardrail": {
"action": "string"
},
"internalServerException": {
},
"output": {
"text": "string"
},
"resourceNotFoundException": {
},
"serviceQuotaExceededException": {
},
"throttlingException": {
},
"validationException": {
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [sessionId](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
The session ID.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
The following data is returned in JSON format by the service.
** [accessDeniedException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 403
** [badGatewayException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
The request failed due to a bad gateway error.
Type: Exception
HTTP Status Code: 502
** [citation](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
A citation event.
Type: [CitationEvent](API_agent-runtime_CitationEvent.md) object
** [conflictException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
Error occurred because of a conflict while performing an operation.
Type: Exception
HTTP Status Code: 409
** [dependencyFailedException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
The request failed due to a dependency error.
Type: Exception
HTTP Status Code: 424
** [guardrail](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
A guardrail event.
Type: [GuardrailEvent](API_agent-runtime_GuardrailEvent.md) object
** [internalServerException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
** [output](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
An output event.
Type: [RetrieveAndGenerateOutputEvent](API_agent-runtime_RetrieveAndGenerateOutputEvent.md) object
** [resourceNotFoundException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 404
** [serviceQuotaExceededException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
Your request exceeds the service quota for your account. You can view your quotas at [Viewing service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html). You can resubmit your request later.
Type: Exception
HTTP Status Code: 400
** [throttlingException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 429
** [validationException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 400
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
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-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream)
# StartFlowExecution
Starts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after five minutes, flow executions let you run flows asynchronously for longer durations. Flow executions also yield control so that your application can perform other tasks.
This operation returns an Amazon Resource Name (ARN) that you can use to track and manage your flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Request Syntax
```
POST /flows/flowIdentifier/aliases/flowAliasIdentifier/executions HTTP/1.1
Content-type: application/json
{
"flowExecutionName": "string",
"inputs": [
{
"content": { ... },
"nodeInputName": "string",
"nodeName": "string",
"nodeOutputName": "string"
}
],
"modelPerformanceConfiguration": {
"performanceConfig": {
"latency": "string"
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [flowAliasIdentifier](#API_agent-runtime_StartFlowExecution_RequestSyntax) **
The unique identifier of the flow alias to use for the flow execution.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [flowIdentifier](#API_agent-runtime_StartFlowExecution_RequestSyntax) **
The unique identifier of the flow to execute.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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.
** [flowExecutionName](#API_agent-runtime_StartFlowExecution_RequestSyntax) **
The unique name for the flow execution. If you don't provide one, a system-generated name is used.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-zA-Z0-9-]{1,36}`
Required: No
** [inputs](#API_agent-runtime_StartFlowExecution_RequestSyntax) **
The input data required for the flow execution. This must match the input schema defined in the flow.
Type: Array of [FlowInput](API_agent-runtime_FlowInput.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** [modelPerformanceConfiguration](#API_agent-runtime_StartFlowExecution_RequestSyntax) **
The performance settings for the foundation model used in the flow execution.
Type: [ModelPerformanceConfiguration](API_agent-runtime_ModelPerformanceConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"executionArn": "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.
** [executionArn](#API_agent-runtime_StartFlowExecution_ResponseSyntax) **
The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
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-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/StartFlowExecution)
# StopFlowExecution
Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to `Aborted`.
## Request Syntax
```
POST /flows/flowIdentifier/aliases/flowAliasIdentifier/executions/executionIdentifier/stop HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [executionIdentifier](#API_agent-runtime_StopFlowExecution_RequestSyntax) **
The unique identifier of the flow execution to stop.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})`
Required: Yes
** [flowAliasIdentifier](#API_agent-runtime_StopFlowExecution_RequestSyntax) **
The unique identifier of the flow alias used for the execution.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** [flowIdentifier](#API_agent-runtime_StopFlowExecution_RequestSyntax) **
The unique identifier of the flow.
Length Constraints: Minimum length of 0. Maximum length of 2048.
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
{
"executionArn": "string",
"status": "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.
** [executionArn](#API_agent-runtime_StopFlowExecution_ResponseSyntax) **
The Amazon Resource Name (ARN) that uniquely identifies the flow execution that was stopped.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})`
** [status](#API_agent-runtime_StopFlowExecution_ResponseSyntax) **
The updated status of the flow execution after the stop request. This will typically be ABORTED if the execution was successfully stopped.
Type: String
Valid Values: `Running | Succeeded | Failed | TimedOut | Aborted`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** BadGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 502
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** DependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
** resourceName **
The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or AWS STS.
HTTP Status Code: 424
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
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-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/StopFlowExecution)
# 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-runtime_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-]+:[0-9]{12}:(session)/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$).*`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [tags](#API_agent-runtime_TagResource_RequestSyntax) **
An object containing key-value pairs that define the tags to attach to the resource.
Type: String to string map
Map Entries: Maximum number of 200 items.
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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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: 400
** 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of TagResource.
```
POST /tags/arn:aws:bedrock:us-west-2:123456789012:session/12345abc-1234-abcd-1234-abcdef123456 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-runtime-2023-07-26/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/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-runtime_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-]+:[0-9]{12}:(session)/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$).*`
Required: Yes
** [tagKeys](#API_agent-runtime_UntagResource_RequestSyntax) **
A list of keys of the tags to remove from the resource.
Array Members: Minimum number of 1 item. 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. Check your permissions and retry your request.
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of UntagResource.
```
DELETE /tags/arn:aws:bedrock:us-west-2:123456789012:session/12345abc-1234-abcd-1234-abcdef123456 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-runtime-2023-07-26/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/UntagResource)
# UpdateSession
Updates the metadata or encryption settings of a session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Request Syntax
```
PUT /sessions/sessionIdentifier/ HTTP/1.1
Content-type: application/json
{
"sessionMetadata": {
"string" : "string"
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [sessionIdentifier](#API_agent-runtime_UpdateSession_RequestSyntax) **
The unique identifier of the session to modify. You can specify either the session's `sessionId` or its Amazon Resource Name (ARN).
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})|([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [sessionMetadata](#API_agent-runtime_UpdateSession_RequestSyntax) **
A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, and the type of device they are using.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Value Length Constraints: Minimum length of 0. Maximum length of 5000.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"lastUpdatedAt": "string",
"sessionArn": "string",
"sessionId": "string",
"sessionStatus": "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.
** [createdAt](#API_agent-runtime_UpdateSession_ResponseSyntax) **
The timestamp for when the session was created.
Type: Timestamp
** [lastUpdatedAt](#API_agent-runtime_UpdateSession_ResponseSyntax) **
The timestamp for when the session was last modified.
Type: Timestamp
** [sessionArn](#API_agent-runtime_UpdateSession_ResponseSyntax) **
The Amazon Resource Name (ARN) of the session that was updated.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionId](#API_agent-runtime_UpdateSession_ResponseSyntax) **
The unique identifier of the session you updated.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
** [sessionStatus](#API_agent-runtime_UpdateSession_ResponseSyntax) **
The status of the session you updated.
Type: String
Valid Values: `ACTIVE | EXPIRED | ENDED`
## 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. Check your permissions and retry your request.
HTTP Status Code: 403
** ConflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
** InternalServerException **
An internal server error occurred. Retry your request.
** reason **
The reason for the exception. If the reason is `BEDROCK_MODEL_INVOCATION_SERVICE_UNAVAILABLE`, the model invocation service is unavailable. 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.
HTTP Status Code: 400
## Examples
### Example request
This example illustrates one usage of UpdateSession.
```
PUT bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/ HTTP/1.1
Content-type: application/json
{
"sessionMetadata": {
"userLanguage" : "French"
}
}
```
## 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-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-agent-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-agent-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-agent-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-agent-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-agent-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-agent-runtime-2023-07-26/UpdateSession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/UpdateSession)
# Data Automation for Amazon Bedrock
The following actions are supported by Data Automation for Amazon Bedrock:
+ [CopyBlueprintStage](API_data-automation_CopyBlueprintStage.md)
+ [CreateBlueprint](API_data-automation_CreateBlueprint.md)
+ [CreateBlueprintVersion](API_data-automation_CreateBlueprintVersion.md)
+ [CreateDataAutomationLibrary](API_data-automation_CreateDataAutomationLibrary.md)
+ [CreateDataAutomationProject](API_data-automation_CreateDataAutomationProject.md)
+ [DeleteBlueprint](API_data-automation_DeleteBlueprint.md)
+ [DeleteDataAutomationLibrary](API_data-automation_DeleteDataAutomationLibrary.md)
+ [DeleteDataAutomationProject](API_data-automation_DeleteDataAutomationProject.md)
+ [GetBlueprint](API_data-automation_GetBlueprint.md)
+ [GetBlueprintOptimizationStatus](API_data-automation_GetBlueprintOptimizationStatus.md)
+ [GetDataAutomationLibrary](API_data-automation_GetDataAutomationLibrary.md)
+ [GetDataAutomationLibraryEntity](API_data-automation_GetDataAutomationLibraryEntity.md)
+ [GetDataAutomationLibraryIngestionJob](API_data-automation_GetDataAutomationLibraryIngestionJob.md)
+ [GetDataAutomationProject](API_data-automation_GetDataAutomationProject.md)
+ [InvokeBlueprintOptimizationAsync](API_data-automation_InvokeBlueprintOptimizationAsync.md)
+ [InvokeDataAutomationLibraryIngestionJob](API_data-automation_InvokeDataAutomationLibraryIngestionJob.md)
+ [ListBlueprints](API_data-automation_ListBlueprints.md)
+ [ListDataAutomationLibraries](API_data-automation_ListDataAutomationLibraries.md)
+ [ListDataAutomationLibraryEntities](API_data-automation_ListDataAutomationLibraryEntities.md)
+ [ListDataAutomationLibraryIngestionJobs](API_data-automation_ListDataAutomationLibraryIngestionJobs.md)
+ [ListDataAutomationProjects](API_data-automation_ListDataAutomationProjects.md)
+ [ListTagsForResource](API_data-automation_ListTagsForResource.md)
+ [TagResource](API_data-automation_TagResource.md)
+ [UntagResource](API_data-automation_UntagResource.md)
+ [UpdateBlueprint](API_data-automation_UpdateBlueprint.md)
+ [UpdateDataAutomationLibrary](API_data-automation_UpdateDataAutomationLibrary.md)
+ [UpdateDataAutomationProject](API_data-automation_UpdateDataAutomationProject.md)
# CopyBlueprintStage
Copies a blueprint from one stage to another.
## Request Syntax
```
PUT /blueprints/blueprintArn/copy-stage HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"sourceStage": "string",
"targetStage": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [blueprintArn](#API_data-automation_CopyBlueprintStage_RequestSyntax) **
The blueprint's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_data-automation_CopyBlueprintStage_RequestSyntax) **
To avoid creating duplicate resources, specify a unique token for this operation.
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
** [sourceStage](#API_data-automation_CopyBlueprintStage_RequestSyntax) **
The stage to copy from.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: Yes
** [targetStage](#API_data-automation_CopyBlueprintStage_RequestSyntax) **
The stage to copy to.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
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 **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CopyBlueprintStage)
# CreateBlueprint
Creates a blueprint. A blueprint has a schema that maps data fields to prompts that tell a model how to get the data out of an image or document. For schema examples, use [ListBlueprints](API_data-automation_ListBlueprints.md) to get a list of public blueprints and [GetBlueprint](API_data-automation_GetBlueprint.md) to view a blueprint.
## Request Syntax
```
PUT /blueprints/ HTTP/1.1
Content-type: application/json
{
"blueprintName": "string",
"blueprintStage": "string",
"clientToken": "string",
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"schema": "string",
"tags": [
{
"key": "string",
"value": "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.
** [blueprintName](#API_data-automation_CreateBlueprint_RequestSyntax) **
A name for the blueprint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: Yes
** [blueprintStage](#API_data-automation_CreateBlueprint_RequestSyntax) **
To indicate that the blueprint is not final, set to `DEVELOPMENT`. Otherwise, the blueprint is created in the `LIVE` stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** [clientToken](#API_data-automation_CreateBlueprint_RequestSyntax) **
To avoid creating duplicate resources, specify a unique token for this blueprint.
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
** [encryptionConfiguration](#API_data-automation_CreateBlueprint_RequestSyntax) **
Encryption settings for the blueprint.
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object
Required: No
** [schema](#API_data-automation_CreateBlueprint_RequestSyntax) **
The blueprint's schema.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: Yes
** [tags](#API_data-automation_CreateBlueprint_RequestSyntax) **
Tags assigned to a blueprint at time of creation.
Type: Array of [Tag](API_data-automation_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
** [type](#API_data-automation_CreateBlueprint_RequestSyntax) **
The type of blueprint to create.
Type: String
Valid Values: `DOCUMENT | IMAGE | AUDIO`
Required: Yes
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"blueprint": {
"blueprintArn": "string",
"blueprintName": "string",
"blueprintStage": "string",
"blueprintVersion": "string",
"creationTime": "string",
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string",
"lastModifiedTime": "string",
"optimizationSamples": [
{
"assetS3Object": {
"s3Uri": "string",
"version": "string"
},
"groundTruthS3Object": {
"s3Uri": "string",
"version": "string"
}
}
],
"optimizationTime": "string",
"schema": "string",
"type": "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.
** [blueprint](#API_data-automation_CreateBlueprint_ResponseSyntax) **
Details about the blueprint.
Type: [Blueprint](API_data-automation_Blueprint.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ServiceQuotaExceededException **
HTTP Status Code: 402
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CreateBlueprint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CreateBlueprint)
# CreateBlueprintVersion
Creates an immutable snapshot of a blueprint.
## Request Syntax
```
POST /blueprints/blueprintArn/versions/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [blueprintArn](#API_data-automation_CreateBlueprintVersion_RequestSyntax) **
The blueprint's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_data-automation_CreateBlueprintVersion_RequestSyntax) **
To avoid creating duplicate resources, specify a unique token for this blueprint version.
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
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"blueprint": {
"blueprintArn": "string",
"blueprintName": "string",
"blueprintStage": "string",
"blueprintVersion": "string",
"creationTime": "string",
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string",
"lastModifiedTime": "string",
"optimizationSamples": [
{
"assetS3Object": {
"s3Uri": "string",
"version": "string"
},
"groundTruthS3Object": {
"s3Uri": "string",
"version": "string"
}
}
],
"optimizationTime": "string",
"schema": "string",
"type": "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.
** [blueprint](#API_data-automation_CreateBlueprintVersion_ResponseSyntax) **
Details about the blueprint.
Type: [Blueprint](API_data-automation_Blueprint.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ServiceQuotaExceededException **
HTTP Status Code: 402
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CreateBlueprintVersion)
# CreateDataAutomationLibrary
Creates a data automation library.
## Request Syntax
```
PUT /data-automation-libraries/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"libraryDescription": "string",
"libraryName": "string",
"tags": [
{
"key": "string",
"value": "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_data-automation_CreateDataAutomationLibrary_RequestSyntax) **
To avoid creating duplicate resources, specify a unique token for this library.
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
** [encryptionConfiguration](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) **
Encryption settings for the library.
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object
Required: No
** [libraryDescription](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) **
A description for the library.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern: `[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*`
Required: No
** [libraryName](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) **
A name for the library.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: Yes
** [tags](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) **
Tags assigned to the library at time of creation.
Type: Array of [Tag](API_data-automation_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"libraryArn": "string",
"status": "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.
** [libraryArn](#API_data-automation_CreateDataAutomationLibrary_ResponseSyntax) **
The library's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
** [status](#API_data-automation_CreateDataAutomationLibrary_ResponseSyntax) **
The library's status.
Type: String
Valid Values: `ACTIVE | DELETING`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ServiceQuotaExceededException **
HTTP Status Code: 402
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CreateDataAutomationLibrary)
# CreateDataAutomationProject
Creates a data automation project.
## Request Syntax
```
PUT /data-automation-projects/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"customOutputConfiguration": {
"blueprints": [
{
"blueprintArn": "string",
"blueprintStage": "string",
"blueprintVersion": "string"
}
]
},
"dataAutomationLibraryConfiguration": {
"libraries": [
{
"libraryArn": "string"
}
]
},
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"overrideConfiguration": {
"audio": {
"languageConfiguration": {
"generativeOutputLanguage": "string",
"identifyMultipleLanguages": boolean,
"inputLanguages": [ "string" ]
},
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
},
"document": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
},
"splitter": {
"state": "string"
}
},
"image": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
},
"modalityRouting": {
"jpeg": "string",
"mov": "string",
"mp4": "string",
"png": "string"
},
"video": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
}
},
"projectDescription": "string",
"projectName": "string",
"projectStage": "string",
"projectType": "string",
"standardOutputConfiguration": {
"audio": {
"extraction": {
"category": {
"state": "string",
"typeConfiguration": {
"transcript": {
"channelLabeling": {
"state": "string"
},
"speakerLabeling": {
"state": "string"
}
}
},
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
},
"document": {
"extraction": {
"boundingBox": {
"state": "string"
},
"granularity": {
"types": [ "string" ]
}
},
"generativeField": {
"state": "string"
},
"outputFormat": {
"additionalFileFormat": {
"state": "string"
},
"textFormat": {
"types": [ "string" ]
}
}
},
"image": {
"extraction": {
"boundingBox": {
"state": "string"
},
"category": {
"state": "string",
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
},
"video": {
"extraction": {
"boundingBox": {
"state": "string"
},
"category": {
"state": "string",
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
}
},
"tags": [
{
"key": "string",
"value": "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_data-automation_CreateDataAutomationProject_RequestSyntax) **
To avoid creating duplicate resources, specify a unique token for this project.
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
** [customOutputConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
Blueprints to enabled for the project.
Type: [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md) object
Required: No
** [dataAutomationLibraryConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
Library configuration for the project.
Type: [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md) object
Required: No
** [encryptionConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
Encryption settings for the project.
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object
Required: No
** [overrideConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
Additional settings to apply to the project.
Type: [OverrideConfiguration](API_data-automation_OverrideConfiguration.md) object
Required: No
** [projectDescription](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
A description for the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Required: No
** [projectName](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
A name for the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: Yes
** [projectStage](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
To indicate that the project is not final, set to `DEVELOPMENT`. Otherwise, the project is created in the `LIVE` stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** [projectType](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
The type of bedrock data automation API that is compatible with this project.
Type: String
Valid Values: `ASYNC | SYNC`
Required: No
** [standardOutputConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
The standard output configuration for the project. If you omit settings for any types, default settings are applied. You can specify an empty configuration to create a project with default settings and view the settings with [GetDataAutomationProject](API_data-automation_GetDataAutomationProject.md).
Type: [StandardOutputConfiguration](API_data-automation_StandardOutputConfiguration.md) object
Required: Yes
** [tags](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **
Tags assigned to the project at time of creation.
Type: Array of [Tag](API_data-automation_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"projectArn": "string",
"projectStage": "string",
"status": "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.
** [projectArn](#API_data-automation_CreateDataAutomationProject_ResponseSyntax) **
The project's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
** [projectStage](#API_data-automation_CreateDataAutomationProject_ResponseSyntax) **
The project's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
** [status](#API_data-automation_CreateDataAutomationProject_ResponseSyntax) **
The project's status.
Type: String
Valid Values: `COMPLETED | IN_PROGRESS | FAILED`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ServiceQuotaExceededException **
HTTP Status Code: 402
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CreateDataAutomationProject)
# DeleteBlueprint
Deletes a blueprint or blueprint version.
## Request Syntax
```
DELETE /blueprints/blueprintArn/?blueprintVersion=blueprintVersion HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [blueprintArn](#API_data-automation_DeleteBlueprint_RequestSyntax) **
The blueprint's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
** [blueprintVersion](#API_data-automation_DeleteBlueprint_RequestSyntax) **
To delete a blueprint version, specify the version.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[0-9]*`
## 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 **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/DeleteBlueprint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DeleteBlueprint)
# DeleteDataAutomationLibrary
Deletes a data automation library.
## Request Syntax
```
DELETE /data-automation-libraries/libraryArn/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [libraryArn](#API_data-automation_DeleteDataAutomationLibrary_RequestSyntax) **
The library's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"libraryArn": "string",
"status": "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.
** [libraryArn](#API_data-automation_DeleteDataAutomationLibrary_ResponseSyntax) **
The library's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
** [status](#API_data-automation_DeleteDataAutomationLibrary_ResponseSyntax) **
The library's status.
Type: String
Valid Values: `ACTIVE | DELETING`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationLibrary)
# DeleteDataAutomationProject
Deletes a data automation project.
## Request Syntax
```
DELETE /data-automation-projects/projectArn/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [projectArn](#API_data-automation_DeleteDataAutomationProject_RequestSyntax) **
The project's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"projectArn": "string",
"status": "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.
** [projectArn](#API_data-automation_DeleteDataAutomationProject_ResponseSyntax) **
The project's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
** [status](#API_data-automation_DeleteDataAutomationProject_ResponseSyntax) **
The project's status.
Type: String
Valid Values: `COMPLETED | IN_PROGRESS | FAILED`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DeleteDataAutomationProject)
# GetBlueprint
Gets details about a blueprint or blueprint version.
## Request Syntax
```
POST /blueprints/blueprintArn/ HTTP/1.1
Content-type: application/json
{
"blueprintStage": "string",
"blueprintVersion": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [blueprintArn](#API_data-automation_GetBlueprint_RequestSyntax) **
The blueprint's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [blueprintStage](#API_data-automation_GetBlueprint_RequestSyntax) **
To view the development stage, set to `DEVELOPMENT`.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** [blueprintVersion](#API_data-automation_GetBlueprint_RequestSyntax) **
To view a blueprint version, specify the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[0-9]*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"blueprint": {
"blueprintArn": "string",
"blueprintName": "string",
"blueprintStage": "string",
"blueprintVersion": "string",
"creationTime": "string",
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string",
"lastModifiedTime": "string",
"optimizationSamples": [
{
"assetS3Object": {
"s3Uri": "string",
"version": "string"
},
"groundTruthS3Object": {
"s3Uri": "string",
"version": "string"
}
}
],
"optimizationTime": "string",
"schema": "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.
** [blueprint](#API_data-automation_GetBlueprint_ResponseSyntax) **
Details about the blueprint.
Type: [Blueprint](API_data-automation_Blueprint.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetBlueprint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetBlueprint)
# GetBlueprintOptimizationStatus
Gets the status of a blueprint optimization job.
## Request Syntax
```
POST /getBlueprintOptimizationStatus/invocationArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [invocationArn](#API_data-automation_GetBlueprintOptimizationStatus_RequestSyntax) **
The ARN of the optimization job invocation.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:blueprint-optimization-invocation/[a-zA-Z0-9-_]+`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"errorMessage": "string",
"errorType": "string",
"outputConfiguration": {
"s3Object": {
"s3Uri": "string",
"version": "string"
}
},
"status": "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.
** [errorMessage](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) **
The error message if the job failed.
Type: String
** [errorType](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) **
The type of error if the job failed.
Type: String
** [outputConfiguration](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) **
The location of the optimization results.
Type: [BlueprintOptimizationOutputConfiguration](API_data-automation_BlueprintOptimizationOutputConfiguration.md) object
** [status](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) **
The job's status.
Type: String
Valid Values: `Created | InProgress | Success | ServiceError | ClientError`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetBlueprintOptimizationStatus)
# GetDataAutomationLibrary
Gets details about a data automation library.
## Request Syntax
```
POST /data-automation-libraries/libraryArn/ HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [libraryArn](#API_data-automation_GetDataAutomationLibrary_RequestSyntax) **
The library's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"library": {
"creationTime": "string",
"entityTypes": [
{
"entityMetadata": "string",
"entityType": "string"
}
],
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string",
"libraryArn": "string",
"libraryDescription": "string",
"libraryName": "string",
"status": "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.
** [library](#API_data-automation_GetDataAutomationLibrary_ResponseSyntax) **
Details about the library.
Type: [DataAutomationLibrary](API_data-automation_DataAutomationLibrary.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibrary)
# GetDataAutomationLibraryEntity
Gets details about a data automation library entity.
## Request Syntax
```
POST /data-automation-libraries/libraryArn/entityType/entityType/entities/entityId HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [entityId](#API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax) **
The entity ID.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: Yes
** [entityType](#API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax) **
The entity type.
Valid Values: `VOCABULARY`
Required: Yes
** [libraryArn](#API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax) **
The library's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"entity": { ... }
}
```
## 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.
** [entity](#API_data-automation_GetDataAutomationLibraryEntity_ResponseSyntax) **
Details about the entity.
Type: [EntityDetails](API_data-automation_EntityDetails.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryEntity)
# GetDataAutomationLibraryIngestionJob
Gets details about a data automation library ingestion job.
## Request Syntax
```
POST /data-automation-libraries/libraryArn/library-ingestion-jobs/jobArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [jobArn](#API_data-automation_GetDataAutomationLibraryIngestionJob_RequestSyntax) **
The job's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library-ingestion-job/[a-zA-Z0-9-]{12,36}`
Required: Yes
** [libraryArn](#API_data-automation_GetDataAutomationLibraryIngestionJob_RequestSyntax) **
The library's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"job": {
"completionTime": "string",
"creationTime": "string",
"entityType": "string",
"errorMessage": "string",
"errorType": "string",
"jobArn": "string",
"jobStatus": "string",
"operationType": "string",
"outputConfiguration": {
"s3Uri": "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.
** [job](#API_data-automation_GetDataAutomationLibraryIngestionJob_ResponseSyntax) **
Details about the job.
Type: [DataAutomationLibraryIngestionJob](API_data-automation_DataAutomationLibraryIngestionJob.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetDataAutomationLibraryIngestionJob)
# GetDataAutomationProject
Gets details about a data automation project.
## Request Syntax
```
POST /data-automation-projects/projectArn/ HTTP/1.1
Content-type: application/json
{
"projectStage": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [projectArn](#API_data-automation_GetDataAutomationProject_RequestSyntax) **
The project's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [projectStage](#API_data-automation_GetDataAutomationProject_RequestSyntax) **
To view the development stage, set to `DEVELOPMENT`.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"project": {
"creationTime": "string",
"customOutputConfiguration": {
"blueprints": [
{
"blueprintArn": "string",
"blueprintStage": "string",
"blueprintVersion": "string"
}
]
},
"dataAutomationLibraryConfiguration": {
"libraries": [
{
"libraryArn": "string"
}
]
},
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string",
"lastModifiedTime": "string",
"overrideConfiguration": {
"audio": {
"languageConfiguration": {
"generativeOutputLanguage": "string",
"identifyMultipleLanguages": boolean,
"inputLanguages": [ "string" ]
},
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
},
"document": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
},
"splitter": {
"state": "string"
}
},
"image": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
},
"modalityRouting": {
"jpeg": "string",
"mov": "string",
"mp4": "string",
"png": "string"
},
"video": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
}
},
"projectArn": "string",
"projectDescription": "string",
"projectName": "string",
"projectStage": "string",
"projectType": "string",
"standardOutputConfiguration": {
"audio": {
"extraction": {
"category": {
"state": "string",
"typeConfiguration": {
"transcript": {
"channelLabeling": {
"state": "string"
},
"speakerLabeling": {
"state": "string"
}
}
},
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
},
"document": {
"extraction": {
"boundingBox": {
"state": "string"
},
"granularity": {
"types": [ "string" ]
}
},
"generativeField": {
"state": "string"
},
"outputFormat": {
"additionalFileFormat": {
"state": "string"
},
"textFormat": {
"types": [ "string" ]
}
}
},
"image": {
"extraction": {
"boundingBox": {
"state": "string"
},
"category": {
"state": "string",
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
},
"video": {
"extraction": {
"boundingBox": {
"state": "string"
},
"category": {
"state": "string",
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
}
},
"status": "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.
** [project](#API_data-automation_GetDataAutomationProject_ResponseSyntax) **
Details about the project.
Type: [DataAutomationProject](API_data-automation_DataAutomationProject.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/GetDataAutomationProject)
# InvokeBlueprintOptimizationAsync
Starts an asynchronous job to optimize a blueprint using sample data.
## Request Syntax
```
POST /invokeBlueprintOptimizationAsync HTTP/1.1
Content-type: application/json
{
"blueprint": {
"blueprintArn": "string",
"stage": "string"
},
"dataAutomationProfileArn": "string",
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"outputConfiguration": {
"s3Object": {
"s3Uri": "string",
"version": "string"
}
},
"samples": [
{
"assetS3Object": {
"s3Uri": "string",
"version": "string"
},
"groundTruthS3Object": {
"s3Uri": "string",
"version": "string"
}
}
],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [blueprint](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **
The blueprint to optimize.
Type: [BlueprintOptimizationObject](API_data-automation_BlueprintOptimizationObject.md) object
Required: Yes
** [dataAutomationProfileArn](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **
The ARN of the data automation profile to use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-profile/[a-zA-Z0-9-_.]+`
Required: Yes
** [encryptionConfiguration](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **
Encryption settings for the optimization job.
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object
Required: No
** [outputConfiguration](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **
Where to store the optimization results.
Type: [BlueprintOptimizationOutputConfiguration](API_data-automation_BlueprintOptimizationOutputConfiguration.md) object
Required: Yes
** [samples](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **
Sample assets and ground truth data to use for optimization.
Type: Array of [BlueprintOptimizationSample](API_data-automation_BlueprintOptimizationSample.md) objects
Required: Yes
** [tags](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **
Tags to assign to the optimization job.
Type: Array of [Tag](API_data-automation_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"invocationArn": "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.
** [invocationArn](#API_data-automation_InvokeBlueprintOptimizationAsync_ResponseSyntax) **
The ARN of the optimization job invocation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:blueprint-optimization-invocation/[a-zA-Z0-9-_]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ServiceQuotaExceededException **
HTTP Status Code: 402
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/InvokeBlueprintOptimizationAsync)
# InvokeDataAutomationLibraryIngestionJob
Invokes a data automation library ingestion job.
## Request Syntax
```
PUT /data-automation-libraries/libraryArn/library-ingestion-jobs/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"entityType": "string",
"inputConfiguration": {
"inlinePayload": { ... },
"s3Object": {
"s3Uri": "string",
"version": "string"
}
},
"notificationConfiguration": {
"eventBridgeConfiguration": {
"eventBridgeEnabled": boolean
}
},
"operationType": "string",
"outputConfiguration": {
"s3Uri": "string"
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [libraryArn](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **
The library's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **
To avoid creating duplicate resources, specify a unique token for this job.
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
** [entityType](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **
The entity type.
Type: String
Valid Values: `VOCABULARY`
Required: Yes
** [inputConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **
Input configuration for the job.
Type: [InputConfiguration](API_data-automation_InputConfiguration.md) object
Required: Yes
** [notificationConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **
Notification configuration for the job.
Type: [NotificationConfiguration](API_data-automation_NotificationConfiguration.md) object
Required: No
** [operationType](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **
The operation type.
Type: String
Valid Values: `UPSERT | DELETE`
Required: Yes
** [outputConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **
Output configuration for the job.
Type: [OutputConfiguration](API_data-automation_OutputConfiguration.md) object
Required: Yes
** [tags](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **
Tags assigned to the job at time of creation.
Type: Array of [Tag](API_data-automation_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 201
Content-type: application/json
{
"jobArn": "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.
** [jobArn](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_ResponseSyntax) **
The job's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library-ingestion-job/[a-zA-Z0-9-]{12,36}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ServiceQuotaExceededException **
HTTP Status Code: 402
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/InvokeDataAutomationLibraryIngestionJob)
# ListBlueprints
Gets a list a blueprints in your account, or public blueprints provided by the service, or versions of a blueprint. By default, the service returns a list of blueprints without blueprint versions that are in your account and in the `LIVE` stage.
## Request Syntax
```
POST /blueprints/ HTTP/1.1
Content-type: application/json
{
"blueprintArn": "string",
"blueprintStageFilter": "string",
"maxResults": number,
"nextToken": "string",
"projectFilter": {
"projectArn": "string",
"projectStage": "string"
},
"resourceOwner": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [blueprintArn](#API_data-automation_ListBlueprints_RequestSyntax) **
The blueprint's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: No
** [blueprintStageFilter](#API_data-automation_ListBlueprints_RequestSyntax) **
The blueprints' stage. To view blueprints in development, specify `DEVELOPMENT`.
Type: String
Valid Values: `DEVELOPMENT | LIVE | ALL`
Required: No
** [maxResults](#API_data-automation_ListBlueprints_RequestSyntax) **
The maximum number of blueprints to return in one page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_data-automation_ListBlueprints_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
** [projectFilter](#API_data-automation_ListBlueprints_RequestSyntax) **
To view blueprints associated with a project, specify the project.
Type: [DataAutomationProjectFilter](API_data-automation_DataAutomationProjectFilter.md) object
Required: No
** [resourceOwner](#API_data-automation_ListBlueprints_RequestSyntax) **
The blueprints' owner. To view public blueprints, specify `SERVICE`.
Type: String
Valid Values: `SERVICE | ACCOUNT`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"blueprints": [
{
"blueprintArn": "string",
"blueprintName": "string",
"blueprintStage": "string",
"blueprintVersion": "string",
"creationTime": "string",
"lastModifiedTime": "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.
** [blueprints](#API_data-automation_ListBlueprints_ResponseSyntax) **
A list of blueprint summaries.
Type: Array of [BlueprintSummary](API_data-automation_BlueprintSummary.md) objects
** [nextToken](#API_data-automation_ListBlueprints_ResponseSyntax) **
A pagination token returned if more results are available.
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 **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListBlueprints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListBlueprints)
# ListDataAutomationLibraries
Gets a list of data automation libraries in your account.
## Request Syntax
```
POST /data-automation-libraries/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string",
"projectFilter": {
"projectArn": "string",
"projectStage": "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_data-automation_ListDataAutomationLibraries_RequestSyntax) **
The maximum number of libraries to return in one page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_data-automation_ListDataAutomationLibraries_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
** [projectFilter](#API_data-automation_ListDataAutomationLibraries_RequestSyntax) **
To view libraries associated with a project, specify the project.
Type: [DataAutomationProjectFilter](API_data-automation_DataAutomationProjectFilter.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"libraries": [
{
"creationTime": "string",
"libraryArn": "string",
"libraryName": "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.
** [libraries](#API_data-automation_ListDataAutomationLibraries_ResponseSyntax) **
A list of library summaries.
Type: Array of [DataAutomationLibrarySummary](API_data-automation_DataAutomationLibrarySummary.md) objects
** [nextToken](#API_data-automation_ListDataAutomationLibraries_ResponseSyntax) **
A pagination token returned if more results are available.
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 **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraries)
# ListDataAutomationLibraryEntities
Gets a list of data automation library entities.
## Request Syntax
```
POST /data-automation-libraries/libraryArn/entityType/entityType/entities/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [entityType](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) **
The entity type.
Valid Values: `VOCABULARY`
Required: Yes
** [libraryArn](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) **
The library's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) **
The maximum number of entities to return in one page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_data-automation_ListDataAutomationLibraryEntities_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
{
"entities": [
{ ... }
],
"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.
** [entities](#API_data-automation_ListDataAutomationLibraryEntities_ResponseSyntax) **
A list of entity summaries.
Type: Array of [DataAutomationLibraryEntitySummary](API_data-automation_DataAutomationLibraryEntitySummary.md) objects
** [nextToken](#API_data-automation_ListDataAutomationLibraryEntities_ResponseSyntax) **
A pagination token returned if more results are available.
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 **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryEntities)
# ListDataAutomationLibraryIngestionJobs
Gets a list of data automation library ingestion jobs.
## Request Syntax
```
POST /data-automation-libraries/libraryArn/library-ingestion-jobs/ HTTP/1.1
Content-type: application/json
{
"maxResults": number,
"nextToken": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [libraryArn](#API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestSyntax) **
The library's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [maxResults](#API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestSyntax) **
The maximum number of jobs to return in one page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_data-automation_ListDataAutomationLibraryIngestionJobs_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
{
"jobs": [
{
"completionTime": "string",
"creationTime": "string",
"entityType": "string",
"jobArn": "string",
"jobStatus": "string",
"operationType": "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.
** [jobs](#API_data-automation_ListDataAutomationLibraryIngestionJobs_ResponseSyntax) **
A list of job summaries.
Type: Array of [DataAutomationLibraryIngestionJobSummary](API_data-automation_DataAutomationLibraryIngestionJobSummary.md) objects
** [nextToken](#API_data-automation_ListDataAutomationLibraryIngestionJobs_ResponseSyntax) **
A pagination token returned if more results are available.
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 **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListDataAutomationLibraryIngestionJobs)
# ListDataAutomationProjects
Gets a list of data automation projects in your account, or public projects provided by the service.
## Request Syntax
```
POST /data-automation-projects/ HTTP/1.1
Content-type: application/json
{
"blueprintFilter": {
"blueprintArn": "string",
"blueprintStage": "string",
"blueprintVersion": "string"
},
"libraryFilter": {
"libraryArn": "string"
},
"maxResults": number,
"nextToken": "string",
"projectStageFilter": "string",
"projectTypeFilter": "string",
"resourceOwner": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [blueprintFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) **
To view projects associated with a blueprint, specify the blueprint.
Type: [BlueprintFilter](API_data-automation_BlueprintFilter.md) object
Required: No
** [libraryFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) **
To view projects associated with a library, specify the library.
Type: [DataAutomationLibraryFilter](API_data-automation_DataAutomationLibraryFilter.md) object
Required: No
** [maxResults](#API_data-automation_ListDataAutomationProjects_RequestSyntax) **
The maximum number of projects to return in one page of results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
** [nextToken](#API_data-automation_ListDataAutomationProjects_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
** [projectStageFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) **
The projects' stage. To view projects in development, specify `DEVELOPMENT`.
Type: String
Valid Values: `DEVELOPMENT | LIVE | ALL`
Required: No
** [projectTypeFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) **
The type of projects to return. Specify `ASYNC` for asynchronous projects, `SYNC` for synchronous projects, or `ALL` to return both types.
Type: String
Valid Values: `ASYNC | SYNC | ALL`
Required: No
** [resourceOwner](#API_data-automation_ListDataAutomationProjects_RequestSyntax) **
The projects' owner. To view public projects, specify `SERVICE`.
Type: String
Valid Values: `SERVICE | ACCOUNT`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"projects": [
{
"creationTime": "string",
"projectArn": "string",
"projectName": "string",
"projectStage": "string",
"projectType": "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_data-automation_ListDataAutomationProjects_ResponseSyntax) **
A pagination token returned if more results are available.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [projects](#API_data-automation_ListDataAutomationProjects_ResponseSyntax) **
A list of project summaries.
Type: Array of [DataAutomationProjectSummary](API_data-automation_DataAutomationProjectSummary.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListDataAutomationProjects)
# ListTagsForResource
Lists a resources tags.
## Request Syntax
```
POST /listTagsForResource HTTP/1.1
Content-type: application/json
{
"resourceARN": "string"
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [resourceARN](#API_data-automation_ListTagsForResource_RequestSyntax) **
The ARN of the resource you want to check the tags of
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]*:[0-9]{12}:(blueprint|data-automation-project|blueprint-optimization-invocation|data-automation-library|data-automation-library-ingestion-job)/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"tags": [
{
"key": "string",
"value": "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_data-automation_ListTagsForResource_ResponseSyntax) **
The requested resource's tags.
Type: Array of [Tag](API_data-automation_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ListTagsForResource)
# TagResource
Lets you add a tag to an already created resource.
## Request Syntax
```
POST /tagResource HTTP/1.1
Content-type: application/json
{
"resourceARN": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [resourceARN](#API_data-automation_TagResource_RequestSyntax) **
The ARN of the resource you want to tag
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]*:[0-9]{12}:(blueprint|data-automation-project|blueprint-optimization-invocation|data-automation-library|data-automation-library-ingestion-job)/[a-zA-Z0-9-]{12,36}`
Required: Yes
** [tags](#API_data-automation_TagResource_RequestSyntax) **
The tags you want to add to a resource.
Type: Array of [Tag](API_data-automation_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
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 **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ServiceQuotaExceededException **
HTTP Status Code: 402
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/TagResource)
# UntagResource
Remove the tags from a resource.
## Request Syntax
```
POST /untagResource HTTP/1.1
Content-type: application/json
{
"resourceARN": "string",
"tagKeys": [ "string" ]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [resourceARN](#API_data-automation_UntagResource_RequestSyntax) **
The ARN of the resource you want to untag.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]*:[0-9]{12}:(blueprint|data-automation-project|blueprint-optimization-invocation|data-automation-library|data-automation-library-ingestion-job)/[a-zA-Z0-9-]{12,36}`
Required: Yes
** [tagKeys](#API_data-automation_UntagResource_RequestSyntax) **
The keys of the tag you want to untag.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
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 **
HTTP Status Code: 403
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UntagResource)
# UpdateBlueprint
Updates a blueprint.
## Request Syntax
```
PUT /blueprints/blueprintArn/ HTTP/1.1
Content-type: application/json
{
"blueprintStage": "string",
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"schema": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [blueprintArn](#API_data-automation_UpdateBlueprint_RequestSyntax) **
The blueprint's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [blueprintStage](#API_data-automation_UpdateBlueprint_RequestSyntax) **
To update the development stage, set to `DEVELOPMENT`.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** [encryptionConfiguration](#API_data-automation_UpdateBlueprint_RequestSyntax) **
Encryption for the updated blueprint.
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object
Required: No
** [schema](#API_data-automation_UpdateBlueprint_RequestSyntax) **
The blueprint's schema.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"blueprint": {
"blueprintArn": "string",
"blueprintName": "string",
"blueprintStage": "string",
"blueprintVersion": "string",
"creationTime": "string",
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string",
"lastModifiedTime": "string",
"optimizationSamples": [
{
"assetS3Object": {
"s3Uri": "string",
"version": "string"
},
"groundTruthS3Object": {
"s3Uri": "string",
"version": "string"
}
}
],
"optimizationTime": "string",
"schema": "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.
** [blueprint](#API_data-automation_UpdateBlueprint_ResponseSyntax) **
Details about the blueprint.
Type: [Blueprint](API_data-automation_Blueprint.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/UpdateBlueprint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UpdateBlueprint)
# UpdateDataAutomationLibrary
Updates a data automation library.
## Request Syntax
```
PUT /data-automation-libraries/libraryArn/ HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"libraryDescription": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [libraryArn](#API_data-automation_UpdateDataAutomationLibrary_RequestSyntax) **
The library's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [clientToken](#API_data-automation_UpdateDataAutomationLibrary_RequestSyntax) **
To avoid creating duplicate resources, specify a unique token for this operation.
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
** [libraryDescription](#API_data-automation_UpdateDataAutomationLibrary_RequestSyntax) **
A description for the library.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern: `[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*`
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"libraryArn": "string",
"status": "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.
** [libraryArn](#API_data-automation_UpdateDataAutomationLibrary_ResponseSyntax) **
The library's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
** [status](#API_data-automation_UpdateDataAutomationLibrary_ResponseSyntax) **
The library's status.
Type: String
Valid Values: `ACTIVE | DELETING`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationLibrary)
# UpdateDataAutomationProject
Updates a data automation project.
## Request Syntax
```
PUT /data-automation-projects/projectArn/ HTTP/1.1
Content-type: application/json
{
"customOutputConfiguration": {
"blueprints": [
{
"blueprintArn": "string",
"blueprintStage": "string",
"blueprintVersion": "string"
}
]
},
"dataAutomationLibraryConfiguration": {
"libraries": [
{
"libraryArn": "string"
}
]
},
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"overrideConfiguration": {
"audio": {
"languageConfiguration": {
"generativeOutputLanguage": "string",
"identifyMultipleLanguages": boolean,
"inputLanguages": [ "string" ]
},
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
},
"document": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
},
"splitter": {
"state": "string"
}
},
"image": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
},
"modalityRouting": {
"jpeg": "string",
"mov": "string",
"mp4": "string",
"png": "string"
},
"video": {
"modalityProcessing": {
"state": "string"
},
"sensitiveDataConfiguration": {
"detectionMode": "string",
"detectionScope": [ "string" ],
"piiEntitiesConfiguration": {
"piiEntityTypes": [ "string" ],
"redactionMaskMode": "string"
}
}
}
},
"projectDescription": "string",
"projectStage": "string",
"standardOutputConfiguration": {
"audio": {
"extraction": {
"category": {
"state": "string",
"typeConfiguration": {
"transcript": {
"channelLabeling": {
"state": "string"
},
"speakerLabeling": {
"state": "string"
}
}
},
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
},
"document": {
"extraction": {
"boundingBox": {
"state": "string"
},
"granularity": {
"types": [ "string" ]
}
},
"generativeField": {
"state": "string"
},
"outputFormat": {
"additionalFileFormat": {
"state": "string"
},
"textFormat": {
"types": [ "string" ]
}
}
},
"image": {
"extraction": {
"boundingBox": {
"state": "string"
},
"category": {
"state": "string",
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
},
"video": {
"extraction": {
"boundingBox": {
"state": "string"
},
"category": {
"state": "string",
"types": [ "string" ]
}
},
"generativeField": {
"state": "string",
"types": [ "string" ]
}
}
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [projectArn](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **
The project's ARN.
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [customOutputConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **
Blueprints to enable for the project.
Type: [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md) object
Required: No
** [dataAutomationLibraryConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **
Library configuration for the project.
Type: [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md) object
Required: No
** [encryptionConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **
Encryption for the created project.
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object
Required: No
** [overrideConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **
Additional settings to apply to the project.
Type: [OverrideConfiguration](API_data-automation_OverrideConfiguration.md) object
Required: No
** [projectDescription](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **
A description for the project.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Required: No
** [projectStage](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **
To update the development stage, set to `DEVELOPMENT`.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** [standardOutputConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **
The standard output configuration for the project. If you omit settings for any types, default settings are applied.
Type: [StandardOutputConfiguration](API_data-automation_StandardOutputConfiguration.md) object
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"projectArn": "string",
"projectStage": "string",
"status": "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.
** [projectArn](#API_data-automation_UpdateDataAutomationProject_ResponseSyntax) **
The project's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
** [projectStage](#API_data-automation_UpdateDataAutomationProject_ResponseSyntax) **
The project's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
** [status](#API_data-automation_UpdateDataAutomationProject_ResponseSyntax) **
The project's status.
Type: String
Valid Values: `COMPLETED | IN_PROGRESS | FAILED`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 403
** ConflictException **
HTTP Status Code: 409
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 404
** ServiceQuotaExceededException **
HTTP Status Code: 402
** ThrottlingException **
HTTP Status Code: 429
** ValidationException **
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-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UpdateDataAutomationProject)
# Runtime for Amazon Bedrock Data Automation
The following actions are supported by Runtime for Amazon Bedrock Data Automation:
+ [GetDataAutomationStatus](API_data-automation-runtime_GetDataAutomationStatus.md)
+ [InvokeDataAutomation](API_data-automation-runtime_InvokeDataAutomation.md)
+ [InvokeDataAutomationAsync](API_data-automation-runtime_InvokeDataAutomationAsync.md)
+ [ListTagsForResource](API_data-automation-runtime_ListTagsForResource.md)
+ [TagResource](API_data-automation-runtime_TagResource.md)
+ [UntagResource](API_data-automation-runtime_UntagResource.md)
# GetDataAutomationStatus
Gets details about a data automation invocation. To process data, start an invocation with [InvokeDataAutomationAsync](API_data-automation-runtime_InvokeDataAutomationAsync.md). When the status is `Success`, retrieve the output from the S3 bucket.
## Request Syntax
```
{
"invocationArn": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [invocationArn](#API_data-automation-runtime_GetDataAutomationStatus_RequestSyntax) **
The invocation ARN returned by [InvokeDataAutomationAsync](API_data-automation-runtime_InvokeDataAutomationAsync.md).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:(insights-invocation|data-automation-invocation)/[a-zA-Z0-9-_]+`
Required: Yes
## Response Syntax
```
{
"errorMessage": "string",
"errorType": "string",
"outputConfiguration": {
"s3Uri": "string"
},
"status": "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.
** [errorMessage](#API_data-automation-runtime_GetDataAutomationStatus_ResponseSyntax) **
If an error ocurred, the error message.
Type: String
** [errorType](#API_data-automation-runtime_GetDataAutomationStatus_ResponseSyntax) **
If an error ocurred, the error's type.
Type: String
** [outputConfiguration](#API_data-automation-runtime_GetDataAutomationStatus_ResponseSyntax) **
The path of the output metadata object.
Type: [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md) object
** [status](#API_data-automation-runtime_GetDataAutomationStatus_ResponseSyntax) **
The invocation's status.
Type: String
Valid Values: `Created | InProgress | Success | ServiceError | ClientError`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 400
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 400
** ThrottlingException **
HTTP Status Code: 400
** ValidationException **
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-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/GetDataAutomationStatus)
# InvokeDataAutomation
Process data with a data automation project or blueprints. The service processes data synchronously. Output can either be returned inline or store in the output in the S3 bucket that you specify.
## Request Syntax
```
{
"blueprints": [
{
"blueprintArn": "string",
"stage": "string",
"version": "string"
}
],
"dataAutomationConfiguration": {
"dataAutomationProjectArn": "string",
"stage": "string"
},
"dataAutomationProfileArn": "string",
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"inputConfiguration": {
"bytes": blob,
"s3Uri": "string"
},
"outputConfiguration": {
"s3Uri": "string"
}
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [blueprints](#API_data-automation-runtime_InvokeDataAutomation_RequestSyntax) **
A list of blueprints to apply to the data.
Type: Array of [Blueprint](API_data-automation-runtime_Blueprint.md) objects
Array Members: Minimum number of 1 item. Maximum number of 40 items.
Required: No
** [dataAutomationConfiguration](#API_data-automation-runtime_InvokeDataAutomation_RequestSyntax) **
The data automation project to process the data with.
Type: [DataAutomationConfiguration](API_data-automation-runtime_DataAutomationConfiguration.md) object
Required: No
** [dataAutomationProfileArn](#API_data-automation-runtime_InvokeDataAutomation_RequestSyntax) **
The ARN of the profile calling your request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-profile/[a-zA-Z0-9-_.]+`
Required: Yes
** [encryptionConfiguration](#API_data-automation-runtime_InvokeDataAutomation_RequestSyntax) **
Encryption settings for the invocation.
Type: [EncryptionConfiguration](API_data-automation-runtime_EncryptionConfiguration.md) object
Required: No
** [inputConfiguration](#API_data-automation-runtime_InvokeDataAutomation_RequestSyntax) **
Where to read the input data from.
Type: [SyncInputConfiguration](API_data-automation-runtime_SyncInputConfiguration.md) object
Required: Yes
** [outputConfiguration](#API_data-automation-runtime_InvokeDataAutomation_RequestSyntax) **
Where to store the output.
Type: [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md) object
Required: No
## Response Syntax
```
{
"outputConfiguration": {
"s3Uri": "string"
},
"outputSegments": [
{
"customOutput": "string",
"customOutputStatus": "string",
"standardOutput": "string"
}
],
"semanticModality": "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.
** [outputConfiguration](#API_data-automation-runtime_InvokeDataAutomation_ResponseSyntax) **
Where to store the output.
Type: [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md) object
** [outputSegments](#API_data-automation-runtime_InvokeDataAutomation_ResponseSyntax) **
List of outputs for each logical sub-doc.
Type: Array of [OutputSegment](API_data-automation-runtime_OutputSegment.md) objects
** [semanticModality](#API_data-automation-runtime_InvokeDataAutomation_ResponseSyntax) **
Detected semantic modality.
Type: String
Valid Values: `DOCUMENT | IMAGE | AUDIO | VIDEO`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 400
** InternalServerException **
HTTP Status Code: 500
** ServiceUnavailableException **
HTTP Status Code: 500
** ThrottlingException **
HTTP Status Code: 400
** TooManyRequestsException **
HTTP Status Code: 400
** ValidationException **
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-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomation)
# InvokeDataAutomationAsync
Process data with a data automation project or blueprints. The service processes data asynchronously and stores the output in the S3 bucket that you specify. To check if an invocation is complete, use [GetDataAutomationStatus](API_data-automation-runtime_GetDataAutomationStatus.md).
## Request Syntax
```
{
"blueprints": [
{
"blueprintArn": "string",
"stage": "string",
"version": "string"
}
],
"clientToken": "string",
"dataAutomationConfiguration": {
"dataAutomationProjectArn": "string",
"stage": "string"
},
"dataAutomationProfileArn": "string",
"encryptionConfiguration": {
"kmsEncryptionContext": {
"string" : "string"
},
"kmsKeyId": "string"
},
"inputConfiguration": {
"assetProcessingConfiguration": {
"video": {
"segmentConfiguration": { ... }
}
},
"s3Uri": "string"
},
"notificationConfiguration": {
"eventBridgeConfiguration": {
"eventBridgeEnabled": boolean
}
},
"outputConfiguration": {
"s3Uri": "string"
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [blueprints](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
A list of blueprints to apply to the data.
Type: Array of [Blueprint](API_data-automation-runtime_Blueprint.md) objects
Array Members: Minimum number of 1 item. Maximum number of 40 items.
Required: No
** [clientToken](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
To avoid making duplicate calls, specify a unique token for this invocation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9])*`
Required: No
** [dataAutomationConfiguration](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
The data automation project to process the data with.
Type: [DataAutomationConfiguration](API_data-automation-runtime_DataAutomationConfiguration.md) object
Required: No
** [dataAutomationProfileArn](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
The ARN of the profile calling your request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-profile/[a-zA-Z0-9-_.]+`
Required: Yes
** [encryptionConfiguration](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
Encryption settings for the invocation.
Type: [EncryptionConfiguration](API_data-automation-runtime_EncryptionConfiguration.md) object
Required: No
** [inputConfiguration](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
Where to read the input data from.
Type: [InputConfiguration](API_data-automation-runtime_InputConfiguration.md) object
Required: Yes
** [notificationConfiguration](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
Notification settings for the invocation.
Type: [NotificationConfiguration](API_data-automation-runtime_NotificationConfiguration.md) object
Required: No
** [outputConfiguration](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
Where to store the output.
Type: [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md) object
Required: Yes
** [tags](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **
Tags associated with your inference at time of creation.
Type: Array of [Tag](API_data-automation-runtime_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
{
"invocationArn": "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.
** [invocationArn](#API_data-automation-runtime_InvokeDataAutomationAsync_ResponseSyntax) **
The ARN of the invocation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:(insights-invocation|data-automation-invocation)/[a-zA-Z0-9-_]+`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 400
** InternalServerException **
HTTP Status Code: 500
** ServiceQuotaExceededException **
HTTP Status Code: 400
** ThrottlingException **
HTTP Status Code: 400
** ValidationException **
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-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/InvokeDataAutomationAsync)
# ListTagsForResource
Lists a resources tags.
## Request Syntax
```
{
"resourceARN": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceARN](#API_data-automation-runtime_ListTagsForResource_RequestSyntax) **
The ARN of the resource you want to check the tags of
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-invocation/[a-zA-Z0-9-_]+`
Required: Yes
## Response Syntax
```
{
"tags": [
{
"key": "string",
"value": "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_data-automation-runtime_ListTagsForResource_ResponseSyntax) **
The requested resource's tags.
Type: Array of [Tag](API_data-automation-runtime_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
HTTP Status Code: 400
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 400
** ThrottlingException **
HTTP Status Code: 400
** ValidationException **
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-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/ListTagsForResource)
# TagResource
Lets you add a tag to an already created resource.
## Request Syntax
```
{
"resourceARN": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceARN](#API_data-automation-runtime_TagResource_RequestSyntax) **
The ARN of the resource you want to tag
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-invocation/[a-zA-Z0-9-_]+`
Required: Yes
** [tags](#API_data-automation-runtime_TagResource_RequestSyntax) **
The tags you want to add to a resource.
Type: Array of [Tag](API_data-automation-runtime_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: Yes
## 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 **
HTTP Status Code: 400
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 400
** ServiceQuotaExceededException **
HTTP Status Code: 400
** ThrottlingException **
HTTP Status Code: 400
** ValidationException **
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-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-runtime-2024-06-13/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/TagResource)
# UntagResource
Remove the tags from a resource.
## Request Syntax
```
{
"resourceARN": "string",
"tagKeys": [ "string" ]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceARN](#API_data-automation-runtime_UntagResource_RequestSyntax) **
The ARN of the resource you want to untag.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-invocation/[a-zA-Z0-9-_]+`
Required: Yes
** [tagKeys](#API_data-automation-runtime_UntagResource_RequestSyntax) **
The keys of the tag you want to untag.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*`
Required: Yes
## 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 **
HTTP Status Code: 400
** InternalServerException **
HTTP Status Code: 500
** ResourceNotFoundException **
HTTP Status Code: 400
** ThrottlingException **
HTTP Status Code: 400
** ValidationException **
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-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-data-automation-runtime-2024-06-13/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/UntagResource)
# Amazon Bedrock Runtime
The following actions are supported by Amazon Bedrock Runtime:
+ [ApplyGuardrail](API_runtime_ApplyGuardrail.md)
+ [Converse](API_runtime_Converse.md)
+ [ConverseStream](API_runtime_ConverseStream.md)
+ [CountTokens](API_runtime_CountTokens.md)
+ [GetAsyncInvoke](API_runtime_GetAsyncInvoke.md)
+ [InvokeModel](API_runtime_InvokeModel.md)
+ [InvokeModelWithBidirectionalStream](API_runtime_InvokeModelWithBidirectionalStream.md)
+ [InvokeModelWithResponseStream](API_runtime_InvokeModelWithResponseStream.md)
+ [ListAsyncInvokes](API_runtime_ListAsyncInvokes.md)
+ [StartAsyncInvoke](API_runtime_StartAsyncInvoke.md)
# ApplyGuardrail
The action to apply a guardrail.
For troubleshooting some of the common errors you might encounter when using the `ApplyGuardrail` API, see [Troubleshooting Amazon Bedrock API Error Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide
## Request Syntax
```
POST /guardrail/guardrailIdentifier/version/guardrailVersion/apply HTTP/1.1
Content-type: application/json
{
"content": [
{ ... }
],
"outputScope": "string",
"source": "string"
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [guardrailIdentifier](#API_runtime_ApplyGuardrail_RequestSyntax) **
The guardrail identifier used in the request to apply the guardrail.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(|([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: Yes
** [guardrailVersion](#API_runtime_ApplyGuardrail_RequestSyntax) **
The guardrail version used in the request to apply the guardrail.
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [content](#API_runtime_ApplyGuardrail_RequestSyntax) **
The content details used in the request to apply the guardrail.
Type: Array of [GuardrailContentBlock](API_runtime_GuardrailContentBlock.md) objects
Required: Yes
** [outputScope](#API_runtime_ApplyGuardrail_RequestSyntax) **
Specifies the scope of the output that you get in the response. Set to `FULL` to return the entire output, including any detected and non-detected entries in the response for enhanced debugging.
Note that the full output scope doesn't apply to word filters or regex in sensitive information filters. It does apply to all other filtering policies, including sensitive information with filters that can detect personally identifiable information (PII).
Type: String
Valid Values: `INTERVENTIONS | FULL`
Required: No
** [source](#API_runtime_ApplyGuardrail_RequestSyntax) **
The source of data used in the request to apply the guardrail.
Type: String
Valid Values: `INPUT | OUTPUT`
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"action": "string",
"actionReason": "string",
"assessments": [
{
"appliedGuardrailDetails": {
"guardrailArn": "string",
"guardrailId": "string",
"guardrailOrigin": [ "string" ],
"guardrailOwnership": "string",
"guardrailVersion": "string"
},
"automatedReasoningPolicy": {
"findings": [
{ ... }
]
},
"contentPolicy": {
"filters": [
{
"action": "string",
"confidence": "string",
"detected": boolean,
"filterStrength": "string",
"type": "string"
}
]
},
"contextualGroundingPolicy": {
"filters": [
{
"action": "string",
"detected": boolean,
"score": number,
"threshold": number,
"type": "string"
}
]
},
"invocationMetrics": {
"guardrailCoverage": {
"images": {
"guarded": number,
"total": number
},
"textCharacters": {
"guarded": number,
"total": number
}
},
"guardrailProcessingLatency": number,
"usage": {
"automatedReasoningPolicies": number,
"automatedReasoningPolicyUnits": number,
"contentPolicyImageUnits": number,
"contentPolicyUnits": number,
"contextualGroundingPolicyUnits": number,
"sensitiveInformationPolicyFreeUnits": number,
"sensitiveInformationPolicyUnits": number,
"topicPolicyUnits": number,
"wordPolicyUnits": number
}
},
"sensitiveInformationPolicy": {
"piiEntities": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
],
"regexes": [
{
"action": "string",
"detected": boolean,
"match": "string",
"name": "string",
"regex": "string"
}
]
},
"topicPolicy": {
"topics": [
{
"action": "string",
"detected": boolean,
"name": "string",
"type": "string"
}
]
},
"wordPolicy": {
"customWords": [
{
"action": "string",
"detected": boolean,
"match": "string"
}
],
"managedWordLists": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
]
}
}
],
"guardrailCoverage": {
"images": {
"guarded": number,
"total": number
},
"textCharacters": {
"guarded": number,
"total": number
}
},
"outputs": [
{
"text": "string"
}
],
"usage": {
"automatedReasoningPolicies": number,
"automatedReasoningPolicyUnits": number,
"contentPolicyImageUnits": number,
"contentPolicyUnits": number,
"contextualGroundingPolicyUnits": number,
"sensitiveInformationPolicyFreeUnits": number,
"sensitiveInformationPolicyUnits": number,
"topicPolicyUnits": number,
"wordPolicyUnits": number
}
}
```
## 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.
** [action](#API_runtime_ApplyGuardrail_ResponseSyntax) **
The action taken in the response from the guardrail.
Type: String
Valid Values: `NONE | GUARDRAIL_INTERVENED`
** [actionReason](#API_runtime_ApplyGuardrail_ResponseSyntax) **
The reason for the action taken when harmful content is detected.
Type: String
** [assessments](#API_runtime_ApplyGuardrail_ResponseSyntax) **
The assessment details in the response from the guardrail.
Type: Array of [GuardrailAssessment](API_runtime_GuardrailAssessment.md) objects
** [guardrailCoverage](#API_runtime_ApplyGuardrail_ResponseSyntax) **
The guardrail coverage details in the apply guardrail response.
Type: [GuardrailCoverage](API_runtime_GuardrailCoverage.md) object
** [outputs](#API_runtime_ApplyGuardrail_ResponseSyntax) **
The output details in the response from the guardrail.
Type: Array of [GuardrailOutputContent](API_runtime_GuardrailOutputContent.md) objects
** [usage](#API_runtime_ApplyGuardrail_ResponseSyntax) **
The usage details in the response from the guardrail.
Type: [GuardrailUsage](API_runtime_GuardrailUsage.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 you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide
HTTP Status Code: 404
** ServiceQuotaExceededException **
Your request exceeds the service quota for your account. You can view your quotas at [Viewing service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html). You can resubmit your request later.
HTTP Status Code: 400
** ServiceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
HTTP Status Code: 503
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
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-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/ApplyGuardrail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ApplyGuardrail)
# Converse
Sends messages to the specified Amazon Bedrock model. `Converse` provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. If a model has unique inference parameters, you can also pass those unique parameters to the model.
Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.
You can submit a prompt by including it in the `messages` field, specifying the `modelId` of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.
You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the `promptVariables` field. You can append more messages to the prompt by using the `messages` field. If you use a prompt from Prompt management, you can't include the following fields in the request: `additionalModelRequestFields`, `inferenceConfig`, `system`, or `toolConfig`. Instead, these fields must be defined through Prompt management. For more information, see [Test a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-test.html).
For information about the Converse API, see [Use the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html). To use a guardrail, see [Use a guardrail with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-use-converse-api.html). To use a tool with a model, see [Tool use (Function calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
For example code, see [Converse API examples](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#message-inference-examples).
This operation requires permission for the `bedrock:InvokeModel` action.
**Important**
To deny all inference access to resources that you specify in the modelId field, you need to deny access to the `bedrock:InvokeModel` and `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies access to the resource through the base inference actions ([InvokeModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html) and [InvokeModelWithResponseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html)). For more information see [Deny access for inference on specific models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference).
For troubleshooting some of the common errors you might encounter when using the `Converse` API, see [Troubleshooting Amazon Bedrock API Error Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide
## Request Syntax
```
POST /model/modelId/converse HTTP/1.1
Content-type: application/json
{
"additionalModelRequestFields": JSON value,
"additionalModelResponseFieldPaths": [ "string" ],
"guardrailConfig": {
"guardrailIdentifier": "string",
"guardrailVersion": "string",
"trace": "string"
},
"inferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
},
"messages": [
{
"content": [
{ ... }
],
"role": "string"
}
],
"outputConfig": {
"textFormat": {
"structure": { ... },
"type": "string"
}
},
"performanceConfig": {
"latency": "string"
},
"promptVariables": {
"string" : { ... }
},
"requestMetadata": {
"string" : "string"
},
"serviceTier": {
"type": "string"
},
"system": [
{ ... }
],
"toolConfig": {
"toolChoice": { ... },
"tools": [
{ ... }
]
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelId](#API_runtime_Converse_RequestSyntax) **
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource 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) in the Amazon Bedrock User Guide.
+ If you use an Amazon Bedrock Marketplace model, specify the ID or ARN of the marketplace endpoint that you created. For more information about Amazon Bedrock Marketplace and setting up an endpoint, see [Amazon Bedrock Marketplace](https://docs.aws.amazon.com/bedrock/latest/userguide/amazon-bedrock-marketplace.html) 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 prompt created through [Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), specify the ARN of the prompt version. For more information, see [Test a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-test.html).
+ 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, specify the ARN of the custom model deployment (for on-demand inference) or the ARN of your provisioned model (for Provisioned Throughput). 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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:custom-model-deployment/[a-z0-9]{12})|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)|(^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?))$|(^arn:aws:sagemaker:[a-z0-9-]+:[0-9]{12}:endpoint/[a-zA-Z0-9-]+$)|(^arn:aws(-[^:]+)?:bedrock:([0-9a-z-]{1,20}):([0-9]{12}):(default-)?prompt-router/[a-zA-Z0-9-:.]+$)`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [additionalModelRequestFields](#API_runtime_Converse_RequestSyntax) **
Additional inference parameters that the model supports, beyond the base set of inference parameters that `Converse` and `ConverseStream` support in the `inferenceConfig` field. For more information, see [Model parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: JSON value
Required: No
** [additionalModelResponseFieldPaths](#API_runtime_Converse_RequestSyntax) **
Additional model parameters field paths to return in the response. `Converse` and `ConverseStream` return the requested fields as a JSON Pointer object in the `additionalModelResponseFields` field. The following is example JSON for `additionalModelResponseFieldPaths`.
`[ "/stop_sequence" ]`
For information about the JSON Pointer syntax, see the [Internet Engineering Task Force (IETF)](https://datatracker.ietf.org/doc/html/rfc6901) documentation.
`Converse` and `ConverseStream` reject an empty JSON Pointer or incorrectly structured JSON Pointer with a `400` error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by `Converse`.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
** [guardrailConfig](#API_runtime_Converse_RequestSyntax) **
Configuration information for a guardrail that you want to use in the request. If you include `guardContent` blocks in the `content` field in the `messages` field, the guardrail operates only on those messages. If you include no `guardContent` blocks, the guardrail operates on all messages in the request body and in any included prompt resource.
Type: [GuardrailConfiguration](API_runtime_GuardrailConfiguration.md) object
Required: No
** [inferenceConfig](#API_runtime_Converse_RequestSyntax) **
Inference parameters to pass to the model. `Converse` and `ConverseStream` support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the `additionalModelRequestFields` request field.
Type: [InferenceConfiguration](API_runtime_InferenceConfiguration.md) object
Required: No
** [messages](#API_runtime_Converse_RequestSyntax) **
The messages that you want to send to the model.
Type: Array of [Message](API_runtime_Message.md) objects
Required: No
** [outputConfig](#API_runtime_Converse_RequestSyntax) **
Output configuration for a model response.
Type: [OutputConfig](API_runtime_OutputConfig.md) object
Required: No
** [performanceConfig](#API_runtime_Converse_RequestSyntax) **
Model performance settings for the request.
Type: [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) object
Required: No
** [promptVariables](#API_runtime_Converse_RequestSyntax) **
Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the `modelId` field.
Type: String to [PromptVariableValues](API_runtime_PromptVariableValues.md) object map
Required: No
** [requestMetadata](#API_runtime_Converse_RequestSyntax) **
Key-value pairs that you can use to filter invocation logs.
Type: String to string map
Map Entries: Maximum number of 16 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern: `[a-zA-Z0-9\s:_@$#=/+,-.]{1,256}`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s:_@$#=/+,-.]{0,256}`
Required: No
** [serviceTier](#API_runtime_Converse_RequestSyntax) **
Specifies the processing tier configuration used for serving the request.
Type: [ServiceTier](API_runtime_ServiceTier.md) object
Required: No
** [system](#API_runtime_Converse_RequestSyntax) **
A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.
Type: Array of [SystemContentBlock](API_runtime_SystemContentBlock.md) objects
Required: No
** [toolConfig](#API_runtime_Converse_RequestSyntax) **
Configuration information for the tools that the model can use when generating a response.
For information about models that support tool use, see [Supported models and model features](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features).
Type: [ToolConfiguration](API_runtime_ToolConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"additionalModelResponseFields": JSON value,
"metrics": {
"latencyMs": number
},
"output": { ... },
"performanceConfig": {
"latency": "string"
},
"serviceTier": {
"type": "string"
},
"stopReason": "string",
"trace": {
"guardrail": {
"actionReason": "string",
"inputAssessment": {
"string" : {
"appliedGuardrailDetails": {
"guardrailArn": "string",
"guardrailId": "string",
"guardrailOrigin": [ "string" ],
"guardrailOwnership": "string",
"guardrailVersion": "string"
},
"automatedReasoningPolicy": {
"findings": [
{ ... }
]
},
"contentPolicy": {
"filters": [
{
"action": "string",
"confidence": "string",
"detected": boolean,
"filterStrength": "string",
"type": "string"
}
]
},
"contextualGroundingPolicy": {
"filters": [
{
"action": "string",
"detected": boolean,
"score": number,
"threshold": number,
"type": "string"
}
]
},
"invocationMetrics": {
"guardrailCoverage": {
"images": {
"guarded": number,
"total": number
},
"textCharacters": {
"guarded": number,
"total": number
}
},
"guardrailProcessingLatency": number,
"usage": {
"automatedReasoningPolicies": number,
"automatedReasoningPolicyUnits": number,
"contentPolicyImageUnits": number,
"contentPolicyUnits": number,
"contextualGroundingPolicyUnits": number,
"sensitiveInformationPolicyFreeUnits": number,
"sensitiveInformationPolicyUnits": number,
"topicPolicyUnits": number,
"wordPolicyUnits": number
}
},
"sensitiveInformationPolicy": {
"piiEntities": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
],
"regexes": [
{
"action": "string",
"detected": boolean,
"match": "string",
"name": "string",
"regex": "string"
}
]
},
"topicPolicy": {
"topics": [
{
"action": "string",
"detected": boolean,
"name": "string",
"type": "string"
}
]
},
"wordPolicy": {
"customWords": [
{
"action": "string",
"detected": boolean,
"match": "string"
}
],
"managedWordLists": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
]
}
}
},
"modelOutput": [ "string" ],
"outputAssessments": {
"string" : [
{
"appliedGuardrailDetails": {
"guardrailArn": "string",
"guardrailId": "string",
"guardrailOrigin": [ "string" ],
"guardrailOwnership": "string",
"guardrailVersion": "string"
},
"automatedReasoningPolicy": {
"findings": [
{ ... }
]
},
"contentPolicy": {
"filters": [
{
"action": "string",
"confidence": "string",
"detected": boolean,
"filterStrength": "string",
"type": "string"
}
]
},
"contextualGroundingPolicy": {
"filters": [
{
"action": "string",
"detected": boolean,
"score": number,
"threshold": number,
"type": "string"
}
]
},
"invocationMetrics": {
"guardrailCoverage": {
"images": {
"guarded": number,
"total": number
},
"textCharacters": {
"guarded": number,
"total": number
}
},
"guardrailProcessingLatency": number,
"usage": {
"automatedReasoningPolicies": number,
"automatedReasoningPolicyUnits": number,
"contentPolicyImageUnits": number,
"contentPolicyUnits": number,
"contextualGroundingPolicyUnits": number,
"sensitiveInformationPolicyFreeUnits": number,
"sensitiveInformationPolicyUnits": number,
"topicPolicyUnits": number,
"wordPolicyUnits": number
}
},
"sensitiveInformationPolicy": {
"piiEntities": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
],
"regexes": [
{
"action": "string",
"detected": boolean,
"match": "string",
"name": "string",
"regex": "string"
}
]
},
"topicPolicy": {
"topics": [
{
"action": "string",
"detected": boolean,
"name": "string",
"type": "string"
}
]
},
"wordPolicy": {
"customWords": [
{
"action": "string",
"detected": boolean,
"match": "string"
}
],
"managedWordLists": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
]
}
}
]
}
},
"promptRouter": {
"invokedModelId": "string"
}
},
"usage": {
"cacheDetails": [
{
"inputTokens": number,
"ttl": "string"
}
],
"cacheReadInputTokens": number,
"cacheWriteInputTokens": number,
"inputTokens": number,
"outputTokens": number,
"totalTokens": number
}
}
```
## 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.
** [additionalModelResponseFields](#API_runtime_Converse_ResponseSyntax) **
Additional fields in the response that are unique to the model.
Type: JSON value
** [metrics](#API_runtime_Converse_ResponseSyntax) **
Metrics for the call to `Converse`.
Type: [ConverseMetrics](API_runtime_ConverseMetrics.md) object
** [output](#API_runtime_Converse_ResponseSyntax) **
The result from the call to `Converse`.
Type: [ConverseOutput](API_runtime_ConverseOutput.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [performanceConfig](#API_runtime_Converse_ResponseSyntax) **
Model performance settings for the request.
Type: [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) object
** [serviceTier](#API_runtime_Converse_ResponseSyntax) **
Specifies the processing tier configuration used for serving the request.
Type: [ServiceTier](API_runtime_ServiceTier.md) object
** [stopReason](#API_runtime_Converse_ResponseSyntax) **
The reason why the model stopped generating output.
Type: String
Valid Values: `end_turn | tool_use | max_tokens | stop_sequence | guardrail_intervened | content_filtered | malformed_model_output | malformed_tool_use | model_context_window_exceeded`
** [trace](#API_runtime_Converse_ResponseSyntax) **
A trace object that contains information about the Guardrail behavior.
Type: [ConverseTrace](API_runtime_ConverseTrace.md) object
** [usage](#API_runtime_Converse_ResponseSyntax) **
The total number of tokens used in the call to `Converse`. The total includes the tokens input to the model and the tokens generated by the model.
Type: [TokenUsage](API_runtime_TokenUsage.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 you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ModelErrorException **
The request failed due to an error while processing the model.
** originalStatusCode **
The original status code.
** resourceName **
The resource name.
HTTP Status Code: 424
** ModelNotReadyException **
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see [Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide.
HTTP Status Code: 429
** ModelTimeoutException **
The request took too long to process. Processing time exceeded the model timeout length.
HTTP Status Code: 408
** ResourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide
HTTP Status Code: 404
** ServiceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
HTTP Status Code: 503
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
HTTP Status Code: 400
## Examples
### Send a message to a model
Send a messsage to Anthropic Claude Sonnet with `Converse`.
#### Sample Request
```
POST /model/anthropic.claude-3-sonnet-20240229-v1:0/converse HTTP/1.1
Content-type: application/json
{
"messages": [
{
"role": "user",
"content": [
{
"text": "Write an article about impact of high inflation to GDP of a country"
}
]
}
],
"system": [{"text" : "You are an economist with access to lots of data"}],
"inferenceConfig": {
"maxTokens": 1000,
"temperature": 0.5
}
}
```
### Example response
Response for the above request.
#### Sample Request
```
HTTP/1.1 200
Content-type: application/json
{
"output": {
"message": {
"content": [
{
"text": ""
}
],
"role": "assistant"
}
},
"stopReason": "end_turn",
"usage": {
"inputTokens": 30,
"outputTokens": 628,
"totalTokens": 658
},
"metrics": {
"latencyMs": 1275
}
}
```
### Send a message with additional model fields
In the following example, the request passess a field (`top_k`) that the `Converse` field doesn't support. You pass the additional field in the `additionalModelRequestFields` field. The example also shows how to set the paths for the additional fields sent in the response from the model.
#### Sample Request
```
POST /model/anthropic.claude-3-sonnet-20240229-v1:0/converse HTTP/1.1
Content-type: application/json
{
"messages": [
{
"role": "user",
"content": [
{
"text": "Provide general steps to debug a BSOD on a Windows laptop."
}
]
}
],
"system": [{"text" : "You are a tech support expert who helps resolve technical issues. Signal 'SUCCESS' if you can resolve the issue, otherwise 'FAILURE'"}],
"inferenceConfig": {
"stopSequences": [ "SUCCESS", "FAILURE" ]
},
"additionalModelRequestFields": {
"top_k": 200
},
"additionalModelResponseFieldPaths": [
"/stop_sequence"
]
}
```
### Example response
Response for the above example.
#### Sample Request
```
HTTP/1.1 200
Content-type: application/json
{
"output": {
"message": {
"content": [
{
"text": ""
}
],
"role": "assistant"
}
},
"additionalModelResponseFields": {
"stop_sequence": "SUCCESS"
},
"stopReason": "stop_sequence",
"usage": {
"inputTokens": 51,
"outputTokens": 442,
"totalTokens": 493
},
"metrics": {
"latencyMs": 7944
}
}
```
### Use an inference profile in a conversation
The following request calls the US Anthropic Claude 3.5 Sonnet inference profile to route traffic to the us-east-1 and us-west-2 regions.
#### Sample Request
```
POST /model/us.anthropic.claude-3-5-sonnet-20240620-v1:0/converse HTTP/1.1
{
"messages": [
{
"role": "user",
"content": [
{
"text": "Hello world"
}
]
}
]
}
```
### Run inference on a prompt resource from Prompt management
Send the following request to run inference on version 1 of a prompt resource from Prompt management whose ID is `PROMPT12345`. Suppose the prompt contains a variable called `{{genre}}`. This request would fill in the variable with the value `pop`. Check that you have `bedrock:RenderPrompt` permissions for the prompt resource. For more information, see [Prerequisites for Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-prereq.html).
#### Sample Request
```
POST /model/arn:aws:bedrock:us-west-2:123456789012:prompt/PROMPT12345:1/converse HTTP/1.1
Content-type: application/json
{
"promptVariables": {
"genre": {
"text": "pop"
}
}
}
```
## 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-runtime-2023-09-30/Converse)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/Converse)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Converse)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/Converse)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Converse)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/Converse)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/Converse)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/Converse)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/Converse)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Converse)
# ConverseStream
Sends messages to the specified Amazon Bedrock model and returns the response in a stream. `ConverseStream` provides a consistent API that works with all Amazon Bedrock models that support messages. This allows you to write code once and use it with different models. Should a model have unique inference parameters, you can also pass those unique parameters to the model.
To find out if a model supports streaming, call [GetFoundationModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html) and check the `responseStreamingSupported` field in the response.
**Note**
The AWS CLI doesn't support streaming operations in Amazon Bedrock, including `ConverseStream`.
Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.
You can submit a prompt by including it in the `messages` field, specifying the `modelId` of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.
You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the `promptVariables` field. You can append more messages to the prompt by using the `messages` field. If you use a prompt from Prompt management, you can't include the following fields in the request: `additionalModelRequestFields`, `inferenceConfig`, `system`, or `toolConfig`. Instead, these fields must be defined through Prompt management. For more information, see [Test a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-test.html).
For information about the Converse API, see [Use the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html). To use a guardrail, see [Use a guardrail with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-use-converse-api.html). To use a tool with a model, see [Tool use (Function calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
For example code, see [Conversation streaming example](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#messages-streaming-inference-example).
This operation requires permission for the `bedrock:InvokeModelWithResponseStream` action.
**Important**
To deny all inference access to resources that you specify in the modelId field, you need to deny access to the `bedrock:InvokeModel` and `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies access to the resource through the base inference actions ([InvokeModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html) and [InvokeModelWithResponseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html)). For more information see [Deny access for inference on specific models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference).
For troubleshooting some of the common errors you might encounter when using the `ConverseStream` API, see [Troubleshooting Amazon Bedrock API Error Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide
## Request Syntax
```
POST /model/modelId/converse-stream HTTP/1.1
Content-type: application/json
{
"additionalModelRequestFields": JSON value,
"additionalModelResponseFieldPaths": [ "string" ],
"guardrailConfig": {
"guardrailIdentifier": "string",
"guardrailVersion": "string",
"streamProcessingMode": "string",
"trace": "string"
},
"inferenceConfig": {
"maxTokens": number,
"stopSequences": [ "string" ],
"temperature": number,
"topP": number
},
"messages": [
{
"content": [
{ ... }
],
"role": "string"
}
],
"outputConfig": {
"textFormat": {
"structure": { ... },
"type": "string"
}
},
"performanceConfig": {
"latency": "string"
},
"promptVariables": {
"string" : { ... }
},
"requestMetadata": {
"string" : "string"
},
"serviceTier": {
"type": "string"
},
"system": [
{ ... }
],
"toolConfig": {
"toolChoice": { ... },
"tools": [
{ ... }
]
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelId](#API_runtime_ConverseStream_RequestSyntax) **
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource 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) in the Amazon Bedrock User Guide.
+ If you use an Amazon Bedrock Marketplace model, specify the ID or ARN of the marketplace endpoint that you created. For more information about Amazon Bedrock Marketplace and setting up an endpoint, see [Amazon Bedrock Marketplace](https://docs.aws.amazon.com/bedrock/latest/userguide/amazon-bedrock-marketplace.html) 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 prompt created through [Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), specify the ARN of the prompt version. For more information, see [Test a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-test.html).
+ 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, specify the ARN of the custom model deployment (for on-demand inference) or the ARN of your provisioned model (for Provisioned Throughput). 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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:custom-model-deployment/[a-z0-9]{12})|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)|(^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?))$|(^arn:aws:sagemaker:[a-z0-9-]+:[0-9]{12}:endpoint/[a-zA-Z0-9-]+$)|(^arn:aws(-[^:]+)?:bedrock:([0-9a-z-]{1,20}):([0-9]{12}):(default-)?prompt-router/[a-zA-Z0-9-:.]+$)`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [additionalModelRequestFields](#API_runtime_ConverseStream_RequestSyntax) **
Additional inference parameters that the model supports, beyond the base set of inference parameters that `Converse` and `ConverseStream` support in the `inferenceConfig` field. For more information, see [Model parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: JSON value
Required: No
** [additionalModelResponseFieldPaths](#API_runtime_ConverseStream_RequestSyntax) **
Additional model parameters field paths to return in the response. `Converse` and `ConverseStream` return the requested fields as a JSON Pointer object in the `additionalModelResponseFields` field. The following is example JSON for `additionalModelResponseFieldPaths`.
`[ "/stop_sequence" ]`
For information about the JSON Pointer syntax, see the [Internet Engineering Task Force (IETF)](https://datatracker.ietf.org/doc/html/rfc6901) documentation.
`Converse` and `ConverseStream` reject an empty JSON Pointer or incorrectly structured JSON Pointer with a `400` error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by `Converse`.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
** [guardrailConfig](#API_runtime_ConverseStream_RequestSyntax) **
Configuration information for a guardrail that you want to use in the request. If you include `guardContent` blocks in the `content` field in the `messages` field, the guardrail operates only on those messages. If you include no `guardContent` blocks, the guardrail operates on all messages in the request body and in any included prompt resource.
Type: [GuardrailStreamConfiguration](API_runtime_GuardrailStreamConfiguration.md) object
Required: No
** [inferenceConfig](#API_runtime_ConverseStream_RequestSyntax) **
Inference parameters to pass to the model. `Converse` and `ConverseStream` support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the `additionalModelRequestFields` request field.
Type: [InferenceConfiguration](API_runtime_InferenceConfiguration.md) object
Required: No
** [messages](#API_runtime_ConverseStream_RequestSyntax) **
The messages that you want to send to the model.
Type: Array of [Message](API_runtime_Message.md) objects
Required: No
** [outputConfig](#API_runtime_ConverseStream_RequestSyntax) **
Output configuration for a model response.
Type: [OutputConfig](API_runtime_OutputConfig.md) object
Required: No
** [performanceConfig](#API_runtime_ConverseStream_RequestSyntax) **
Model performance settings for the request.
Type: [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) object
Required: No
** [promptVariables](#API_runtime_ConverseStream_RequestSyntax) **
Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don't specify a prompt resource in the `modelId` field.
Type: String to [PromptVariableValues](API_runtime_PromptVariableValues.md) object map
Required: No
** [requestMetadata](#API_runtime_ConverseStream_RequestSyntax) **
Key-value pairs that you can use to filter invocation logs.
Type: String to string map
Map Entries: Maximum number of 16 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern: `[a-zA-Z0-9\s:_@$#=/+,-.]{1,256}`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s:_@$#=/+,-.]{0,256}`
Required: No
** [serviceTier](#API_runtime_ConverseStream_RequestSyntax) **
Specifies the processing tier configuration used for serving the request.
Type: [ServiceTier](API_runtime_ServiceTier.md) object
Required: No
** [system](#API_runtime_ConverseStream_RequestSyntax) **
A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.
Type: Array of [SystemContentBlock](API_runtime_SystemContentBlock.md) objects
Required: No
** [toolConfig](#API_runtime_ConverseStream_RequestSyntax) **
Configuration information for the tools that the model can use when generating a response.
For information about models that support streaming tool use, see [Supported models and model features](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features).
Type: [ToolConfiguration](API_runtime_ToolConfiguration.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"contentBlockDelta": {
"contentBlockIndex": number,
"delta": { ... }
},
"contentBlockStart": {
"contentBlockIndex": number,
"start": { ... }
},
"contentBlockStop": {
"contentBlockIndex": number
},
"internalServerException": {
},
"messageStart": {
"role": "string"
},
"messageStop": {
"additionalModelResponseFields": JSON value,
"stopReason": "string"
},
"metadata": {
"metrics": {
"latencyMs": number
},
"performanceConfig": {
"latency": "string"
},
"serviceTier": {
"type": "string"
},
"trace": {
"guardrail": {
"actionReason": "string",
"inputAssessment": {
"string" : {
"appliedGuardrailDetails": {
"guardrailArn": "string",
"guardrailId": "string",
"guardrailOrigin": [ "string" ],
"guardrailOwnership": "string",
"guardrailVersion": "string"
},
"automatedReasoningPolicy": {
"findings": [
{ ... }
]
},
"contentPolicy": {
"filters": [
{
"action": "string",
"confidence": "string",
"detected": boolean,
"filterStrength": "string",
"type": "string"
}
]
},
"contextualGroundingPolicy": {
"filters": [
{
"action": "string",
"detected": boolean,
"score": number,
"threshold": number,
"type": "string"
}
]
},
"invocationMetrics": {
"guardrailCoverage": {
"images": {
"guarded": number,
"total": number
},
"textCharacters": {
"guarded": number,
"total": number
}
},
"guardrailProcessingLatency": number,
"usage": {
"automatedReasoningPolicies": number,
"automatedReasoningPolicyUnits": number,
"contentPolicyImageUnits": number,
"contentPolicyUnits": number,
"contextualGroundingPolicyUnits": number,
"sensitiveInformationPolicyFreeUnits": number,
"sensitiveInformationPolicyUnits": number,
"topicPolicyUnits": number,
"wordPolicyUnits": number
}
},
"sensitiveInformationPolicy": {
"piiEntities": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
],
"regexes": [
{
"action": "string",
"detected": boolean,
"match": "string",
"name": "string",
"regex": "string"
}
]
},
"topicPolicy": {
"topics": [
{
"action": "string",
"detected": boolean,
"name": "string",
"type": "string"
}
]
},
"wordPolicy": {
"customWords": [
{
"action": "string",
"detected": boolean,
"match": "string"
}
],
"managedWordLists": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
]
}
}
},
"modelOutput": [ "string" ],
"outputAssessments": {
"string" : [
{
"appliedGuardrailDetails": {
"guardrailArn": "string",
"guardrailId": "string",
"guardrailOrigin": [ "string" ],
"guardrailOwnership": "string",
"guardrailVersion": "string"
},
"automatedReasoningPolicy": {
"findings": [
{ ... }
]
},
"contentPolicy": {
"filters": [
{
"action": "string",
"confidence": "string",
"detected": boolean,
"filterStrength": "string",
"type": "string"
}
]
},
"contextualGroundingPolicy": {
"filters": [
{
"action": "string",
"detected": boolean,
"score": number,
"threshold": number,
"type": "string"
}
]
},
"invocationMetrics": {
"guardrailCoverage": {
"images": {
"guarded": number,
"total": number
},
"textCharacters": {
"guarded": number,
"total": number
}
},
"guardrailProcessingLatency": number,
"usage": {
"automatedReasoningPolicies": number,
"automatedReasoningPolicyUnits": number,
"contentPolicyImageUnits": number,
"contentPolicyUnits": number,
"contextualGroundingPolicyUnits": number,
"sensitiveInformationPolicyFreeUnits": number,
"sensitiveInformationPolicyUnits": number,
"topicPolicyUnits": number,
"wordPolicyUnits": number
}
},
"sensitiveInformationPolicy": {
"piiEntities": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
],
"regexes": [
{
"action": "string",
"detected": boolean,
"match": "string",
"name": "string",
"regex": "string"
}
]
},
"topicPolicy": {
"topics": [
{
"action": "string",
"detected": boolean,
"name": "string",
"type": "string"
}
]
},
"wordPolicy": {
"customWords": [
{
"action": "string",
"detected": boolean,
"match": "string"
}
],
"managedWordLists": [
{
"action": "string",
"detected": boolean,
"match": "string",
"type": "string"
}
]
}
}
]
}
},
"promptRouter": {
"invokedModelId": "string"
}
},
"usage": {
"cacheDetails": [
{
"inputTokens": number,
"ttl": "string"
}
],
"cacheReadInputTokens": number,
"cacheWriteInputTokens": number,
"inputTokens": number,
"outputTokens": number,
"totalTokens": number
}
},
"modelStreamErrorException": {
},
"serviceUnavailableException": {
},
"throttlingException": {
},
"validationException": {
}
}
```
## 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.
** [contentBlockDelta](#API_runtime_ConverseStream_ResponseSyntax) **
The messages output content block delta.
Type: [ContentBlockDeltaEvent](API_runtime_ContentBlockDeltaEvent.md) object
** [contentBlockStart](#API_runtime_ConverseStream_ResponseSyntax) **
Start information for a content block.
Type: [ContentBlockStartEvent](API_runtime_ContentBlockStartEvent.md) object
** [contentBlockStop](#API_runtime_ConverseStream_ResponseSyntax) **
Stop information for a content block.
Type: [ContentBlockStopEvent](API_runtime_ContentBlockStopEvent.md) object
** [internalServerException](#API_runtime_ConverseStream_ResponseSyntax) **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
** [messageStart](#API_runtime_ConverseStream_ResponseSyntax) **
Message start information.
Type: [MessageStartEvent](API_runtime_MessageStartEvent.md) object
** [messageStop](#API_runtime_ConverseStream_ResponseSyntax) **
Message stop information.
Type: [MessageStopEvent](API_runtime_MessageStopEvent.md) object
** [metadata](#API_runtime_ConverseStream_ResponseSyntax) **
Metadata for the converse output stream.
Type: [ConverseStreamMetadataEvent](API_runtime_ConverseStreamMetadataEvent.md) object
** [modelStreamErrorException](#API_runtime_ConverseStream_ResponseSyntax) **
A streaming error occurred. Retry your request.
Type: Exception
HTTP Status Code: 424
** [serviceUnavailableException](#API_runtime_ConverseStream_ResponseSyntax) **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
Type: Exception
HTTP Status Code: 503
** [throttlingException](#API_runtime_ConverseStream_ResponseSyntax) **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 429
** [validationException](#API_runtime_ConverseStream_ResponseSyntax) **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 400
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ModelErrorException **
The request failed due to an error while processing the model.
** originalStatusCode **
The original status code.
** resourceName **
The resource name.
HTTP Status Code: 424
** ModelNotReadyException **
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see [Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide.
HTTP Status Code: 429
** ModelTimeoutException **
The request took too long to process. Processing time exceeded the model timeout length.
HTTP Status Code: 408
** ResourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide
HTTP Status Code: 404
** ServiceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
HTTP Status Code: 503
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
HTTP Status Code: 400
## Examples
### Send a message to a model and stream the response.
Send a message to Anthropic Claude Sonnet with `ConverseStream` and stream the response.
#### Sample Request
```
POST /model/anthropic.claude-3-sonnet-20240229-v1:0/converse-stream HTTP/1.1
{
"messages": [
{
"role": "user",
"content": [
{
"text": "Write an article about impact of high inflation to GDP of a country"
}
]
}
],
"system": [{"text" : "You are an economist with access to lots of data"}],
"inferenceConfig": {
"maxTokens": 1000,
"temperature": 0.5
}
}
```
## 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-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/ConverseStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStream)
# CountTokens
Returns the token count for a given inference request. This operation helps you estimate token usage before sending requests to foundation models by returning the token count that would be used if the same input were sent to the model in an inference request.
Token counting is model-specific because different models use different tokenization strategies. The token count returned by this operation will match the token count that would be charged if the same input were sent to the model in an `InvokeModel` or `Converse` request.
You can use this operation to:
+ Estimate costs before sending inference requests.
+ Optimize prompts to fit within token limits.
+ Plan for token usage in your applications.
This operation accepts the same input formats as `InvokeModel` and `Converse`, allowing you to count tokens for both raw text inputs and structured conversation formats.
The following operations are related to `CountTokens`:
+ [InvokeModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html) - Sends inference requests to foundation models
+ [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) - Sends conversation-based inference requests to foundation models
## Request Syntax
```
POST /model/modelId/count-tokens HTTP/1.1
Content-type: application/json
{
"input": { ... }
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelId](#API_runtime_CountTokens_RequestSyntax) **
The unique identifier or ARN of the foundation model to use for token counting. Each model processes tokens differently, so the token count is specific to the model you specify.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z_\.\-/0-9:]+`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [input](#API_runtime_CountTokens_RequestSyntax) **
The input for which to count tokens. The structure of this parameter depends on whether you're counting tokens for an `InvokeModel` or `Converse` request:
+ For `InvokeModel` requests, provide the request body in the `invokeModel` field
+ For `Converse` requests, provide the messages and system content in the `converse` field
The input format must be compatible with the model specified in the `modelId` parameter.
Type: [CountTokensInput](API_runtime_CountTokensInput.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"inputTokens": number
}
```
## 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.
** [inputTokens](#API_runtime_CountTokens_ResponseSyntax) **
The number of tokens in the provided input according to the specified model's tokenization rules. This count represents the number of input tokens that would be processed if the same input were sent to the model in an inference request. Use this value to estimate costs and ensure your inputs stay within model token limits.
Type: Integer
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide
HTTP Status Code: 404
** ServiceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
HTTP Status Code: 503
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
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-runtime-2023-09-30/CountTokens)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/CountTokens)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CountTokens)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/CountTokens)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CountTokens)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/CountTokens)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/CountTokens)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/CountTokens)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/CountTokens)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CountTokens)
# GetAsyncInvoke
Retrieve information about an asynchronous invocation.
## Request Syntax
```
GET /async-invoke/invocationArn HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [invocationArn](#API_runtime_GetAsyncInvoke_RequestSyntax) **
The invocation's ARN.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}`
Required: Yes
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"clientRequestToken": "string",
"endTime": "string",
"failureMessage": "string",
"invocationArn": "string",
"lastModifiedTime": "string",
"modelArn": "string",
"outputDataConfig": { ... },
"status": "string",
"submitTime": "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.
** [clientRequestToken](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
The invocation's idempotency token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[!-~]*`
** [endTime](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
When the invocation ended.
Type: Timestamp
** [failureMessage](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
An error message.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
** [invocationArn](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
The invocation's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}`
** [lastModifiedTime](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
The invocation's last modified time.
Type: Timestamp
** [modelArn](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
The invocation's model ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:[a-z0-9\-]+:bedrock:[a-z0-9\-]*:[0-9]*:(provisioned-model|foundation-model)/.+`
** [outputDataConfig](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
Output data settings.
Type: [AsyncInvokeOutputDataConfig](API_runtime_AsyncInvokeOutputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
** [status](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
The invocation's status.
Type: String
Valid Values: `InProgress | Completed | Failed`
** [submitTime](#API_runtime_GetAsyncInvoke_ResponseSyntax) **
When the invocation request was submitted.
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 you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
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-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/GetAsyncInvoke)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GetAsyncInvoke)
# InvokeModel
Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. You use model inference to generate text, images, and embeddings.
For example code, see [Invoke model code examples](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-invoke.html#inference-example-invoke).
This operation requires permission for the `bedrock:InvokeModel` action.
**Important**
To deny all inference access to resources that you specify in the modelId field, you need to deny access to the `bedrock:InvokeModel` and `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies access to the resource through the Converse API actions ([Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) and [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)). For more information see [Deny access for inference on specific models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference).
For troubleshooting some of the common errors you might encounter when using the `InvokeModel` API, see [Troubleshooting Amazon Bedrock API Error Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide
## Request Syntax
```
POST /model/modelId/invoke HTTP/1.1
Content-Type: contentType
Accept: accept
X-Amzn-Bedrock-Trace: trace
X-Amzn-Bedrock-GuardrailIdentifier: guardrailIdentifier
X-Amzn-Bedrock-GuardrailVersion: guardrailVersion
X-Amzn-Bedrock-PerformanceConfig-Latency: performanceConfigLatency
X-Amzn-Bedrock-Service-Tier: serviceTier
body
```
## URI Request Parameters
The request uses the following URI parameters.
** [accept](#API_runtime_InvokeModel_RequestSyntax) **
The desired MIME type of the inference body in the response. The default value is `application/json`.
** [contentType](#API_runtime_InvokeModel_RequestSyntax) **
The MIME type of the input data in the request. You must specify `application/json`.
** [guardrailIdentifier](#API_runtime_InvokeModel_RequestSyntax) **
The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.
An error will be thrown in the following situations.
+ You don't provide a guardrail identifier but you specify the `amazon-bedrock-guardrailConfig` field in the request body.
+ You enable the guardrail but the `contentType` isn't `application/json`.
+ You provide a guardrail identifier, but `guardrailVersion` isn't specified.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(|([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
** [guardrailVersion](#API_runtime_InvokeModel_RequestSyntax) **
The version number for the guardrail. The value can also be `DRAFT`.
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`
** [modelId](#API_runtime_InvokeModel_RequestSyntax) **
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource 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) in the Amazon Bedrock User Guide.
+ If you use an Amazon Bedrock Marketplace model, specify the ID or ARN of the marketplace endpoint that you created. For more information about Amazon Bedrock Marketplace and setting up an endpoint, see [Amazon Bedrock Marketplace](https://docs.aws.amazon.com/bedrock/latest/userguide/amazon-bedrock-marketplace.html) 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 prompt created through [Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), specify the ARN of the prompt version. For more information, see [Test a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-test.html).
+ 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, specify the ARN of the custom model deployment (for on-demand inference) or the ARN of your provisioned model (for Provisioned Throughput). 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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:custom-model-deployment/[a-z0-9]{12})|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)$|(^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?))$|(^arn:aws:sagemaker:[a-z0-9-]+:[0-9]{12}:endpoint/[a-zA-Z0-9-]+$)|(^arn:aws(-[^:]+)?:bedrock:([0-9a-z-]{1,20}):([0-9]{12}):(default-)?prompt-router/[a-zA-Z0-9-:.]+$)`
Required: Yes
** [performanceConfigLatency](#API_runtime_InvokeModel_RequestSyntax) **
Model performance settings for the request.
Valid Values: `standard | optimized`
** [serviceTier](#API_runtime_InvokeModel_RequestSyntax) **
Specifies the processing tier type used for serving the request.
Valid Values: `priority | default | flex | reserved`
** [trace](#API_runtime_InvokeModel_RequestSyntax) **
Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
Valid Values: `ENABLED | DISABLED | ENABLED_FULL`
## Request Body
The request accepts the following binary data.
** [body](#API_runtime_InvokeModel_RequestSyntax) **
The prompt and inference parameters in the format specified in the `contentType` in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). For more information, see [Run inference](https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html) in the Bedrock User Guide.
Length Constraints: Minimum length of 0. Maximum length of 25000000.
## Response Syntax
```
HTTP/1.1 200
Content-Type: contentType
X-Amzn-Bedrock-PerformanceConfig-Latency: performanceConfigLatency
X-Amzn-Bedrock-Service-Tier: serviceTier
body
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [contentType](#API_runtime_InvokeModel_ResponseSyntax) **
The MIME type of the inference result.
** [performanceConfigLatency](#API_runtime_InvokeModel_ResponseSyntax) **
Model performance settings for the request.
Valid Values: `standard | optimized`
** [serviceTier](#API_runtime_InvokeModel_ResponseSyntax) **
Specifies the processing tier type used for serving the request.
Valid Values: `priority | default | flex | reserved`
The response returns the following as the HTTP body.
** [body](#API_runtime_InvokeModel_ResponseSyntax) **
Inference response from the model in the format specified in the `contentType` header. To see the format and content of the request and response bodies for different models, refer to [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Length Constraints: Minimum length of 0. Maximum length of 25000000.
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ModelErrorException **
The request failed due to an error while processing the model.
** originalStatusCode **
The original status code.
** resourceName **
The resource name.
HTTP Status Code: 424
** ModelNotReadyException **
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see [Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide.
HTTP Status Code: 429
** ModelTimeoutException **
The request took too long to process. Processing time exceeded the model timeout length.
HTTP Status Code: 408
** ResourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide
HTTP Status Code: 404
** ServiceQuotaExceededException **
Your request exceeds the service quota for your account. You can view your quotas at [Viewing service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html). You can resubmit your request later.
HTTP Status Code: 400
** ServiceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
HTTP Status Code: 503
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
HTTP Status Code: 400
## Examples
### Run inference on a text model
Send an invoke request to run inference on a Titan Text G1 - Express model. We set the `accept` parameter to accept any content type in the response.
#### Sample Request
```
POST https://bedrock-runtime.us-east-1.amazonaws.com/model/amazon.titan-text-express-v1/invoke
-H accept: */*
-H content-type: application/json
Payload
{"inputText": "Hello world"}
```
### Run inference on an image model
In the following example, the request sets the `accept` parameter to `image/png`.
#### Sample Request
```
POST https://bedrock-runtime.us-east-1.amazonaws.com/model/stability.stable-diffusion-xl-v1/invoke
-H accept: image/png
-H content-type: application/json
Payload
{"inputText": "Picture of a bird"}
```
### Use a guardrail
This example shows how to use a guardrail with `InvokeModel`.
#### Sample Request
```
POST /model/modelId/invoke HTTP/1.1
Accept: accept
Content-Type: contentType
X-Amzn-Bedrock-GuardrailIdentifier: guardrailIdentifier
X-Amzn-Bedrock-GuardrailVersion: guardrailVersion
X-Amzn-Bedrock-GuardrailTrace: guardrailTrace
X-Amzn-Bedrock-Trace: trace
body
// body
{
"amazon-bedrock-guardrailConfig": {
"tagSuffix": "string"
}
}
```
### Example response
This is an example response from `InvokeModel` when using a guardrail.
#### Sample Request
```
HTTP/1.1 200
Content-Type: contentType
body
// body
{
"amazon-bedrock-guardrailAction": "INTERVENED | NONE",
"amazon-bedrock-trace": {
"guardrails": {
// Detailed guardrail trace
}
}
}
```
### Use an inference profile in model invocation
The following request calls the US Anthropic Claude 3.5 Sonnet inference profile to route traffic to the us-east-1 and us-west-2 regions.
#### Sample Request
```
POST /model/us.anthropic.claude-3-5-sonnet-20240620-v1:0/invoke HTTP/1.1
{
"anthropic_version": "bedrock-2023-05-31",
"max_tokens": 1024,
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "Hello world"
}
]
}
]
}
```
## 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-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/InvokeModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModel)
# InvokeModelWithBidirectionalStream
Invoke the specified Amazon Bedrock model to run inference using the bidirectional stream. The response is returned in a stream that remains open for 8 minutes. A single session can contain multiple prompts and responses from the model. The prompts to the model are provided as audio files and the model's responses are spoken back to the user and transcribed.
It is possible for users to interrupt the model's response with a new prompt, which will halt the response speech. The model will retain contextual awareness of the conversation while pivoting to respond to the new prompt.
This operation requires permission for the `bedrock:InvokeModel` action.
Note that to log `InvokeModelWithBidirectionalStream` API calls in CloudTrail, you need to configure advanced event selectors to record data events for the `AWS::Bedrock::Model` resource type and `AWS:Bedrock::AsyncInvoke`. To learn more, see [Monitor Amazon Bedrock API calls using CloudTrail](https://docs.aws.amazon.com/bedrock/latest/userguide/logging-using-cloudtrail.html).
**Important**
To deny all inference access to resources that you specify in the modelId field, you need to deny access to the `bedrock:InvokeModel` and `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies access to the resource through the Converse API actions ([Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) and [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)). For more information see [Deny access for inference on specific models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference).
For more information, see [Using the Amazon Nova Sonic Speech-to-Speech model](https://docs.aws.amazon.com/nova/latest/userguide/speech.html).
## Request Syntax
```
POST /model/modelId/invoke-with-bidirectional-stream HTTP/1.1
Content-type: application/json
{
"chunk": {
"bytes": blob
}
}
```
## URI Request Parameters
The request uses the following URI parameters.
** [modelId](#API_runtime_InvokeModelWithBidirectionalStream_RequestSyntax) **
The model ID or ARN of the model ID to use. Currently, only `amazon.nova-sonic-v1:0` is supported.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:custom-model-deployment/[a-z0-9]{12})|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)$|(^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?))$|(^arn:aws:sagemaker:[a-z0-9-]+:[0-9]{12}:endpoint/[a-zA-Z0-9-]+$)|(^arn:aws(-[^:]+)?:bedrock:([0-9a-z-]{1,20}):([0-9]{12}):(default-)?prompt-router/[a-zA-Z0-9-:.]+$)`
Required: Yes
## Request Body
The request accepts the following data in JSON format.
** [chunk](#API_runtime_InvokeModelWithBidirectionalStream_RequestSyntax) **
The audio chunk that is used as input for the invocation step.
Type: [BidirectionalInputPayloadPart](API_runtime_BidirectionalInputPayloadPart.md) object
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"chunk": {
"bytes": blob
},
"internalServerException": {
},
"modelStreamErrorException": {
},
"modelTimeoutException": {
},
"serviceUnavailableException": {
},
"throttlingException": {
},
"validationException": {
}
}
```
## 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.
** [chunk](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **
The speech chunk that was provided as output from the invocation step.
Type: [BidirectionalOutputPayloadPart](API_runtime_BidirectionalOutputPayloadPart.md) object
** [internalServerException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **
The request encountered an unknown internal error.
Type: Exception
HTTP Status Code: 500
** [modelStreamErrorException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **
The request encountered an error with the model stream.
Type: Exception
HTTP Status Code: 424
** [modelTimeoutException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **
The connection was closed because a request was not received within the timeout period.
Type: Exception
HTTP Status Code: 408
** [serviceUnavailableException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **
The request has failed due to a temporary failure of the server.
Type: Exception
HTTP Status Code: 503
** [throttlingException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **
The request was denied due to request throttling.
Type: Exception
HTTP Status Code: 429
** [validationException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **
The input fails to satisfy the constraints specified by an AWS service.
Type: Exception
HTTP Status Code: 400
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ModelErrorException **
The request failed due to an error while processing the model.
** originalStatusCode **
The original status code.
** resourceName **
The resource name.
HTTP Status Code: 424
** ModelNotReadyException **
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see [Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide.
HTTP Status Code: 429
** ModelStreamErrorException **
An error occurred while streaming the response. Retry your request.
** originalMessage **
The original message.
** originalStatusCode **
The original status code.
HTTP Status Code: 424
** ModelTimeoutException **
The request took too long to process. Processing time exceeded the model timeout length.
HTTP Status Code: 408
** ResourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide
HTTP Status Code: 404
** ServiceQuotaExceededException **
Your request exceeds the service quota for your account. You can view your quotas at [Viewing service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html). You can resubmit your request later.
HTTP Status Code: 400
** ServiceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
HTTP Status Code: 503
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
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-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStream)
# InvokeModelWithResponseStream
Invoke the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. The response is returned in a stream.
To see if a model supports streaming, call [GetFoundationModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html) and check the `responseStreamingSupported` field in the response.
**Note**
The AWS CLI doesn't support streaming operations in Amazon Bedrock, including `InvokeModelWithResponseStream`.
For example code, see [Invoke model with streaming code example](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-invoke.html#inference-examples-stream).
This operation requires permissions to perform the `bedrock:InvokeModelWithResponseStream` action.
**Important**
To deny all inference access to resources that you specify in the modelId field, you need to deny access to the `bedrock:InvokeModel` and `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies access to the resource through the Converse API actions ([Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) and [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)). For more information see [Deny access for inference on specific models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference).
For troubleshooting some of the common errors you might encounter when using the `InvokeModelWithResponseStream` API, see [Troubleshooting Amazon Bedrock API Error Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide
## Request Syntax
```
POST /model/modelId/invoke-with-response-stream HTTP/1.1
Content-Type: contentType
X-Amzn-Bedrock-Accept: accept
X-Amzn-Bedrock-Trace: trace
X-Amzn-Bedrock-GuardrailIdentifier: guardrailIdentifier
X-Amzn-Bedrock-GuardrailVersion: guardrailVersion
X-Amzn-Bedrock-PerformanceConfig-Latency: performanceConfigLatency
X-Amzn-Bedrock-Service-Tier: serviceTier
body
```
## URI Request Parameters
The request uses the following URI parameters.
** [accept](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
The desired MIME type of the inference body in the response. The default value is `application/json`.
** [contentType](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
The MIME type of the input data in the request. You must specify `application/json`.
** [guardrailIdentifier](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.
An error is thrown in the following situations.
+ You don't provide a guardrail identifier but you specify the `amazon-bedrock-guardrailConfig` field in the request body.
+ You enable the guardrail but the `contentType` isn't `application/json`.
+ You provide a guardrail identifier, but `guardrailVersion` isn't specified.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(|([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
** [guardrailVersion](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
The version number for the guardrail. The value can also be `DRAFT`.
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`
** [modelId](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource 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) in the Amazon Bedrock User Guide.
+ If you use an Amazon Bedrock Marketplace model, specify the ID or ARN of the marketplace endpoint that you created. For more information about Amazon Bedrock Marketplace and setting up an endpoint, see [Amazon Bedrock Marketplace](https://docs.aws.amazon.com/bedrock/latest/userguide/amazon-bedrock-marketplace.html) 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 prompt created through [Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), specify the ARN of the prompt version. For more information, see [Test a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-test.html).
+ 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, specify the ARN of the custom model deployment (for on-demand inference) or the ARN of your provisioned model (for Provisioned Throughput). 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.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:custom-model-deployment/[a-z0-9]{12})|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|(([0-9a-zA-Z][_-]?)+)|([a-zA-Z0-9-:.]+)$|(^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?))$|(^arn:aws:sagemaker:[a-z0-9-]+:[0-9]{12}:endpoint/[a-zA-Z0-9-]+$)|(^arn:aws(-[^:]+)?:bedrock:([0-9a-z-]{1,20}):([0-9]{12}):(default-)?prompt-router/[a-zA-Z0-9-:.]+$)`
Required: Yes
** [performanceConfigLatency](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
Model performance settings for the request.
Valid Values: `standard | optimized`
** [serviceTier](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
Specifies the processing tier type used for serving the request.
Valid Values: `priority | default | flex | reserved`
** [trace](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
Valid Values: `ENABLED | DISABLED | ENABLED_FULL`
## Request Body
The request accepts the following binary data.
** [body](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **
The prompt and inference parameters in the format specified in the `contentType` in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). For more information, see [Run inference](https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html) in the Bedrock User Guide.
Length Constraints: Minimum length of 0. Maximum length of 25000000.
## Response Syntax
```
HTTP/1.1 200
X-Amzn-Bedrock-Content-Type: contentType
X-Amzn-Bedrock-PerformanceConfig-Latency: performanceConfigLatency
X-Amzn-Bedrock-Service-Tier: serviceTier
Content-type: application/json
{
"chunk": {
"bytes": blob
},
"internalServerException": {
},
"modelStreamErrorException": {
},
"modelTimeoutException": {
},
"serviceUnavailableException": {
},
"throttlingException": {
},
"validationException": {
}
}
```
## Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
** [contentType](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
The MIME type of the inference result.
** [performanceConfigLatency](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
Model performance settings for the request.
Valid Values: `standard | optimized`
** [serviceTier](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
Specifies the processing tier type used for serving the request.
Valid Values: `priority | default | flex | reserved`
The following data is returned in JSON format by the service.
** [chunk](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
Content included in the response.
Type: [PayloadPart](API_runtime_PayloadPart.md) object
** [internalServerException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
** [modelStreamErrorException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
An error occurred while streaming the response. Retry your request.
Type: Exception
HTTP Status Code: 424
** [modelTimeoutException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
The request took too long to process. Processing time exceeded the model timeout length.
Type: Exception
HTTP Status Code: 408
** [serviceUnavailableException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
The service isn't available. Try again later.
Type: Exception
HTTP Status Code: 503
** [throttlingException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) to increase the rate or number of tokens you can process.
Type: Exception
HTTP Status Code: 429
** [validationException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ModelErrorException **
The request failed due to an error while processing the model.
** originalStatusCode **
The original status code.
** resourceName **
The resource name.
HTTP Status Code: 424
** ModelNotReadyException **
The model specified in the request is not ready to serve inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see [Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide.
HTTP Status Code: 429
** ModelStreamErrorException **
An error occurred while streaming the response. Retry your request.
** originalMessage **
The original message.
** originalStatusCode **
The original status code.
HTTP Status Code: 424
** ModelTimeoutException **
The request took too long to process. Processing time exceeded the model timeout length.
HTTP Status Code: 408
** ResourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide
HTTP Status Code: 404
** ServiceQuotaExceededException **
Your request exceeds the service quota for your account. You can view your quotas at [Viewing service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html). You can resubmit your request later.
HTTP Status Code: 400
** ServiceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
HTTP Status Code: 503
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
HTTP Status Code: 400
## Examples
### Run inference with streaming on a text model
For streaming, you can set `x-amzn-bedrock-accept-type` in the header to contain the desired content type of the response. In this example, we set it to accept any content type. The default value is `application/json`.
#### Sample Request
```
POST https://bedrock-runtime.us-east-1.amazonaws.com/model/amazon.titan-text-express-v1/invoke-with-response-stream
-H accept: application/vnd.amazon.eventstream
-H content-type: application/json
-H x-amzn-bedrock-accept: */*
Payload
{"inputText": "Hello world"}
```
### Example response
For streaming, the content type in the response is always set to `application/vnd.amazon.eventstream`. The response includes an additional header (x-amzn-bedrock-content-type), which contains the actual content type of the response.
#### Sample Request
```
-H content-type: application/vnd.amazon.eventstream
-H x-amzn-bedrock-content-type: application/json
Payload (stream events)
```
### Use a guardrail
This examples show how to use a guardrail with `InvokeModelWithResponseStream`.
```
POST /model/modelId/invoke-with-response-stream HTTP/1.1
X-Amzn-Bedrock-Accept: accept
Content-Type: contentType
X-Amzn-Bedrock-GuardrailIdentifier: guardrailIdentifier
X-Amzn-Bedrock-GuardrailVersion: guardrailVersion
X-Amzn-Bedrock-GuardrailTrace: guardrailTrace
X-Amzn-Bedrock-Trace: trace
body
// body
{
"amazon-bedrock-guardrailConfig": {
"tagSuffix": "string",
"streamProcessingMode": "string"
}
}
```
### Example response
This examples shows the response from a call to `InvokeModelWithResponseStream` when using a guardrail.
```
HTTP/1.1 200
X-Amzn-Bedrock-Content-Type: contentType
Content-type: application/json
// chunk 1
{
"completion": "...",
"amazon-bedrock-guardrailAction": "INTERVENED | NONE"
}
// chunk 2
{
"completion": "...",
"amazon-bedrock-guardrailAction": "INTERVENED | NONE"
}
// last chunk
{
"completion": "...",
"amazon-bedrock-guardrailAction": "INTERVENED | NONE",
"amazon-bedrock-trace": {
"guardrail": {
... // Detailed guardrail trace
}
}
}
```
## 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-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModelWithResponseStream)
# ListAsyncInvokes
Lists asynchronous invocations.
## Request Syntax
```
GET /async-invoke?maxResults=maxResults&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals&submitTimeAfter=submitTimeAfter&submitTimeBefore=submitTimeBefore HTTP/1.1
```
## URI Request Parameters
The request uses the following URI parameters.
** [maxResults](#API_runtime_ListAsyncInvokes_RequestSyntax) **
The maximum number of invocations to return in one page of results.
Valid Range: Minimum value of 1. Maximum value of 1000.
** [nextToken](#API_runtime_ListAsyncInvokes_RequestSyntax) **
Specify the pagination token from a previous request to retrieve the next page of results.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `\S*`
** [sortBy](#API_runtime_ListAsyncInvokes_RequestSyntax) **
How to sort the response.
Valid Values: `SubmissionTime`
** [sortOrder](#API_runtime_ListAsyncInvokes_RequestSyntax) **
The sorting order for the response.
Valid Values: `Ascending | Descending`
** [statusEquals](#API_runtime_ListAsyncInvokes_RequestSyntax) **
Filter invocations by status.
Valid Values: `InProgress | Completed | Failed`
** [submitTimeAfter](#API_runtime_ListAsyncInvokes_RequestSyntax) **
Include invocations submitted after this time.
** [submitTimeBefore](#API_runtime_ListAsyncInvokes_RequestSyntax) **
Include invocations submitted before this time.
## Request Body
The request does not have a request body.
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"asyncInvokeSummaries": [
{
"clientRequestToken": "string",
"endTime": "string",
"failureMessage": "string",
"invocationArn": "string",
"lastModifiedTime": "string",
"modelArn": "string",
"outputDataConfig": { ... },
"status": "string",
"submitTime": "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.
** [asyncInvokeSummaries](#API_runtime_ListAsyncInvokes_ResponseSyntax) **
A list of invocation summaries.
Type: Array of [AsyncInvokeSummary](API_runtime_AsyncInvokeSummary.md) objects
** [nextToken](#API_runtime_ListAsyncInvokes_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 you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
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-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/ListAsyncInvokes)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ListAsyncInvokes)
# StartAsyncInvoke
Starts an asynchronous invocation.
This operation requires permission for the `bedrock:InvokeModel` action.
**Important**
To deny all inference access to resources that you specify in the modelId field, you need to deny access to the `bedrock:InvokeModel` and `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies access to the resource through the Converse API actions ([Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) and [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)). For more information see [Deny access for inference on specific models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference).
## Request Syntax
```
POST /async-invoke HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string",
"modelId": "string",
"modelInput": JSON value,
"outputDataConfig": { ... },
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## URI Request Parameters
The request does not use any URI parameters.
## Request Body
The request accepts the following data in JSON format.
** [clientRequestToken](#API_runtime_StartAsyncInvoke_RequestSyntax) **
Specify idempotency token to ensure that requests are not duplicated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[!-~]*`
Required: No
** [modelId](#API_runtime_StartAsyncInvoke_RequestSyntax) **
The model to invoke.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z_\.\-/0-9:]+`
Required: Yes
** [modelInput](#API_runtime_StartAsyncInvoke_RequestSyntax) **
Input to send to the model.
Type: JSON value
Required: Yes
** [outputDataConfig](#API_runtime_StartAsyncInvoke_RequestSyntax) **
Where to store the output.
Type: [AsyncInvokeOutputDataConfig](API_runtime_AsyncInvokeOutputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** [tags](#API_runtime_StartAsyncInvoke_RequestSyntax) **
Tags to apply to the invocation.
Type: Array of [Tag](API_runtime_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## Response Syntax
```
HTTP/1.1 200
Content-type: application/json
{
"invocationArn": "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.
** [invocationArn](#API_runtime_StartAsyncInvoke_ResponseSyntax) **
The ARN of the invocation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** AccessDeniedException **
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide
HTTP Status Code: 403
** ConflictException **
Error occurred because of a conflict while performing an operation.
HTTP Status Code: 400
** InternalServerException **
An internal server error occurred. For troubleshooting this error, see [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide
HTTP Status Code: 500
** ResourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide
HTTP Status Code: 404
** ServiceQuotaExceededException **
Your request exceeds the service quota for your account. You can view your quotas at [Viewing service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html). You can resubmit your request later.
HTTP Status Code: 400
** ServiceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
HTTP Status Code: 503
** ThrottlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide
HTTP Status Code: 429
** ValidationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide
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-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/bedrock-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/bedrock-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/bedrock-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/bedrock-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/bedrock-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/bedrock-runtime-2023-09-30/StartAsyncInvoke)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/StartAsyncInvoke)
# Data Types
The following data types are supported by Amazon Bedrock:
+ [AccountEnforcedGuardrailInferenceInputConfiguration](API_AccountEnforcedGuardrailInferenceInputConfiguration.md)
+ [AccountEnforcedGuardrailOutputConfiguration](API_AccountEnforcedGuardrailOutputConfiguration.md)
+ [AgreementAvailability](API_AgreementAvailability.md)
+ [AutomatedEvaluationConfig](API_AutomatedEvaluationConfig.md)
+ [AutomatedEvaluationCustomMetricConfig](API_AutomatedEvaluationCustomMetricConfig.md)
+ [AutomatedEvaluationCustomMetricSource](API_AutomatedEvaluationCustomMetricSource.md)
+ [AutomatedReasoningCheckFinding](API_AutomatedReasoningCheckFinding.md)
+ [AutomatedReasoningCheckImpossibleFinding](API_AutomatedReasoningCheckImpossibleFinding.md)
+ [AutomatedReasoningCheckInputTextReference](API_AutomatedReasoningCheckInputTextReference.md)
+ [AutomatedReasoningCheckInvalidFinding](API_AutomatedReasoningCheckInvalidFinding.md)
+ [AutomatedReasoningCheckLogicWarning](API_AutomatedReasoningCheckLogicWarning.md)
+ [AutomatedReasoningCheckNoTranslationsFinding](API_AutomatedReasoningCheckNoTranslationsFinding.md)
+ [AutomatedReasoningCheckRule](API_AutomatedReasoningCheckRule.md)
+ [AutomatedReasoningCheckSatisfiableFinding](API_AutomatedReasoningCheckSatisfiableFinding.md)
+ [AutomatedReasoningCheckScenario](API_AutomatedReasoningCheckScenario.md)
+ [AutomatedReasoningCheckTooComplexFinding](API_AutomatedReasoningCheckTooComplexFinding.md)
+ [AutomatedReasoningCheckTranslation](API_AutomatedReasoningCheckTranslation.md)
+ [AutomatedReasoningCheckTranslationAmbiguousFinding](API_AutomatedReasoningCheckTranslationAmbiguousFinding.md)
+ [AutomatedReasoningCheckTranslationOption](API_AutomatedReasoningCheckTranslationOption.md)
+ [AutomatedReasoningCheckValidFinding](API_AutomatedReasoningCheckValidFinding.md)
+ [AutomatedReasoningLogicStatement](API_AutomatedReasoningLogicStatement.md)
+ [AutomatedReasoningPolicyAddRuleAnnotation](API_AutomatedReasoningPolicyAddRuleAnnotation.md)
+ [AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation](API_AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation.md)
+ [AutomatedReasoningPolicyAddRuleMutation](API_AutomatedReasoningPolicyAddRuleMutation.md)
+ [AutomatedReasoningPolicyAddTypeAnnotation](API_AutomatedReasoningPolicyAddTypeAnnotation.md)
+ [AutomatedReasoningPolicyAddTypeMutation](API_AutomatedReasoningPolicyAddTypeMutation.md)
+ [AutomatedReasoningPolicyAddTypeValue](API_AutomatedReasoningPolicyAddTypeValue.md)
+ [AutomatedReasoningPolicyAddVariableAnnotation](API_AutomatedReasoningPolicyAddVariableAnnotation.md)
+ [AutomatedReasoningPolicyAddVariableMutation](API_AutomatedReasoningPolicyAddVariableMutation.md)
+ [AutomatedReasoningPolicyAnnotatedChunk](API_AutomatedReasoningPolicyAnnotatedChunk.md)
+ [AutomatedReasoningPolicyAnnotatedContent](API_AutomatedReasoningPolicyAnnotatedContent.md)
+ [AutomatedReasoningPolicyAnnotatedLine](API_AutomatedReasoningPolicyAnnotatedLine.md)
+ [AutomatedReasoningPolicyAnnotation](API_AutomatedReasoningPolicyAnnotation.md)
+ [AutomatedReasoningPolicyAtomicStatement](API_AutomatedReasoningPolicyAtomicStatement.md)
+ [AutomatedReasoningPolicyBuildLog](API_AutomatedReasoningPolicyBuildLog.md)
+ [AutomatedReasoningPolicyBuildLogEntry](API_AutomatedReasoningPolicyBuildLogEntry.md)
+ [AutomatedReasoningPolicyBuildResultAssetManifest](API_AutomatedReasoningPolicyBuildResultAssetManifest.md)
+ [AutomatedReasoningPolicyBuildResultAssetManifestEntry](API_AutomatedReasoningPolicyBuildResultAssetManifestEntry.md)
+ [AutomatedReasoningPolicyBuildResultAssets](API_AutomatedReasoningPolicyBuildResultAssets.md)
+ [AutomatedReasoningPolicyBuildStep](API_AutomatedReasoningPolicyBuildStep.md)
+ [AutomatedReasoningPolicyBuildStepContext](API_AutomatedReasoningPolicyBuildStepContext.md)
+ [AutomatedReasoningPolicyBuildStepMessage](API_AutomatedReasoningPolicyBuildStepMessage.md)
+ [AutomatedReasoningPolicyBuildWorkflowDocument](API_AutomatedReasoningPolicyBuildWorkflowDocument.md)
+ [AutomatedReasoningPolicyBuildWorkflowRepairContent](API_AutomatedReasoningPolicyBuildWorkflowRepairContent.md)
+ [AutomatedReasoningPolicyBuildWorkflowSource](API_AutomatedReasoningPolicyBuildWorkflowSource.md)
+ [AutomatedReasoningPolicyBuildWorkflowSummary](API_AutomatedReasoningPolicyBuildWorkflowSummary.md)
+ [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md)
+ [AutomatedReasoningPolicyDefinitionElement](API_AutomatedReasoningPolicyDefinitionElement.md)
+ [AutomatedReasoningPolicyDefinitionQualityReport](API_AutomatedReasoningPolicyDefinitionQualityReport.md)
+ [AutomatedReasoningPolicyDefinitionRule](API_AutomatedReasoningPolicyDefinitionRule.md)
+ [AutomatedReasoningPolicyDefinitionType](API_AutomatedReasoningPolicyDefinitionType.md)
+ [AutomatedReasoningPolicyDefinitionTypeValue](API_AutomatedReasoningPolicyDefinitionTypeValue.md)
+ [AutomatedReasoningPolicyDefinitionTypeValuePair](API_AutomatedReasoningPolicyDefinitionTypeValuePair.md)
+ [AutomatedReasoningPolicyDefinitionVariable](API_AutomatedReasoningPolicyDefinitionVariable.md)
+ [AutomatedReasoningPolicyDeleteRuleAnnotation](API_AutomatedReasoningPolicyDeleteRuleAnnotation.md)
+ [AutomatedReasoningPolicyDeleteRuleMutation](API_AutomatedReasoningPolicyDeleteRuleMutation.md)
+ [AutomatedReasoningPolicyDeleteTypeAnnotation](API_AutomatedReasoningPolicyDeleteTypeAnnotation.md)
+ [AutomatedReasoningPolicyDeleteTypeMutation](API_AutomatedReasoningPolicyDeleteTypeMutation.md)
+ [AutomatedReasoningPolicyDeleteTypeValue](API_AutomatedReasoningPolicyDeleteTypeValue.md)
+ [AutomatedReasoningPolicyDeleteVariableAnnotation](API_AutomatedReasoningPolicyDeleteVariableAnnotation.md)
+ [AutomatedReasoningPolicyDeleteVariableMutation](API_AutomatedReasoningPolicyDeleteVariableMutation.md)
+ [AutomatedReasoningPolicyDisjointRuleSet](API_AutomatedReasoningPolicyDisjointRuleSet.md)
+ [AutomatedReasoningPolicyFidelityReport](API_AutomatedReasoningPolicyFidelityReport.md)
+ [AutomatedReasoningPolicyGeneratedTestCase](API_AutomatedReasoningPolicyGeneratedTestCase.md)
+ [AutomatedReasoningPolicyGeneratedTestCases](API_AutomatedReasoningPolicyGeneratedTestCases.md)
+ [AutomatedReasoningPolicyGenerateFidelityReportContent](API_AutomatedReasoningPolicyGenerateFidelityReportContent.md)
+ [AutomatedReasoningPolicyIngestContentAnnotation](API_AutomatedReasoningPolicyIngestContentAnnotation.md)
+ [AutomatedReasoningPolicyMutation](API_AutomatedReasoningPolicyMutation.md)
+ [AutomatedReasoningPolicyPlanning](API_AutomatedReasoningPolicyPlanning.md)
+ [AutomatedReasoningPolicyReportSourceDocument](API_AutomatedReasoningPolicyReportSourceDocument.md)
+ [AutomatedReasoningPolicyRuleReport](API_AutomatedReasoningPolicyRuleReport.md)
+ [AutomatedReasoningPolicyScenario](API_AutomatedReasoningPolicyScenario.md)
+ [AutomatedReasoningPolicyScenarios](API_AutomatedReasoningPolicyScenarios.md)
+ [AutomatedReasoningPolicySourceDocument](API_AutomatedReasoningPolicySourceDocument.md)
+ [AutomatedReasoningPolicyStatementLocation](API_AutomatedReasoningPolicyStatementLocation.md)
+ [AutomatedReasoningPolicyStatementReference](API_AutomatedReasoningPolicyStatementReference.md)
+ [AutomatedReasoningPolicySummary](API_AutomatedReasoningPolicySummary.md)
+ [AutomatedReasoningPolicyTestCase](API_AutomatedReasoningPolicyTestCase.md)
+ [AutomatedReasoningPolicyTestResult](API_AutomatedReasoningPolicyTestResult.md)
+ [AutomatedReasoningPolicyTypeValueAnnotation](API_AutomatedReasoningPolicyTypeValueAnnotation.md)
+ [AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation](API_AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation.md)
+ [AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation](API_AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation.md)
+ [AutomatedReasoningPolicyUpdateRuleAnnotation](API_AutomatedReasoningPolicyUpdateRuleAnnotation.md)
+ [AutomatedReasoningPolicyUpdateRuleMutation](API_AutomatedReasoningPolicyUpdateRuleMutation.md)
+ [AutomatedReasoningPolicyUpdateTypeAnnotation](API_AutomatedReasoningPolicyUpdateTypeAnnotation.md)
+ [AutomatedReasoningPolicyUpdateTypeMutation](API_AutomatedReasoningPolicyUpdateTypeMutation.md)
+ [AutomatedReasoningPolicyUpdateTypeValue](API_AutomatedReasoningPolicyUpdateTypeValue.md)
+ [AutomatedReasoningPolicyUpdateVariableAnnotation](API_AutomatedReasoningPolicyUpdateVariableAnnotation.md)
+ [AutomatedReasoningPolicyUpdateVariableMutation](API_AutomatedReasoningPolicyUpdateVariableMutation.md)
+ [AutomatedReasoningPolicyVariableReport](API_AutomatedReasoningPolicyVariableReport.md)
+ [AutomatedReasoningPolicyWorkflowTypeContent](API_AutomatedReasoningPolicyWorkflowTypeContent.md)
+ [BatchDeleteEvaluationJobError](API_BatchDeleteEvaluationJobError.md)
+ [BatchDeleteEvaluationJobItem](API_BatchDeleteEvaluationJobItem.md)
+ [BedrockEvaluatorModel](API_BedrockEvaluatorModel.md)
+ [ByteContentDoc](API_ByteContentDoc.md)
+ [CloudWatchConfig](API_CloudWatchConfig.md)
+ [CustomizationConfig](API_CustomizationConfig.md)
+ [CustomMetricBedrockEvaluatorModel](API_CustomMetricBedrockEvaluatorModel.md)
+ [CustomMetricDefinition](API_CustomMetricDefinition.md)
+ [CustomMetricEvaluatorModelConfig](API_CustomMetricEvaluatorModelConfig.md)
+ [CustomModelDeploymentSummary](API_CustomModelDeploymentSummary.md)
+ [CustomModelDeploymentUpdateDetails](API_CustomModelDeploymentUpdateDetails.md)
+ [CustomModelSummary](API_CustomModelSummary.md)
+ [CustomModelUnits](API_CustomModelUnits.md)
+ [DataProcessingDetails](API_DataProcessingDetails.md)
+ [DimensionalPriceRate](API_DimensionalPriceRate.md)
+ [DistillationConfig](API_DistillationConfig.md)
+ [EndpointConfig](API_EndpointConfig.md)
+ [EvaluationBedrockModel](API_EvaluationBedrockModel.md)
+ [EvaluationConfig](API_EvaluationConfig.md)
+ [EvaluationDataset](API_EvaluationDataset.md)
+ [EvaluationDatasetLocation](API_EvaluationDatasetLocation.md)
+ [EvaluationDatasetMetricConfig](API_EvaluationDatasetMetricConfig.md)
+ [EvaluationInferenceConfig](API_EvaluationInferenceConfig.md)
+ [EvaluationInferenceConfigSummary](API_EvaluationInferenceConfigSummary.md)
+ [EvaluationModelConfig](API_EvaluationModelConfig.md)
+ [EvaluationModelConfigSummary](API_EvaluationModelConfigSummary.md)
+ [EvaluationOutputDataConfig](API_EvaluationOutputDataConfig.md)
+ [EvaluationPrecomputedInferenceSource](API_EvaluationPrecomputedInferenceSource.md)
+ [EvaluationPrecomputedRagSourceConfig](API_EvaluationPrecomputedRagSourceConfig.md)
+ [EvaluationPrecomputedRetrieveAndGenerateSourceConfig](API_EvaluationPrecomputedRetrieveAndGenerateSourceConfig.md)
+ [EvaluationPrecomputedRetrieveSourceConfig](API_EvaluationPrecomputedRetrieveSourceConfig.md)
+ [EvaluationRagConfigSummary](API_EvaluationRagConfigSummary.md)
+ [EvaluationSummary](API_EvaluationSummary.md)
+ [EvaluatorModelConfig](API_EvaluatorModelConfig.md)
+ [ExternalSource](API_ExternalSource.md)
+ [ExternalSourcesGenerationConfiguration](API_ExternalSourcesGenerationConfiguration.md)
+ [ExternalSourcesRetrieveAndGenerateConfiguration](API_ExternalSourcesRetrieveAndGenerateConfiguration.md)
+ [FieldForReranking](API_FieldForReranking.md)
+ [FilterAttribute](API_FilterAttribute.md)
+ [FoundationModelDetails](API_FoundationModelDetails.md)
+ [FoundationModelLifecycle](API_FoundationModelLifecycle.md)
+ [FoundationModelSummary](API_FoundationModelSummary.md)
+ [GenerationConfiguration](API_GenerationConfiguration.md)
+ [GraderConfig](API_GraderConfig.md)
+ [GuardrailAutomatedReasoningPolicy](API_GuardrailAutomatedReasoningPolicy.md)
+ [GuardrailAutomatedReasoningPolicyConfig](API_GuardrailAutomatedReasoningPolicyConfig.md)
+ [GuardrailConfiguration](API_GuardrailConfiguration.md)
+ [GuardrailContentFilter](API_GuardrailContentFilter.md)
+ [GuardrailContentFilterConfig](API_GuardrailContentFilterConfig.md)
+ [GuardrailContentFiltersTier](API_GuardrailContentFiltersTier.md)
+ [GuardrailContentFiltersTierConfig](API_GuardrailContentFiltersTierConfig.md)
+ [GuardrailContentPolicy](API_GuardrailContentPolicy.md)
+ [GuardrailContentPolicyConfig](API_GuardrailContentPolicyConfig.md)
+ [GuardrailContextualGroundingFilter](API_GuardrailContextualGroundingFilter.md)
+ [GuardrailContextualGroundingFilterConfig](API_GuardrailContextualGroundingFilterConfig.md)
+ [GuardrailContextualGroundingPolicy](API_GuardrailContextualGroundingPolicy.md)
+ [GuardrailContextualGroundingPolicyConfig](API_GuardrailContextualGroundingPolicyConfig.md)
+ [GuardrailCrossRegionConfig](API_GuardrailCrossRegionConfig.md)
+ [GuardrailCrossRegionDetails](API_GuardrailCrossRegionDetails.md)
+ [GuardrailManagedWords](API_GuardrailManagedWords.md)
+ [GuardrailManagedWordsConfig](API_GuardrailManagedWordsConfig.md)
+ [GuardrailPiiEntity](API_GuardrailPiiEntity.md)
+ [GuardrailPiiEntityConfig](API_GuardrailPiiEntityConfig.md)
+ [GuardrailRegex](API_GuardrailRegex.md)
+ [GuardrailRegexConfig](API_GuardrailRegexConfig.md)
+ [GuardrailSensitiveInformationPolicy](API_GuardrailSensitiveInformationPolicy.md)
+ [GuardrailSensitiveInformationPolicyConfig](API_GuardrailSensitiveInformationPolicyConfig.md)
+ [GuardrailSummary](API_GuardrailSummary.md)
+ [GuardrailTopic](API_GuardrailTopic.md)
+ [GuardrailTopicConfig](API_GuardrailTopicConfig.md)
+ [GuardrailTopicPolicy](API_GuardrailTopicPolicy.md)
+ [GuardrailTopicPolicyConfig](API_GuardrailTopicPolicyConfig.md)
+ [GuardrailTopicsTier](API_GuardrailTopicsTier.md)
+ [GuardrailTopicsTierConfig](API_GuardrailTopicsTierConfig.md)
+ [GuardrailWord](API_GuardrailWord.md)
+ [GuardrailWordConfig](API_GuardrailWordConfig.md)
+ [GuardrailWordPolicy](API_GuardrailWordPolicy.md)
+ [GuardrailWordPolicyConfig](API_GuardrailWordPolicyConfig.md)
+ [HumanEvaluationConfig](API_HumanEvaluationConfig.md)
+ [HumanEvaluationCustomMetric](API_HumanEvaluationCustomMetric.md)
+ [HumanWorkflowConfig](API_HumanWorkflowConfig.md)
+ [ImplicitFilterConfiguration](API_ImplicitFilterConfiguration.md)
+ [ImportedModelSummary](API_ImportedModelSummary.md)
+ [InferenceProfileModel](API_InferenceProfileModel.md)
+ [InferenceProfileModelSource](API_InferenceProfileModelSource.md)
+ [InferenceProfileSummary](API_InferenceProfileSummary.md)
+ [InvocationLogsConfig](API_InvocationLogsConfig.md)
+ [InvocationLogSource](API_InvocationLogSource.md)
+ [KbInferenceConfig](API_KbInferenceConfig.md)
+ [KnowledgeBaseConfig](API_KnowledgeBaseConfig.md)
+ [KnowledgeBaseRetrievalConfiguration](API_KnowledgeBaseRetrievalConfiguration.md)
+ [KnowledgeBaseRetrieveAndGenerateConfiguration](API_KnowledgeBaseRetrieveAndGenerateConfiguration.md)
+ [KnowledgeBaseVectorSearchConfiguration](API_KnowledgeBaseVectorSearchConfiguration.md)
+ [LambdaGraderConfig](API_LambdaGraderConfig.md)
+ [LegalTerm](API_LegalTerm.md)
+ [LoggingConfig](API_LoggingConfig.md)
+ [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md)
+ [MarketplaceModelEndpointSummary](API_MarketplaceModelEndpointSummary.md)
+ [MetadataAttributeSchema](API_MetadataAttributeSchema.md)
+ [MetadataConfigurationForReranking](API_MetadataConfigurationForReranking.md)
+ [ModelCopyJobSummary](API_ModelCopyJobSummary.md)
+ [ModelCustomizationJobSummary](API_ModelCustomizationJobSummary.md)
+ [ModelDataSource](API_ModelDataSource.md)
+ [ModelEnforcement](API_ModelEnforcement.md)
+ [ModelImportJobSummary](API_ModelImportJobSummary.md)
+ [ModelInvocationJobInputDataConfig](API_ModelInvocationJobInputDataConfig.md)
+ [ModelInvocationJobOutputDataConfig](API_ModelInvocationJobOutputDataConfig.md)
+ [ModelInvocationJobS3InputDataConfig](API_ModelInvocationJobS3InputDataConfig.md)
+ [ModelInvocationJobS3OutputDataConfig](API_ModelInvocationJobS3OutputDataConfig.md)
+ [ModelInvocationJobSummary](API_ModelInvocationJobSummary.md)
+ [Offer](API_Offer.md)
+ [OrchestrationConfiguration](API_OrchestrationConfiguration.md)
+ [OutputDataConfig](API_OutputDataConfig.md)
+ [PerformanceConfiguration](API_PerformanceConfiguration.md)
+ [PricingTerm](API_PricingTerm.md)
+ [PromptRouterSummary](API_PromptRouterSummary.md)
+ [PromptRouterTargetModel](API_PromptRouterTargetModel.md)
+ [PromptTemplate](API_PromptTemplate.md)
+ [ProvisionedModelSummary](API_ProvisionedModelSummary.md)
+ [QueryTransformationConfiguration](API_QueryTransformationConfiguration.md)
+ [RAGConfig](API_RAGConfig.md)
+ [RatingScaleItem](API_RatingScaleItem.md)
+ [RatingScaleItemValue](API_RatingScaleItemValue.md)
+ [RequestMetadataBaseFilters](API_RequestMetadataBaseFilters.md)
+ [RequestMetadataFilters](API_RequestMetadataFilters.md)
+ [RerankingMetadataSelectiveModeConfiguration](API_RerankingMetadataSelectiveModeConfiguration.md)
+ [RetrievalFilter](API_RetrievalFilter.md)
+ [RetrieveAndGenerateConfiguration](API_RetrieveAndGenerateConfiguration.md)
+ [RetrieveConfig](API_RetrieveConfig.md)
+ [RFTConfig](API_RFTConfig.md)
+ [RFTHyperParameters](API_RFTHyperParameters.md)
+ [RoutingCriteria](API_RoutingCriteria.md)
+ [S3Config](API_S3Config.md)
+ [S3DataSource](API_S3DataSource.md)
+ [S3ObjectDoc](API_S3ObjectDoc.md)
+ [SageMakerEndpoint](API_SageMakerEndpoint.md)
+ [SelectiveContentGuarding](API_SelectiveContentGuarding.md)
+ [StatusDetails](API_StatusDetails.md)
+ [SupportTerm](API_SupportTerm.md)
+ [Tag](API_Tag.md)
+ [TeacherModelConfig](API_TeacherModelConfig.md)
+ [TermDetails](API_TermDetails.md)
+ [TextInferenceConfig](API_TextInferenceConfig.md)
+ [TrainingDataConfig](API_TrainingDataConfig.md)
+ [TrainingDetails](API_TrainingDetails.md)
+ [TrainingMetrics](API_TrainingMetrics.md)
+ [ValidationDataConfig](API_ValidationDataConfig.md)
+ [ValidationDetails](API_ValidationDetails.md)
+ [Validator](API_Validator.md)
+ [ValidatorMetric](API_ValidatorMetric.md)
+ [ValidityTerm](API_ValidityTerm.md)
+ [VectorSearchBedrockRerankingConfiguration](API_VectorSearchBedrockRerankingConfiguration.md)
+ [VectorSearchBedrockRerankingModelConfiguration](API_VectorSearchBedrockRerankingModelConfiguration.md)
+ [VectorSearchRerankingConfiguration](API_VectorSearchRerankingConfiguration.md)
+ [VpcConfig](API_VpcConfig.md)
The following data types are supported by Agents for Amazon Bedrock:
+ [ActionGroupExecutor](API_agent_ActionGroupExecutor.md)
+ [ActionGroupSummary](API_agent_ActionGroupSummary.md)
+ [Agent](API_agent_Agent.md)
+ [AgentActionGroup](API_agent_AgentActionGroup.md)
+ [AgentAlias](API_agent_AgentAlias.md)
+ [AgentAliasHistoryEvent](API_agent_AgentAliasHistoryEvent.md)
+ [AgentAliasRoutingConfigurationListItem](API_agent_AgentAliasRoutingConfigurationListItem.md)
+ [AgentAliasSummary](API_agent_AgentAliasSummary.md)
+ [AgentCollaborator](API_agent_AgentCollaborator.md)
+ [AgentCollaboratorSummary](API_agent_AgentCollaboratorSummary.md)
+ [AgentDescriptor](API_agent_AgentDescriptor.md)
+ [AgentFlowNodeConfiguration](API_agent_AgentFlowNodeConfiguration.md)
+ [AgentKnowledgeBase](API_agent_AgentKnowledgeBase.md)
+ [AgentKnowledgeBaseSummary](API_agent_AgentKnowledgeBaseSummary.md)
+ [AgentSummary](API_agent_AgentSummary.md)
+ [AgentVersion](API_agent_AgentVersion.md)
+ [AgentVersionSummary](API_agent_AgentVersionSummary.md)
+ [AnyToolChoice](API_agent_AnyToolChoice.md)
+ [APISchema](API_agent_APISchema.md)
+ [AudioConfiguration](API_agent_AudioConfiguration.md)
+ [AudioSegmentationConfiguration](API_agent_AudioSegmentationConfiguration.md)
+ [AutoToolChoice](API_agent_AutoToolChoice.md)
+ [BedrockDataAutomationConfiguration](API_agent_BedrockDataAutomationConfiguration.md)
+ [BedrockEmbeddingModelConfiguration](API_agent_BedrockEmbeddingModelConfiguration.md)
+ [BedrockFoundationModelConfiguration](API_agent_BedrockFoundationModelConfiguration.md)
+ [BedrockFoundationModelContextEnrichmentConfiguration](API_agent_BedrockFoundationModelContextEnrichmentConfiguration.md)
+ [ByteContentDoc](API_agent_ByteContentDoc.md)
+ [CachePointBlock](API_agent_CachePointBlock.md)
+ [ChatPromptTemplateConfiguration](API_agent_ChatPromptTemplateConfiguration.md)
+ [ChunkingConfiguration](API_agent_ChunkingConfiguration.md)
+ [CollectorFlowNodeConfiguration](API_agent_CollectorFlowNodeConfiguration.md)
+ [ConditionFlowNodeConfiguration](API_agent_ConditionFlowNodeConfiguration.md)
+ [ConfluenceCrawlerConfiguration](API_agent_ConfluenceCrawlerConfiguration.md)
+ [ConfluenceDataSourceConfiguration](API_agent_ConfluenceDataSourceConfiguration.md)
+ [ConfluenceSourceConfiguration](API_agent_ConfluenceSourceConfiguration.md)
+ [ContentBlock](API_agent_ContentBlock.md)
+ [ContextEnrichmentConfiguration](API_agent_ContextEnrichmentConfiguration.md)
+ [CrawlFilterConfiguration](API_agent_CrawlFilterConfiguration.md)
+ [CuratedQuery](API_agent_CuratedQuery.md)
+ [CustomContent](API_agent_CustomContent.md)
+ [CustomDocumentIdentifier](API_agent_CustomDocumentIdentifier.md)
+ [CustomOrchestration](API_agent_CustomOrchestration.md)
+ [CustomS3Location](API_agent_CustomS3Location.md)
+ [CustomTransformationConfiguration](API_agent_CustomTransformationConfiguration.md)
+ [CyclicConnectionFlowValidationDetails](API_agent_CyclicConnectionFlowValidationDetails.md)
+ [DataSource](API_agent_DataSource.md)
+ [DataSourceConfiguration](API_agent_DataSourceConfiguration.md)
+ [DataSourceSummary](API_agent_DataSourceSummary.md)
+ [DocumentContent](API_agent_DocumentContent.md)
+ [DocumentIdentifier](API_agent_DocumentIdentifier.md)
+ [DocumentMetadata](API_agent_DocumentMetadata.md)
+ [DuplicateConditionExpressionFlowValidationDetails](API_agent_DuplicateConditionExpressionFlowValidationDetails.md)
+ [DuplicateConnectionsFlowValidationDetails](API_agent_DuplicateConnectionsFlowValidationDetails.md)
+ [EmbeddingModelConfiguration](API_agent_EmbeddingModelConfiguration.md)
+ [EnrichmentStrategyConfiguration](API_agent_EnrichmentStrategyConfiguration.md)
+ [FieldForReranking](API_agent_FieldForReranking.md)
+ [FixedSizeChunkingConfiguration](API_agent_FixedSizeChunkingConfiguration.md)
+ [FlowAliasConcurrencyConfiguration](API_agent_FlowAliasConcurrencyConfiguration.md)
+ [FlowAliasRoutingConfigurationListItem](API_agent_FlowAliasRoutingConfigurationListItem.md)
+ [FlowAliasSummary](API_agent_FlowAliasSummary.md)
+ [FlowCondition](API_agent_FlowCondition.md)
+ [FlowConditionalConnectionConfiguration](API_agent_FlowConditionalConnectionConfiguration.md)
+ [FlowConnection](API_agent_FlowConnection.md)
+ [FlowConnectionConfiguration](API_agent_FlowConnectionConfiguration.md)
+ [FlowDataConnectionConfiguration](API_agent_FlowDataConnectionConfiguration.md)
+ [FlowDefinition](API_agent_FlowDefinition.md)
+ [FlowNode](API_agent_FlowNode.md)
+ [FlowNodeConfiguration](API_agent_FlowNodeConfiguration.md)
+ [FlowNodeInput](API_agent_FlowNodeInput.md)
+ [FlowNodeOutput](API_agent_FlowNodeOutput.md)
+ [FlowSummary](API_agent_FlowSummary.md)
+ [FlowValidation](API_agent_FlowValidation.md)
+ [FlowValidationDetails](API_agent_FlowValidationDetails.md)
+ [FlowVersionSummary](API_agent_FlowVersionSummary.md)
+ [Function](API_agent_Function.md)
+ [FunctionSchema](API_agent_FunctionSchema.md)
+ [GuardrailConfiguration](API_agent_GuardrailConfiguration.md)
+ [HierarchicalChunkingConfiguration](API_agent_HierarchicalChunkingConfiguration.md)
+ [HierarchicalChunkingLevelConfiguration](API_agent_HierarchicalChunkingLevelConfiguration.md)
+ [IncompatibleConnectionDataTypeFlowValidationDetails](API_agent_IncompatibleConnectionDataTypeFlowValidationDetails.md)
+ [InferenceConfiguration](API_agent_InferenceConfiguration.md)
+ [IngestionJob](API_agent_IngestionJob.md)
+ [IngestionJobFilter](API_agent_IngestionJobFilter.md)
+ [IngestionJobSortBy](API_agent_IngestionJobSortBy.md)
+ [IngestionJobStatistics](API_agent_IngestionJobStatistics.md)
+ [IngestionJobSummary](API_agent_IngestionJobSummary.md)
+ [InlineCodeFlowNodeConfiguration](API_agent_InlineCodeFlowNodeConfiguration.md)
+ [InlineContent](API_agent_InlineContent.md)
+ [InputFlowNodeConfiguration](API_agent_InputFlowNodeConfiguration.md)
+ [IntermediateStorage](API_agent_IntermediateStorage.md)
+ [InvalidLoopBoundaryFlowValidationDetails](API_agent_InvalidLoopBoundaryFlowValidationDetails.md)
+ [IteratorFlowNodeConfiguration](API_agent_IteratorFlowNodeConfiguration.md)
+ [KendraKnowledgeBaseConfiguration](API_agent_KendraKnowledgeBaseConfiguration.md)
+ [KnowledgeBase](API_agent_KnowledgeBase.md)
+ [KnowledgeBaseConfiguration](API_agent_KnowledgeBaseConfiguration.md)
+ [KnowledgeBaseDocument](API_agent_KnowledgeBaseDocument.md)
+ [KnowledgeBaseDocumentDetail](API_agent_KnowledgeBaseDocumentDetail.md)
+ [KnowledgeBaseFlowNodeConfiguration](API_agent_KnowledgeBaseFlowNodeConfiguration.md)
+ [KnowledgeBaseOrchestrationConfiguration](API_agent_KnowledgeBaseOrchestrationConfiguration.md)
+ [KnowledgeBasePromptTemplate](API_agent_KnowledgeBasePromptTemplate.md)
+ [KnowledgeBaseSummary](API_agent_KnowledgeBaseSummary.md)
+ [LambdaFunctionFlowNodeConfiguration](API_agent_LambdaFunctionFlowNodeConfiguration.md)
+ [LexFlowNodeConfiguration](API_agent_LexFlowNodeConfiguration.md)
+ [LoopControllerFlowNodeConfiguration](API_agent_LoopControllerFlowNodeConfiguration.md)
+ [LoopFlowNodeConfiguration](API_agent_LoopFlowNodeConfiguration.md)
+ [LoopIncompatibleNodeTypeFlowValidationDetails](API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.md)
+ [LoopInputFlowNodeConfiguration](API_agent_LoopInputFlowNodeConfiguration.md)
+ [MalformedConditionExpressionFlowValidationDetails](API_agent_MalformedConditionExpressionFlowValidationDetails.md)
+ [MalformedNodeInputExpressionFlowValidationDetails](API_agent_MalformedNodeInputExpressionFlowValidationDetails.md)
+ [MemoryConfiguration](API_agent_MemoryConfiguration.md)
+ [Message](API_agent_Message.md)
+ [MetadataAttribute](API_agent_MetadataAttribute.md)
+ [MetadataAttributeValue](API_agent_MetadataAttributeValue.md)
+ [MetadataConfigurationForReranking](API_agent_MetadataConfigurationForReranking.md)
+ [MismatchedNodeInputTypeFlowValidationDetails](API_agent_MismatchedNodeInputTypeFlowValidationDetails.md)
+ [MismatchedNodeOutputTypeFlowValidationDetails](API_agent_MismatchedNodeOutputTypeFlowValidationDetails.md)
+ [MissingConnectionConfigurationFlowValidationDetails](API_agent_MissingConnectionConfigurationFlowValidationDetails.md)
+ [MissingDefaultConditionFlowValidationDetails](API_agent_MissingDefaultConditionFlowValidationDetails.md)
+ [MissingEndingNodesFlowValidationDetails](API_agent_MissingEndingNodesFlowValidationDetails.md)
+ [MissingLoopControllerNodeFlowValidationDetails](API_agent_MissingLoopControllerNodeFlowValidationDetails.md)
+ [MissingLoopInputNodeFlowValidationDetails](API_agent_MissingLoopInputNodeFlowValidationDetails.md)
+ [MissingNodeConfigurationFlowValidationDetails](API_agent_MissingNodeConfigurationFlowValidationDetails.md)
+ [MissingNodeInputFlowValidationDetails](API_agent_MissingNodeInputFlowValidationDetails.md)
+ [MissingNodeOutputFlowValidationDetails](API_agent_MissingNodeOutputFlowValidationDetails.md)
+ [MissingStartingNodesFlowValidationDetails](API_agent_MissingStartingNodesFlowValidationDetails.md)
+ [MongoDbAtlasConfiguration](API_agent_MongoDbAtlasConfiguration.md)
+ [MongoDbAtlasFieldMapping](API_agent_MongoDbAtlasFieldMapping.md)
+ [MultipleLoopControllerNodesFlowValidationDetails](API_agent_MultipleLoopControllerNodesFlowValidationDetails.md)
+ [MultipleLoopInputNodesFlowValidationDetails](API_agent_MultipleLoopInputNodesFlowValidationDetails.md)
+ [MultipleNodeInputConnectionsFlowValidationDetails](API_agent_MultipleNodeInputConnectionsFlowValidationDetails.md)
+ [NeptuneAnalyticsConfiguration](API_agent_NeptuneAnalyticsConfiguration.md)
+ [NeptuneAnalyticsFieldMapping](API_agent_NeptuneAnalyticsFieldMapping.md)
+ [OpenSearchManagedClusterConfiguration](API_agent_OpenSearchManagedClusterConfiguration.md)
+ [OpenSearchManagedClusterFieldMapping](API_agent_OpenSearchManagedClusterFieldMapping.md)
+ [OpenSearchServerlessConfiguration](API_agent_OpenSearchServerlessConfiguration.md)
+ [OpenSearchServerlessFieldMapping](API_agent_OpenSearchServerlessFieldMapping.md)
+ [OrchestrationExecutor](API_agent_OrchestrationExecutor.md)
+ [OutputFlowNodeConfiguration](API_agent_OutputFlowNodeConfiguration.md)
+ [ParameterDetail](API_agent_ParameterDetail.md)
+ [ParsingConfiguration](API_agent_ParsingConfiguration.md)
+ [ParsingPrompt](API_agent_ParsingPrompt.md)
+ [PatternObjectFilter](API_agent_PatternObjectFilter.md)
+ [PatternObjectFilterConfiguration](API_agent_PatternObjectFilterConfiguration.md)
+ [PerformanceConfiguration](API_agent_PerformanceConfiguration.md)
+ [PineconeConfiguration](API_agent_PineconeConfiguration.md)
+ [PineconeFieldMapping](API_agent_PineconeFieldMapping.md)
+ [PromptAgentResource](API_agent_PromptAgentResource.md)
+ [PromptConfiguration](API_agent_PromptConfiguration.md)
+ [PromptFlowNodeConfiguration](API_agent_PromptFlowNodeConfiguration.md)
+ [PromptFlowNodeInlineConfiguration](API_agent_PromptFlowNodeInlineConfiguration.md)
+ [PromptFlowNodeResourceConfiguration](API_agent_PromptFlowNodeResourceConfiguration.md)
+ [PromptFlowNodeSourceConfiguration](API_agent_PromptFlowNodeSourceConfiguration.md)
+ [PromptGenAiResource](API_agent_PromptGenAiResource.md)
+ [PromptInferenceConfiguration](API_agent_PromptInferenceConfiguration.md)
+ [PromptInputVariable](API_agent_PromptInputVariable.md)
+ [PromptMetadataEntry](API_agent_PromptMetadataEntry.md)
+ [PromptModelInferenceConfiguration](API_agent_PromptModelInferenceConfiguration.md)
+ [PromptOverrideConfiguration](API_agent_PromptOverrideConfiguration.md)
+ [PromptSummary](API_agent_PromptSummary.md)
+ [PromptTemplateConfiguration](API_agent_PromptTemplateConfiguration.md)
+ [PromptVariant](API_agent_PromptVariant.md)
+ [QueryGenerationColumn](API_agent_QueryGenerationColumn.md)
+ [QueryGenerationConfiguration](API_agent_QueryGenerationConfiguration.md)
+ [QueryGenerationContext](API_agent_QueryGenerationContext.md)
+ [QueryGenerationTable](API_agent_QueryGenerationTable.md)
+ [RdsConfiguration](API_agent_RdsConfiguration.md)
+ [RdsFieldMapping](API_agent_RdsFieldMapping.md)
+ [RedisEnterpriseCloudConfiguration](API_agent_RedisEnterpriseCloudConfiguration.md)
+ [RedisEnterpriseCloudFieldMapping](API_agent_RedisEnterpriseCloudFieldMapping.md)
+ [RedshiftConfiguration](API_agent_RedshiftConfiguration.md)
+ [RedshiftProvisionedAuthConfiguration](API_agent_RedshiftProvisionedAuthConfiguration.md)
+ [RedshiftProvisionedConfiguration](API_agent_RedshiftProvisionedConfiguration.md)
+ [RedshiftQueryEngineAwsDataCatalogStorageConfiguration](API_agent_RedshiftQueryEngineAwsDataCatalogStorageConfiguration.md)
+ [RedshiftQueryEngineConfiguration](API_agent_RedshiftQueryEngineConfiguration.md)
+ [RedshiftQueryEngineRedshiftStorageConfiguration](API_agent_RedshiftQueryEngineRedshiftStorageConfiguration.md)
+ [RedshiftQueryEngineStorageConfiguration](API_agent_RedshiftQueryEngineStorageConfiguration.md)
+ [RedshiftServerlessAuthConfiguration](API_agent_RedshiftServerlessAuthConfiguration.md)
+ [RedshiftServerlessConfiguration](API_agent_RedshiftServerlessConfiguration.md)
+ [RerankingMetadataSelectiveModeConfiguration](API_agent_RerankingMetadataSelectiveModeConfiguration.md)
+ [RetrievalFlowNodeConfiguration](API_agent_RetrievalFlowNodeConfiguration.md)
+ [RetrievalFlowNodeS3Configuration](API_agent_RetrievalFlowNodeS3Configuration.md)
+ [RetrievalFlowNodeServiceConfiguration](API_agent_RetrievalFlowNodeServiceConfiguration.md)
+ [S3Content](API_agent_S3Content.md)
+ [S3DataSourceConfiguration](API_agent_S3DataSourceConfiguration.md)
+ [S3Identifier](API_agent_S3Identifier.md)
+ [S3Location](API_agent_S3Location.md)
+ [S3VectorsConfiguration](API_agent_S3VectorsConfiguration.md)
+ [SalesforceCrawlerConfiguration](API_agent_SalesforceCrawlerConfiguration.md)
+ [SalesforceDataSourceConfiguration](API_agent_SalesforceDataSourceConfiguration.md)
+ [SalesforceSourceConfiguration](API_agent_SalesforceSourceConfiguration.md)
+ [SeedUrl](API_agent_SeedUrl.md)
+ [SemanticChunkingConfiguration](API_agent_SemanticChunkingConfiguration.md)
+ [ServerSideEncryptionConfiguration](API_agent_ServerSideEncryptionConfiguration.md)
+ [SessionSummaryConfiguration](API_agent_SessionSummaryConfiguration.md)
+ [SharePointCrawlerConfiguration](API_agent_SharePointCrawlerConfiguration.md)
+ [SharePointDataSourceConfiguration](API_agent_SharePointDataSourceConfiguration.md)
+ [SharePointSourceConfiguration](API_agent_SharePointSourceConfiguration.md)
+ [SpecificToolChoice](API_agent_SpecificToolChoice.md)
+ [SqlKnowledgeBaseConfiguration](API_agent_SqlKnowledgeBaseConfiguration.md)
+ [StorageConfiguration](API_agent_StorageConfiguration.md)
+ [StorageFlowNodeConfiguration](API_agent_StorageFlowNodeConfiguration.md)
+ [StorageFlowNodeS3Configuration](API_agent_StorageFlowNodeS3Configuration.md)
+ [StorageFlowNodeServiceConfiguration](API_agent_StorageFlowNodeServiceConfiguration.md)
+ [SupplementalDataStorageConfiguration](API_agent_SupplementalDataStorageConfiguration.md)
+ [SupplementalDataStorageLocation](API_agent_SupplementalDataStorageLocation.md)
+ [SystemContentBlock](API_agent_SystemContentBlock.md)
+ [TextContentDoc](API_agent_TextContentDoc.md)
+ [TextPromptTemplateConfiguration](API_agent_TextPromptTemplateConfiguration.md)
+ [Tool](API_agent_Tool.md)
+ [ToolChoice](API_agent_ToolChoice.md)
+ [ToolConfiguration](API_agent_ToolConfiguration.md)
+ [ToolInputSchema](API_agent_ToolInputSchema.md)
+ [ToolSpecification](API_agent_ToolSpecification.md)
+ [Transformation](API_agent_Transformation.md)
+ [TransformationFunction](API_agent_TransformationFunction.md)
+ [TransformationLambdaConfiguration](API_agent_TransformationLambdaConfiguration.md)
+ [UnfulfilledNodeInputFlowValidationDetails](API_agent_UnfulfilledNodeInputFlowValidationDetails.md)
+ [UnknownConnectionConditionFlowValidationDetails](API_agent_UnknownConnectionConditionFlowValidationDetails.md)
+ [UnknownConnectionSourceFlowValidationDetails](API_agent_UnknownConnectionSourceFlowValidationDetails.md)
+ [UnknownConnectionSourceOutputFlowValidationDetails](API_agent_UnknownConnectionSourceOutputFlowValidationDetails.md)
+ [UnknownConnectionTargetFlowValidationDetails](API_agent_UnknownConnectionTargetFlowValidationDetails.md)
+ [UnknownConnectionTargetInputFlowValidationDetails](API_agent_UnknownConnectionTargetInputFlowValidationDetails.md)
+ [UnknownNodeInputFlowValidationDetails](API_agent_UnknownNodeInputFlowValidationDetails.md)
+ [UnknownNodeOutputFlowValidationDetails](API_agent_UnknownNodeOutputFlowValidationDetails.md)
+ [UnreachableNodeFlowValidationDetails](API_agent_UnreachableNodeFlowValidationDetails.md)
+ [UnsatisfiedConnectionConditionsFlowValidationDetails](API_agent_UnsatisfiedConnectionConditionsFlowValidationDetails.md)
+ [UnspecifiedFlowValidationDetails](API_agent_UnspecifiedFlowValidationDetails.md)
+ [UrlConfiguration](API_agent_UrlConfiguration.md)
+ [ValidationExceptionField](API_agent_ValidationExceptionField.md)
+ [VectorIngestionConfiguration](API_agent_VectorIngestionConfiguration.md)
+ [VectorKnowledgeBaseConfiguration](API_agent_VectorKnowledgeBaseConfiguration.md)
+ [VectorSearchBedrockRerankingConfiguration](API_agent_VectorSearchBedrockRerankingConfiguration.md)
+ [VectorSearchBedrockRerankingModelConfiguration](API_agent_VectorSearchBedrockRerankingModelConfiguration.md)
+ [VectorSearchRerankingConfiguration](API_agent_VectorSearchRerankingConfiguration.md)
+ [VideoConfiguration](API_agent_VideoConfiguration.md)
+ [VideoSegmentationConfiguration](API_agent_VideoSegmentationConfiguration.md)
+ [WebCrawlerConfiguration](API_agent_WebCrawlerConfiguration.md)
+ [WebCrawlerLimits](API_agent_WebCrawlerLimits.md)
+ [WebDataSourceConfiguration](API_agent_WebDataSourceConfiguration.md)
+ [WebSourceConfiguration](API_agent_WebSourceConfiguration.md)
The following data types are supported by Agents for Amazon Bedrock Runtime:
+ [ActionGroupExecutor](API_agent-runtime_ActionGroupExecutor.md)
+ [ActionGroupInvocationInput](API_agent-runtime_ActionGroupInvocationInput.md)
+ [ActionGroupInvocationOutput](API_agent-runtime_ActionGroupInvocationOutput.md)
+ [AgentActionGroup](API_agent-runtime_AgentActionGroup.md)
+ [AgentCollaboratorInputPayload](API_agent-runtime_AgentCollaboratorInputPayload.md)
+ [AgentCollaboratorInvocationInput](API_agent-runtime_AgentCollaboratorInvocationInput.md)
+ [AgentCollaboratorInvocationOutput](API_agent-runtime_AgentCollaboratorInvocationOutput.md)
+ [AgentCollaboratorOutputPayload](API_agent-runtime_AgentCollaboratorOutputPayload.md)
+ [AnalyzePromptEvent](API_agent-runtime_AnalyzePromptEvent.md)
+ [ApiInvocationInput](API_agent-runtime_ApiInvocationInput.md)
+ [ApiParameter](API_agent-runtime_ApiParameter.md)
+ [ApiRequestBody](API_agent-runtime_ApiRequestBody.md)
+ [ApiResult](API_agent-runtime_ApiResult.md)
+ [APISchema](API_agent-runtime_APISchema.md)
+ [Attribution](API_agent-runtime_Attribution.md)
+ [AudioSegment](API_agent-runtime_AudioSegment.md)
+ [BedrockModelConfigurations](API_agent-runtime_BedrockModelConfigurations.md)
+ [BedrockRerankingConfiguration](API_agent-runtime_BedrockRerankingConfiguration.md)
+ [BedrockRerankingModelConfiguration](API_agent-runtime_BedrockRerankingModelConfiguration.md)
+ [BedrockSessionContentBlock](API_agent-runtime_BedrockSessionContentBlock.md)
+ [ByteContentDoc](API_agent-runtime_ByteContentDoc.md)
+ [ByteContentFile](API_agent-runtime_ByteContentFile.md)
+ [Caller](API_agent-runtime_Caller.md)
+ [Citation](API_agent-runtime_Citation.md)
+ [CitationEvent](API_agent-runtime_CitationEvent.md)
+ [CodeInterpreterInvocationInput](API_agent-runtime_CodeInterpreterInvocationInput.md)
+ [CodeInterpreterInvocationOutput](API_agent-runtime_CodeInterpreterInvocationOutput.md)
+ [Collaborator](API_agent-runtime_Collaborator.md)
+ [CollaboratorConfiguration](API_agent-runtime_CollaboratorConfiguration.md)
+ [ConditionResultEvent](API_agent-runtime_ConditionResultEvent.md)
+ [ContentBlock](API_agent-runtime_ContentBlock.md)
+ [ContentBody](API_agent-runtime_ContentBody.md)
+ [ConversationHistory](API_agent-runtime_ConversationHistory.md)
+ [CustomOrchestration](API_agent-runtime_CustomOrchestration.md)
+ [CustomOrchestrationTrace](API_agent-runtime_CustomOrchestrationTrace.md)
+ [CustomOrchestrationTraceEvent](API_agent-runtime_CustomOrchestrationTraceEvent.md)
+ [ExternalSource](API_agent-runtime_ExternalSource.md)
+ [ExternalSourcesGenerationConfiguration](API_agent-runtime_ExternalSourcesGenerationConfiguration.md)
+ [ExternalSourcesRetrieveAndGenerateConfiguration](API_agent-runtime_ExternalSourcesRetrieveAndGenerateConfiguration.md)
+ [FailureTrace](API_agent-runtime_FailureTrace.md)
+ [FieldForReranking](API_agent-runtime_FieldForReranking.md)
+ [FilePart](API_agent-runtime_FilePart.md)
+ [FileSource](API_agent-runtime_FileSource.md)
+ [FilterAttribute](API_agent-runtime_FilterAttribute.md)
+ [FinalResponse](API_agent-runtime_FinalResponse.md)
+ [FlowCompletionEvent](API_agent-runtime_FlowCompletionEvent.md)
+ [FlowExecutionContent](API_agent-runtime_FlowExecutionContent.md)
+ [FlowExecutionError](API_agent-runtime_FlowExecutionError.md)
+ [FlowExecutionEvent](API_agent-runtime_FlowExecutionEvent.md)
+ [FlowExecutionInputEvent](API_agent-runtime_FlowExecutionInputEvent.md)
+ [FlowExecutionOutputEvent](API_agent-runtime_FlowExecutionOutputEvent.md)
+ [FlowExecutionSummary](API_agent-runtime_FlowExecutionSummary.md)
+ [FlowFailureEvent](API_agent-runtime_FlowFailureEvent.md)
+ [FlowInput](API_agent-runtime_FlowInput.md)
+ [FlowInputContent](API_agent-runtime_FlowInputContent.md)
+ [FlowInputField](API_agent-runtime_FlowInputField.md)
+ [FlowMultiTurnInputContent](API_agent-runtime_FlowMultiTurnInputContent.md)
+ [FlowMultiTurnInputRequestEvent](API_agent-runtime_FlowMultiTurnInputRequestEvent.md)
+ [FlowOutputContent](API_agent-runtime_FlowOutputContent.md)
+ [FlowOutputEvent](API_agent-runtime_FlowOutputEvent.md)
+ [FlowOutputField](API_agent-runtime_FlowOutputField.md)
+ [FlowResponseStream](API_agent-runtime_FlowResponseStream.md)
+ [FlowTrace](API_agent-runtime_FlowTrace.md)
+ [FlowTraceCondition](API_agent-runtime_FlowTraceCondition.md)
+ [FlowTraceConditionNodeResultEvent](API_agent-runtime_FlowTraceConditionNodeResultEvent.md)
+ [FlowTraceDependencyEvent](API_agent-runtime_FlowTraceDependencyEvent.md)
+ [FlowTraceEvent](API_agent-runtime_FlowTraceEvent.md)
+ [FlowTraceNodeActionEvent](API_agent-runtime_FlowTraceNodeActionEvent.md)
+ [FlowTraceNodeInputContent](API_agent-runtime_FlowTraceNodeInputContent.md)
+ [FlowTraceNodeInputEvent](API_agent-runtime_FlowTraceNodeInputEvent.md)
+ [FlowTraceNodeInputExecutionChainItem](API_agent-runtime_FlowTraceNodeInputExecutionChainItem.md)
+ [FlowTraceNodeInputField](API_agent-runtime_FlowTraceNodeInputField.md)
+ [FlowTraceNodeInputSource](API_agent-runtime_FlowTraceNodeInputSource.md)
+ [FlowTraceNodeOutputContent](API_agent-runtime_FlowTraceNodeOutputContent.md)
+ [FlowTraceNodeOutputEvent](API_agent-runtime_FlowTraceNodeOutputEvent.md)
+ [FlowTraceNodeOutputField](API_agent-runtime_FlowTraceNodeOutputField.md)
+ [FlowTraceNodeOutputNext](API_agent-runtime_FlowTraceNodeOutputNext.md)
+ [FunctionDefinition](API_agent-runtime_FunctionDefinition.md)
+ [FunctionInvocationInput](API_agent-runtime_FunctionInvocationInput.md)
+ [FunctionParameter](API_agent-runtime_FunctionParameter.md)
+ [FunctionResult](API_agent-runtime_FunctionResult.md)
+ [FunctionSchema](API_agent-runtime_FunctionSchema.md)
+ [GeneratedQuery](API_agent-runtime_GeneratedQuery.md)
+ [GeneratedResponsePart](API_agent-runtime_GeneratedResponsePart.md)
+ [GenerationConfiguration](API_agent-runtime_GenerationConfiguration.md)
+ [GuardrailAssessment](API_agent-runtime_GuardrailAssessment.md)
+ [GuardrailConfiguration](API_agent-runtime_GuardrailConfiguration.md)
+ [GuardrailConfigurationWithArn](API_agent-runtime_GuardrailConfigurationWithArn.md)
+ [GuardrailContentFilter](API_agent-runtime_GuardrailContentFilter.md)
+ [GuardrailContentPolicyAssessment](API_agent-runtime_GuardrailContentPolicyAssessment.md)
+ [GuardrailCustomWord](API_agent-runtime_GuardrailCustomWord.md)
+ [GuardrailEvent](API_agent-runtime_GuardrailEvent.md)
+ [GuardrailManagedWord](API_agent-runtime_GuardrailManagedWord.md)
+ [GuardrailPiiEntityFilter](API_agent-runtime_GuardrailPiiEntityFilter.md)
+ [GuardrailRegexFilter](API_agent-runtime_GuardrailRegexFilter.md)
+ [GuardrailSensitiveInformationPolicyAssessment](API_agent-runtime_GuardrailSensitiveInformationPolicyAssessment.md)
+ [GuardrailTopic](API_agent-runtime_GuardrailTopic.md)
+ [GuardrailTopicPolicyAssessment](API_agent-runtime_GuardrailTopicPolicyAssessment.md)
+ [GuardrailTrace](API_agent-runtime_GuardrailTrace.md)
+ [GuardrailWordPolicyAssessment](API_agent-runtime_GuardrailWordPolicyAssessment.md)
+ [ImageBlock](API_agent-runtime_ImageBlock.md)
+ [ImageInput](API_agent-runtime_ImageInput.md)
+ [ImageInputSource](API_agent-runtime_ImageInputSource.md)
+ [ImageSource](API_agent-runtime_ImageSource.md)
+ [ImplicitFilterConfiguration](API_agent-runtime_ImplicitFilterConfiguration.md)
+ [InferenceConfig](API_agent-runtime_InferenceConfig.md)
+ [InferenceConfiguration](API_agent-runtime_InferenceConfiguration.md)
+ [InlineAgentFilePart](API_agent-runtime_InlineAgentFilePart.md)
+ [InlineAgentPayloadPart](API_agent-runtime_InlineAgentPayloadPart.md)
+ [InlineAgentResponseStream](API_agent-runtime_InlineAgentResponseStream.md)
+ [InlineAgentReturnControlPayload](API_agent-runtime_InlineAgentReturnControlPayload.md)
+ [InlineAgentTracePart](API_agent-runtime_InlineAgentTracePart.md)
+ [InlineBedrockModelConfigurations](API_agent-runtime_InlineBedrockModelConfigurations.md)
+ [InlineSessionState](API_agent-runtime_InlineSessionState.md)
+ [InputFile](API_agent-runtime_InputFile.md)
+ [InputImage](API_agent-runtime_InputImage.md)
+ [InputPrompt](API_agent-runtime_InputPrompt.md)
+ [InvocationInput](API_agent-runtime_InvocationInput.md)
+ [InvocationInputMember](API_agent-runtime_InvocationInputMember.md)
+ [InvocationResultMember](API_agent-runtime_InvocationResultMember.md)
+ [InvocationStep](API_agent-runtime_InvocationStep.md)
+ [InvocationStepPayload](API_agent-runtime_InvocationStepPayload.md)
+ [InvocationStepSummary](API_agent-runtime_InvocationStepSummary.md)
+ [InvocationSummary](API_agent-runtime_InvocationSummary.md)
+ [KnowledgeBase](API_agent-runtime_KnowledgeBase.md)
+ [KnowledgeBaseConfiguration](API_agent-runtime_KnowledgeBaseConfiguration.md)
+ [KnowledgeBaseLookupInput](API_agent-runtime_KnowledgeBaseLookupInput.md)
+ [KnowledgeBaseLookupOutput](API_agent-runtime_KnowledgeBaseLookupOutput.md)
+ [KnowledgeBaseQuery](API_agent-runtime_KnowledgeBaseQuery.md)
+ [KnowledgeBaseRetrievalConfiguration](API_agent-runtime_KnowledgeBaseRetrievalConfiguration.md)
+ [KnowledgeBaseRetrievalResult](API_agent-runtime_KnowledgeBaseRetrievalResult.md)
+ [KnowledgeBaseRetrieveAndGenerateConfiguration](API_agent-runtime_KnowledgeBaseRetrieveAndGenerateConfiguration.md)
+ [KnowledgeBaseVectorSearchConfiguration](API_agent-runtime_KnowledgeBaseVectorSearchConfiguration.md)
+ [Memory](API_agent-runtime_Memory.md)
+ [MemorySessionSummary](API_agent-runtime_MemorySessionSummary.md)
+ [Message](API_agent-runtime_Message.md)
+ [Metadata](API_agent-runtime_Metadata.md)
+ [MetadataAttributeSchema](API_agent-runtime_MetadataAttributeSchema.md)
+ [MetadataConfigurationForReranking](API_agent-runtime_MetadataConfigurationForReranking.md)
+ [ModelInvocationInput](API_agent-runtime_ModelInvocationInput.md)
+ [ModelPerformanceConfiguration](API_agent-runtime_ModelPerformanceConfiguration.md)
+ [NodeActionEvent](API_agent-runtime_NodeActionEvent.md)
+ [NodeDependencyEvent](API_agent-runtime_NodeDependencyEvent.md)
+ [NodeExecutionContent](API_agent-runtime_NodeExecutionContent.md)
+ [NodeFailureEvent](API_agent-runtime_NodeFailureEvent.md)
+ [NodeInputEvent](API_agent-runtime_NodeInputEvent.md)
+ [NodeInputExecutionChainItem](API_agent-runtime_NodeInputExecutionChainItem.md)
+ [NodeInputField](API_agent-runtime_NodeInputField.md)
+ [NodeInputSource](API_agent-runtime_NodeInputSource.md)
+ [NodeOutputEvent](API_agent-runtime_NodeOutputEvent.md)
+ [NodeOutputField](API_agent-runtime_NodeOutputField.md)
+ [NodeOutputNext](API_agent-runtime_NodeOutputNext.md)
+ [NodeTraceElements](API_agent-runtime_NodeTraceElements.md)
+ [Observation](API_agent-runtime_Observation.md)
+ [OptimizedPrompt](API_agent-runtime_OptimizedPrompt.md)
+ [OptimizedPromptEvent](API_agent-runtime_OptimizedPromptEvent.md)
+ [OptimizedPromptStream](API_agent-runtime_OptimizedPromptStream.md)
+ [OrchestrationConfiguration](API_agent-runtime_OrchestrationConfiguration.md)
+ [OrchestrationExecutor](API_agent-runtime_OrchestrationExecutor.md)
+ [OrchestrationModelInvocationOutput](API_agent-runtime_OrchestrationModelInvocationOutput.md)
+ [OrchestrationTrace](API_agent-runtime_OrchestrationTrace.md)
+ [OutputFile](API_agent-runtime_OutputFile.md)
+ [Parameter](API_agent-runtime_Parameter.md)
+ [ParameterDetail](API_agent-runtime_ParameterDetail.md)
+ [PayloadPart](API_agent-runtime_PayloadPart.md)
+ [PerformanceConfiguration](API_agent-runtime_PerformanceConfiguration.md)
+ [PostProcessingModelInvocationOutput](API_agent-runtime_PostProcessingModelInvocationOutput.md)
+ [PostProcessingParsedResponse](API_agent-runtime_PostProcessingParsedResponse.md)
+ [PostProcessingTrace](API_agent-runtime_PostProcessingTrace.md)
+ [PreProcessingModelInvocationOutput](API_agent-runtime_PreProcessingModelInvocationOutput.md)
+ [PreProcessingParsedResponse](API_agent-runtime_PreProcessingParsedResponse.md)
+ [PreProcessingTrace](API_agent-runtime_PreProcessingTrace.md)
+ [PromptConfiguration](API_agent-runtime_PromptConfiguration.md)
+ [PromptCreationConfigurations](API_agent-runtime_PromptCreationConfigurations.md)
+ [PromptOverrideConfiguration](API_agent-runtime_PromptOverrideConfiguration.md)
+ [PromptTemplate](API_agent-runtime_PromptTemplate.md)
+ [PropertyParameters](API_agent-runtime_PropertyParameters.md)
+ [QueryGenerationInput](API_agent-runtime_QueryGenerationInput.md)
+ [QueryTransformationConfiguration](API_agent-runtime_QueryTransformationConfiguration.md)
+ [Rationale](API_agent-runtime_Rationale.md)
+ [RawResponse](API_agent-runtime_RawResponse.md)
+ [ReasoningContentBlock](API_agent-runtime_ReasoningContentBlock.md)
+ [ReasoningTextBlock](API_agent-runtime_ReasoningTextBlock.md)
+ [RepromptResponse](API_agent-runtime_RepromptResponse.md)
+ [RequestBody](API_agent-runtime_RequestBody.md)
+ [RerankDocument](API_agent-runtime_RerankDocument.md)
+ [RerankingConfiguration](API_agent-runtime_RerankingConfiguration.md)
+ [RerankingMetadataSelectiveModeConfiguration](API_agent-runtime_RerankingMetadataSelectiveModeConfiguration.md)
+ [RerankQuery](API_agent-runtime_RerankQuery.md)
+ [RerankResult](API_agent-runtime_RerankResult.md)
+ [RerankSource](API_agent-runtime_RerankSource.md)
+ [RerankTextDocument](API_agent-runtime_RerankTextDocument.md)
+ [ResponseStream](API_agent-runtime_ResponseStream.md)
+ [RetrievalFilter](API_agent-runtime_RetrievalFilter.md)
+ [RetrievalResultConfluenceLocation](API_agent-runtime_RetrievalResultConfluenceLocation.md)
+ [RetrievalResultContent](API_agent-runtime_RetrievalResultContent.md)
+ [RetrievalResultContentColumn](API_agent-runtime_RetrievalResultContentColumn.md)
+ [RetrievalResultCustomDocumentLocation](API_agent-runtime_RetrievalResultCustomDocumentLocation.md)
+ [RetrievalResultKendraDocumentLocation](API_agent-runtime_RetrievalResultKendraDocumentLocation.md)
+ [RetrievalResultLocation](API_agent-runtime_RetrievalResultLocation.md)
+ [RetrievalResultS3Location](API_agent-runtime_RetrievalResultS3Location.md)
+ [RetrievalResultSalesforceLocation](API_agent-runtime_RetrievalResultSalesforceLocation.md)
+ [RetrievalResultSharePointLocation](API_agent-runtime_RetrievalResultSharePointLocation.md)
+ [RetrievalResultSqlLocation](API_agent-runtime_RetrievalResultSqlLocation.md)
+ [RetrievalResultWebLocation](API_agent-runtime_RetrievalResultWebLocation.md)
+ [RetrieveAndGenerateConfiguration](API_agent-runtime_RetrieveAndGenerateConfiguration.md)
+ [RetrieveAndGenerateInput](API_agent-runtime_RetrieveAndGenerateInput.md)
+ [RetrieveAndGenerateOutput](API_agent-runtime_RetrieveAndGenerateOutput.md)
+ [RetrieveAndGenerateOutputEvent](API_agent-runtime_RetrieveAndGenerateOutputEvent.md)
+ [RetrieveAndGenerateSessionConfiguration](API_agent-runtime_RetrieveAndGenerateSessionConfiguration.md)
+ [RetrieveAndGenerateStreamResponseOutput](API_agent-runtime_RetrieveAndGenerateStreamResponseOutput.md)
+ [RetrievedReference](API_agent-runtime_RetrievedReference.md)
+ [ReturnControlPayload](API_agent-runtime_ReturnControlPayload.md)
+ [ReturnControlResults](API_agent-runtime_ReturnControlResults.md)
+ [RoutingClassifierModelInvocationOutput](API_agent-runtime_RoutingClassifierModelInvocationOutput.md)
+ [RoutingClassifierTrace](API_agent-runtime_RoutingClassifierTrace.md)
+ [S3Identifier](API_agent-runtime_S3Identifier.md)
+ [S3Location](API_agent-runtime_S3Location.md)
+ [S3ObjectDoc](API_agent-runtime_S3ObjectDoc.md)
+ [S3ObjectFile](API_agent-runtime_S3ObjectFile.md)
+ [SatisfiedCondition](API_agent-runtime_SatisfiedCondition.md)
+ [SessionState](API_agent-runtime_SessionState.md)
+ [SessionSummary](API_agent-runtime_SessionSummary.md)
+ [Span](API_agent-runtime_Span.md)
+ [StreamingConfigurations](API_agent-runtime_StreamingConfigurations.md)
+ [TextInferenceConfig](API_agent-runtime_TextInferenceConfig.md)
+ [TextPrompt](API_agent-runtime_TextPrompt.md)
+ [TextResponsePart](API_agent-runtime_TextResponsePart.md)
+ [TextToSqlConfiguration](API_agent-runtime_TextToSqlConfiguration.md)
+ [TextToSqlKnowledgeBaseConfiguration](API_agent-runtime_TextToSqlKnowledgeBaseConfiguration.md)
+ [Trace](API_agent-runtime_Trace.md)
+ [TraceElements](API_agent-runtime_TraceElements.md)
+ [TracePart](API_agent-runtime_TracePart.md)
+ [TransformationConfiguration](API_agent-runtime_TransformationConfiguration.md)
+ [Usage](API_agent-runtime_Usage.md)
+ [VectorSearchBedrockRerankingConfiguration](API_agent-runtime_VectorSearchBedrockRerankingConfiguration.md)
+ [VectorSearchBedrockRerankingModelConfiguration](API_agent-runtime_VectorSearchBedrockRerankingModelConfiguration.md)
+ [VectorSearchRerankingConfiguration](API_agent-runtime_VectorSearchRerankingConfiguration.md)
+ [VideoSegment](API_agent-runtime_VideoSegment.md)
The following data types are supported by Data Automation for Amazon Bedrock:
+ [AudioExtractionCategory](API_data-automation_AudioExtractionCategory.md)
+ [AudioExtractionCategoryTypeConfiguration](API_data-automation_AudioExtractionCategoryTypeConfiguration.md)
+ [AudioLanguageConfiguration](API_data-automation_AudioLanguageConfiguration.md)
+ [AudioOverrideConfiguration](API_data-automation_AudioOverrideConfiguration.md)
+ [AudioStandardExtraction](API_data-automation_AudioStandardExtraction.md)
+ [AudioStandardGenerativeField](API_data-automation_AudioStandardGenerativeField.md)
+ [AudioStandardOutputConfiguration](API_data-automation_AudioStandardOutputConfiguration.md)
+ [Blueprint](API_data-automation_Blueprint.md)
+ [BlueprintFilter](API_data-automation_BlueprintFilter.md)
+ [BlueprintItem](API_data-automation_BlueprintItem.md)
+ [BlueprintOptimizationObject](API_data-automation_BlueprintOptimizationObject.md)
+ [BlueprintOptimizationOutputConfiguration](API_data-automation_BlueprintOptimizationOutputConfiguration.md)
+ [BlueprintOptimizationSample](API_data-automation_BlueprintOptimizationSample.md)
+ [BlueprintSummary](API_data-automation_BlueprintSummary.md)
+ [ChannelLabelingConfiguration](API_data-automation_ChannelLabelingConfiguration.md)
+ [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md)
+ [DataAutomationLibrary](API_data-automation_DataAutomationLibrary.md)
+ [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md)
+ [DataAutomationLibraryEntitySummary](API_data-automation_DataAutomationLibraryEntitySummary.md)
+ [DataAutomationLibraryFilter](API_data-automation_DataAutomationLibraryFilter.md)
+ [DataAutomationLibraryIngestionJob](API_data-automation_DataAutomationLibraryIngestionJob.md)
+ [DataAutomationLibraryIngestionJobSummary](API_data-automation_DataAutomationLibraryIngestionJobSummary.md)
+ [DataAutomationLibraryItem](API_data-automation_DataAutomationLibraryItem.md)
+ [DataAutomationLibrarySummary](API_data-automation_DataAutomationLibrarySummary.md)
+ [DataAutomationProject](API_data-automation_DataAutomationProject.md)
+ [DataAutomationProjectFilter](API_data-automation_DataAutomationProjectFilter.md)
+ [DataAutomationProjectSummary](API_data-automation_DataAutomationProjectSummary.md)
+ [DeleteEntitiesInfo](API_data-automation_DeleteEntitiesInfo.md)
+ [DocumentBoundingBox](API_data-automation_DocumentBoundingBox.md)
+ [DocumentExtractionGranularity](API_data-automation_DocumentExtractionGranularity.md)
+ [DocumentOutputAdditionalFileFormat](API_data-automation_DocumentOutputAdditionalFileFormat.md)
+ [DocumentOutputFormat](API_data-automation_DocumentOutputFormat.md)
+ [DocumentOutputTextFormat](API_data-automation_DocumentOutputTextFormat.md)
+ [DocumentOverrideConfiguration](API_data-automation_DocumentOverrideConfiguration.md)
+ [DocumentStandardExtraction](API_data-automation_DocumentStandardExtraction.md)
+ [DocumentStandardGenerativeField](API_data-automation_DocumentStandardGenerativeField.md)
+ [DocumentStandardOutputConfiguration](API_data-automation_DocumentStandardOutputConfiguration.md)
+ [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md)
+ [EntityDetails](API_data-automation_EntityDetails.md)
+ [EntityTypeInfo](API_data-automation_EntityTypeInfo.md)
+ [EventBridgeConfiguration](API_data-automation_EventBridgeConfiguration.md)
+ [ImageBoundingBox](API_data-automation_ImageBoundingBox.md)
+ [ImageExtractionCategory](API_data-automation_ImageExtractionCategory.md)
+ [ImageOverrideConfiguration](API_data-automation_ImageOverrideConfiguration.md)
+ [ImageStandardExtraction](API_data-automation_ImageStandardExtraction.md)
+ [ImageStandardGenerativeField](API_data-automation_ImageStandardGenerativeField.md)
+ [ImageStandardOutputConfiguration](API_data-automation_ImageStandardOutputConfiguration.md)
+ [InlinePayload](API_data-automation_InlinePayload.md)
+ [InputConfiguration](API_data-automation_InputConfiguration.md)
+ [ModalityProcessingConfiguration](API_data-automation_ModalityProcessingConfiguration.md)
+ [ModalityRoutingConfiguration](API_data-automation_ModalityRoutingConfiguration.md)
+ [NotificationConfiguration](API_data-automation_NotificationConfiguration.md)
+ [OutputConfiguration](API_data-automation_OutputConfiguration.md)
+ [OverrideConfiguration](API_data-automation_OverrideConfiguration.md)
+ [Phrase](API_data-automation_Phrase.md)
+ [PIIEntitiesConfiguration](API_data-automation_PIIEntitiesConfiguration.md)
+ [S3Object](API_data-automation_S3Object.md)
+ [SensitiveDataConfiguration](API_data-automation_SensitiveDataConfiguration.md)
+ [SpeakerLabelingConfiguration](API_data-automation_SpeakerLabelingConfiguration.md)
+ [SplitterConfiguration](API_data-automation_SplitterConfiguration.md)
+ [StandardOutputConfiguration](API_data-automation_StandardOutputConfiguration.md)
+ [Tag](API_data-automation_Tag.md)
+ [TranscriptConfiguration](API_data-automation_TranscriptConfiguration.md)
+ [UpsertEntityInfo](API_data-automation_UpsertEntityInfo.md)
+ [ValidationExceptionField](API_data-automation_ValidationExceptionField.md)
+ [VideoBoundingBox](API_data-automation_VideoBoundingBox.md)
+ [VideoExtractionCategory](API_data-automation_VideoExtractionCategory.md)
+ [VideoOverrideConfiguration](API_data-automation_VideoOverrideConfiguration.md)
+ [VideoStandardExtraction](API_data-automation_VideoStandardExtraction.md)
+ [VideoStandardGenerativeField](API_data-automation_VideoStandardGenerativeField.md)
+ [VideoStandardOutputConfiguration](API_data-automation_VideoStandardOutputConfiguration.md)
+ [VocabularyEntity](API_data-automation_VocabularyEntity.md)
+ [VocabularyEntityInfo](API_data-automation_VocabularyEntityInfo.md)
+ [VocabularyEntitySummary](API_data-automation_VocabularyEntitySummary.md)
The following data types are supported by Runtime for Amazon Bedrock Data Automation:
+ [AssetProcessingConfiguration](API_data-automation-runtime_AssetProcessingConfiguration.md)
+ [Blueprint](API_data-automation-runtime_Blueprint.md)
+ [DataAutomationConfiguration](API_data-automation-runtime_DataAutomationConfiguration.md)
+ [EncryptionConfiguration](API_data-automation-runtime_EncryptionConfiguration.md)
+ [EventBridgeConfiguration](API_data-automation-runtime_EventBridgeConfiguration.md)
+ [InputConfiguration](API_data-automation-runtime_InputConfiguration.md)
+ [NotificationConfiguration](API_data-automation-runtime_NotificationConfiguration.md)
+ [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md)
+ [OutputSegment](API_data-automation-runtime_OutputSegment.md)
+ [SyncInputConfiguration](API_data-automation-runtime_SyncInputConfiguration.md)
+ [Tag](API_data-automation-runtime_Tag.md)
+ [TimestampSegment](API_data-automation-runtime_TimestampSegment.md)
+ [VideoAssetProcessingConfiguration](API_data-automation-runtime_VideoAssetProcessingConfiguration.md)
+ [VideoSegmentConfiguration](API_data-automation-runtime_VideoSegmentConfiguration.md)
The following data types are supported by Amazon Bedrock Runtime:
+ [AnyToolChoice](API_runtime_AnyToolChoice.md)
+ [AppliedGuardrailDetails](API_runtime_AppliedGuardrailDetails.md)
+ [AsyncInvokeOutputDataConfig](API_runtime_AsyncInvokeOutputDataConfig.md)
+ [AsyncInvokeS3OutputDataConfig](API_runtime_AsyncInvokeS3OutputDataConfig.md)
+ [AsyncInvokeSummary](API_runtime_AsyncInvokeSummary.md)
+ [AudioBlock](API_runtime_AudioBlock.md)
+ [AudioSource](API_runtime_AudioSource.md)
+ [AutoToolChoice](API_runtime_AutoToolChoice.md)
+ [BidirectionalInputPayloadPart](API_runtime_BidirectionalInputPayloadPart.md)
+ [BidirectionalOutputPayloadPart](API_runtime_BidirectionalOutputPayloadPart.md)
+ [CacheDetail](API_runtime_CacheDetail.md)
+ [CachePointBlock](API_runtime_CachePointBlock.md)
+ [Citation](API_runtime_Citation.md)
+ [CitationGeneratedContent](API_runtime_CitationGeneratedContent.md)
+ [CitationLocation](API_runtime_CitationLocation.md)
+ [CitationsConfig](API_runtime_CitationsConfig.md)
+ [CitationsContentBlock](API_runtime_CitationsContentBlock.md)
+ [CitationsDelta](API_runtime_CitationsDelta.md)
+ [CitationSourceContent](API_runtime_CitationSourceContent.md)
+ [CitationSourceContentDelta](API_runtime_CitationSourceContentDelta.md)
+ [ContentBlock](API_runtime_ContentBlock.md)
+ [ContentBlockDelta](API_runtime_ContentBlockDelta.md)
+ [ContentBlockDeltaEvent](API_runtime_ContentBlockDeltaEvent.md)
+ [ContentBlockStart](API_runtime_ContentBlockStart.md)
+ [ContentBlockStartEvent](API_runtime_ContentBlockStartEvent.md)
+ [ContentBlockStopEvent](API_runtime_ContentBlockStopEvent.md)
+ [ConverseMetrics](API_runtime_ConverseMetrics.md)
+ [ConverseOutput](API_runtime_ConverseOutput.md)
+ [ConverseStreamMetadataEvent](API_runtime_ConverseStreamMetadataEvent.md)
+ [ConverseStreamMetrics](API_runtime_ConverseStreamMetrics.md)
+ [ConverseStreamOutput](API_runtime_ConverseStreamOutput.md)
+ [ConverseStreamTrace](API_runtime_ConverseStreamTrace.md)
+ [ConverseTokensRequest](API_runtime_ConverseTokensRequest.md)
+ [ConverseTrace](API_runtime_ConverseTrace.md)
+ [CountTokensInput](API_runtime_CountTokensInput.md)
+ [DocumentBlock](API_runtime_DocumentBlock.md)
+ [DocumentCharLocation](API_runtime_DocumentCharLocation.md)
+ [DocumentChunkLocation](API_runtime_DocumentChunkLocation.md)
+ [DocumentContentBlock](API_runtime_DocumentContentBlock.md)
+ [DocumentPageLocation](API_runtime_DocumentPageLocation.md)
+ [DocumentSource](API_runtime_DocumentSource.md)
+ [ErrorBlock](API_runtime_ErrorBlock.md)
+ [GuardrailAssessment](API_runtime_GuardrailAssessment.md)
+ [GuardrailAutomatedReasoningFinding](API_runtime_GuardrailAutomatedReasoningFinding.md)
+ [GuardrailAutomatedReasoningImpossibleFinding](API_runtime_GuardrailAutomatedReasoningImpossibleFinding.md)
+ [GuardrailAutomatedReasoningInputTextReference](API_runtime_GuardrailAutomatedReasoningInputTextReference.md)
+ [GuardrailAutomatedReasoningInvalidFinding](API_runtime_GuardrailAutomatedReasoningInvalidFinding.md)
+ [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md)
+ [GuardrailAutomatedReasoningNoTranslationsFinding](API_runtime_GuardrailAutomatedReasoningNoTranslationsFinding.md)
+ [GuardrailAutomatedReasoningPolicyAssessment](API_runtime_GuardrailAutomatedReasoningPolicyAssessment.md)
+ [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md)
+ [GuardrailAutomatedReasoningSatisfiableFinding](API_runtime_GuardrailAutomatedReasoningSatisfiableFinding.md)
+ [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md)
+ [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md)
+ [GuardrailAutomatedReasoningTooComplexFinding](API_runtime_GuardrailAutomatedReasoningTooComplexFinding.md)
+ [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md)
+ [GuardrailAutomatedReasoningTranslationAmbiguousFinding](API_runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding.md)
+ [GuardrailAutomatedReasoningTranslationOption](API_runtime_GuardrailAutomatedReasoningTranslationOption.md)
+ [GuardrailAutomatedReasoningValidFinding](API_runtime_GuardrailAutomatedReasoningValidFinding.md)
+ [GuardrailConfiguration](API_runtime_GuardrailConfiguration.md)
+ [GuardrailContentBlock](API_runtime_GuardrailContentBlock.md)
+ [GuardrailContentFilter](API_runtime_GuardrailContentFilter.md)
+ [GuardrailContentPolicyAssessment](API_runtime_GuardrailContentPolicyAssessment.md)
+ [GuardrailContextualGroundingFilter](API_runtime_GuardrailContextualGroundingFilter.md)
+ [GuardrailContextualGroundingPolicyAssessment](API_runtime_GuardrailContextualGroundingPolicyAssessment.md)
+ [GuardrailConverseContentBlock](API_runtime_GuardrailConverseContentBlock.md)
+ [GuardrailConverseImageBlock](API_runtime_GuardrailConverseImageBlock.md)
+ [GuardrailConverseImageSource](API_runtime_GuardrailConverseImageSource.md)
+ [GuardrailConverseTextBlock](API_runtime_GuardrailConverseTextBlock.md)
+ [GuardrailCoverage](API_runtime_GuardrailCoverage.md)
+ [GuardrailCustomWord](API_runtime_GuardrailCustomWord.md)
+ [GuardrailImageBlock](API_runtime_GuardrailImageBlock.md)
+ [GuardrailImageCoverage](API_runtime_GuardrailImageCoverage.md)
+ [GuardrailImageSource](API_runtime_GuardrailImageSource.md)
+ [GuardrailInvocationMetrics](API_runtime_GuardrailInvocationMetrics.md)
+ [GuardrailManagedWord](API_runtime_GuardrailManagedWord.md)
+ [GuardrailOutputContent](API_runtime_GuardrailOutputContent.md)
+ [GuardrailPiiEntityFilter](API_runtime_GuardrailPiiEntityFilter.md)
+ [GuardrailRegexFilter](API_runtime_GuardrailRegexFilter.md)
+ [GuardrailSensitiveInformationPolicyAssessment](API_runtime_GuardrailSensitiveInformationPolicyAssessment.md)
+ [GuardrailStreamConfiguration](API_runtime_GuardrailStreamConfiguration.md)
+ [GuardrailTextBlock](API_runtime_GuardrailTextBlock.md)
+ [GuardrailTextCharactersCoverage](API_runtime_GuardrailTextCharactersCoverage.md)
+ [GuardrailTopic](API_runtime_GuardrailTopic.md)
+ [GuardrailTopicPolicyAssessment](API_runtime_GuardrailTopicPolicyAssessment.md)
+ [GuardrailTraceAssessment](API_runtime_GuardrailTraceAssessment.md)
+ [GuardrailUsage](API_runtime_GuardrailUsage.md)
+ [GuardrailWordPolicyAssessment](API_runtime_GuardrailWordPolicyAssessment.md)
+ [ImageBlock](API_runtime_ImageBlock.md)
+ [ImageBlockDelta](API_runtime_ImageBlockDelta.md)
+ [ImageBlockStart](API_runtime_ImageBlockStart.md)
+ [ImageSource](API_runtime_ImageSource.md)
+ [InferenceConfiguration](API_runtime_InferenceConfiguration.md)
+ [InvokeModelTokensRequest](API_runtime_InvokeModelTokensRequest.md)
+ [InvokeModelWithBidirectionalStreamInput](API_runtime_InvokeModelWithBidirectionalStreamInput.md)
+ [InvokeModelWithBidirectionalStreamOutput](API_runtime_InvokeModelWithBidirectionalStreamOutput.md)
+ [JsonSchemaDefinition](API_runtime_JsonSchemaDefinition.md)
+ [Message](API_runtime_Message.md)
+ [MessageStartEvent](API_runtime_MessageStartEvent.md)
+ [MessageStopEvent](API_runtime_MessageStopEvent.md)
+ [OutputConfig](API_runtime_OutputConfig.md)
+ [OutputFormat](API_runtime_OutputFormat.md)
+ [OutputFormatStructure](API_runtime_OutputFormatStructure.md)
+ [PayloadPart](API_runtime_PayloadPart.md)
+ [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md)
+ [PromptRouterTrace](API_runtime_PromptRouterTrace.md)
+ [PromptVariableValues](API_runtime_PromptVariableValues.md)
+ [ReasoningContentBlock](API_runtime_ReasoningContentBlock.md)
+ [ReasoningContentBlockDelta](API_runtime_ReasoningContentBlockDelta.md)
+ [ReasoningTextBlock](API_runtime_ReasoningTextBlock.md)
+ [ResponseStream](API_runtime_ResponseStream.md)
+ [S3Location](API_runtime_S3Location.md)
+ [SearchResultBlock](API_runtime_SearchResultBlock.md)
+ [SearchResultContentBlock](API_runtime_SearchResultContentBlock.md)
+ [SearchResultLocation](API_runtime_SearchResultLocation.md)
+ [ServiceTier](API_runtime_ServiceTier.md)
+ [SpecificToolChoice](API_runtime_SpecificToolChoice.md)
+ [SystemContentBlock](API_runtime_SystemContentBlock.md)
+ [SystemTool](API_runtime_SystemTool.md)
+ [Tag](API_runtime_Tag.md)
+ [TokenUsage](API_runtime_TokenUsage.md)
+ [Tool](API_runtime_Tool.md)
+ [ToolChoice](API_runtime_ToolChoice.md)
+ [ToolConfiguration](API_runtime_ToolConfiguration.md)
+ [ToolInputSchema](API_runtime_ToolInputSchema.md)
+ [ToolResultBlock](API_runtime_ToolResultBlock.md)
+ [ToolResultBlockDelta](API_runtime_ToolResultBlockDelta.md)
+ [ToolResultBlockStart](API_runtime_ToolResultBlockStart.md)
+ [ToolResultContentBlock](API_runtime_ToolResultContentBlock.md)
+ [ToolSpecification](API_runtime_ToolSpecification.md)
+ [ToolUseBlock](API_runtime_ToolUseBlock.md)
+ [ToolUseBlockDelta](API_runtime_ToolUseBlockDelta.md)
+ [ToolUseBlockStart](API_runtime_ToolUseBlockStart.md)
+ [VideoBlock](API_runtime_VideoBlock.md)
+ [VideoSource](API_runtime_VideoSource.md)
+ [WebLocation](API_runtime_WebLocation.md)
# Amazon Bedrock
The following data types are supported by Amazon Bedrock:
+ [AccountEnforcedGuardrailInferenceInputConfiguration](API_AccountEnforcedGuardrailInferenceInputConfiguration.md)
+ [AccountEnforcedGuardrailOutputConfiguration](API_AccountEnforcedGuardrailOutputConfiguration.md)
+ [AgreementAvailability](API_AgreementAvailability.md)
+ [AutomatedEvaluationConfig](API_AutomatedEvaluationConfig.md)
+ [AutomatedEvaluationCustomMetricConfig](API_AutomatedEvaluationCustomMetricConfig.md)
+ [AutomatedEvaluationCustomMetricSource](API_AutomatedEvaluationCustomMetricSource.md)
+ [AutomatedReasoningCheckFinding](API_AutomatedReasoningCheckFinding.md)
+ [AutomatedReasoningCheckImpossibleFinding](API_AutomatedReasoningCheckImpossibleFinding.md)
+ [AutomatedReasoningCheckInputTextReference](API_AutomatedReasoningCheckInputTextReference.md)
+ [AutomatedReasoningCheckInvalidFinding](API_AutomatedReasoningCheckInvalidFinding.md)
+ [AutomatedReasoningCheckLogicWarning](API_AutomatedReasoningCheckLogicWarning.md)
+ [AutomatedReasoningCheckNoTranslationsFinding](API_AutomatedReasoningCheckNoTranslationsFinding.md)
+ [AutomatedReasoningCheckRule](API_AutomatedReasoningCheckRule.md)
+ [AutomatedReasoningCheckSatisfiableFinding](API_AutomatedReasoningCheckSatisfiableFinding.md)
+ [AutomatedReasoningCheckScenario](API_AutomatedReasoningCheckScenario.md)
+ [AutomatedReasoningCheckTooComplexFinding](API_AutomatedReasoningCheckTooComplexFinding.md)
+ [AutomatedReasoningCheckTranslation](API_AutomatedReasoningCheckTranslation.md)
+ [AutomatedReasoningCheckTranslationAmbiguousFinding](API_AutomatedReasoningCheckTranslationAmbiguousFinding.md)
+ [AutomatedReasoningCheckTranslationOption](API_AutomatedReasoningCheckTranslationOption.md)
+ [AutomatedReasoningCheckValidFinding](API_AutomatedReasoningCheckValidFinding.md)
+ [AutomatedReasoningLogicStatement](API_AutomatedReasoningLogicStatement.md)
+ [AutomatedReasoningPolicyAddRuleAnnotation](API_AutomatedReasoningPolicyAddRuleAnnotation.md)
+ [AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation](API_AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation.md)
+ [AutomatedReasoningPolicyAddRuleMutation](API_AutomatedReasoningPolicyAddRuleMutation.md)
+ [AutomatedReasoningPolicyAddTypeAnnotation](API_AutomatedReasoningPolicyAddTypeAnnotation.md)
+ [AutomatedReasoningPolicyAddTypeMutation](API_AutomatedReasoningPolicyAddTypeMutation.md)
+ [AutomatedReasoningPolicyAddTypeValue](API_AutomatedReasoningPolicyAddTypeValue.md)
+ [AutomatedReasoningPolicyAddVariableAnnotation](API_AutomatedReasoningPolicyAddVariableAnnotation.md)
+ [AutomatedReasoningPolicyAddVariableMutation](API_AutomatedReasoningPolicyAddVariableMutation.md)
+ [AutomatedReasoningPolicyAnnotatedChunk](API_AutomatedReasoningPolicyAnnotatedChunk.md)
+ [AutomatedReasoningPolicyAnnotatedContent](API_AutomatedReasoningPolicyAnnotatedContent.md)
+ [AutomatedReasoningPolicyAnnotatedLine](API_AutomatedReasoningPolicyAnnotatedLine.md)
+ [AutomatedReasoningPolicyAnnotation](API_AutomatedReasoningPolicyAnnotation.md)
+ [AutomatedReasoningPolicyAtomicStatement](API_AutomatedReasoningPolicyAtomicStatement.md)
+ [AutomatedReasoningPolicyBuildLog](API_AutomatedReasoningPolicyBuildLog.md)
+ [AutomatedReasoningPolicyBuildLogEntry](API_AutomatedReasoningPolicyBuildLogEntry.md)
+ [AutomatedReasoningPolicyBuildResultAssetManifest](API_AutomatedReasoningPolicyBuildResultAssetManifest.md)
+ [AutomatedReasoningPolicyBuildResultAssetManifestEntry](API_AutomatedReasoningPolicyBuildResultAssetManifestEntry.md)
+ [AutomatedReasoningPolicyBuildResultAssets](API_AutomatedReasoningPolicyBuildResultAssets.md)
+ [AutomatedReasoningPolicyBuildStep](API_AutomatedReasoningPolicyBuildStep.md)
+ [AutomatedReasoningPolicyBuildStepContext](API_AutomatedReasoningPolicyBuildStepContext.md)
+ [AutomatedReasoningPolicyBuildStepMessage](API_AutomatedReasoningPolicyBuildStepMessage.md)
+ [AutomatedReasoningPolicyBuildWorkflowDocument](API_AutomatedReasoningPolicyBuildWorkflowDocument.md)
+ [AutomatedReasoningPolicyBuildWorkflowRepairContent](API_AutomatedReasoningPolicyBuildWorkflowRepairContent.md)
+ [AutomatedReasoningPolicyBuildWorkflowSource](API_AutomatedReasoningPolicyBuildWorkflowSource.md)
+ [AutomatedReasoningPolicyBuildWorkflowSummary](API_AutomatedReasoningPolicyBuildWorkflowSummary.md)
+ [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md)
+ [AutomatedReasoningPolicyDefinitionElement](API_AutomatedReasoningPolicyDefinitionElement.md)
+ [AutomatedReasoningPolicyDefinitionQualityReport](API_AutomatedReasoningPolicyDefinitionQualityReport.md)
+ [AutomatedReasoningPolicyDefinitionRule](API_AutomatedReasoningPolicyDefinitionRule.md)
+ [AutomatedReasoningPolicyDefinitionType](API_AutomatedReasoningPolicyDefinitionType.md)
+ [AutomatedReasoningPolicyDefinitionTypeValue](API_AutomatedReasoningPolicyDefinitionTypeValue.md)
+ [AutomatedReasoningPolicyDefinitionTypeValuePair](API_AutomatedReasoningPolicyDefinitionTypeValuePair.md)
+ [AutomatedReasoningPolicyDefinitionVariable](API_AutomatedReasoningPolicyDefinitionVariable.md)
+ [AutomatedReasoningPolicyDeleteRuleAnnotation](API_AutomatedReasoningPolicyDeleteRuleAnnotation.md)
+ [AutomatedReasoningPolicyDeleteRuleMutation](API_AutomatedReasoningPolicyDeleteRuleMutation.md)
+ [AutomatedReasoningPolicyDeleteTypeAnnotation](API_AutomatedReasoningPolicyDeleteTypeAnnotation.md)
+ [AutomatedReasoningPolicyDeleteTypeMutation](API_AutomatedReasoningPolicyDeleteTypeMutation.md)
+ [AutomatedReasoningPolicyDeleteTypeValue](API_AutomatedReasoningPolicyDeleteTypeValue.md)
+ [AutomatedReasoningPolicyDeleteVariableAnnotation](API_AutomatedReasoningPolicyDeleteVariableAnnotation.md)
+ [AutomatedReasoningPolicyDeleteVariableMutation](API_AutomatedReasoningPolicyDeleteVariableMutation.md)
+ [AutomatedReasoningPolicyDisjointRuleSet](API_AutomatedReasoningPolicyDisjointRuleSet.md)
+ [AutomatedReasoningPolicyFidelityReport](API_AutomatedReasoningPolicyFidelityReport.md)
+ [AutomatedReasoningPolicyGeneratedTestCase](API_AutomatedReasoningPolicyGeneratedTestCase.md)
+ [AutomatedReasoningPolicyGeneratedTestCases](API_AutomatedReasoningPolicyGeneratedTestCases.md)
+ [AutomatedReasoningPolicyGenerateFidelityReportContent](API_AutomatedReasoningPolicyGenerateFidelityReportContent.md)
+ [AutomatedReasoningPolicyIngestContentAnnotation](API_AutomatedReasoningPolicyIngestContentAnnotation.md)
+ [AutomatedReasoningPolicyMutation](API_AutomatedReasoningPolicyMutation.md)
+ [AutomatedReasoningPolicyPlanning](API_AutomatedReasoningPolicyPlanning.md)
+ [AutomatedReasoningPolicyReportSourceDocument](API_AutomatedReasoningPolicyReportSourceDocument.md)
+ [AutomatedReasoningPolicyRuleReport](API_AutomatedReasoningPolicyRuleReport.md)
+ [AutomatedReasoningPolicyScenario](API_AutomatedReasoningPolicyScenario.md)
+ [AutomatedReasoningPolicyScenarios](API_AutomatedReasoningPolicyScenarios.md)
+ [AutomatedReasoningPolicySourceDocument](API_AutomatedReasoningPolicySourceDocument.md)
+ [AutomatedReasoningPolicyStatementLocation](API_AutomatedReasoningPolicyStatementLocation.md)
+ [AutomatedReasoningPolicyStatementReference](API_AutomatedReasoningPolicyStatementReference.md)
+ [AutomatedReasoningPolicySummary](API_AutomatedReasoningPolicySummary.md)
+ [AutomatedReasoningPolicyTestCase](API_AutomatedReasoningPolicyTestCase.md)
+ [AutomatedReasoningPolicyTestResult](API_AutomatedReasoningPolicyTestResult.md)
+ [AutomatedReasoningPolicyTypeValueAnnotation](API_AutomatedReasoningPolicyTypeValueAnnotation.md)
+ [AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation](API_AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation.md)
+ [AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation](API_AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation.md)
+ [AutomatedReasoningPolicyUpdateRuleAnnotation](API_AutomatedReasoningPolicyUpdateRuleAnnotation.md)
+ [AutomatedReasoningPolicyUpdateRuleMutation](API_AutomatedReasoningPolicyUpdateRuleMutation.md)
+ [AutomatedReasoningPolicyUpdateTypeAnnotation](API_AutomatedReasoningPolicyUpdateTypeAnnotation.md)
+ [AutomatedReasoningPolicyUpdateTypeMutation](API_AutomatedReasoningPolicyUpdateTypeMutation.md)
+ [AutomatedReasoningPolicyUpdateTypeValue](API_AutomatedReasoningPolicyUpdateTypeValue.md)
+ [AutomatedReasoningPolicyUpdateVariableAnnotation](API_AutomatedReasoningPolicyUpdateVariableAnnotation.md)
+ [AutomatedReasoningPolicyUpdateVariableMutation](API_AutomatedReasoningPolicyUpdateVariableMutation.md)
+ [AutomatedReasoningPolicyVariableReport](API_AutomatedReasoningPolicyVariableReport.md)
+ [AutomatedReasoningPolicyWorkflowTypeContent](API_AutomatedReasoningPolicyWorkflowTypeContent.md)
+ [BatchDeleteEvaluationJobError](API_BatchDeleteEvaluationJobError.md)
+ [BatchDeleteEvaluationJobItem](API_BatchDeleteEvaluationJobItem.md)
+ [BedrockEvaluatorModel](API_BedrockEvaluatorModel.md)
+ [ByteContentDoc](API_ByteContentDoc.md)
+ [CloudWatchConfig](API_CloudWatchConfig.md)
+ [CustomizationConfig](API_CustomizationConfig.md)
+ [CustomMetricBedrockEvaluatorModel](API_CustomMetricBedrockEvaluatorModel.md)
+ [CustomMetricDefinition](API_CustomMetricDefinition.md)
+ [CustomMetricEvaluatorModelConfig](API_CustomMetricEvaluatorModelConfig.md)
+ [CustomModelDeploymentSummary](API_CustomModelDeploymentSummary.md)
+ [CustomModelDeploymentUpdateDetails](API_CustomModelDeploymentUpdateDetails.md)
+ [CustomModelSummary](API_CustomModelSummary.md)
+ [CustomModelUnits](API_CustomModelUnits.md)
+ [DataProcessingDetails](API_DataProcessingDetails.md)
+ [DimensionalPriceRate](API_DimensionalPriceRate.md)
+ [DistillationConfig](API_DistillationConfig.md)
+ [EndpointConfig](API_EndpointConfig.md)
+ [EvaluationBedrockModel](API_EvaluationBedrockModel.md)
+ [EvaluationConfig](API_EvaluationConfig.md)
+ [EvaluationDataset](API_EvaluationDataset.md)
+ [EvaluationDatasetLocation](API_EvaluationDatasetLocation.md)
+ [EvaluationDatasetMetricConfig](API_EvaluationDatasetMetricConfig.md)
+ [EvaluationInferenceConfig](API_EvaluationInferenceConfig.md)
+ [EvaluationInferenceConfigSummary](API_EvaluationInferenceConfigSummary.md)
+ [EvaluationModelConfig](API_EvaluationModelConfig.md)
+ [EvaluationModelConfigSummary](API_EvaluationModelConfigSummary.md)
+ [EvaluationOutputDataConfig](API_EvaluationOutputDataConfig.md)
+ [EvaluationPrecomputedInferenceSource](API_EvaluationPrecomputedInferenceSource.md)
+ [EvaluationPrecomputedRagSourceConfig](API_EvaluationPrecomputedRagSourceConfig.md)
+ [EvaluationPrecomputedRetrieveAndGenerateSourceConfig](API_EvaluationPrecomputedRetrieveAndGenerateSourceConfig.md)
+ [EvaluationPrecomputedRetrieveSourceConfig](API_EvaluationPrecomputedRetrieveSourceConfig.md)
+ [EvaluationRagConfigSummary](API_EvaluationRagConfigSummary.md)
+ [EvaluationSummary](API_EvaluationSummary.md)
+ [EvaluatorModelConfig](API_EvaluatorModelConfig.md)
+ [ExternalSource](API_ExternalSource.md)
+ [ExternalSourcesGenerationConfiguration](API_ExternalSourcesGenerationConfiguration.md)
+ [ExternalSourcesRetrieveAndGenerateConfiguration](API_ExternalSourcesRetrieveAndGenerateConfiguration.md)
+ [FieldForReranking](API_FieldForReranking.md)
+ [FilterAttribute](API_FilterAttribute.md)
+ [FoundationModelDetails](API_FoundationModelDetails.md)
+ [FoundationModelLifecycle](API_FoundationModelLifecycle.md)
+ [FoundationModelSummary](API_FoundationModelSummary.md)
+ [GenerationConfiguration](API_GenerationConfiguration.md)
+ [GraderConfig](API_GraderConfig.md)
+ [GuardrailAutomatedReasoningPolicy](API_GuardrailAutomatedReasoningPolicy.md)
+ [GuardrailAutomatedReasoningPolicyConfig](API_GuardrailAutomatedReasoningPolicyConfig.md)
+ [GuardrailConfiguration](API_GuardrailConfiguration.md)
+ [GuardrailContentFilter](API_GuardrailContentFilter.md)
+ [GuardrailContentFilterConfig](API_GuardrailContentFilterConfig.md)
+ [GuardrailContentFiltersTier](API_GuardrailContentFiltersTier.md)
+ [GuardrailContentFiltersTierConfig](API_GuardrailContentFiltersTierConfig.md)
+ [GuardrailContentPolicy](API_GuardrailContentPolicy.md)
+ [GuardrailContentPolicyConfig](API_GuardrailContentPolicyConfig.md)
+ [GuardrailContextualGroundingFilter](API_GuardrailContextualGroundingFilter.md)
+ [GuardrailContextualGroundingFilterConfig](API_GuardrailContextualGroundingFilterConfig.md)
+ [GuardrailContextualGroundingPolicy](API_GuardrailContextualGroundingPolicy.md)
+ [GuardrailContextualGroundingPolicyConfig](API_GuardrailContextualGroundingPolicyConfig.md)
+ [GuardrailCrossRegionConfig](API_GuardrailCrossRegionConfig.md)
+ [GuardrailCrossRegionDetails](API_GuardrailCrossRegionDetails.md)
+ [GuardrailManagedWords](API_GuardrailManagedWords.md)
+ [GuardrailManagedWordsConfig](API_GuardrailManagedWordsConfig.md)
+ [GuardrailPiiEntity](API_GuardrailPiiEntity.md)
+ [GuardrailPiiEntityConfig](API_GuardrailPiiEntityConfig.md)
+ [GuardrailRegex](API_GuardrailRegex.md)
+ [GuardrailRegexConfig](API_GuardrailRegexConfig.md)
+ [GuardrailSensitiveInformationPolicy](API_GuardrailSensitiveInformationPolicy.md)
+ [GuardrailSensitiveInformationPolicyConfig](API_GuardrailSensitiveInformationPolicyConfig.md)
+ [GuardrailSummary](API_GuardrailSummary.md)
+ [GuardrailTopic](API_GuardrailTopic.md)
+ [GuardrailTopicConfig](API_GuardrailTopicConfig.md)
+ [GuardrailTopicPolicy](API_GuardrailTopicPolicy.md)
+ [GuardrailTopicPolicyConfig](API_GuardrailTopicPolicyConfig.md)
+ [GuardrailTopicsTier](API_GuardrailTopicsTier.md)
+ [GuardrailTopicsTierConfig](API_GuardrailTopicsTierConfig.md)
+ [GuardrailWord](API_GuardrailWord.md)
+ [GuardrailWordConfig](API_GuardrailWordConfig.md)
+ [GuardrailWordPolicy](API_GuardrailWordPolicy.md)
+ [GuardrailWordPolicyConfig](API_GuardrailWordPolicyConfig.md)
+ [HumanEvaluationConfig](API_HumanEvaluationConfig.md)
+ [HumanEvaluationCustomMetric](API_HumanEvaluationCustomMetric.md)
+ [HumanWorkflowConfig](API_HumanWorkflowConfig.md)
+ [ImplicitFilterConfiguration](API_ImplicitFilterConfiguration.md)
+ [ImportedModelSummary](API_ImportedModelSummary.md)
+ [InferenceProfileModel](API_InferenceProfileModel.md)
+ [InferenceProfileModelSource](API_InferenceProfileModelSource.md)
+ [InferenceProfileSummary](API_InferenceProfileSummary.md)
+ [InvocationLogsConfig](API_InvocationLogsConfig.md)
+ [InvocationLogSource](API_InvocationLogSource.md)
+ [KbInferenceConfig](API_KbInferenceConfig.md)
+ [KnowledgeBaseConfig](API_KnowledgeBaseConfig.md)
+ [KnowledgeBaseRetrievalConfiguration](API_KnowledgeBaseRetrievalConfiguration.md)
+ [KnowledgeBaseRetrieveAndGenerateConfiguration](API_KnowledgeBaseRetrieveAndGenerateConfiguration.md)
+ [KnowledgeBaseVectorSearchConfiguration](API_KnowledgeBaseVectorSearchConfiguration.md)
+ [LambdaGraderConfig](API_LambdaGraderConfig.md)
+ [LegalTerm](API_LegalTerm.md)
+ [LoggingConfig](API_LoggingConfig.md)
+ [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md)
+ [MarketplaceModelEndpointSummary](API_MarketplaceModelEndpointSummary.md)
+ [MetadataAttributeSchema](API_MetadataAttributeSchema.md)
+ [MetadataConfigurationForReranking](API_MetadataConfigurationForReranking.md)
+ [ModelCopyJobSummary](API_ModelCopyJobSummary.md)
+ [ModelCustomizationJobSummary](API_ModelCustomizationJobSummary.md)
+ [ModelDataSource](API_ModelDataSource.md)
+ [ModelEnforcement](API_ModelEnforcement.md)
+ [ModelImportJobSummary](API_ModelImportJobSummary.md)
+ [ModelInvocationJobInputDataConfig](API_ModelInvocationJobInputDataConfig.md)
+ [ModelInvocationJobOutputDataConfig](API_ModelInvocationJobOutputDataConfig.md)
+ [ModelInvocationJobS3InputDataConfig](API_ModelInvocationJobS3InputDataConfig.md)
+ [ModelInvocationJobS3OutputDataConfig](API_ModelInvocationJobS3OutputDataConfig.md)
+ [ModelInvocationJobSummary](API_ModelInvocationJobSummary.md)
+ [Offer](API_Offer.md)
+ [OrchestrationConfiguration](API_OrchestrationConfiguration.md)
+ [OutputDataConfig](API_OutputDataConfig.md)
+ [PerformanceConfiguration](API_PerformanceConfiguration.md)
+ [PricingTerm](API_PricingTerm.md)
+ [PromptRouterSummary](API_PromptRouterSummary.md)
+ [PromptRouterTargetModel](API_PromptRouterTargetModel.md)
+ [PromptTemplate](API_PromptTemplate.md)
+ [ProvisionedModelSummary](API_ProvisionedModelSummary.md)
+ [QueryTransformationConfiguration](API_QueryTransformationConfiguration.md)
+ [RAGConfig](API_RAGConfig.md)
+ [RatingScaleItem](API_RatingScaleItem.md)
+ [RatingScaleItemValue](API_RatingScaleItemValue.md)
+ [RequestMetadataBaseFilters](API_RequestMetadataBaseFilters.md)
+ [RequestMetadataFilters](API_RequestMetadataFilters.md)
+ [RerankingMetadataSelectiveModeConfiguration](API_RerankingMetadataSelectiveModeConfiguration.md)
+ [RetrievalFilter](API_RetrievalFilter.md)
+ [RetrieveAndGenerateConfiguration](API_RetrieveAndGenerateConfiguration.md)
+ [RetrieveConfig](API_RetrieveConfig.md)
+ [RFTConfig](API_RFTConfig.md)
+ [RFTHyperParameters](API_RFTHyperParameters.md)
+ [RoutingCriteria](API_RoutingCriteria.md)
+ [S3Config](API_S3Config.md)
+ [S3DataSource](API_S3DataSource.md)
+ [S3ObjectDoc](API_S3ObjectDoc.md)
+ [SageMakerEndpoint](API_SageMakerEndpoint.md)
+ [SelectiveContentGuarding](API_SelectiveContentGuarding.md)
+ [StatusDetails](API_StatusDetails.md)
+ [SupportTerm](API_SupportTerm.md)
+ [Tag](API_Tag.md)
+ [TeacherModelConfig](API_TeacherModelConfig.md)
+ [TermDetails](API_TermDetails.md)
+ [TextInferenceConfig](API_TextInferenceConfig.md)
+ [TrainingDataConfig](API_TrainingDataConfig.md)
+ [TrainingDetails](API_TrainingDetails.md)
+ [TrainingMetrics](API_TrainingMetrics.md)
+ [ValidationDataConfig](API_ValidationDataConfig.md)
+ [ValidationDetails](API_ValidationDetails.md)
+ [Validator](API_Validator.md)
+ [ValidatorMetric](API_ValidatorMetric.md)
+ [ValidityTerm](API_ValidityTerm.md)
+ [VectorSearchBedrockRerankingConfiguration](API_VectorSearchBedrockRerankingConfiguration.md)
+ [VectorSearchBedrockRerankingModelConfiguration](API_VectorSearchBedrockRerankingModelConfiguration.md)
+ [VectorSearchRerankingConfiguration](API_VectorSearchRerankingConfiguration.md)
+ [VpcConfig](API_VpcConfig.md)
# AccountEnforcedGuardrailInferenceInputConfiguration
Account-level enforced guardrail input configuration.
## Contents
** guardrailIdentifier **
Identifier for the guardrail, could be the ID or the ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: Yes
** guardrailVersion **
Numerical guardrail version.
Type: String
Pattern: `[1-9][0-9]{0,7}`
Required: Yes
** modelEnforcement **
Model-specific information for the enforced guardrail configuration. If not present, the configuration is enforced on all models
Type: [ModelEnforcement](API_ModelEnforcement.md) object
Required: No
** selectiveContentGuarding **
Selective content guarding controls for enforced guardrails.
Type: [SelectiveContentGuarding](API_SelectiveContentGuarding.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AccountEnforcedGuardrailInferenceInputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AccountEnforcedGuardrailInferenceInputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AccountEnforcedGuardrailInferenceInputConfiguration)
# AccountEnforcedGuardrailOutputConfiguration
Account enforced guardrail output configuration.
## Contents
** configId **
Unique ID for the account enforced configuration.
Type: String
Pattern: `[a-z0-9]+`
Required: No
** createdAt **
Timestamp.
Type: Timestamp
Required: No
** createdBy **
The ARN of the role used to update the configuration.
Type: String
Required: No
** guardrailArn **
ARN representation for the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+`
Required: No
** guardrailId **
Unique ID for the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: `[a-z0-9]+`
Required: No
** guardrailVersion **
Numerical guardrail version.
Type: String
Pattern: `[1-9][0-9]{0,7}`
Required: No
** inputTags **
*This member has been deprecated.*
Whether to honor or ignore input tags at runtime.
Type: String
Valid Values: `HONOR | IGNORE`
Required: No
** modelEnforcement **
Model-specific information for the enforced guardrail configuration.
Type: [ModelEnforcement](API_ModelEnforcement.md) object
Required: No
** owner **
Configuration owner type.
Type: String
Valid Values: `ACCOUNT`
Required: No
** selectiveContentGuarding **
Selective content guarding controls for enforced guardrails.
Type: [SelectiveContentGuarding](API_SelectiveContentGuarding.md) object
Required: No
** updatedAt **
Timestamp.
Type: Timestamp
Required: No
** updatedBy **
The ARN of the role used to update the configuration.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AccountEnforcedGuardrailOutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AccountEnforcedGuardrailOutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AccountEnforcedGuardrailOutputConfiguration)
# AgreementAvailability
Information about the agreement availability
## Contents
** status **
Status of the agreement.
Type: String
Valid Values: `AVAILABLE | PENDING | NOT_AVAILABLE | ERROR`
Required: Yes
** errorMessage **
Error message.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AgreementAvailability)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AgreementAvailability)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AgreementAvailability)
# AutomatedEvaluationConfig
The configuration details of an automated evaluation job. The `EvaluationDatasetMetricConfig` object is used to specify the prompt datasets, task type, and metric names.
## Contents
** datasetMetricConfigs **
Configuration details of the prompt datasets and metrics you want to use for your evaluation job.
Type: Array of [EvaluationDatasetMetricConfig](API_EvaluationDatasetMetricConfig.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** customMetricConfig **
Defines the configuration of custom metrics to be used in an evaluation job.
Type: [AutomatedEvaluationCustomMetricConfig](API_AutomatedEvaluationCustomMetricConfig.md) object
Required: No
** evaluatorModelConfig **
Contains the evaluator model configuration details. `EvaluatorModelConfig` is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.
Type: [EvaluatorModelConfig](API_EvaluatorModelConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedEvaluationConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedEvaluationConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedEvaluationConfig)
# AutomatedEvaluationCustomMetricConfig
Defines the configuration of custom metrics to be used in an evaluation job. To learn more about using custom metrics in Amazon Bedrock evaluation jobs, see [Create a prompt for a custom metrics (LLM-as-a-judge model evaluations)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-custom-metrics-prompt-formats.html) and [Create a prompt for a custom metrics (RAG evaluations)](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-evaluation-custom-metrics-prompt-formats.html).
## Contents
** customMetrics **
Defines a list of custom metrics to be used in an Amazon Bedrock evaluation job.
Type: Array of [AutomatedEvaluationCustomMetricSource](API_AutomatedEvaluationCustomMetricSource.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes
** evaluatorModelConfig **
Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.
Type: [CustomMetricEvaluatorModelConfig](API_CustomMetricEvaluatorModelConfig.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedEvaluationCustomMetricConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedEvaluationCustomMetricConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedEvaluationCustomMetricConfig)
# AutomatedEvaluationCustomMetricSource
An array item definining a single custom metric for use in an Amazon Bedrock evaluation job.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** customMetricDefinition **
The definition of a custom metric for use in an Amazon Bedrock evaluation job.
Type: [CustomMetricDefinition](API_CustomMetricDefinition.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedEvaluationCustomMetricSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedEvaluationCustomMetricSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedEvaluationCustomMetricSource)
# AutomatedReasoningCheckFinding
Represents the result of an Automated Reasoning validation check, indicating whether the content is logically valid, invalid, or falls into other categories based on the policy rules.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** impossible **
Indicates that Automated Reasoning cannot make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.
Type: [AutomatedReasoningCheckImpossibleFinding](API_AutomatedReasoningCheckImpossibleFinding.md) object
Required: No
** invalid **
Indicates that the claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exist different claims that are consistent with the premises and Automated Reasoning policy.
Type: [AutomatedReasoningCheckInvalidFinding](API_AutomatedReasoningCheckInvalidFinding.md) object
Required: No
** noTranslations **
Identifies that some or all of the input prompt wasn't translated into logic. This can happen if the input isn't relevant to the Automated Reasoning policy, or if the policy doesn't have variables to model relevant input.
Type: [AutomatedReasoningCheckNoTranslationsFinding](API_AutomatedReasoningCheckNoTranslationsFinding.md) object
Required: No
** satisfiable **
Indicates that the claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.
Type: [AutomatedReasoningCheckSatisfiableFinding](API_AutomatedReasoningCheckSatisfiableFinding.md) object
Required: No
** tooComplex **
Indicates that the input contains too much information for Automated Reasoning to process within its latency limits.
Type: [AutomatedReasoningCheckTooComplexFinding](API_AutomatedReasoningCheckTooComplexFinding.md) object
Required: No
** translationAmbiguous **
Indicates that an ambiguity was detected in the translation, making it unsound to continue with validity checking. Additional context or follow-up questions might be needed to get translation to succeed.
Type: [AutomatedReasoningCheckTranslationAmbiguousFinding](API_AutomatedReasoningCheckTranslationAmbiguousFinding.md) object
Required: No
** valid **
Indicates that the claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false.
Type: [AutomatedReasoningCheckValidFinding](API_AutomatedReasoningCheckValidFinding.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckFinding)
# AutomatedReasoningCheckImpossibleFinding
Indicates that no valid claims can be made due to logical contradictions in the premises or rules.
## Contents
** contradictingRules **
The automated reasoning policy rules that contradict the claims and/or premises in the input.
Type: Array of [AutomatedReasoningCheckRule](API_AutomatedReasoningCheckRule.md) objects
Required: No
** logicWarning **
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
Type: [AutomatedReasoningCheckLogicWarning](API_AutomatedReasoningCheckLogicWarning.md) object
Required: No
** translation **
The logical translation of the input that this finding evaluates.
Type: [AutomatedReasoningCheckTranslation](API_AutomatedReasoningCheckTranslation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckImpossibleFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckImpossibleFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckImpossibleFinding)
# AutomatedReasoningCheckInputTextReference
References a portion of the original input text that corresponds to logical elements.
## Contents
** text **
The specific text from the original input that this reference points to.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckInputTextReference)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckInputTextReference)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckInputTextReference)
# AutomatedReasoningCheckInvalidFinding
Indicates that the claims are logically false and contradictory to the established rules or premises.
## Contents
** contradictingRules **
The automated reasoning policy rules that contradict the claims in the input.
Type: Array of [AutomatedReasoningCheckRule](API_AutomatedReasoningCheckRule.md) objects
Required: No
** logicWarning **
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
Type: [AutomatedReasoningCheckLogicWarning](API_AutomatedReasoningCheckLogicWarning.md) object
Required: No
** translation **
The logical translation of the input that this finding invalidates.
Type: [AutomatedReasoningCheckTranslation](API_AutomatedReasoningCheckTranslation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckInvalidFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckInvalidFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckInvalidFinding)
# AutomatedReasoningCheckLogicWarning
Identifies logical issues in the translated statements that exist independent of any policy rules, such as statements that are always true or always false.
## Contents
** claims **
The logical statements that are validated while assuming the policy and premises.
Type: Array of [AutomatedReasoningLogicStatement](API_AutomatedReasoningLogicStatement.md) objects
Required: No
** premises **
The logical statements that serve as premises under which the claims are validated.
Type: Array of [AutomatedReasoningLogicStatement](API_AutomatedReasoningLogicStatement.md) objects
Required: No
** type **
The category of the detected logical issue, such as statements that are always true or always false.
Type: String
Valid Values: `ALWAYS_TRUE | ALWAYS_FALSE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckLogicWarning)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckLogicWarning)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckLogicWarning)
# AutomatedReasoningCheckNoTranslationsFinding
Indicates that no relevant logical information could be extracted from the input for validation.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckNoTranslationsFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckNoTranslationsFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckNoTranslationsFinding)
# AutomatedReasoningCheckRule
References a specific automated reasoning policy rule that was applied during evaluation.
## Contents
** id **
The unique identifier of the automated reasoning rule.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: No
** policyVersionArn **
The ARN of the automated reasoning policy version that contains this rule.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckRule)
# AutomatedReasoningCheckSatisfiableFinding
Indicates that the claims could be either true or false depending on additional assumptions not provided in the input.
## Contents
** claimsFalseScenario **
An example scenario demonstrating how the claims could be logically false.
Type: [AutomatedReasoningCheckScenario](API_AutomatedReasoningCheckScenario.md) object
Required: No
** claimsTrueScenario **
An example scenario demonstrating how the claims could be logically true.
Type: [AutomatedReasoningCheckScenario](API_AutomatedReasoningCheckScenario.md) object
Required: No
** logicWarning **
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
Type: [AutomatedReasoningCheckLogicWarning](API_AutomatedReasoningCheckLogicWarning.md) object
Required: No
** translation **
The logical translation of the input that this finding evaluates.
Type: [AutomatedReasoningCheckTranslation](API_AutomatedReasoningCheckTranslation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckSatisfiableFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckSatisfiableFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckSatisfiableFinding)
# AutomatedReasoningCheckScenario
Represents a logical scenario where claims can be evaluated as true or false, containing specific logical assignments.
## Contents
** statements **
List of logical assignments and statements that define this scenario.
Type: Array of [AutomatedReasoningLogicStatement](API_AutomatedReasoningLogicStatement.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckScenario)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckScenario)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckScenario)
# AutomatedReasoningCheckTooComplexFinding
Indicates that the input exceeds the processing capacity due to the volume or complexity of the logical information.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckTooComplexFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckTooComplexFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckTooComplexFinding)
# AutomatedReasoningCheckTranslation
Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.
## Contents
** claims **
The logical statements that are being validated against the premises and policy rules.
Type: Array of [AutomatedReasoningLogicStatement](API_AutomatedReasoningLogicStatement.md) objects
Required: Yes
** confidence **
A confidence score between 0 and 1 indicating how certain the system is about the logical translation.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
** premises **
The logical statements that serve as the foundation or assumptions for the claims.
Type: Array of [AutomatedReasoningLogicStatement](API_AutomatedReasoningLogicStatement.md) objects
Required: No
** untranslatedClaims **
References to portions of the original input text that correspond to the claims but could not be fully translated.
Type: Array of [AutomatedReasoningCheckInputTextReference](API_AutomatedReasoningCheckInputTextReference.md) objects
Required: No
** untranslatedPremises **
References to portions of the original input text that correspond to the premises but could not be fully translated.
Type: Array of [AutomatedReasoningCheckInputTextReference](API_AutomatedReasoningCheckInputTextReference.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckTranslation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckTranslation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckTranslation)
# AutomatedReasoningCheckTranslationAmbiguousFinding
Indicates that the input has multiple valid logical interpretations, requiring additional context or clarification.
## Contents
** differenceScenarios **
Scenarios showing how the different translation options differ in meaning.
Type: Array of [AutomatedReasoningCheckScenario](API_AutomatedReasoningCheckScenario.md) objects
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Required: No
** options **
Different logical interpretations that were detected during translation of the input.
Type: Array of [AutomatedReasoningCheckTranslationOption](API_AutomatedReasoningCheckTranslationOption.md) objects
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckTranslationAmbiguousFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckTranslationAmbiguousFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckTranslationAmbiguousFinding)
# AutomatedReasoningCheckTranslationOption
Represents one possible logical interpretation of ambiguous input content.
## Contents
** translations **
Different logical interpretations that were detected during translation of the input.
Type: Array of [AutomatedReasoningCheckTranslation](API_AutomatedReasoningCheckTranslation.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckTranslationOption)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckTranslationOption)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckTranslationOption)
# AutomatedReasoningCheckValidFinding
Indicates that the claims are definitively true and logically implied by the premises, with no possible alternative interpretations.
## Contents
** claimsTrueScenario **
An example scenario demonstrating how the claims are logically true.
Type: [AutomatedReasoningCheckScenario](API_AutomatedReasoningCheckScenario.md) object
Required: No
** logicWarning **
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
Type: [AutomatedReasoningCheckLogicWarning](API_AutomatedReasoningCheckLogicWarning.md) object
Required: No
** supportingRules **
The automated reasoning policy rules that support why this result is considered valid.
Type: Array of [AutomatedReasoningCheckRule](API_AutomatedReasoningCheckRule.md) objects
Required: No
** translation **
The logical translation of the input that this finding validates.
Type: [AutomatedReasoningCheckTranslation](API_AutomatedReasoningCheckTranslation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningCheckValidFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningCheckValidFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningCheckValidFinding)
# AutomatedReasoningLogicStatement
Represents a logical statement that can be expressed both in formal logic notation and natural language, providing dual representations for better understanding and validation.
## Contents
** logic **
The formal logic representation of the statement using mathematical notation and logical operators.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: Yes
** naturalLanguage **
The natural language representation of the logical statement, providing a human-readable interpretation of the formal logic.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningLogicStatement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningLogicStatement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningLogicStatement)
# AutomatedReasoningPolicyAddRuleAnnotation
An annotation for adding a new rule to an Automated Reasoning policy using a formal logical expression.
## Contents
** expression **
The formal logical expression that defines the rule, using mathematical notation and referencing policy variables and types.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[\s\S]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleAnnotation)
# AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation
An annotation for adding a new rule to the policy by converting a natural language description into a formal logical expression.
## Contents
** naturalLanguage **
The natural language description of the rule that should be converted into a formal logical expression.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation)
# AutomatedReasoningPolicyAddRuleMutation
A mutation operation that adds a new rule to the policy definition during the build process.
## Contents
** rule **
The rule definition that specifies the formal logical expression and metadata for the new rule being added to the policy.
Type: [AutomatedReasoningPolicyDefinitionRule](API_AutomatedReasoningPolicyDefinitionRule.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAddRuleMutation)
# AutomatedReasoningPolicyAddTypeAnnotation
An annotation for adding a new custom type to an Automated Reasoning policy, defining a set of possible values for variables.
## Contents
** description **
A description of what the custom type represents and how it should be used in the policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: Yes
** name **
The name of the new custom type. This name will be used to reference the type in variable definitions and rules.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** values **
The list of possible values that variables of this type can take, each with its own description and identifier.
Type: Array of [AutomatedReasoningPolicyDefinitionTypeValue](API_AutomatedReasoningPolicyDefinitionTypeValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 150 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeAnnotation)
# AutomatedReasoningPolicyAddTypeMutation
A mutation operation that adds a new custom type to the policy definition during the build process.
## Contents
** type **
The type definition that specifies the name, description, and possible values for the new custom type being added to the policy.
Type: [AutomatedReasoningPolicyDefinitionType](API_AutomatedReasoningPolicyDefinitionType.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeMutation)
# AutomatedReasoningPolicyAddTypeValue
Represents a single value that can be added to an existing custom type in the policy.
## Contents
** value **
The identifier or name of the new value to add to the type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** description **
A description of what this new type value represents and when it should be used.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAddTypeValue)
# AutomatedReasoningPolicyAddVariableAnnotation
An annotation for adding a new variable to an Automated Reasoning policy, which can be used in rule expressions.
## Contents
** description **
A description of what the variable represents and how it should be used in rules.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: Yes
** name **
The name of the new variable. This name will be used to reference the variable in rule expressions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** type **
The type of the variable, which can be a built-in type (like string or number) or a custom type defined in the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAddVariableAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAddVariableAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAddVariableAnnotation)
# AutomatedReasoningPolicyAddVariableMutation
A mutation operation that adds a new variable to the policy definition during the build process.
## Contents
** variable **
The variable definition that specifies the name, type, and description for the new variable being added to the policy.
Type: [AutomatedReasoningPolicyDefinitionVariable](API_AutomatedReasoningPolicyDefinitionVariable.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAddVariableMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAddVariableMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAddVariableMutation)
# AutomatedReasoningPolicyAnnotatedChunk
Represents a portion of a source document with line number annotations. Chunks help organize document content for easier navigation and reference.
## Contents
** content **
The lines of text contained within this chunk, each annotated with its line number.
Type: Array of [AutomatedReasoningPolicyAnnotatedContent](API_AutomatedReasoningPolicyAnnotatedContent.md) objects
Required: Yes
** pageNumber **
The page number where this chunk begins, if the document is divided into pages.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedChunk)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedChunk)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedChunk)
# AutomatedReasoningPolicyAnnotatedContent
Represents a content element within an annotated chunk. This union type allows for different types of content elements to be included in document chunks, such as individual lines of text with their line numbers.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** line **
An annotated line of text from the source document, including both the line number and the text content.
Type: [AutomatedReasoningPolicyAnnotatedLine](API_AutomatedReasoningPolicyAnnotatedLine.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedContent)
# AutomatedReasoningPolicyAnnotatedLine
Represents a single line of text from a source document, annotated with its line number for precise referencing.
## Contents
** lineNumber **
The line number of this text within the source document.
Type: Integer
Required: No
** lineText **
The actual text content of this line from the source document.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedLine)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedLine)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotatedLine)
# AutomatedReasoningPolicyAnnotation
Contains the various operations that can be performed on an Automated Reasoning policy, including adding, updating, and deleting rules, variables, and types.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** addRule **
An operation to add a new logical rule to the policy using formal mathematical expressions.
Type: [AutomatedReasoningPolicyAddRuleAnnotation](API_AutomatedReasoningPolicyAddRuleAnnotation.md) object
Required: No
** addRuleFromNaturalLanguage **
An operation to add a new rule by converting natural language descriptions into formal logical expressions.
Type: [AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation](API_AutomatedReasoningPolicyAddRuleFromNaturalLanguageAnnotation.md) object
Required: No
** addType **
An operation to add a new custom type to the policy, defining a set of possible values for policy variables.
Type: [AutomatedReasoningPolicyAddTypeAnnotation](API_AutomatedReasoningPolicyAddTypeAnnotation.md) object
Required: No
** addVariable **
An operation to add a new variable to the policy, which can be used in rule expressions to represent dynamic values.
Type: [AutomatedReasoningPolicyAddVariableAnnotation](API_AutomatedReasoningPolicyAddVariableAnnotation.md) object
Required: No
** deleteRule **
An operation to remove a rule from the policy.
Type: [AutomatedReasoningPolicyDeleteRuleAnnotation](API_AutomatedReasoningPolicyDeleteRuleAnnotation.md) object
Required: No
** deleteType **
An operation to remove a custom type from the policy. The type must not be referenced by any variables or rules.
Type: [AutomatedReasoningPolicyDeleteTypeAnnotation](API_AutomatedReasoningPolicyDeleteTypeAnnotation.md) object
Required: No
** deleteVariable **
An operation to remove a variable from the policy. The variable must not be referenced by any rules.
Type: [AutomatedReasoningPolicyDeleteVariableAnnotation](API_AutomatedReasoningPolicyDeleteVariableAnnotation.md) object
Required: No
** ingestContent **
An operation to process and incorporate new content into the policy, extracting additional rules and concepts.
Type: [AutomatedReasoningPolicyIngestContentAnnotation](API_AutomatedReasoningPolicyIngestContentAnnotation.md) object
Required: No
** updateFromRulesFeedback **
An operation to update the policy based on feedback about how specific rules performed during testing or validation.
Type: [AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation](API_AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation.md) object
Required: No
** updateFromScenarioFeedback **
An operation to update the policy based on feedback about how it performed on specific test scenarios.
Type: [AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation](API_AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation.md) object
Required: No
** updateRule **
An operation to modify an existing rule in the policy, such as changing its logical expression or conditions.
Type: [AutomatedReasoningPolicyUpdateRuleAnnotation](API_AutomatedReasoningPolicyUpdateRuleAnnotation.md) object
Required: No
** updateType **
An operation to modify an existing custom type in the policy, such as changing its name, description, or allowed values.
Type: [AutomatedReasoningPolicyUpdateTypeAnnotation](API_AutomatedReasoningPolicyUpdateTypeAnnotation.md) object
Required: No
** updateVariable **
An operation to modify an existing variable in the policy, such as changing its name, type, or description.
Type: [AutomatedReasoningPolicyUpdateVariableAnnotation](API_AutomatedReasoningPolicyUpdateVariableAnnotation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAnnotation)
# AutomatedReasoningPolicyAtomicStatement
Represents a single, indivisible statement extracted from a source document. Atomic statements are the fundamental units used to ground policy rules and variables to their source material.
## Contents
** id **
A unique identifier for this atomic statement within the fidelity report.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8.
Pattern: `[a-zA-Z0-9]*`
Required: Yes
** location **
Information about where this statement appears in the source document, including line numbers.
Type: [AutomatedReasoningPolicyStatementLocation](API_AutomatedReasoningPolicyStatementLocation.md) object
Required: Yes
** text **
The actual text content of the atomic statement as extracted from the source document.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyAtomicStatement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyAtomicStatement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyAtomicStatement)
# AutomatedReasoningPolicyBuildLog
Contains detailed logging information about the policy build process, including steps taken, decisions made, and any issues encountered.
## Contents
** entries **
A list of log entries documenting each step in the policy build process, including timestamps, status, and detailed messages.
Type: Array of [AutomatedReasoningPolicyBuildLogEntry](API_AutomatedReasoningPolicyBuildLogEntry.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildLog)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildLog)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildLog)
# AutomatedReasoningPolicyBuildLogEntry
Represents a single entry in the policy build log, containing information about a specific step or event in the build process.
## Contents
** annotation **
The annotation or operation that was being processed when this log entry was created.
Type: [AutomatedReasoningPolicyAnnotation](API_AutomatedReasoningPolicyAnnotation.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** buildSteps **
Detailed information about the specific build steps that were executed, including any sub-operations or transformations.
Type: Array of [AutomatedReasoningPolicyBuildStep](API_AutomatedReasoningPolicyBuildStep.md) objects
Required: Yes
** status **
The status of the build step (e.g., SUCCESS, FAILED, IN\$1PROGRESS).
Type: String
Valid Values: `APPLIED | FAILED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildLogEntry)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildLogEntry)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildLogEntry)
# AutomatedReasoningPolicyBuildResultAssetManifest
A catalog of all artifacts produced by a build workflow, providing a comprehensive list of available assets including their types and identifiers.
## Contents
** entries **
The list of asset entries in the manifest, each describing an available artifact that can be retrieved.
Type: Array of [AutomatedReasoningPolicyBuildResultAssetManifestEntry](API_AutomatedReasoningPolicyBuildResultAssetManifestEntry.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssetManifest)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssetManifest)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssetManifest)
# AutomatedReasoningPolicyBuildResultAssetManifestEntry
Represents a single entry in the asset manifest, describing one artifact produced by the build workflow.
## Contents
** assetType **
The type of asset (e.g., BUILD\$1LOG, QUALITY\$1REPORT, POLICY\$1DEFINITION, GENERATED\$1TEST\$1CASES, POLICY\$1SCENARIOS, FIDELITY\$1REPORT, ASSET\$1MANIFEST, SOURCE\$1DOCUMENT).
Type: String
Valid Values: `BUILD_LOG | QUALITY_REPORT | POLICY_DEFINITION | GENERATED_TEST_CASES | POLICY_SCENARIOS | FIDELITY_REPORT | ASSET_MANIFEST | SOURCE_DOCUMENT`
Required: Yes
** assetId **
A unique identifier for the asset, if applicable. Use this ID when requesting specific assets through the API.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[0-9a-fA-F\-]+`
Required: No
** assetName **
A human-readable name for the asset, if applicable. This helps identify specific documents or reports within the workflow results.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssetManifestEntry)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssetManifestEntry)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssetManifestEntry)
# AutomatedReasoningPolicyBuildResultAssets
Contains the various assets generated during a policy build workflow, including logs, quality reports, test cases, and the final policy definition.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** assetManifest **
A manifest listing all available artifacts produced by the build workflow. This provides a catalog of all assets that can be retrieved, including their types, names, and identifiers.
Type: [AutomatedReasoningPolicyBuildResultAssetManifest](API_AutomatedReasoningPolicyBuildResultAssetManifest.md) object
Required: No
** buildLog **
The complete build log containing detailed information about each step in the policy generation process.
Type: [AutomatedReasoningPolicyBuildLog](API_AutomatedReasoningPolicyBuildLog.md) object
Required: No
** document **
A source document that was used as input during the build workflow. This allows you to retrieve the original documents that were processed to generate the policy.
Type: [AutomatedReasoningPolicySourceDocument](API_AutomatedReasoningPolicySourceDocument.md) object
Required: No
** fidelityReport **
A comprehensive fidelity report that measures how accurately the generated policy represents the source documents. The report includes coverage and accuracy scores, along with detailed grounding information for rules and variables.
Type: [AutomatedReasoningPolicyFidelityReport](API_AutomatedReasoningPolicyFidelityReport.md) object
Required: No
** generatedTestCases **
A comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.
Type: [AutomatedReasoningPolicyGeneratedTestCases](API_AutomatedReasoningPolicyGeneratedTestCases.md) object
Required: No
** policyDefinition **
The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents.
Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object
Required: No
** policyScenarios **
An entity encompassing all the policy scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.
Type: [AutomatedReasoningPolicyScenarios](API_AutomatedReasoningPolicyScenarios.md) object
Required: No
** qualityReport **
A comprehensive report analyzing the quality of the generated policy, including metrics about rule coverage, potential conflicts, and unused elements.
Type: [AutomatedReasoningPolicyDefinitionQualityReport](API_AutomatedReasoningPolicyDefinitionQualityReport.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildResultAssets)
# AutomatedReasoningPolicyBuildStep
Represents a single step in the policy build process, containing context about what was being processed and any messages or results.
## Contents
** context **
Contextual information about what was being processed during this build step, such as the type of operation or the source material being analyzed.
Type: [AutomatedReasoningPolicyBuildStepContext](API_AutomatedReasoningPolicyBuildStepContext.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** messages **
A list of messages generated during this build step, including informational messages, warnings, and error details.
Type: Array of [AutomatedReasoningPolicyBuildStepMessage](API_AutomatedReasoningPolicyBuildStepMessage.md) objects
Required: Yes
** priorElement **
Reference to the previous element or step in the build process, helping to trace the sequence of operations.
Type: [AutomatedReasoningPolicyDefinitionElement](API_AutomatedReasoningPolicyDefinitionElement.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStep)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStep)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStep)
# AutomatedReasoningPolicyBuildStepContext
Provides context about what type of operation was being performed during a build step.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** mutation **
Indicates that this build step involved modifying the policy structure, such as adding or updating rules, variables, or types.
Type: [AutomatedReasoningPolicyMutation](API_AutomatedReasoningPolicyMutation.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** planning **
Indicates that this build step was part of the planning phase, where the system determines what operations to perform.
Type: [AutomatedReasoningPolicyPlanning](API_AutomatedReasoningPolicyPlanning.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStepContext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStepContext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStepContext)
# AutomatedReasoningPolicyBuildStepMessage
Represents a message generated during a build step, providing information about what happened or any issues encountered.
## Contents
** message **
The content of the message, describing what occurred during the build step.
Type: String
Required: Yes
** messageType **
The type of message (e.g., INFO, WARNING, ERROR) indicating its severity and purpose.
Type: String
Valid Values: `INFO | WARNING | ERROR`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStepMessage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStepMessage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildStepMessage)
# AutomatedReasoningPolicyBuildWorkflowDocument
Represents a source document used in the policy build workflow, containing the content and metadata needed for policy generation.
## Contents
** document **
The actual content of the source document that will be analyzed to extract policy rules and concepts.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 5000000.
Required: Yes
** documentContentType **
The MIME type of the document content (e.g., text/plain, application/pdf, text/markdown).
Type: String
Valid Values: `pdf | txt`
Required: Yes
** documentName **
A descriptive name for the document that helps identify its purpose and content.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
** documentDescription **
A detailed description of the document's content and how it should be used in the policy generation process.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowDocument)
# AutomatedReasoningPolicyBuildWorkflowRepairContent
Contains content and instructions for repairing or improving an existing Automated Reasoning policy.
## Contents
** annotations **
Specific annotations or modifications to apply during the policy repair process, such as rule corrections or variable updates.
Type: Array of [AutomatedReasoningPolicyAnnotation](API_AutomatedReasoningPolicyAnnotation.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowRepairContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowRepairContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowRepairContent)
# AutomatedReasoningPolicyBuildWorkflowSource
Defines the source content for a policy build workflow, which can include documents, repair instructions, or other input materials.
## Contents
** policyDefinition **
An existing policy definition that serves as the starting point for the build workflow, typically used in policy repair or update scenarios.
Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object
Required: No
** workflowContent **
The actual content to be processed in the build workflow, such as documents to analyze or repair instructions to apply.
Type: [AutomatedReasoningPolicyWorkflowTypeContent](API_AutomatedReasoningPolicyWorkflowTypeContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowSource)
# AutomatedReasoningPolicyBuildWorkflowSummary
Provides a summary of a policy build workflow, including its current status, timing information, and key identifiers.
## Contents
** buildWorkflowId **
The unique identifier of the build workflow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 36.
Pattern: `[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}`
Required: Yes
** buildWorkflowType **
The type of build workflow (e.g., DOCUMENT\$1INGESTION, POLICY\$1REPAIR).
Type: String
Valid Values: `INGEST_CONTENT | REFINE_POLICY | IMPORT_POLICY | GENERATE_FIDELITY_REPORT`
Required: Yes
** createdAt **
The timestamp when the build workflow was created.
Type: Timestamp
Required: Yes
** policyArn **
The Amazon Resource Name (ARN) of the Automated Reasoning policy associated with this build workflow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** status **
The current status of the build workflow (e.g., RUNNING, COMPLETED, FAILED, CANCELLED).
Type: String
Valid Values: `SCHEDULED | CANCEL_REQUESTED | PREPROCESSING | BUILDING | TESTING | COMPLETED | FAILED | CANCELLED`
Required: Yes
** updatedAt **
The timestamp when the build workflow was last updated.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyBuildWorkflowSummary)
# AutomatedReasoningPolicyDefinition
Contains the formal logic rules, variables, and custom variable types that define an Automated Reasoning policy. The policy definition specifies the constraints used to validate foundation model responses for accuracy and logical consistency.
## Contents
** rules **
The formal logic rules extracted from the source document. Rules define the logical constraints that determine whether model responses are valid, invalid, or satisfiable.
Type: Array of [AutomatedReasoningPolicyDefinitionRule](API_AutomatedReasoningPolicyDefinitionRule.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1500 items.
Required: No
** types **
The custom user-defined vairable types used in the policy. Types are enum-based variable types that provide additional context beyond the predefined variable types.
Type: Array of [AutomatedReasoningPolicyDefinitionType](API_AutomatedReasoningPolicyDefinitionType.md) objects
Array Members: Minimum number of 0 items. Maximum number of 150 items.
Required: No
** variables **
The variables that represent concepts in the policy. Variables can have values assigned when translating natural language into formal logic. Their descriptions are crucial for accurate translation.
Type: Array of [AutomatedReasoningPolicyDefinitionVariable](API_AutomatedReasoningPolicyDefinitionVariable.md) objects
Array Members: Minimum number of 0 items. Maximum number of 600 items.
Required: No
** version **
The version of the policy definition format.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDefinition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDefinition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDefinition)
# AutomatedReasoningPolicyDefinitionElement
Represents a single element in an Automated Reasoning policy definition, such as a rule, variable, or type definition.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** policyDefinitionRule **
A rule element within the policy definition that contains a formal logical expression used for validation.
Type: [AutomatedReasoningPolicyDefinitionRule](API_AutomatedReasoningPolicyDefinitionRule.md) object
Required: No
** policyDefinitionType **
A custom type element within the policy definition that defines a set of possible values for variables.
Type: [AutomatedReasoningPolicyDefinitionType](API_AutomatedReasoningPolicyDefinitionType.md) object
Required: No
** policyDefinitionVariable **
A variable element within the policy definition that represents a concept used in logical expressions and rules.
Type: [AutomatedReasoningPolicyDefinitionVariable](API_AutomatedReasoningPolicyDefinitionVariable.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionElement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionElement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionElement)
# AutomatedReasoningPolicyDefinitionQualityReport
Provides a comprehensive analysis of the quality and completeness of an Automated Reasoning policy definition, highlighting potential issues and optimization opportunities.
## Contents
** conflictingRules **
A list of rules that may conflict with each other, potentially leading to inconsistent policy behavior.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 500 items.
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
** disjointRuleSets **
Groups of rules that operate on completely separate sets of variables, indicating the policy may be addressing multiple unrelated concerns.
Type: Array of [AutomatedReasoningPolicyDisjointRuleSet](API_AutomatedReasoningPolicyDisjointRuleSet.md) objects
Required: Yes
** ruleCount **
The total number of rules defined in the policy.
Type: Integer
Required: Yes
** typeCount **
The total number of custom types defined in the policy.
Type: Integer
Required: Yes
** unusedTypes **
A list of custom types that are defined but not referenced by any variables or rules, suggesting they may be unnecessary.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 150 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** unusedTypeValues **
A list of type values that are defined but never used in any rules, indicating potential cleanup opportunities.
Type: Array of [AutomatedReasoningPolicyDefinitionTypeValuePair](API_AutomatedReasoningPolicyDefinitionTypeValuePair.md) objects
Array Members: Minimum number of 1 item. Maximum number of 22500 items.
Required: Yes
** unusedVariables **
A list of variables that are defined but not referenced by any rules, suggesting they may be unnecessary.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 600 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** variableCount **
The total number of variables defined in the policy.
Type: Integer
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionQualityReport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionQualityReport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionQualityReport)
# AutomatedReasoningPolicyDefinitionRule
Represents a formal logic rule in an Automated Reasoning policy. For example, rules can be expressed as if-then statements that define logical constraints.
## Contents
** expression **
The formal logic expression of the rule.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[\s\S]+`
Required: Yes
** id **
The unique identifier of the rule within the policy.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
** alternateExpression **
The human-readable form of the rule expression, often in natural language or simplified notation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[\s\S]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionRule)
# AutomatedReasoningPolicyDefinitionType
Represents a custom user-defined viarble type in an Automated Reasoning policy. Types are enum-based and provide additional context beyond predefined variable types.
## Contents
** name **
The name of the custom type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** values **
The possible values for this enum-based type, each with its own description.
Type: Array of [AutomatedReasoningPolicyDefinitionTypeValue](API_AutomatedReasoningPolicyDefinitionTypeValue.md) objects
Array Members: Minimum number of 1 item. Maximum number of 150 items.
Required: Yes
** description **
The description of what the custom type represents.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionType)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionType)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionType)
# AutomatedReasoningPolicyDefinitionTypeValue
Represents a single value within a custom type definition, including its identifier and description.
## Contents
** value **
The actual value or identifier for this type value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** description **
A human-readable description explaining what this type value represents and when it should be used.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionTypeValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionTypeValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionTypeValue)
# AutomatedReasoningPolicyDefinitionTypeValuePair
Associates a type name with a specific value name, used for referencing type values in rules and other policy elements.
## Contents
** typeName **
The name of the custom type that contains the referenced value.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** valueName **
The name of the specific value within the type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionTypeValuePair)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionTypeValuePair)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionTypeValuePair)
# AutomatedReasoningPolicyDefinitionVariable
Represents a variable in an Automated Reasoning policy. Variables represent concepts that can have values assigned during natural language translation.
## Contents
** description **
The description of the variable that explains what it represents and how users might refer to it. Clear and comprehensive descriptions are essential for accurate natural language translation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: Yes
** name **
The name of the variable. Use descriptive names that clearly indicate the concept being represented.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** type **
The data type of the variable. Valid types include bool, int, real, enum, and custom types that you can provide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionVariable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionVariable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDefinitionVariable)
# AutomatedReasoningPolicyDeleteRuleAnnotation
An annotation for removing a rule from an Automated Reasoning policy.
## Contents
** ruleId **
The unique identifier of the rule to delete from the policy.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteRuleAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteRuleAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteRuleAnnotation)
# AutomatedReasoningPolicyDeleteRuleMutation
A mutation operation that removes a rule from the policy definition during the build process.
## Contents
** id **
The unique identifier of the rule to delete.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteRuleMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteRuleMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteRuleMutation)
# AutomatedReasoningPolicyDeleteTypeAnnotation
An annotation for removing a custom type from an Automated Reasoning policy.
## Contents
** name **
The name of the custom type to delete from the policy. The type must not be referenced by any variables or rules.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeAnnotation)
# AutomatedReasoningPolicyDeleteTypeMutation
A mutation operation that removes a custom type from the policy definition during the build process.
## Contents
** name **
The name of the custom type to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeMutation)
# AutomatedReasoningPolicyDeleteTypeValue
Represents a value to be removed from an existing custom type in the policy.
## Contents
** value **
The identifier or name of the value to remove from the type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteTypeValue)
# AutomatedReasoningPolicyDeleteVariableAnnotation
An annotation for removing a variable from an Automated Reasoning policy.
## Contents
** name **
The name of the variable to delete from the policy. The variable must not be referenced by any rules.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteVariableAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteVariableAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteVariableAnnotation)
# AutomatedReasoningPolicyDeleteVariableMutation
A mutation operation that removes a variable from the policy definition during the build process.
## Contents
** name **
The name of the variable to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteVariableMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteVariableMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDeleteVariableMutation)
# AutomatedReasoningPolicyDisjointRuleSet
Represents a set of rules that operate on completely separate variables, indicating they address different concerns or domains within the policy.
## Contents
** rules **
The list of rules that form this disjoint set, all operating on the same set of variables.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 500 items.
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
** variables **
The set of variables that are used by the rules in this disjoint set.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 600 items.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyDisjointRuleSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyDisjointRuleSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyDisjointRuleSet)
# AutomatedReasoningPolicyFidelityReport
A comprehensive analysis report that measures how accurately a generated policy represents the source documents. The report includes coverage and accuracy scores, detailed grounding information linking policy elements to source statements, and annotated document content.
## Contents
** accuracyScore **
A score from 0.0 to 1.0 indicating how accurate the policy rules are relative to the source documents. A higher score means the policy rules more faithfully represent the source material.
Type: Double
Valid Range: Minimum value of 0.0. Maximum value of 1.0.
Required: Yes
** coverageScore **
A score from 0.0 to 1.0 indicating how well the policy covers the statements in the source documents. A higher score means more of the source content is represented in the policy.
Type: Double
Valid Range: Minimum value of 0.0. Maximum value of 1.0.
Required: Yes
** documentSources **
A list of source documents with their content broken down into atomic statements and annotated with line numbers for precise referencing.
Type: Array of [AutomatedReasoningPolicyReportSourceDocument](API_AutomatedReasoningPolicyReportSourceDocument.md) objects
Required: Yes
** ruleReports **
A mapping from rule identifiers to detailed fidelity reports for each rule, showing which source statements ground each rule and how accurate it is.
Type: String to [AutomatedReasoningPolicyRuleReport](API_AutomatedReasoningPolicyRuleReport.md) object map
Key Length Constraints: Fixed length of 12.
Key Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
** variableReports **
A mapping from variable names to detailed fidelity reports for each variable, showing which source statements ground each variable and how accurate it is.
Type: String to [AutomatedReasoningPolicyVariableReport](API_AutomatedReasoningPolicyVariableReport.md) object map
Key Length Constraints: Minimum length of 1. Maximum length of 64.
Key Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyFidelityReport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyFidelityReport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyFidelityReport)
# AutomatedReasoningPolicyGeneratedTestCase
Represents a generated test case, consisting of query content, guard content, and expected results.
## Contents
** expectedAggregatedFindingsResult **
The expected results of the generated test case. Possible values include:
+ `VALID` - The claims are true. The claims are implied by the premises and the Automated Reasoning policy. Given the Automated Reasoning policy and premises, it is not possible for these claims to be false. In other words, there are no alternative answers that are true that contradict the claims.
+ `INVALID` - The claims are false. The claims are not implied by the premises and Automated Reasoning policy. Furthermore, there exists different claims that are consistent with the premises and Automated Reasoning policy.
+ `SATISFIABLE` - The claims can be true or false. It depends on what assumptions are made for the claim to be implied from the premises and Automated Reasoning policy rules. In this situation, different assumptions can make input claims false and alternative claims true.
+ `IMPOSSIBLE` - Automated Reasoning can’t make a statement about the claims. This can happen if the premises are logically incorrect, or if there is a conflict within the Automated Reasoning policy itself.
Type: String
Valid Values: `VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION`
Required: Yes
** guardContent **
The output content that's validated by the Automated Reasoning policy. This represents the foundation model response that will be checked for accuracy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
** queryContent **
The input query or prompt that generated the content. This provides context for the validation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyGeneratedTestCase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyGeneratedTestCase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyGeneratedTestCase)
# AutomatedReasoningPolicyGeneratedTestCases
Contains a comprehensive test suite generated by the build workflow, providing validation capabilities for automated reasoning policies.
## Contents
** generatedTestCases **
Represents a collection of generated test cases.
Type: Array of [AutomatedReasoningPolicyGeneratedTestCase](API_AutomatedReasoningPolicyGeneratedTestCase.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyGeneratedTestCases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyGeneratedTestCases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyGeneratedTestCases)
# AutomatedReasoningPolicyGenerateFidelityReportContent
Configuration for generating a fidelity report, which can either analyze new documents or update an existing fidelity report with a new policy definition.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** documents **
Source documents to analyze for generating a new fidelity report. The documents will be processed to create atomic statements and grounding information.
Type: Array of [AutomatedReasoningPolicyBuildWorkflowDocument](API_AutomatedReasoningPolicyBuildWorkflowDocument.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyGenerateFidelityReportContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyGenerateFidelityReportContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyGenerateFidelityReportContent)
# AutomatedReasoningPolicyIngestContentAnnotation
An annotation for processing and incorporating new content into an Automated Reasoning policy.
## Contents
** content **
The new content to be analyzed and incorporated into the policy, such as additional documents or rule descriptions.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Pattern: `[\s\S]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyIngestContentAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyIngestContentAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyIngestContentAnnotation)
# AutomatedReasoningPolicyMutation
A container for various mutation operations that can be applied to an Automated Reasoning policy, including adding, updating, and deleting policy elements.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** addRule **
A mutation to add a new rule to the policy.
Type: [AutomatedReasoningPolicyAddRuleMutation](API_AutomatedReasoningPolicyAddRuleMutation.md) object
Required: No
** addType **
A mutation to add a new custom type to the policy.
Type: [AutomatedReasoningPolicyAddTypeMutation](API_AutomatedReasoningPolicyAddTypeMutation.md) object
Required: No
** addVariable **
A mutation to add a new variable to the policy.
Type: [AutomatedReasoningPolicyAddVariableMutation](API_AutomatedReasoningPolicyAddVariableMutation.md) object
Required: No
** deleteRule **
A mutation to remove a rule from the policy.
Type: [AutomatedReasoningPolicyDeleteRuleMutation](API_AutomatedReasoningPolicyDeleteRuleMutation.md) object
Required: No
** deleteType **
A mutation to remove a custom type from the policy.
Type: [AutomatedReasoningPolicyDeleteTypeMutation](API_AutomatedReasoningPolicyDeleteTypeMutation.md) object
Required: No
** deleteVariable **
A mutation to remove a variable from the policy.
Type: [AutomatedReasoningPolicyDeleteVariableMutation](API_AutomatedReasoningPolicyDeleteVariableMutation.md) object
Required: No
** updateRule **
A mutation to modify an existing rule in the policy.
Type: [AutomatedReasoningPolicyUpdateRuleMutation](API_AutomatedReasoningPolicyUpdateRuleMutation.md) object
Required: No
** updateType **
A mutation to modify an existing custom type in the policy.
Type: [AutomatedReasoningPolicyUpdateTypeMutation](API_AutomatedReasoningPolicyUpdateTypeMutation.md) object
Required: No
** updateVariable **
A mutation to modify an existing variable in the policy.
Type: [AutomatedReasoningPolicyUpdateVariableMutation](API_AutomatedReasoningPolicyUpdateVariableMutation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyMutation)
# AutomatedReasoningPolicyPlanning
Represents the planning phase of policy build workflow, where the system analyzes source content and determines what operations to perform.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyPlanning)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyPlanning)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyPlanning)
# AutomatedReasoningPolicyReportSourceDocument
Represents a source document that was analyzed during fidelity report generation, including the document's metadata and its content broken down into atomic statements.
## Contents
** atomicStatements **
The list of atomic statements extracted from this document, representing the fundamental units of meaning used for grounding.
Type: Array of [AutomatedReasoningPolicyAtomicStatement](API_AutomatedReasoningPolicyAtomicStatement.md) objects
Required: Yes
** documentContent **
The document's content organized into annotated chunks with line number information for precise referencing.
Type: Array of [AutomatedReasoningPolicyAnnotatedChunk](API_AutomatedReasoningPolicyAnnotatedChunk.md) objects
Required: Yes
** documentHash **
A SHA-256 hash of the document content, used for verification and ensuring the document hasn't changed since analysis.
Type: String
Length Constraints: Fixed length of 64.
Required: Yes
** documentId **
A unique identifier for this document within the fidelity report.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8.
Pattern: `[a-zA-Z0-9]*`
Required: Yes
** documentName **
The name of the source document that was analyzed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyReportSourceDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyReportSourceDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyReportSourceDocument)
# AutomatedReasoningPolicyRuleReport
Provides detailed fidelity analysis for a specific policy rule, including which source document statements support it and how accurate the rule is.
## Contents
** rule **
The identifier of the policy rule being analyzed in this report.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
** accuracyJustification **
A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
** accuracyScore **
A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.
Type: Double
Valid Range: Minimum value of 0.0. Maximum value of 1.0.
Required: No
** groundingJustifications **
Explanations describing how the source statements support and justify this specific rule.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
** groundingStatements **
References to statements from the source documents that provide the basis or justification for this rule.
Type: Array of [AutomatedReasoningPolicyStatementReference](API_AutomatedReasoningPolicyStatementReference.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyRuleReport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyRuleReport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyRuleReport)
# AutomatedReasoningPolicyScenario
Represents a test scenario used to validate an Automated Reasoning policy, including the test conditions and expected outcomes.
## Contents
** alternateExpression **
An alternative way to express the same test scenario, used for validation and comparison purposes.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: Yes
** expectedResult **
The expected outcome when this scenario is evaluated against the policy (e.g., PASS, FAIL, VIOLATION).
Type: String
Valid Values: `VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION`
Required: Yes
** expression **
The logical expression or condition that defines this test scenario.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: Yes
** ruleIds **
The list of rule identifiers that are expected to be triggered or evaluated by this test scenario.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyScenario)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyScenario)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyScenario)
# AutomatedReasoningPolicyScenarios
Contains a comprehensive entity encompassing all the scenarios generated by the build workflow, which can be used to validate an Automated Reasoning policy.
## Contents
** policyScenarios **
Represents a collection of generated policy scenarios.
Type: Array of [AutomatedReasoningPolicyScenario](API_AutomatedReasoningPolicyScenario.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyScenarios)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyScenarios)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyScenarios)
# AutomatedReasoningPolicySourceDocument
Represents a source document that was processed during a build workflow. Contains the document content, metadata, and a hash for verification.
## Contents
** document **
The raw content of the source document as a binary blob.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 5000000.
Required: Yes
** documentContentType **
The MIME type of the document (e.g., application/pdf, text/plain).
Type: String
Valid Values: `pdf | txt`
Required: Yes
** documentHash **
A SHA-256 hash of the document content, used for verification and integrity checking.
Type: String
Length Constraints: Fixed length of 64.
Required: Yes
** documentName **
The name of the source document for identification purposes.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
** documentDescription **
An optional description providing context about the document's content and purpose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicySourceDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicySourceDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicySourceDocument)
# AutomatedReasoningPolicyStatementLocation
Describes the location of a statement within a source document using line numbers.
## Contents
** lines **
The line numbers in the source document where this statement appears.
Type: Array of integers
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyStatementLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyStatementLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyStatementLocation)
# AutomatedReasoningPolicyStatementReference
References a specific atomic statement within a source document, used to link policy elements back to their source material.
## Contents
** documentId **
The unique identifier of the document containing the referenced statement.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8.
Pattern: `[a-zA-Z0-9]*`
Required: Yes
** statementId **
The unique identifier of the specific atomic statement being referenced.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8.
Pattern: `[a-zA-Z0-9]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyStatementReference)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyStatementReference)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyStatementReference)
# AutomatedReasoningPolicySummary
Contains summary information about an Automated Reasoning policy, including metadata and timestamps.
## Contents
** createdAt **
The timestamp when the policy was created.
Type: Timestamp
Required: Yes
** name **
The name of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[0-9a-zA-Z-_ ]+`
Required: Yes
** policyArn **
The Amazon Resource Name (ARN) of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** policyId **
The unique identifier of the policy.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `[a-z0-9]{12}`
Required: Yes
** updatedAt **
The timestamp when the policy was last updated.
Type: Timestamp
Required: Yes
** version **
The version of the policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `([1-9][0-9]{0,11})`
Required: Yes
** description **
The description of the policy.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicySummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicySummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicySummary)
# AutomatedReasoningPolicyTestCase
Represents a test for validating an Automated Reasoning policy. tests contain sample inputs and expected outcomes to verify policy behavior.
## Contents
** createdAt **
The timestamp when the test was created.
Type: Timestamp
Required: Yes
** guardContent **
The output content to be validated by the policy, typically representing a foundation model response.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
** testCaseId **
The unique identifier of the test.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[0-9A-Z]{12}`
Required: Yes
** updatedAt **
The timestamp when the test was last updated.
Type: Timestamp
Required: Yes
** confidenceThreshold **
The minimum confidence level for logic validation. Content meeting this threshold is considered high-confidence and can be validated.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** expectedAggregatedFindingsResult **
The expected result of the Automated Reasoning check for this test.
Type: String
Valid Values: `VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION`
Required: No
** queryContent **
The input query or prompt that generated the content. This provides context for the validation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyTestCase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyTestCase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyTestCase)
# AutomatedReasoningPolicyTestResult
Contains the results of testing an Automated Reasoning policy against various scenarios and validation checks.
## Contents
** policyArn **
The Amazon Resource Name (ARN) of the Automated Reasoning policy that was tested.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** testCase **
The test case that was executed, including the input content, expected results, and configuration parameters used during validation.
Type: [AutomatedReasoningPolicyTestCase](API_AutomatedReasoningPolicyTestCase.md) object
Required: Yes
** testRunStatus **
The overall status of the test run (e.g., COMPLETED, FAILED, IN\$1PROGRESS).
Type: String
Valid Values: `NOT_STARTED | SCHEDULED | IN_PROGRESS | COMPLETED | FAILED`
Required: Yes
** updatedAt **
The timestamp when the test results were last updated.
Type: Timestamp
Required: Yes
** aggregatedTestFindingsResult **
A summary of all test findings, aggregated to provide an overall assessment of policy quality and correctness.
Type: String
Valid Values: `VALID | INVALID | SATISFIABLE | IMPOSSIBLE | TRANSLATION_AMBIGUOUS | TOO_COMPLEX | NO_TRANSLATION`
Required: No
** testFindings **
Detailed findings from the test run, including any issues, violations, or unexpected behaviors discovered.
Type: Array of [AutomatedReasoningCheckFinding](API_AutomatedReasoningCheckFinding.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
** testRunResult **
The overall result of the test run, indicating whether the policy passed or failed validation.
Type: String
Valid Values: `PASSED | FAILED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyTestResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyTestResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyTestResult)
# AutomatedReasoningPolicyTypeValueAnnotation
An annotation for managing values within custom types, including adding, updating, or removing specific type values.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** addTypeValue **
An operation to add a new value to an existing custom type.
Type: [AutomatedReasoningPolicyAddTypeValue](API_AutomatedReasoningPolicyAddTypeValue.md) object
Required: No
** deleteTypeValue **
An operation to remove a value from an existing custom type.
Type: [AutomatedReasoningPolicyDeleteTypeValue](API_AutomatedReasoningPolicyDeleteTypeValue.md) object
Required: No
** updateTypeValue **
An operation to modify an existing value within a custom type.
Type: [AutomatedReasoningPolicyUpdateTypeValue](API_AutomatedReasoningPolicyUpdateTypeValue.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyTypeValueAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyTypeValueAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyTypeValueAnnotation)
# AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation
An annotation for updating the policy based on feedback about how specific rules performed during testing or real-world usage.
## Contents
** feedback **
The feedback information about rule performance, including suggestions for improvements or corrections.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: Yes
** ruleIds **
The list of rule identifiers that the feedback applies to.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateFromRuleFeedbackAnnotation)
# AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation
An annotation for updating the policy based on feedback about how it performed on specific test scenarios.
## Contents
** scenarioExpression **
The logical expression that defines the test scenario that generated this feedback.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: Yes
** feedback **
The feedback information about scenario performance, including any issues or improvements identified.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
** ruleIds **
The list of rule identifiers that were involved in the scenario being evaluated.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateFromScenarioFeedbackAnnotation)
# AutomatedReasoningPolicyUpdateRuleAnnotation
An annotation for modifying an existing rule in an Automated Reasoning policy.
## Contents
** expression **
The new formal logical expression for the rule, replacing the previous expression.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[\s\S]+`
Required: Yes
** ruleId **
The unique identifier of the rule to update.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `[A-Z][0-9A-Z]{11}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateRuleAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateRuleAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateRuleAnnotation)
# AutomatedReasoningPolicyUpdateRuleMutation
A mutation operation that modifies an existing rule in the policy definition during the build process.
## Contents
** rule **
The updated rule definition containing the modified formal logical expression and any changed metadata for the existing rule.
Type: [AutomatedReasoningPolicyDefinitionRule](API_AutomatedReasoningPolicyDefinitionRule.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateRuleMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateRuleMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateRuleMutation)
# AutomatedReasoningPolicyUpdateTypeAnnotation
An annotation for modifying an existing custom type in an Automated Reasoning policy.
## Contents
** name **
The current name of the custom type to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** values **
The updated list of values for the custom type, which can include additions, modifications, or removals.
Type: Array of [AutomatedReasoningPolicyTypeValueAnnotation](API_AutomatedReasoningPolicyTypeValueAnnotation.md) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: Yes
** description **
The new description for the custom type, replacing the previous description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
** newName **
The new name for the custom type, if you want to rename it. If not provided, the name remains unchanged.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeAnnotation)
# AutomatedReasoningPolicyUpdateTypeMutation
A mutation operation that modifies an existing custom type in the policy definition during the build process.
## Contents
** type **
The updated type definition containing the modified name, description, or values for the existing custom type.
Type: [AutomatedReasoningPolicyDefinitionType](API_AutomatedReasoningPolicyDefinitionType.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeMutation)
# AutomatedReasoningPolicyUpdateTypeValue
Represents a modification to a value within an existing custom type.
## Contents
** value **
The current identifier or name of the type value to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** description **
The new description for the type value, replacing the previous description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
** newValue **
The new identifier or name for the type value, if you want to rename it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateTypeValue)
# AutomatedReasoningPolicyUpdateVariableAnnotation
An annotation for modifying an existing variable in an Automated Reasoning policy.
## Contents
** name **
The current name of the variable to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** description **
The new description for the variable, replacing the previous description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: No
** newName **
The new name for the variable, if you want to rename it. If not provided, the name remains unchanged.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateVariableAnnotation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateVariableAnnotation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateVariableAnnotation)
# AutomatedReasoningPolicyUpdateVariableMutation
A mutation operation that modifies an existing variable in the policy definition during the build process.
## Contents
** variable **
The updated variable definition containing the modified name, type, or description for the existing variable.
Type: [AutomatedReasoningPolicyDefinitionVariable](API_AutomatedReasoningPolicyDefinitionVariable.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateVariableMutation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateVariableMutation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyUpdateVariableMutation)
# AutomatedReasoningPolicyVariableReport
Provides detailed fidelity analysis for a specific policy variable, including which source document statements support it and how accurate the variable definition is.
## Contents
** policyVariable **
The name of the policy variable being analyzed in this report.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[A-Za-z][A-Za-z0-9_]*`
Required: Yes
** accuracyJustification **
A textual explanation of the accuracy score, describing why the variable received this particular accuracy rating.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
** accuracyScore **
A score from 0.0 to 1.0 indicating how accurately this variable represents concepts from the source material.
Type: Double
Valid Range: Minimum value of 0.0. Maximum value of 1.0.
Required: No
** groundingJustifications **
Explanations describing how the source statements support and justify this specific variable definition.
Type: Array of strings
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
** groundingStatements **
References to statements from the source documents that provide the basis or justification for this variable.
Type: Array of [AutomatedReasoningPolicyStatementReference](API_AutomatedReasoningPolicyStatementReference.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyVariableReport)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyVariableReport)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyVariableReport)
# AutomatedReasoningPolicyWorkflowTypeContent
Defines the content and configuration for different types of policy build workflows.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** documents **
The list of documents to be processed in a document ingestion workflow.
Type: Array of [AutomatedReasoningPolicyBuildWorkflowDocument](API_AutomatedReasoningPolicyBuildWorkflowDocument.md) objects
Array Members: Fixed number of 1 item.
Required: No
** generateFidelityReportContent **
The content configuration for generating a fidelity report workflow. This can include source documents to analyze or an existing fidelity report to update with a new policy definition.
Type: [AutomatedReasoningPolicyGenerateFidelityReportContent](API_AutomatedReasoningPolicyGenerateFidelityReportContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** policyRepairAssets **
The assets and instructions needed for a policy repair workflow, including repair annotations and guidance.
Type: [AutomatedReasoningPolicyBuildWorkflowRepairContent](API_AutomatedReasoningPolicyBuildWorkflowRepairContent.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/AutomatedReasoningPolicyWorkflowTypeContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/AutomatedReasoningPolicyWorkflowTypeContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/AutomatedReasoningPolicyWorkflowTypeContent)
# BatchDeleteEvaluationJobError
A JSON array that provides the status of the evaluation jobs being deleted.
## Contents
** code **
A HTTP status code of the evaluation job being deleted.
Type: String
Required: Yes
** jobIdentifier **
The ARN of the evaluation job being deleted.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})`
Required: Yes
** message **
A status message about the evaluation job deletion.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/BatchDeleteEvaluationJobError)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/BatchDeleteEvaluationJobError)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/BatchDeleteEvaluationJobError)
# BatchDeleteEvaluationJobItem
An evaluation job for deletion, and it’s current status.
## Contents
** jobIdentifier **
The Amazon Resource Name (ARN) of the evaluation job for deletion.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12})`
Required: Yes
** jobStatus **
The status of the evaluation job for deletion.
Type: String
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/BatchDeleteEvaluationJobItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/BatchDeleteEvaluationJobItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/BatchDeleteEvaluationJobItem)
# BedrockEvaluatorModel
The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.
## Contents
** modelIdentifier **
The Amazon Resource Name (ARN) of the evaluator model used used in knowledge base evaluation job or in model evaluation job that use a model as judge.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))$|(^[a-z0-9-]+[.][a-z0-9-]+([.][a-z0-9-]+)*(:[a-z0-9-]+)?$)|^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/BedrockEvaluatorModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/BedrockEvaluatorModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/BedrockEvaluatorModel)
# ByteContentDoc
Contains the document contained in the wrapper object, along with its attributes/fields.
## Contents
** contentType **
The MIME type of the document contained in the wrapper object.
Type: String
Pattern: `.*[a-z]{1,20}/.{1,20}.*`
Required: Yes
** data **
The byte value of the file to upload, encoded as a Base-64 string.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 10485760.
Required: Yes
** identifier **
The file name of the document contained in the wrapper object.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ByteContentDoc)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ByteContentDoc)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ByteContentDoc)
# CloudWatchConfig
CloudWatch logging configuration.
## Contents
** logGroupName **
The log group name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Required: Yes
** roleArn **
The role Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** largeDataDeliveryS3Config **
S3 configuration for delivering a large amount of data.
Type: [S3Config](API_S3Config.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CloudWatchConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CloudWatchConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CloudWatchConfig)
# CustomizationConfig
A model customization configuration
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** distillationConfig **
The Distillation configuration for the custom model.
Type: [DistillationConfig](API_DistillationConfig.md) object
Required: No
** rftConfig **
Configuration settings for reinforcement fine-tuning (RFT) model customization, including grader configuration and hyperparameters.
Type: [RFTConfig](API_RFTConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CustomizationConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CustomizationConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CustomizationConfig)
# CustomMetricBedrockEvaluatorModel
Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.
## Contents
** modelIdentifier **
The Amazon Resource Name (ARN) of the evaluator model for custom metrics. For a list of supported evaluator models, see [Evaluate model performance using another LLM as a judge](https://docs.aws.amazon.com/bedrock/latest/userguide/evaluation-judge.html) and [Evaluate the performance of RAG sources using Amazon Bedrock evaluations](https://docs.aws.amazon.com/bedrock/latest/userguide/evaluation-kb.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))$|(^[a-z0-9-]+[.][a-z0-9-]+([.][a-z0-9-]+)*(:[a-z0-9-]+)?$)|^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CustomMetricBedrockEvaluatorModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CustomMetricBedrockEvaluatorModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CustomMetricBedrockEvaluatorModel)
# CustomMetricDefinition
The definition of a custom metric for use in an Amazon Bedrock evaluation job. A custom metric definition includes a metric name, prompt (instructions) and optionally, a rating scale. Your prompt must include a task description and input variables. The required input variables are different for model-as-a-judge and RAG evaluations.
For more information about how to define a custom metric in Amazon Bedrock, see [Create a prompt for a custom metrics (LLM-as-a-judge model evaluations)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-custom-metrics-prompt-formats.html) and [Create a prompt for a custom metrics (RAG evaluations)](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-evaluation-custom-metrics-prompt-formats.html).
## Contents
** instructions **
The prompt for a custom metric that instructs the evaluator model how to rate the model or RAG source under evaluation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5000.
Required: Yes
** name **
The name for a custom metric. Names must be unique in your AWS region.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[0-9a-zA-Z-_.]+`
Required: Yes
** ratingScale **
Defines the rating scale to be used for a custom metric. We recommend that you always define a ratings scale when creating a custom metric. If you don't define a scale, Amazon Bedrock won't be able to visually display the results of the evaluation in the console or calculate average values of numerical scores. For more information on specifying a rating scale, see [Specifying an output schema (rating scale)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-custom-metrics-prompt-formats.html#model-evaluation-custom-metrics-prompt-formats-schema).
Type: Array of [RatingScaleItem](API_RatingScaleItem.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CustomMetricDefinition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CustomMetricDefinition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CustomMetricDefinition)
# CustomMetricEvaluatorModelConfig
Configuration of the evaluator model you want to use to evaluate custom metrics in an Amazon Bedrock evaluation job.
## Contents
** bedrockEvaluatorModels **
Defines the model you want to evaluate custom metrics in an Amazon Bedrock evaluation job.
Type: Array of [CustomMetricBedrockEvaluatorModel](API_CustomMetricBedrockEvaluatorModel.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CustomMetricEvaluatorModelConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CustomMetricEvaluatorModelConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CustomMetricEvaluatorModelConfig)
# CustomModelDeploymentSummary
Contains summary information about a custom model deployment, including its ARN, name, status, and associated custom model.
## Contents
** createdAt **
The date and time when the custom model deployment was created.
Type: Timestamp
Required: Yes
** customModelDeploymentArn **
The Amazon Resource Name (ARN) of the custom model deployment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model-deployment/[a-z0-9]{12}`
Required: Yes
** customModelDeploymentName **
The name of the custom model deployment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: Yes
** modelArn **
The Amazon Resource Name (ARN) of the custom model associated with this deployment.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
Required: Yes
** status **
The status of the custom model deployment. Possible values are `CREATING`, `ACTIVE`, and `FAILED`.
Type: String
Valid Values: `Creating | Active | Failed`
Required: Yes
** failureMessage **
If the deployment status is `FAILED`, this field contains a message describing the failure reason.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** lastUpdatedAt **
The date and time when the custom model deployment was last modified.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CustomModelDeploymentSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CustomModelDeploymentSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CustomModelDeploymentSummary)
# CustomModelDeploymentUpdateDetails
Details about an update to a custom model deployment, including the new custom model resource ARN and current update status.
## Contents
** modelArn **
ARN of the new custom model being deployed as part of the update.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
Required: Yes
** updateStatus **
Current status of the deployment update.
Type: String
Valid Values: `Updating | UpdateCompleted | UpdateFailed`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CustomModelDeploymentUpdateDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CustomModelDeploymentUpdateDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CustomModelDeploymentUpdateDetails)
# CustomModelSummary
Summary information for a custom model.
## Contents
** baseModelArn **
The base model Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
Required: Yes
** baseModelName **
The base model name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})`
Required: Yes
** creationTime **
Creation time of the model.
Type: Timestamp
Required: Yes
** modelArn **
The Amazon Resource Name (ARN) of the custom model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
Required: Yes
** modelName **
The name of the custom model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: Yes
** customizationType **
Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html).
Type: String
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION | REINFORCEMENT_FINE_TUNING | IMPORTED`
Required: No
** modelStatus **
The current status of the custom model. Possible values include:
+ `Creating` - The model is being created and validated.
+ `Active` - The model has been successfully created and is ready for use.
+ `Failed` - The model creation process failed.
Type: String
Valid Values: `Active | Creating | Failed`
Required: No
** ownerAccountId **
The unique identifier of the account that owns the model.
Type: String
Pattern: `[0-9]{12}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CustomModelSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CustomModelSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CustomModelSummary)
# CustomModelUnits
A `CustomModelUnit` (CMU) is an abstract view of the hardware utilization that Amazon Bedrock needs to host a single copy of your custom model. A model copy represents a single instance of your imported model that is ready to serve inference requests. Amazon Bedrock determines the number of custom model units that a model copy needs when you import the custom model.
You can use `CustomModelUnits` to estimate the cost of running your custom model. For more information, see [Calculate the cost of running a custom model](https://docs.aws.amazon.com/bedrock/latest/userguide/import-model-calculate-cost.html).
## Contents
** customModelUnitsPerModelCopy **
The number of custom model units used to host a model copy.
Type: Integer
Required: No
** customModelUnitsVersion **
The version of the custom model unit. Use to determine the billing rate for the custom model unit.
Type: String
Pattern: `v\d+.\d+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/CustomModelUnits)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/CustomModelUnits)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/CustomModelUnits)
# DataProcessingDetails
For a Distillation job, the status details for the data processing sub-task of the job.
## Contents
** creationTime **
The start time of the data processing sub-task of the job.
Type: Timestamp
Required: No
** lastModifiedTime **
The latest update to the data processing sub-task of the job.
Type: Timestamp
Required: No
** status **
The status of the data processing sub-task of the job.
Type: String
Valid Values: `InProgress | Completed | Stopping | Stopped | Failed | NotStarted`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DataProcessingDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DataProcessingDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DataProcessingDetails)
# DimensionalPriceRate
Dimensional price rate.
## Contents
** description **
Description of the price rate.
Type: String
Required: No
** dimension **
Dimension for the price rate.
Type: String
Required: No
** price **
Single-dimensional rate information.
Type: String
Required: No
** unit **
Unit associated with the price.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DimensionalPriceRate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DimensionalPriceRate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DimensionalPriceRate)
# DistillationConfig
Settings for distilling a foundation model into a smaller and more efficient model.
## Contents
** teacherModelConfig **
The teacher model configuration.
Type: [TeacherModelConfig](API_TeacherModelConfig.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/DistillationConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/DistillationConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/DistillationConfig)
# EndpointConfig
Specifies the configuration for the endpoint.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** sageMaker **
The configuration specific to Amazon SageMaker for the endpoint.
Type: [SageMakerEndpoint](API_SageMakerEndpoint.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EndpointConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EndpointConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EndpointConfig)
# EvaluationBedrockModel
Contains the ARN of the Amazon Bedrock model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) specified in your evaluation job. Each Amazon Bedrock model supports different `inferenceParams`. To learn more about supported inference parameters for Amazon Bedrock models, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
The `inferenceParams` are specified using JSON. To successfully insert JSON as string make sure that all quotations are properly escaped. For example, `"temperature":"0.25"` key value pair would need to be formatted as `\"temperature\":\"0.25\"` to successfully accepted in the request.
## Contents
** modelIdentifier **
The ARN of the Amazon Bedrock model or inference profile specified.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:application-inference-profile/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([0-9]{12}:(default-prompt-router|prompt-router)/[a-zA-Z0-9-:.]+)))|(([a-z]{2,4}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:endpoint/[a-z0-9-]{1,63}`
Required: Yes
** inferenceParams **
Each Amazon Bedrock support different inference parameters that change how the model behaves during inference.
For code examples that demonstrate how to use the `inferenceParams` parameter, see [Create a model evaluation job in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-jobs-management-create.html#model-evaluation-jobs-management-create-auto).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1023.
Required: No
** performanceConfig **
Specifies performance settings for the model or inference profile.
Type: [PerformanceConfiguration](API_PerformanceConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationBedrockModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationBedrockModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationBedrockModel)
# EvaluationConfig
The configuration details of either an automated or human-based evaluation job.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** automated **
Contains the configuration details of an automated evaluation job that computes metrics.
Type: [AutomatedEvaluationConfig](API_AutomatedEvaluationConfig.md) object
Required: No
** human **
Contains the configuration details of an evaluation job that uses human workers.
Type: [HumanEvaluationConfig](API_HumanEvaluationConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationConfig)
# EvaluationDataset
Used to specify the name of a built-in prompt dataset and optionally, the Amazon S3 bucket where a custom prompt dataset is saved.
## Contents
** name **
Used to specify supported built-in prompt datasets. Valid values are `Builtin.Bold`, `Builtin.BoolQ`, `Builtin.NaturalQuestions`, `Builtin.Gigaword`, `Builtin.RealToxicityPrompts`, `Builtin.TriviaQA`, `Builtin.T-Rex`, `Builtin.WomensEcommerceClothingReviews` and `Builtin.Wikitext2`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[0-9a-zA-Z-_.]+`
Required: Yes
** datasetLocation **
For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.
Type: [EvaluationDatasetLocation](API_EvaluationDatasetLocation.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationDataset)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationDataset)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationDataset)
# EvaluationDatasetLocation
The location in Amazon S3 where your prompt dataset is stored.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3Uri **
The S3 URI of the S3 bucket specified in the job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationDatasetLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationDatasetLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationDatasetLocation)
# EvaluationDatasetMetricConfig
Defines the prompt datasets, built-in metric names and custom metric names, and the task type.
## Contents
** dataset **
Specifies the prompt dataset.
Type: [EvaluationDataset](API_EvaluationDataset.md) object
Required: Yes
** metricNames **
The names of the metrics you want to use for your evaluation job.
For knowledge base evaluation jobs that evaluate retrieval only, valid values are "`Builtin.ContextRelevance`", "`Builtin.ContextCoverage`".
For knowledge base evaluation jobs that evaluate retrieval with response generation, valid values are "`Builtin.Correctness`", "`Builtin.Completeness`", "`Builtin.Helpfulness`", "`Builtin.LogicalCoherence`", "`Builtin.Faithfulness`", "`Builtin.Harmfulness`", "`Builtin.Stereotyping`", "`Builtin.Refusal`".
For automated model evaluation jobs, valid values are "`Builtin.Accuracy`", "`Builtin.Robustness`", and "`Builtin.Toxicity`". In model evaluation jobs that use a LLM as judge you can specify "`Builtin.Correctness`", "`Builtin.Completeness"`, "`Builtin.Faithfulness"`, "`Builtin.Helpfulness`", "`Builtin.Coherence`", "`Builtin.Relevance`", "`Builtin.FollowingInstructions`", "`Builtin.ProfessionalStyleAndTone`", You can also specify the following responsible AI related metrics only for model evaluation job that use a LLM as judge "`Builtin.Harmfulness`", "`Builtin.Stereotyping`", and "`Builtin.Refusal`".
For human-based model evaluation jobs, the list of strings must match the `name` parameter specified in `HumanEvaluationCustomMetric`.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[0-9a-zA-Z-_.]+`
Required: Yes
** taskType **
The the type of task you want to evaluate for your evaluation job. This applies only to model evaluation jobs and is ignored for knowledge base evaluation jobs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[A-Za-z0-9]+`
Valid Values: `Summarization | Classification | QuestionAndAnswer | Generation | Custom`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationDatasetMetricConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationDatasetMetricConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationDatasetMetricConfig)
# EvaluationInferenceConfig
The configuration details of the inference model for an evaluation job.
For automated model evaluation jobs, only a single model is supported.
For human-based model evaluation jobs, your annotator can compare the responses for up to two different models.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** models **
Specifies the inference models.
Type: Array of [EvaluationModelConfig](API_EvaluationModelConfig.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: No
** ragConfigs **
Contains the configuration details of the inference for a knowledge base evaluation job, including either the retrieval only configuration or the retrieval with response generation configuration.
Type: Array of [RAGConfig](API_RAGConfig.md) objects
Array Members: Fixed number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationInferenceConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationInferenceConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationInferenceConfig)
# EvaluationInferenceConfigSummary
Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
## Contents
** modelConfigSummary **
A summary of the models used in an Amazon Bedrock model evaluation job. These resources can be models in Amazon Bedrock or models outside of Amazon Bedrock that you use to generate your own inference response data.
Type: [EvaluationModelConfigSummary](API_EvaluationModelConfigSummary.md) object
Required: No
** ragConfigSummary **
A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.
Type: [EvaluationRagConfigSummary](API_EvaluationRagConfigSummary.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationInferenceConfigSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationInferenceConfigSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationInferenceConfigSummary)
# EvaluationModelConfig
Defines the models used in the model evaluation job.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bedrockModel **
Defines the Amazon Bedrock model or inference profile and inference parameters you want used.
Type: [EvaluationBedrockModel](API_EvaluationBedrockModel.md) object
Required: No
** precomputedInferenceSource **
Defines the model used to generate inference response data for a model evaluation job where you provide your own inference response data.
Type: [EvaluationPrecomputedInferenceSource](API_EvaluationPrecomputedInferenceSource.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationModelConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationModelConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationModelConfig)
# EvaluationModelConfigSummary
A summary of the models used in an Amazon Bedrock model evaluation job. These resources can be models in Amazon Bedrock or models outside of Amazon Bedrock that you use to generate your own inference response data.
## Contents
** bedrockModelIdentifiers **
The Amazon Resource Names (ARNs) of the models used for the evaluation job.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:application-inference-profile/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([0-9]{12}:(default-prompt-router|prompt-router)/[a-zA-Z0-9-:.]+)))|(([a-z]{2,4}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:endpoint/[a-z0-9-]{1,63}`
Required: No
** precomputedInferenceSourceIdentifiers **
A label that identifies the models used for a model evaluation job where you provide your own inference response data.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationModelConfigSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationModelConfigSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationModelConfigSummary)
# EvaluationOutputDataConfig
The Amazon S3 location where the results of your evaluation job are saved.
## Contents
** s3Uri **
The Amazon S3 URI where the results of the evaluation job are saved.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationOutputDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationOutputDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationOutputDataConfig)
# EvaluationPrecomputedInferenceSource
A summary of a model used for a model evaluation job where you provide your own inference response data.
## Contents
** inferenceSourceIdentifier **
A label that identifies a model used in a model evaluation job where you provide your own inference response data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationPrecomputedInferenceSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationPrecomputedInferenceSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationPrecomputedInferenceSource)
# EvaluationPrecomputedRagSourceConfig
A summary of a RAG source used for a Knowledge Base evaluation job where you provide your own inference response data.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** retrieveAndGenerateSourceConfig **
A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.
Type: [EvaluationPrecomputedRetrieveAndGenerateSourceConfig](API_EvaluationPrecomputedRetrieveAndGenerateSourceConfig.md) object
Required: No
** retrieveSourceConfig **
A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.
Type: [EvaluationPrecomputedRetrieveSourceConfig](API_EvaluationPrecomputedRetrieveSourceConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationPrecomputedRagSourceConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationPrecomputedRagSourceConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationPrecomputedRagSourceConfig)
# EvaluationPrecomputedRetrieveAndGenerateSourceConfig
A summary of a RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.
## Contents
** ragSourceIdentifier **
A label that identifies the RAG source used for a retrieve-and-generate Knowledge Base evaluation job where you provide your own inference response data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationPrecomputedRetrieveAndGenerateSourceConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationPrecomputedRetrieveAndGenerateSourceConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationPrecomputedRetrieveAndGenerateSourceConfig)
# EvaluationPrecomputedRetrieveSourceConfig
A summary of a RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.
## Contents
** ragSourceIdentifier **
A label that identifies the RAG source used for a retrieve-only Knowledge Base evaluation job where you provide your own inference response data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationPrecomputedRetrieveSourceConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationPrecomputedRetrieveSourceConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationPrecomputedRetrieveSourceConfig)
# EvaluationRagConfigSummary
A summary of the RAG resources used in an Amazon Bedrock Knowledge Base evaluation job. These resources can be Knowledge Bases in Amazon Bedrock or RAG sources outside of Amazon Bedrock that you use to generate your own inference response data.
## Contents
** bedrockKnowledgeBaseIdentifiers **
The Amazon Resource Names (ARNs) of the Knowledge Base resources used for a Knowledge Base evaluation job where Amazon Bedrock invokes the Knowledge Base for you.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: No
** precomputedRagSourceIdentifiers **
A label that identifies the RAG sources used for a Knowledge Base evaluation job where you provide your own inference response data.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]([a-zA-Z0-9._-]){0,255}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationRagConfigSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationRagConfigSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationRagConfigSummary)
# EvaluationSummary
Summary information of an evaluation job.
## Contents
** creationTime **
The time the evaluation job was created.
Type: Timestamp
Required: Yes
** evaluationTaskTypes **
The type of task for model evaluation.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[A-Za-z0-9]+`
Valid Values: `Summarization | Classification | QuestionAndAnswer | Generation | Custom`
Required: Yes
** jobArn **
The Amazon Resource Name (ARN) of the evaluation job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:evaluation-job/[a-z0-9]{12}`
Required: Yes
** jobName **
The name for the evaluation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-z0-9](-*[a-z0-9]){0,62}`
Required: Yes
** jobType **
Specifies whether the evaluation job is automated or human-based.
Type: String
Valid Values: `Human | Automated`
Required: Yes
** status **
The current status of the evaluation job.
Type: String
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting`
Required: Yes
** applicationType **
Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).
Type: String
Valid Values: `ModelEvaluation | RagEvaluation`
Required: No
** customMetricsEvaluatorModelIdentifiers **
The Amazon Resource Names (ARNs) of the models used to compute custom metrics in an Amazon Bedrock evaluation job.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))$|(^[a-z0-9-]+[.][a-z0-9-]+([.][a-z0-9-]+)*(:[a-z0-9-]+)?$)|^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: No
** evaluatorModelIdentifiers **
The Amazon Resource Names (ARNs) of the models used to compute the metrics for a knowledge base evaluation job.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))))$|(^[a-z0-9-]+[.][a-z0-9-]+([.][a-z0-9-]+)*(:[a-z0-9-]+)?$)|^[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: No
** inferenceConfigSummary **
Identifies the models, Knowledge Bases, or other RAG sources evaluated in a model or Knowledge Base evaluation job.
Type: [EvaluationInferenceConfigSummary](API_EvaluationInferenceConfigSummary.md) object
Required: No
** modelIdentifiers **
*This member has been deprecated.*
The Amazon Resource Names (ARNs) of the model(s) used for the evaluation job.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|([0-9]{12}:provisioned-model/[a-z0-9]{12})|([0-9]{12}:imported-model/[a-z0-9]{12})|([0-9]{12}:application-inference-profile/[a-z0-9]{12})|([0-9]{12}:inference-profile/(([a-z-]{2,8}.)[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([0-9]{12}:(default-prompt-router|prompt-router)/[a-zA-Z0-9-:.]+)))|(([a-z]{2,4}[.]{1})([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63})))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.:]?[a-z0-9-]{1,63}))|arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:endpoint/[a-z0-9-]{1,63}`
Required: No
** ragIdentifiers **
*This member has been deprecated.*
The Amazon Resource Names (ARNs) of the knowledge base resources used for a knowledge base evaluation job.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluationSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluationSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluationSummary)
# EvaluatorModelConfig
Specifies the model configuration for the evaluator model. `EvaluatorModelConfig` is required for evaluation jobs that use a knowledge base or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bedrockEvaluatorModels **
The evaluator model used in knowledge base evaluation job or in model evaluation job that use a model as judge. This model computes all evaluation related metrics.
Type: Array of [BedrockEvaluatorModel](API_BedrockEvaluatorModel.md) objects
Array Members: Fixed number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/EvaluatorModelConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/EvaluatorModelConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/EvaluatorModelConfig)
# ExternalSource
The unique external source of the content contained in the wrapper object.
## Contents
** sourceType **
The source type of the external source wrapper object.
Type: String
Valid Values: `S3 | BYTE_CONTENT`
Required: Yes
** byteContent **
The identifier, content type, and data of the external source wrapper object.
Type: [ByteContentDoc](API_ByteContentDoc.md) object
Required: No
** s3Location **
The S3 location of the external source wrapper object.
Type: [S3ObjectDoc](API_S3ObjectDoc.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ExternalSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ExternalSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ExternalSource)
# ExternalSourcesGenerationConfiguration
The response generation configuration of the external source wrapper object.
## Contents
** additionalModelRequestFields **
Additional model parameters and their corresponding values not included in the text inference configuration for an external source. Takes in custom model parameters specific to the language model being used.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** guardrailConfiguration **
Configuration details for the guardrail.
Type: [GuardrailConfiguration](API_GuardrailConfiguration.md) object
Required: No
** kbInferenceConfig **
Configuration details for inference when using `RetrieveAndGenerate` to generate responses while using an external source.
Type: [KbInferenceConfig](API_KbInferenceConfig.md) object
Required: No
** promptTemplate **
Contains the template for the prompt for the external source wrapper object.
Type: [PromptTemplate](API_PromptTemplate.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ExternalSourcesGenerationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ExternalSourcesGenerationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ExternalSourcesGenerationConfiguration)
# ExternalSourcesRetrieveAndGenerateConfiguration
The configuration of the external source wrapper object in the `retrieveAndGenerate` function.
## Contents
** modelArn **
The Amazon Resource Name (ARN) of the foundation model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) used to generate responses.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:(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
** sources **
The document for the external source wrapper object in the `retrieveAndGenerate` function.
Type: Array of [ExternalSource](API_ExternalSource.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** generationConfiguration **
Contains configurations details for response generation based on retrieved text chunks.
Type: [ExternalSourcesGenerationConfiguration](API_ExternalSourcesGenerationConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ExternalSourcesRetrieveAndGenerateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ExternalSourcesRetrieveAndGenerateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ExternalSourcesRetrieveAndGenerateConfiguration)
# FieldForReranking
Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance.
## Contents
** fieldName **
The name of the metadata field to be used during the reranking process.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/FieldForReranking)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/FieldForReranking)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/FieldForReranking)
# FilterAttribute
Specifies the name of the metadata attribute/field to apply filters. You must match the name of the attribute/field in your data source/document metadata.
## Contents
** key **
The name of metadata attribute/field, which must match the name in your data source/document metadata.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** value **
The value of the metadata attribute/field.
Type: JSON value
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/FilterAttribute)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/FilterAttribute)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/FilterAttribute)
# FoundationModelDetails
Information about a foundation model.
## Contents
** modelArn **
The model Amazon Resource Name (ARN).
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}`
Required: Yes
** modelId **
The model identifier.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: Yes
** customizationsSupported **
The customization that the model supports.
Type: Array of strings
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION`
Required: No
** inferenceTypesSupported **
The inference types that the model supports.
Type: Array of strings
Valid Values: `ON_DEMAND | PROVISIONED`
Required: No
** inputModalities **
The input modalities that the model supports.
Type: Array of strings
Valid Values: `TEXT | IMAGE | EMBEDDING`
Required: No
** modelLifecycle **
Contains details about whether a model version is available or deprecated
Type: [FoundationModelLifecycle](API_FoundationModelLifecycle.md) object
Required: No
** modelName **
The model name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: `.*`
Required: No
** outputModalities **
The output modalities that the model supports.
Type: Array of strings
Valid Values: `TEXT | IMAGE | EMBEDDING`
Required: No
** providerName **
The model's provider name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: `.*`
Required: No
** responseStreamingSupported **
Indicates whether the model supports streaming.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/FoundationModelDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/FoundationModelDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/FoundationModelDetails)
# FoundationModelLifecycle
Details about whether a model version is available or deprecated.
## Contents
** status **
Specifies whether a model version is available (`ACTIVE`) or deprecated (`LEGACY`.
Type: String
Valid Values: `ACTIVE | LEGACY`
Required: Yes
** endOfLifeTime **
Time when model is no longer available for use in all AWS regions
Type: Timestamp
Required: No
** legacyTime **
Time when the model enters legacy state
Type: Timestamp
Required: No
** publicExtendedAccessTime **
Public extended accesss portion of the legacy period, where users should expect higher pricing
Type: Timestamp
Required: No
** startOfLifeTime **
Launch time when the model first becomes available
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/FoundationModelLifecycle)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/FoundationModelLifecycle)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/FoundationModelLifecycle)
# FoundationModelSummary
Summary information for a foundation model.
## Contents
** modelArn **
The Amazon Resource Name (ARN) of the foundation model.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}`
Required: Yes
** modelId **
The model ID of the foundation model.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 140.
Pattern: `[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}|)`
Required: Yes
** customizationsSupported **
Whether the model supports fine-tuning or continual pre-training.
Type: Array of strings
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION`
Required: No
** inferenceTypesSupported **
The inference types that the model supports.
Type: Array of strings
Valid Values: `ON_DEMAND | PROVISIONED`
Required: No
** inputModalities **
The input modalities that the model supports.
Type: Array of strings
Valid Values: `TEXT | IMAGE | EMBEDDING`
Required: No
** modelLifecycle **
Contains details about whether a model version is available or deprecated.
Type: [FoundationModelLifecycle](API_FoundationModelLifecycle.md) object
Required: No
** modelName **
The name of the model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: `.*`
Required: No
** outputModalities **
The output modalities that the model supports.
Type: Array of strings
Valid Values: `TEXT | IMAGE | EMBEDDING`
Required: No
** providerName **
The model's provider name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern: `.*`
Required: No
** responseStreamingSupported **
Indicates whether the model supports streaming.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/FoundationModelSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/FoundationModelSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/FoundationModelSummary)
# GenerationConfiguration
The configuration details for response generation based on retrieved text chunks.
## Contents
** additionalModelRequestFields **
Additional model parameters and corresponding values not included in the `textInferenceConfig` structure for a knowledge base. This allows you to provide custom model parameters specific to the language model being used.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** guardrailConfiguration **
Contains configuration details for the guardrail.
Type: [GuardrailConfiguration](API_GuardrailConfiguration.md) object
Required: No
** kbInferenceConfig **
Contains configuration details for inference for knowledge base retrieval and response generation.
Type: [KbInferenceConfig](API_KbInferenceConfig.md) object
Required: No
** promptTemplate **
Contains the template for the prompt that's sent to the model for response generation.
Type: [PromptTemplate](API_PromptTemplate.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GenerationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GenerationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GenerationConfiguration)
# GraderConfig
Configuration for the grader used in reinforcement fine-tuning to evaluate model responses and provide reward signals.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** lambdaGrader **
Configuration for using an AWS Lambda function as the grader for evaluating model responses and provide reward signals in reinforcement fine-tuning.
Type: [LambdaGraderConfig](API_LambdaGraderConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GraderConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GraderConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GraderConfig)
# GuardrailAutomatedReasoningPolicy
Represents the configuration of Automated Reasoning policies within a Amazon Bedrock Guardrail, including the policies to apply and confidence thresholds.
## Contents
** policies **
The list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** confidenceThreshold **
The minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailAutomatedReasoningPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailAutomatedReasoningPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailAutomatedReasoningPolicy)
# GuardrailAutomatedReasoningPolicyConfig
Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.
## Contents
** policies **
The list of Automated Reasoning policy ARNs to include in the guardrail configuration.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: Yes
** confidenceThreshold **
The confidence threshold for triggering guardrail actions based on Automated Reasoning policy violations.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailAutomatedReasoningPolicyConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailAutomatedReasoningPolicyConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailAutomatedReasoningPolicyConfig)
# GuardrailConfiguration
The configuration details for the guardrail.
## Contents
** guardrailId **
The unique identifier for the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: `[a-z0-9]+`
Required: Yes
** guardrailVersion **
The version of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(([1-9][0-9]{0,7})|(DRAFT))`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailConfiguration)
# GuardrailContentFilter
Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
+ **Hate** – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
+ **Insults** – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
+ **Sexual** – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
+ **Violence** – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence.
For more information, see [Guardrails content filters](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html).
This data type is used in the following API operations:
+ [GetGuardrail response body](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
## Contents
** inputStrength **
The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
Type: String
Valid Values: `NONE | LOW | MEDIUM | HIGH`
Required: Yes
** outputStrength **
The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
Type: String
Valid Values: `NONE | LOW | MEDIUM | HIGH`
Required: Yes
** type **
The harmful category that the content filter is applied to.
Type: String
Valid Values: `SEXUAL | VIOLENCE | HATE | INSULTS | MISCONDUCT | PROMPT_ATTACK`
Required: Yes
** inputAction **
The action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** inputEnabled **
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** inputModalities **
The input modalities selected for the guardrail content filter.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Valid Values: `TEXT | IMAGE`
Required: No
** outputAction **
The action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** outputEnabled **
Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputModalities **
The output modalities selected for the guardrail content filter.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Valid Values: `TEXT | IMAGE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContentFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContentFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContentFilter)
# GuardrailContentFilterConfig
Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.
+ **Hate** – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
+ **Insults** – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
+ **Sexual** – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
+ **Violence** – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.
Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence.
For more information, see [Guardrails content filters](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html).
## Contents
** inputStrength **
The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
Type: String
Valid Values: `NONE | LOW | MEDIUM | HIGH`
Required: Yes
** outputStrength **
The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
Type: String
Valid Values: `NONE | LOW | MEDIUM | HIGH`
Required: Yes
** type **
The harmful category that the content filter is applied to.
Type: String
Valid Values: `SEXUAL | VIOLENCE | HATE | INSULTS | MISCONDUCT | PROMPT_ATTACK`
Required: Yes
** inputAction **
Specifies the action to take when harmful content is detected. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** inputEnabled **
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** inputModalities **
The input modalities selected for the guardrail content filter configuration.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Valid Values: `TEXT | IMAGE`
Required: No
** outputAction **
Specifies the action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** outputEnabled **
Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputModalities **
The output modalities selected for the guardrail content filter configuration.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Valid Values: `TEXT | IMAGE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContentFilterConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContentFilterConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContentFilterConfig)
# GuardrailContentFiltersTier
The tier that your guardrail uses for content filters.
## Contents
** tierName **
The tier that your guardrail uses for content filters. Valid values include:
+ `CLASSIC` tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
+ `STANDARD` tier – Provides a more robust solution than the `CLASSIC` tier and has more comprehensive language support. This tier requires that your guardrail use [cross-Region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).
Type: String
Valid Values: `CLASSIC | STANDARD`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContentFiltersTier)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContentFiltersTier)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContentFiltersTier)
# GuardrailContentFiltersTierConfig
The tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
## Contents
** tierName **
The tier that your guardrail uses for content filters. Valid values include:
+ `CLASSIC` tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
+ `STANDARD` tier – Provides a more robust solution than the `CLASSIC` tier and has more comprehensive language support. This tier requires that your guardrail use [cross-Region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).
Type: String
Valid Values: `CLASSIC | STANDARD`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContentFiltersTierConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContentFiltersTierConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContentFiltersTierConfig)
# GuardrailContentPolicy
Contains details about how to handle harmful content.
This data type is used in the following API operations:
+ [GetGuardrail response body](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
## Contents
** filters **
Contains the type of the content filter and how strongly it should apply to prompts and model responses.
Type: Array of [GuardrailContentFilter](API_GuardrailContentFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Required: No
** tier **
The tier that your guardrail uses for content filters.
Type: [GuardrailContentFiltersTier](API_GuardrailContentFiltersTier.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContentPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContentPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContentPolicy)
# GuardrailContentPolicyConfig
Contains details about how to handle harmful content.
## Contents
** filtersConfig **
Contains the type of the content filter and how strongly it should apply to prompts and model responses.
Type: Array of [GuardrailContentFilterConfig](API_GuardrailContentFilterConfig.md) objects
Array Members: Minimum number of 1 item. Maximum number of 6 items.
Required: Yes
** tierConfig **
The tier that your guardrail uses for content filters.
Type: [GuardrailContentFiltersTierConfig](API_GuardrailContentFiltersTierConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContentPolicyConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContentPolicyConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContentPolicyConfig)
# GuardrailContextualGroundingFilter
The details for the guardrails contextual grounding filter.
## Contents
** threshold **
The threshold details for the guardrails contextual grounding filter.
Type: Double
Valid Range: Minimum value of 0.
Required: Yes
** type **
The filter type details for the guardrails contextual grounding filter.
Type: String
Valid Values: `GROUNDING | RELEVANCE`
Required: Yes
** action **
The action to take when content fails the contextual grounding evaluation. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** enabled **
Indicates whether contextual grounding is enabled for evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContextualGroundingFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContextualGroundingFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContextualGroundingFilter)
# GuardrailContextualGroundingFilterConfig
The filter configuration details for the guardrails contextual grounding filter.
## Contents
** threshold **
The threshold details for the guardrails contextual grounding filter.
Type: Double
Valid Range: Minimum value of 0.
Required: Yes
** type **
The filter details for the guardrails contextual grounding filter.
Type: String
Valid Values: `GROUNDING | RELEVANCE`
Required: Yes
** action **
Specifies the action to take when content fails the contextual grounding evaluation. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** enabled **
Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContextualGroundingFilterConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContextualGroundingFilterConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContextualGroundingFilterConfig)
# GuardrailContextualGroundingPolicy
The details for the guardrails contextual grounding policy.
## Contents
** filters **
The filter details for the guardrails contextual grounding policy.
Type: Array of [GuardrailContextualGroundingFilter](API_GuardrailContextualGroundingFilter.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContextualGroundingPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContextualGroundingPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContextualGroundingPolicy)
# GuardrailContextualGroundingPolicyConfig
The policy configuration details for the guardrails contextual grounding policy.
## Contents
** filtersConfig **
The filter configuration details for the guardrails contextual grounding policy.
Type: Array of [GuardrailContextualGroundingFilterConfig](API_GuardrailContextualGroundingFilterConfig.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailContextualGroundingPolicyConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailContextualGroundingPolicyConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailContextualGroundingPolicyConfig)
# GuardrailCrossRegionConfig
The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.
For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).
## Contents
** guardrailProfileIdentifier **
The ID or Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current AWS Region. For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html).
Type: String
Length Constraints: Minimum length of 15. Maximum length of 2048.
Pattern: `[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+|arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailCrossRegionConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailCrossRegionConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailCrossRegionConfig)
# GuardrailCrossRegionDetails
Contains details about the system-defined guardrail profile that you're using with your guardrail for cross-Region inference.
For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).
## Contents
** guardrailProfileArn **
The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+`
Required: No
** guardrailProfileId **
The ID of the guardrail profile that your guardrail is using. Profile availability depends on your current AWS Region. For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html).
Type: String
Length Constraints: Minimum length of 15. Maximum length of 30.
Pattern: `[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailCrossRegionDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailCrossRegionDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailCrossRegionDetails)
# GuardrailManagedWords
The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)
## Contents
** type **
ManagedWords\$1type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)
Type: String
Valid Values: `PROFANITY`
Required: Yes
** inputAction **
The action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** inputEnabled **
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
The action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** outputEnabled **
Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailManagedWords)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailManagedWords)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailManagedWords)
# GuardrailManagedWordsConfig
The managed word list to configure for the guardrail.
## Contents
** type **
The managed word type to configure for the guardrail.
Type: String
Valid Values: `PROFANITY`
Required: Yes
** inputAction **
Specifies the action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** inputEnabled **
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
Specifies the action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** outputEnabled **
Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailManagedWordsConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailManagedWordsConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailManagedWordsConfig)
# GuardrailPiiEntity
The PII entity configured for the guardrail.
## Contents
** action **
The configured guardrail action when PII entity is detected.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: Yes
** type **
The type of PII entity. For example, Social Security Number.
Type: String
Valid Values: `ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER | CREDIT_DEBIT_CARD_CVV | CREDIT_DEBIT_CARD_EXPIRY | CREDIT_DEBIT_CARD_NUMBER | DRIVER_ID | EMAIL | INTERNATIONAL_BANK_ACCOUNT_NUMBER | IP_ADDRESS | LICENSE_PLATE | MAC_ADDRESS | NAME | PASSWORD | PHONE | PIN | SWIFT_CODE | UK_NATIONAL_HEALTH_SERVICE_NUMBER | UK_NATIONAL_INSURANCE_NUMBER | UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER | URL | USERNAME | US_BANK_ACCOUNT_NUMBER | US_BANK_ROUTING_NUMBER | US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER | US_PASSPORT_NUMBER | US_SOCIAL_SECURITY_NUMBER | VEHICLE_IDENTIFICATION_NUMBER`
Required: Yes
** inputAction **
The action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `ANONYMIZE` – Mask the content and replace it with identifier tags.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: No
** inputEnabled **
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
The action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `ANONYMIZE` – Mask the content and replace it with identifier tags.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: No
** outputEnabled **
Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailPiiEntity)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailPiiEntity)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailPiiEntity)
# GuardrailPiiEntityConfig
The PII entity to configure for the guardrail.
## Contents
** action **
Configure guardrail action when the PII entity is detected.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: Yes
** type **
Configure guardrail type when the PII entity is detected.
The following PIIs are used to block or mask sensitive information:
+ **General**
+ **ADDRESS**
A physical address, such as "100 Main Street, Anytown, USA" or "Suite \$112, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.
+ **AGE**
An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age.
+ **NAME**
An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.
+ **EMAIL**
An email address, such as *marymajor@email.com*.
+ **PHONE**
A phone number. This entity type also includes fax and pager numbers.
+ **USERNAME**
A user name that identifies an account, such as a login name, screen name, nick name, or handle.
+ **PASSWORD**
An alphanumeric string that is used as a password, such as "\$1*very20special\$1pass\$1*".
+ **DRIVER\$1ID**
The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.
+ **LICENSE\$1PLATE**
A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.
+ **VEHICLE\$1IDENTIFICATION\$1NUMBER**
A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs.
+ **Finance**
+ **CREDIT\$1DEBIT\$1CARD\$1CVV**
A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.
+ **CREDIT\$1DEBIT\$1CARD\$1EXPIRY**
The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. Guardrails recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*.
+ **CREDIT\$1DEBIT\$1CARD\$1NUMBER**
The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.
+ **PIN**
A four-digit personal identification number (PIN) with which you can access your bank account.
+ **INTERNATIONAL\$1BANK\$1ACCOUNT\$1NUMBER**
An International Bank Account Number has specific formats in each country. For more information, see [www.iban.com/structure](https://www.iban.com/structure).
+ **SWIFT\$1CODE**
A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.
SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.
+ **IT**
+ **IP\$1ADDRESS**
An IPv4 address, such as *198.51.100.0*.
+ **MAC\$1ADDRESS**
A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC).
+ **URL**
A web address, such as *www.example.com*.
+ **AWS\$1ACCESS\$1KEY**
A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.
+ **AWS\$1SECRET\$1KEY**
A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.
+ **USA specific**
+ **US\$1BANK\$1ACCOUNT\$1NUMBER**
A US bank account number, which is typically 10 to 12 digits long.
+ **US\$1BANK\$1ROUTING\$1NUMBER**
A US bank account routing number. These are typically nine digits long,
+ **US\$1INDIVIDUAL\$1TAX\$1IDENTIFICATION\$1NUMBER**
A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.
+ **US\$1PASSPORT\$1NUMBER**
A US passport number. Passport numbers range from six to nine alphanumeric characters.
+ **US\$1SOCIAL\$1SECURITY\$1NUMBER**
A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.
+ **Canada specific**
+ **CA\$1HEALTH\$1NUMBER**
A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.
+ **CA\$1SOCIAL\$1INSURANCE\$1NUMBER**
A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.
The SIN is formatted as three groups of three digits, such as *123-456-789*. A SIN can be validated through a simple check-digit process called the [Luhn algorithm](https://www.wikipedia.org/wiki/Luhn_algorithm).
+ **UK Specific**
+ **UK\$1NATIONAL\$1HEALTH\$1SERVICE\$1NUMBER**
A UK National Health Service Number is a 10-17 digit number, such as *485 777 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.
+ **UK\$1NATIONAL\$1INSURANCE\$1NUMBER**
A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.
The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.
+ **UK\$1UNIQUE\$1TAXPAYER\$1REFERENCE\$1NUMBER**
A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.
+ **Custom**
+ **Regex filter** - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..
Type: String
Valid Values: `ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER | CREDIT_DEBIT_CARD_CVV | CREDIT_DEBIT_CARD_EXPIRY | CREDIT_DEBIT_CARD_NUMBER | DRIVER_ID | EMAIL | INTERNATIONAL_BANK_ACCOUNT_NUMBER | IP_ADDRESS | LICENSE_PLATE | MAC_ADDRESS | NAME | PASSWORD | PHONE | PIN | SWIFT_CODE | UK_NATIONAL_HEALTH_SERVICE_NUMBER | UK_NATIONAL_INSURANCE_NUMBER | UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER | URL | USERNAME | US_BANK_ACCOUNT_NUMBER | US_BANK_ROUTING_NUMBER | US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER | US_PASSPORT_NUMBER | US_SOCIAL_SECURITY_NUMBER | VEHICLE_IDENTIFICATION_NUMBER`
Required: Yes
** inputAction **
Specifies the action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `ANONYMIZE` – Mask the content and replace it with identifier tags.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: No
** inputEnabled **
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
Specifies the action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `ANONYMIZE` – Mask the content and replace it with identifier tags.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: No
** outputEnabled **
Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailPiiEntityConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailPiiEntityConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailPiiEntityConfig)
# GuardrailRegex
The regular expression configured for the guardrail.
## Contents
** action **
The action taken when a match to the regular expression is detected.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: Yes
** name **
The name of the regular expression for the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** pattern **
The pattern of the regular expression configured for the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
** description **
The description of the regular expression for the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
** inputAction **
The action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: No
** inputEnabled **
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
The action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: No
** outputEnabled **
Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailRegex)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailRegex)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailRegex)
# GuardrailRegexConfig
The regular expression to configure for the guardrail.
## Contents
** action **
The guardrail action to configure when matching regular expression is detected.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: Yes
** name **
The name of the regular expression to configure for the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** pattern **
The regular expression pattern to configure for the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
** description **
The description of the regular expression to configure for the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
** inputAction **
Specifies the action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: No
** inputEnabled **
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
Specifies the action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | ANONYMIZE | NONE`
Required: No
** outputEnabled **
Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailRegexConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailRegexConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailRegexConfig)
# GuardrailSensitiveInformationPolicy
Contains details about PII entities and regular expressions configured for the guardrail.
## Contents
** piiEntities **
The list of PII entities configured for the guardrail.
Type: Array of [GuardrailPiiEntity](API_GuardrailPiiEntity.md) objects
Array Members: Minimum number of 1 item.
Required: No
** regexes **
The list of regular expressions configured for the guardrail.
Type: Array of [GuardrailRegex](API_GuardrailRegex.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailSensitiveInformationPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailSensitiveInformationPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailSensitiveInformationPolicy)
# GuardrailSensitiveInformationPolicyConfig
Contains details about PII entities and regular expressions to configure for the guardrail.
## Contents
** piiEntitiesConfig **
A list of PII entities to configure to the guardrail.
Type: Array of [GuardrailPiiEntityConfig](API_GuardrailPiiEntityConfig.md) objects
Array Members: Minimum number of 1 item.
Required: No
** regexesConfig **
A list of regular expressions to configure to the guardrail.
Type: Array of [GuardrailRegexConfig](API_GuardrailRegexConfig.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailSensitiveInformationPolicyConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailSensitiveInformationPolicyConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailSensitiveInformationPolicyConfig)
# GuardrailSummary
Contains details about a guardrail.
This data type is used in the following API operations:
+ [ListGuardrails response body](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax)
## Contents
** arn **
The ARN of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+`
Required: Yes
** createdAt **
The date and time at which the guardrail was created.
Type: Timestamp
Required: Yes
** id **
The unique identifier of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: `[a-z0-9]+`
Required: Yes
** name **
The name of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: `[0-9a-zA-Z-_]+`
Required: Yes
** status **
The status of the guardrail.
Type: String
Valid Values: `CREATING | UPDATING | VERSIONING | READY | FAILED | DELETING`
Required: Yes
** updatedAt **
The date and time at which the guardrail was last updated.
Type: Timestamp
Required: Yes
** version **
The version of the guardrail.
Type: String
Pattern: `(([1-9][0-9]{0,7})|(DRAFT))`
Required: Yes
** crossRegionDetails **
Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).
Type: [GuardrailCrossRegionDetails](API_GuardrailCrossRegionDetails.md) object
Required: No
** description **
A description of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailSummary)
# GuardrailTopic
Details about topics for the guardrail to identify and deny.
This data type is used in the following API operations:
+ [GetGuardrail response body](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
## Contents
** definition **
A definition of the topic to deny.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
** name **
The name of the topic to deny.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[0-9a-zA-Z-_ !?.]+`
Required: Yes
** examples **
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** inputAction **
The action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** inputEnabled **
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
The action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** outputEnabled **
Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** type **
Specifies to deny the topic.
Type: String
Valid Values: `DENY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailTopic)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailTopic)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailTopic)
# GuardrailTopicConfig
Details about topics for the guardrail to identify and deny.
## Contents
** definition **
A definition of the topic to deny.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
** name **
The name of the topic to deny.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[0-9a-zA-Z-_ !?.]+`
Required: Yes
** type **
Specifies to deny the topic.
Type: String
Valid Values: `DENY`
Required: Yes
** examples **
A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** inputAction **
Specifies the action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** inputEnabled **
Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
Specifies the action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** outputEnabled **
Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailTopicConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailTopicConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailTopicConfig)
# GuardrailTopicPolicy
Contains details about topics that the guardrail should identify and deny.
This data type is used in the following API operations:
+ [GetGuardrail response body](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax)
## Contents
** topics **
A list of policies related to topics that the guardrail should deny.
Type: Array of [GuardrailTopic](API_GuardrailTopic.md) objects
Array Members: Minimum number of 1 item. Maximum number of 30 items.
Required: Yes
** tier **
The tier that your guardrail uses for denied topic filters.
Type: [GuardrailTopicsTier](API_GuardrailTopicsTier.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailTopicPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailTopicPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailTopicPolicy)
# GuardrailTopicPolicyConfig
Contains details about topics that the guardrail should identify and deny.
## Contents
** topicsConfig **
A list of policies related to topics that the guardrail should deny.
Type: Array of [GuardrailTopicConfig](API_GuardrailTopicConfig.md) objects
Array Members: Minimum number of 1 item. Maximum number of 30 items.
Required: Yes
** tierConfig **
The tier that your guardrail uses for denied topic filters.
Type: [GuardrailTopicsTierConfig](API_GuardrailTopicsTierConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailTopicPolicyConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailTopicPolicyConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailTopicPolicyConfig)
# GuardrailTopicsTier
The tier that your guardrail uses for denied topic filters.
## Contents
** tierName **
The tier that your guardrail uses for denied topic filters. Valid values include:
+ `CLASSIC` tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
+ `STANDARD` tier – Provides a more robust solution than the `CLASSIC` tier and has more comprehensive language support. This tier requires that your guardrail use [cross-Region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).
Type: String
Valid Values: `CLASSIC | STANDARD`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailTopicsTier)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailTopicsTier)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailTopicsTier)
# GuardrailTopicsTierConfig
The tier that your guardrail uses for denied topic filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.
## Contents
** tierName **
The tier that your guardrail uses for denied topic filters. Valid values include:
+ `CLASSIC` tier – Provides established guardrails functionality supporting English, French, and Spanish languages.
+ `STANDARD` tier – Provides a more robust solution than the `CLASSIC` tier and has more comprehensive language support. This tier requires that your guardrail use [cross-Region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html).
Type: String
Valid Values: `CLASSIC | STANDARD`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailTopicsTierConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailTopicsTierConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailTopicsTierConfig)
# GuardrailWord
A word configured for the guardrail.
## Contents
** text **
Text of the word configured for the guardrail to block.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** inputAction **
The action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** inputEnabled **
Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
The action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** outputEnabled **
Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailWord)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailWord)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailWord)
# GuardrailWordConfig
A word to configure for the guardrail.
## Contents
** text **
Text of the word configured for the guardrail to block.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** inputAction **
Specifies the action to take when harmful content is detected in the input. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** inputEnabled **
Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
** outputAction **
Specifies the action to take when harmful content is detected in the output. Supported values include:
+ `BLOCK` – Block the content and replace it with blocked messaging.
+ `NONE` – Take no action but return detection information in the trace response.
Type: String
Valid Values: `BLOCK | NONE`
Required: No
** outputEnabled **
Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailWordConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailWordConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailWordConfig)
# GuardrailWordPolicy
Contains details about the word policy configured for the guardrail.
## Contents
** managedWordLists **
A list of managed words configured for the guardrail.
Type: Array of [GuardrailManagedWords](API_GuardrailManagedWords.md) objects
Required: No
** words **
A list of words configured for the guardrail.
Type: Array of [GuardrailWord](API_GuardrailWord.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailWordPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailWordPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailWordPolicy)
# GuardrailWordPolicyConfig
Contains details about the word policy to configured for the guardrail.
## Contents
** managedWordListsConfig **
A list of managed words to configure for the guardrail.
Type: Array of [GuardrailManagedWordsConfig](API_GuardrailManagedWordsConfig.md) objects
Required: No
** wordsConfig **
A list of words to configure for the guardrail.
Type: Array of [GuardrailWordConfig](API_GuardrailWordConfig.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/GuardrailWordPolicyConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/GuardrailWordPolicyConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/GuardrailWordPolicyConfig)
# HumanEvaluationConfig
Specifies the custom metrics, how tasks will be rated, the flow definition ARN, and your custom prompt datasets. Model evaluation jobs use human workers *only* support the use of custom prompt datasets. To learn more about custom prompt datasets and the required format, see [Custom prompt datasets](https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html).
When you create custom metrics in `HumanEvaluationCustomMetric` you must specify the metric's `name`. The list of `names` specified in the `HumanEvaluationCustomMetric` array, must match the `metricNames` array of strings specified in `EvaluationDatasetMetricConfig`. For example, if in the `HumanEvaluationCustomMetric` array your specified the names `"accuracy", "toxicity", "readability"` as custom metrics *then* the `metricNames` array would need to look like the following `["accuracy", "toxicity", "readability"]` in `EvaluationDatasetMetricConfig`.
## Contents
** datasetMetricConfigs **
Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.
Type: Array of [EvaluationDatasetMetricConfig](API_EvaluationDatasetMetricConfig.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** customMetrics **
A `HumanEvaluationCustomMetric` object. It contains the names the metrics, how the metrics are to be evaluated, an optional description.
Type: Array of [HumanEvaluationCustomMetric](API_HumanEvaluationCustomMetric.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
** humanWorkflowConfig **
The parameters of the human workflow.
Type: [HumanWorkflowConfig](API_HumanWorkflowConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/HumanEvaluationConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/HumanEvaluationConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/HumanEvaluationConfig)
# HumanEvaluationCustomMetric
In a model evaluation job that uses human workers you must define the name of the metric, and how you want that metric rated `ratingMethod`, and an optional description of the metric.
## Contents
** name **
The name of the metric. Your human evaluators will see this name in the evaluation UI.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[0-9a-zA-Z-_.]+`
Required: Yes
** ratingMethod **
Choose how you want your human workers to evaluation your model. Valid values for rating methods are `ThumbsUpDown`, `IndividualLikertScale`,`ComparisonLikertScale`, `ComparisonChoice`, and `ComparisonRank`
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: `[0-9a-zA-Z-_]+`
Required: Yes
** description **
An optional description of the metric. Use this parameter to provide more details about the metric.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `.+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/HumanEvaluationCustomMetric)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/HumanEvaluationCustomMetric)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/HumanEvaluationCustomMetric)
# HumanWorkflowConfig
Contains `SageMakerFlowDefinition` object. The object is used to specify the prompt dataset, task type, rating method and metric names.
## Contents
** flowDefinitionArn **
The Amazon Resource Number (ARN) for the flow definition
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `arn:aws(-[^:]+)?:sagemaker:[a-z0-9-]{1,20}:[0-9]{12}:flow-definition/.*`
Required: Yes
** instructions **
Instructions for the flow definition
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5000.
Pattern: `[\S\s]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/HumanWorkflowConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/HumanWorkflowConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/HumanWorkflowConfig)
# ImplicitFilterConfiguration
Configuration for implicit filtering in Knowledge Base vector searches. Implicit filtering allows you to automatically filter search results based on metadata attributes without requiring explicit filter expressions in each query.
## Contents
** metadataAttributes **
A list of metadata attribute schemas that define the structure and properties of metadata fields used for implicit filtering. Each attribute defines a key, type, and optional description.
Type: Array of [MetadataAttributeSchema](API_MetadataAttributeSchema.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
** modelArn **
The Amazon Resource Name (ARN) of the foundation model used for implicit filtering. This model processes the query to extract relevant filtering criteria.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:(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
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ImplicitFilterConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ImplicitFilterConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ImplicitFilterConfiguration)
# ImportedModelSummary
Information about the imported model.
## Contents
** creationTime **
Creation time of the imported model.
Type: Timestamp
Required: Yes
** modelArn **
The Amazon Resource Name (ARN) of the imported model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}`
Required: Yes
** modelName **
Name of the imported model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
Required: Yes
** instructSupported **
Specifies if the imported model supports converse.
Type: Boolean
Required: No
** modelArchitecture **
The architecture of the imported model.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ImportedModelSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ImportedModelSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ImportedModelSummary)
# InferenceProfileModel
Contains information about a model.
## Contents
** modelArn **
The Amazon Resource Name (ARN) of the model.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/InferenceProfileModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/InferenceProfileModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/InferenceProfileModel)
# InferenceProfileModelSource
Contains information about the model or system-defined inference profile that is the source for an inference profile..
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** copyFrom **
The ARN of the model or system-defined inference profile that is the source for the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|foundation-model)/[a-zA-Z0-9-:.]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/InferenceProfileModelSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/InferenceProfileModelSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/InferenceProfileModelSource)
# InferenceProfileSummary
Contains information about an inference profile.
## Contents
** inferenceProfileArn **
The Amazon Resource Name (ARN) of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+`
Required: Yes
** inferenceProfileId **
The unique identifier of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9-:.]+`
Required: Yes
** inferenceProfileName **
The name of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `([0-9a-zA-Z][ _-]?)+`
Required: Yes
** models **
A list of information about each model in the inference profile.
Type: Array of [InferenceProfileModel](API_InferenceProfileModel.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** status **
The status of the inference profile. `ACTIVE` means that the inference profile is ready to be used.
Type: String
Valid Values: `ACTIVE`
Required: Yes
** type **
The type of the inference profile. The following types are possible:
+ `SYSTEM_DEFINED` – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.
+ `APPLICATION` – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.
Type: String
Valid Values: `SYSTEM_DEFINED | APPLICATION`
Required: Yes
** createdAt **
The time at which the inference profile was created.
Type: Timestamp
Required: No
** description **
The description of the inference profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `([0-9a-zA-Z:.][ _-]?)+`
Required: No
** updatedAt **
The time at which the inference profile was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/InferenceProfileSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/InferenceProfileSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/InferenceProfileSummary)
# InvocationLogsConfig
Settings for using invocation logs to customize a model.
## Contents
** invocationLogSource **
The source of the invocation logs.
Type: [InvocationLogSource](API_InvocationLogSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** requestMetadataFilters **
Rules for filtering invocation logs based on request metadata.
Type: [RequestMetadataFilters](API_RequestMetadataFilters.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** usePromptResponse **
Whether to use the model's response for training, or just the prompt. The default value is `False`.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/InvocationLogsConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/InvocationLogsConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/InvocationLogsConfig)
# InvocationLogSource
A storage location for invocation logs.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3Uri **
The URI of an invocation log in a bucket.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/InvocationLogSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/InvocationLogSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/InvocationLogSource)
# KbInferenceConfig
Contains configuration details of the inference for knowledge base retrieval and response generation.
## Contents
** textInferenceConfig **
Contains configuration details for text generation using a language model via the `RetrieveAndGenerate` function.
Type: [TextInferenceConfig](API_TextInferenceConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/KbInferenceConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/KbInferenceConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/KbInferenceConfig)
# KnowledgeBaseConfig
The configuration details for retrieving information from a knowledge base and generating responses.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** retrieveAndGenerateConfig **
Contains configuration details for retrieving information from a knowledge base and generating responses.
Type: [RetrieveAndGenerateConfiguration](API_RetrieveAndGenerateConfiguration.md) object
Required: No
** retrieveConfig **
Contains configuration details for retrieving information from a knowledge base.
Type: [RetrieveConfig](API_RetrieveConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/KnowledgeBaseConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/KnowledgeBaseConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/KnowledgeBaseConfig)
# KnowledgeBaseRetrievalConfiguration
Contains configuration details for retrieving information from a knowledge base.
## Contents
** vectorSearchConfiguration **
Contains configuration details for returning the results from the vector search.
Type: [KnowledgeBaseVectorSearchConfiguration](API_KnowledgeBaseVectorSearchConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/KnowledgeBaseRetrievalConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/KnowledgeBaseRetrievalConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/KnowledgeBaseRetrievalConfiguration)
# KnowledgeBaseRetrieveAndGenerateConfiguration
Contains configuration details for retrieving information from a knowledge base and generating responses.
## Contents
** knowledgeBaseId **
The unique identifier of the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** modelArn **
The Amazon Resource Name (ARN) of the foundation model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) used to generate responses.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:(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
** generationConfiguration **
Contains configurations details for response generation based on retrieved text chunks.
Type: [GenerationConfiguration](API_GenerationConfiguration.md) object
Required: No
** orchestrationConfiguration **
Contains configuration details for the model to process the prompt prior to retrieval and response generation.
Type: [OrchestrationConfiguration](API_OrchestrationConfiguration.md) object
Required: No
** retrievalConfiguration **
Contains configuration details for retrieving text chunks.
Type: [KnowledgeBaseRetrievalConfiguration](API_KnowledgeBaseRetrievalConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/KnowledgeBaseRetrieveAndGenerateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/KnowledgeBaseRetrieveAndGenerateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/KnowledgeBaseRetrieveAndGenerateConfiguration)
# KnowledgeBaseVectorSearchConfiguration
The configuration details for returning the results from the knowledge base vector search.
## Contents
** filter **
Specifies the filters to use on the metadata fields in the knowledge base data sources before returning results.
Type: [RetrievalFilter](API_RetrievalFilter.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** implicitFilterConfiguration **
Configuration for implicit filtering in Knowledge Base vector searches. This allows the system to automatically apply filters based on the query context without requiring explicit filter expressions.
Type: [ImplicitFilterConfiguration](API_ImplicitFilterConfiguration.md) object
Required: No
** numberOfResults **
The number of text chunks to retrieve; the number of results to return.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** overrideSearchType **
By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a `HYBRID` search using both vector embeddings and raw text, or `SEMANTIC` search using only vector embeddings. For other vector store configurations, only `SEMANTIC` search is available.
Type: String
Valid Values: `HYBRID | SEMANTIC`
Required: No
** rerankingConfiguration **
Configuration for reranking search results in Knowledge Base vector searches. Reranking improves search relevance by reordering initial vector search results using more sophisticated relevance models.
Type: [VectorSearchRerankingConfiguration](API_VectorSearchRerankingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration)
# LambdaGraderConfig
Configuration for using an AWS Lambda function to grade model responses during reinforcement fine-tuning training.
## Contents
** lambdaArn **
ARN of the AWS Lambda function that will evaluate model responses and return reward scores for RFT training.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/LambdaGraderConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/LambdaGraderConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/LambdaGraderConfig)
# LegalTerm
The legal term of the agreement.
## Contents
** url **
URL to the legal term document.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/LegalTerm)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/LegalTerm)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/LegalTerm)
# LoggingConfig
Configuration fields for invocation logging.
## Contents
** audioDataDeliveryEnabled **
Set to include audio data in the log delivery.
Type: Boolean
Required: No
** cloudWatchConfig **
CloudWatch logging configuration.
Type: [CloudWatchConfig](API_CloudWatchConfig.md) object
Required: No
** embeddingDataDeliveryEnabled **
Set to include embeddings data in the log delivery.
Type: Boolean
Required: No
** imageDataDeliveryEnabled **
Set to include image data in the log delivery.
Type: Boolean
Required: No
** s3Config **
S3 configuration for storing log data.
Type: [S3Config](API_S3Config.md) object
Required: No
** textDataDeliveryEnabled **
Set to include text data in the log delivery.
Type: Boolean
Required: No
** videoDataDeliveryEnabled **
Set to include video data in the log delivery.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/LoggingConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/LoggingConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/LoggingConfig)
# MarketplaceModelEndpoint
Contains details about an endpoint for a model from Amazon Bedrock Marketplace.
## Contents
** createdAt **
The timestamp when the endpoint was registered.
Type: Timestamp
Required: Yes
** endpointArn **
The Amazon Resource Name (ARN) of the endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
** endpointConfig **
The configuration of the endpoint, including the number and type of instances used.
Type: [EndpointConfig](API_EndpointConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** endpointStatus **
The current status of the endpoint (e.g., Creating, InService, Updating, Failed).
Type: String
Required: Yes
** modelSourceIdentifier **
The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*`
Required: Yes
** updatedAt **
The timestamp when the endpoint was last updated.
Type: Timestamp
Required: Yes
** endpointStatusMessage **
Additional information about the endpoint status, if available.
Type: String
Required: No
** status **
The overall status of the endpoint in Amazon Bedrock Marketplace (e.g., ACTIVE, INACTIVE).
Type: String
Valid Values: `REGISTERED | INCOMPATIBLE_ENDPOINT`
Required: No
** statusMessage **
Additional information about the overall status, if available.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/MarketplaceModelEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/MarketplaceModelEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/MarketplaceModelEndpoint)
# MarketplaceModelEndpointSummary
Provides a summary of an endpoint for a model from Amazon Bedrock Marketplace.
## Contents
** createdAt **
The timestamp when the endpoint was created.
Type: Timestamp
Required: Yes
** endpointArn **
The Amazon Resource Name (ARN) of the endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
** modelSourceIdentifier **
The ARN of the model from Amazon Bedrock Marketplace that is deployed on this endpoint.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*arn:aws:sagemaker:.*:hub-content/SageMakerPublicHub/Model/.*`
Required: Yes
** updatedAt **
The timestamp when the endpoint was last updated.
Type: Timestamp
Required: Yes
** status **
The overall status of the endpoint in Amazon Bedrock Marketplace.
Type: String
Valid Values: `REGISTERED | INCOMPATIBLE_ENDPOINT`
Required: No
** statusMessage **
Additional information about the overall status, if available.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/MarketplaceModelEndpointSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/MarketplaceModelEndpointSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/MarketplaceModelEndpointSummary)
# MetadataAttributeSchema
Defines the schema for a metadata attribute used in Knowledge Base vector searches. Metadata attributes provide additional context for documents and can be used for filtering and reranking search results.
## Contents
** description **
An optional description of the metadata attribute that provides additional context about its purpose and usage.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: Yes
** key **
The unique identifier for the metadata attribute. This key is used to reference the attribute in filter expressions and reranking configurations.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[\s\S]+`
Required: Yes
** type **
The data type of the metadata attribute. The type determines how the attribute can be used in filter expressions and reranking.
Type: String
Valid Values: `STRING | NUMBER | BOOLEAN | STRING_LIST`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/MetadataAttributeSchema)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/MetadataAttributeSchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/MetadataAttributeSchema)
# MetadataConfigurationForReranking
Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.
## Contents
** selectionMode **
The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
Type: String
Valid Values: `SELECTIVE | ALL`
Required: Yes
** selectiveModeConfiguration **
Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.
Type: [RerankingMetadataSelectiveModeConfiguration](API_RerankingMetadataSelectiveModeConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/MetadataConfigurationForReranking)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/MetadataConfigurationForReranking)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/MetadataConfigurationForReranking)
# ModelCopyJobSummary
Contains details about each model copy job.
This data type is used in the following API operations:
+ [ListModelCopyJobs response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListModelCopyJobs.html#API_ListModelCopyJobs_ResponseSyntax)
## Contents
** creationTime **
The time that the model copy job was created.
Type: Timestamp
Required: Yes
** jobArn **
The Amazon Resoource Name (ARN) of the model copy job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-copy-job/[a-z0-9]{12}`
Required: Yes
** sourceAccountId **
The unique identifier of the account that the model being copied originated from.
Type: String
Pattern: `[0-9]{12}`
Required: Yes
** sourceModelArn **
The Amazon Resource Name (ARN) of the original model being copied.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
Required: Yes
** status **
The status of the model copy job.
Type: String
Valid Values: `InProgress | Completed | Failed`
Required: Yes
** targetModelArn **
The Amazon Resource Name (ARN) of the copied model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
Required: Yes
** failureMessage **
If a model fails to be copied, a message describing why the job failed is included here.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** sourceModelName **
The name of the original model being copied.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: No
** targetModelKmsKeyArn **
The Amazon Resource Name (ARN) of the KMS key used to encrypt the copied model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}`
Required: No
** targetModelName **
The name of the copied model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: No
** targetModelTags **
Tags associated with the copied model.
Type: Array of [Tag](API_Tag.md) objects
Array Members: Minimum number of 0 items. Maximum number of 200 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelCopyJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelCopyJobSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelCopyJobSummary)
# ModelCustomizationJobSummary
Information about one customization job
## Contents
** baseModelArn **
Amazon Resource Name (ARN) of the base model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
Required: Yes
** creationTime **
Creation time of the custom model.
Type: Timestamp
Required: Yes
** jobArn **
Amazon Resource Name (ARN) of the customization job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-customization-job/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}/[a-z0-9]{12}`
Required: Yes
** jobName **
Name of the customization job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
Required: Yes
** status **
Status of the customization job.
Type: String
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped`
Required: Yes
** customizationType **
Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html).
Type: String
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION | REINFORCEMENT_FINE_TUNING | IMPORTED`
Required: No
** customModelArn **
Amazon Resource Name (ARN) of the custom model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:custom-model/(imported|[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})/[a-z0-9]{12}`
Required: No
** customModelName **
Name of the custom model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?){1,63}`
Required: No
** endTime **
Time that the customization job ended.
Type: Timestamp
Required: No
** lastModifiedTime **
Time that the customization job was last modified.
Type: Timestamp
Required: No
** statusDetails **
Details about the status of the data processing sub-task of the job.
Type: [StatusDetails](API_StatusDetails.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelCustomizationJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelCustomizationJobSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelCustomizationJobSummary)
# ModelDataSource
The data source of the model to import.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3DataSource **
The Amazon S3 data source of the model to import.
Type: [S3DataSource](API_S3DataSource.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelDataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelDataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelDataSource)
# ModelEnforcement
Model-specific information for the enforced guardrail configuration.
## Contents
** excludedModels **
Models to exclude from enforcement of the guardrail.
Type: Array of strings
Array Members: Minimum number of 0 items.
Pattern: `([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}){0,1}`
Required: Yes
** includedModels **
Models to enforce the guardrail on.
Type: Array of strings
Array Members: Minimum number of 1 item.
Pattern: `(ALL|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}(/[a-z0-9]{12}){0,1})`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelEnforcement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelEnforcement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelEnforcement)
# ModelImportJobSummary
Information about the import job.
## Contents
** creationTime **
The time import job was created.
Type: Timestamp
Required: Yes
** jobArn **
The Amazon Resource Name (ARN) of the import job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-import-job/[a-z0-9]{12}`
Required: Yes
** jobName **
The name of the import job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9](-*[a-zA-Z0-9\+\-\.])*`
Required: Yes
** status **
The status of the imported job.
Type: String
Valid Values: `InProgress | Completed | Failed`
Required: Yes
** endTime **
The time when import job ended.
Type: Timestamp
Required: No
** importedModelArn **
The Amazon resource Name (ARN) of the imported model.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:imported-model/[a-z0-9]{12}`
Required: No
** importedModelName **
The name of the imported model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
Required: No
** lastModifiedTime **
The time when the import job was last modified.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelImportJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelImportJobSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelImportJobSummary)
# ModelInvocationJobInputDataConfig
Details about the location of the input to the batch inference job.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3InputDataConfig **
Contains the configuration of the S3 location of the input data.
Type: [ModelInvocationJobS3InputDataConfig](API_ModelInvocationJobS3InputDataConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelInvocationJobInputDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelInvocationJobInputDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelInvocationJobInputDataConfig)
# ModelInvocationJobOutputDataConfig
Contains the configuration of the S3 location of the output data.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3OutputDataConfig **
Contains the configuration of the S3 location of the output data.
Type: [ModelInvocationJobS3OutputDataConfig](API_ModelInvocationJobS3OutputDataConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelInvocationJobOutputDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelInvocationJobOutputDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelInvocationJobOutputDataConfig)
# ModelInvocationJobS3InputDataConfig
Contains the configuration of the S3 location of the input data.
## Contents
** s3Uri **
The S3 location of the input data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: Yes
** s3BucketOwner **
The ID of the AWS account that owns the S3 bucket containing the input data.
Type: String
Pattern: `[0-9]{12}`
Required: No
** s3InputFormat **
The format of the input data.
Type: String
Valid Values: `JSONL`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelInvocationJobS3InputDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelInvocationJobS3InputDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelInvocationJobS3InputDataConfig)
# ModelInvocationJobS3OutputDataConfig
Contains the configuration of the S3 location of the output data.
## Contents
** s3Uri **
The S3 location of the output data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: Yes
** s3BucketOwner **
The ID of the AWS account that owns the S3 bucket containing the output data.
Type: String
Pattern: `[0-9]{12}`
Required: No
** s3EncryptionKeyId **
The unique identifier of the key that encrypts the S3 location of the output data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelInvocationJobS3OutputDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelInvocationJobS3OutputDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelInvocationJobS3OutputDataConfig)
# ModelInvocationJobSummary
A summary of a batch inference job.
## Contents
** inputDataConfig **
Details about the location of the input to the batch inference job.
Type: [ModelInvocationJobInputDataConfig](API_ModelInvocationJobInputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** jobArn **
The Amazon Resource Name (ARN) of the batch inference job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1011.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:model-invocation-job/[a-z0-9]{12})`
Required: Yes
** jobName **
The name of the batch inference job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `[a-zA-Z0-9]{1,63}(-*[a-zA-Z0-9\+\-\.]){0,63}`
Required: Yes
** modelId **
The unique identifier of the foundation model used for model inference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-:]{1,63}/[a-z0-9]{12}$)|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)`
Required: Yes
** outputDataConfig **
Details about the location of the output of the batch inference job.
Type: [ModelInvocationJobOutputDataConfig](API_ModelInvocationJobOutputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** roleArn **
The Amazon Resource Name (ARN) of the service role with permissions to carry out and manage batch inference. You can use the console to create a default service role or follow the steps at [Create a service role for batch inference](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-iam-sr.html).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** submitTime **
The time at which the batch inference job was submitted.
Type: Timestamp
Required: Yes
** clientRequestToken **
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 1. Maximum length of 256.
Pattern: `[a-zA-Z0-9]{1,256}(-*[a-zA-Z0-9]){0,256}`
Required: No
** endTime **
The time at which the batch inference job ended.
Type: Timestamp
Required: No
** errorRecordCount **
The number of records that failed to process in the batch inference job.
Type: Long
Valid Range: Minimum value of 0.
Required: No
** jobExpirationTime **
The time at which the batch inference job times or timed out.
Type: Timestamp
Required: No
** lastModifiedTime **
The time at which the batch inference job was last modified.
Type: Timestamp
Required: No
** message **
If the batch inference job failed, this field contains a message describing why the job failed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** modelInvocationType **
The invocation endpoint for ModelInvocationJob
Type: String
Valid Values: `InvokeModel | Converse`
Required: No
** processedRecordCount **
The number of records that have been processed in the batch inference job.
Type: Long
Valid Range: Minimum value of 0.
Required: No
** status **
The status of the batch inference job.
The following statuses are possible:
+ Submitted – This job has been submitted to a queue for validation.
+ Validating – This job is being validated for the requirements described in [Format and upload your batch inference data](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data.html). The criteria include the following:
+ Your IAM service role has access to the Amazon S3 buckets containing your files.
+ Your files are .jsonl files and each individual record is a JSON object in the correct format. Note that validation doesn't check if the `modelInput` value matches the request body for the model.
+ Your files fulfill the requirements for file size and number of records. For more information, see [Quotas for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html).
+ Scheduled – This job has been validated and is now in a queue. The job will automatically start when it reaches its turn.
+ Expired – This job timed out because it was scheduled but didn't begin before the set timeout duration. Submit a new job request.
+ InProgress – This job has begun. You can start viewing the results in the output S3 location.
+ Completed – This job has successfully completed. View the output files in the output S3 location.
+ PartiallyCompleted – This job has partially completed. Not all of your records could be processed in time. View the output files in the output S3 location.
+ Failed – This job has failed. Check the failure message for any further details. For further assistance, reach out to the [Support Center](https://console.aws.amazon.com/support/home/).
+ Stopped – This job was stopped by a user.
+ Stopping – This job is being stopped by a user.
Type: String
Valid Values: `Submitted | InProgress | Completed | Failed | Stopping | Stopped | PartiallyCompleted | Expired | Validating | Scheduled`
Required: No
** successRecordCount **
The number of records that were successfully processed in the batch inference job.
Type: Long
Valid Range: Minimum value of 0.
Required: No
** timeoutDurationInHours **
The number of hours after which the batch inference job was set to time out.
Type: Integer
Valid Range: Minimum value of 24. Maximum value of 168.
Required: No
** totalRecordCount **
The total number of records in the batch inference job.
Type: Long
Valid Range: Minimum value of 0.
Required: No
** vpcConfig **
The configuration of the Virtual Private Cloud (VPC) for the data in the batch inference job. For more information, see [Protect batch inference jobs using a VPC](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-vpc).
Type: [VpcConfig](API_VpcConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ModelInvocationJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ModelInvocationJobSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ModelInvocationJobSummary)
# Offer
An offer dictates usage terms for the model.
## Contents
** offerToken **
Offer token.
Type: String
Required: Yes
** termDetails **
Details about the terms of the offer.
Type: [TermDetails](API_TermDetails.md) object
Required: Yes
** offerId **
Offer Id for a model offer.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/Offer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/Offer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/Offer)
# OrchestrationConfiguration
The configuration details for the model to process the prompt prior to retrieval and response generation.
## Contents
** queryTransformationConfiguration **
Contains configuration details for transforming the prompt.
Type: [QueryTransformationConfiguration](API_QueryTransformationConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/OrchestrationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/OrchestrationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/OrchestrationConfiguration)
# OutputDataConfig
S3 Location of the output data.
## Contents
** s3Uri **
The S3 URI where the output data is stored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/OutputDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/OutputDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/OutputDataConfig)
# PerformanceConfiguration
Contains performance settings for a model.
## Contents
** latency **
Specifies whether to use the latency-optimized or standard version of a model or inference profile.
Type: String
Valid Values: `standard | optimized`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PerformanceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PerformanceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PerformanceConfiguration)
# PricingTerm
Describes the usage-based pricing term.
## Contents
** rateCard **
Describes a usage price for each dimension.
Type: Array of [DimensionalPriceRate](API_DimensionalPriceRate.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PricingTerm)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PricingTerm)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PricingTerm)
# PromptRouterSummary
Details about a prompt router.
## Contents
** fallbackModel **
The router's fallback model.
Type: [PromptRouterTargetModel](API_PromptRouterTargetModel.md) object
Required: Yes
** models **
The router's models.
Type: Array of [PromptRouterTargetModel](API_PromptRouterTargetModel.md) objects
Required: Yes
** promptRouterArn **
The router's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:default-prompt-router/[a-zA-Z0-9-:.]+`
Required: Yes
** promptRouterName **
The router's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `([0-9a-zA-Z][ _-]?)+`
Required: Yes
** routingCriteria **
The router's routing criteria.
Type: [RoutingCriteria](API_RoutingCriteria.md) object
Required: Yes
** status **
The router's status.
Type: String
Valid Values: `AVAILABLE`
Required: Yes
** type **
The summary's type.
Type: String
Valid Values: `custom | default`
Required: Yes
** createdAt **
When the router was created.
Type: Timestamp
Required: No
** description **
The router's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `([0-9a-zA-Z:.][ _-]?)+`
Required: No
** updatedAt **
When the router was updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PromptRouterSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PromptRouterSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PromptRouterSummary)
# PromptRouterTargetModel
The target model for a prompt router.
## Contents
** modelArn **
The target model's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `.*(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PromptRouterTargetModel)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PromptRouterTargetModel)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PromptRouterTargetModel)
# PromptTemplate
The template for the prompt that's sent to the model for response generation.
## Contents
** textPromptTemplate **
The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see [Knowledge base prompt template](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html) and [Use XML tags with Anthropic Claude models](https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/use-xml-tags).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/PromptTemplate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/PromptTemplate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/PromptTemplate)
# ProvisionedModelSummary
A summary of information about a Provisioned Throughput.
This data type is used in the following API operations:
+ [ListProvisionedThroughputs response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListProvisionedModelThroughputs.html#API_ListProvisionedModelThroughputs_ResponseSyntax)
## Contents
** creationTime **
The time that the Provisioned Throughput was created.
Type: Timestamp
Required: Yes
** desiredModelArn **
The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value differs from the `modelArn` if updating hasn't completed.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
Required: Yes
** desiredModelUnits **
The number of model units that was requested to be allocated to the Provisioned Throughput.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
** foundationModelArn **
The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}`
Required: Yes
** lastModifiedTime **
The time that the Provisioned Throughput was last modified.
Type: Timestamp
Required: Yes
** modelArn **
The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1011.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/((imported)|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}))(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}))`
Required: Yes
** modelUnits **
The number of model units allocated to the Provisioned Throughput.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
** provisionedModelArn **
The Amazon Resource Name (ARN) of the Provisioned Throughput.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}`
Required: Yes
** provisionedModelName **
The name of the Provisioned Throughput.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: `([0-9a-zA-Z][_-]?)+`
Required: Yes
** status **
The status of the Provisioned Throughput.
Type: String
Valid Values: `Creating | InService | Updating | Failed`
Required: Yes
** commitmentDuration **
The duration for which the Provisioned Throughput was committed.
Type: String
Valid Values: `OneMonth | SixMonths`
Required: No
** commitmentExpirationTime **
The timestamp for when the commitment term of the Provisioned Throughput expires.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ProvisionedModelSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ProvisionedModelSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ProvisionedModelSummary)
# QueryTransformationConfiguration
The configuration details for transforming the prompt.
## Contents
** type **
The type of transformation to apply to the prompt.
Type: String
Valid Values: `QUERY_DECOMPOSITION`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/QueryTransformationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/QueryTransformationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/QueryTransformationConfiguration)
# RAGConfig
Contains configuration details for retrieval of information and response generation.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** knowledgeBaseConfig **
Contains configuration details for knowledge base retrieval and response generation.
Type: [KnowledgeBaseConfig](API_KnowledgeBaseConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** precomputedRagSourceConfig **
Contains configuration details about the RAG source used to generate inference response data for a Knowledge Base evaluation job.
Type: [EvaluationPrecomputedRagSourceConfig](API_EvaluationPrecomputedRagSourceConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RAGConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RAGConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RAGConfig)
# RatingScaleItem
Defines the value and corresponding definition for one rating in a custom metric rating scale.
## Contents
** definition **
Defines the definition for one rating in a custom metric rating scale.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** value **
Defines the value for one rating in a custom metric rating scale.
Type: [RatingScaleItemValue](API_RatingScaleItemValue.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RatingScaleItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RatingScaleItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RatingScaleItem)
# RatingScaleItemValue
Defines the value for one rating in a custom metric rating scale.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** floatValue **
A floating point number representing the value for a rating in a custom metric rating scale.
Type: Float
Required: No
** stringValue **
A string representing the value for a rating in a custom metric rating scale.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RatingScaleItemValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RatingScaleItemValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RatingScaleItemValue)
# RequestMetadataBaseFilters
A mapping of a metadata key to a value that it should or should not equal.
## Contents
** equals **
Include results where the key equals the value.
Type: String to string map
Map Entries: Maximum number of 1 item.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern: `[a-zA-Z0-9\s._:/=+$@-]{1,256}`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+$@-]{0,256}`
Required: No
** notEquals **
Include results where the key does not equal the value.
Type: String to string map
Map Entries: Maximum number of 1 item.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern: `[a-zA-Z0-9\s._:/=+$@-]{1,256}`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+$@-]{0,256}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RequestMetadataBaseFilters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RequestMetadataBaseFilters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RequestMetadataBaseFilters)
# RequestMetadataFilters
Rules for filtering invocation logs. A filter can be a mapping of a metadata key to a value that it should or should not equal (a base filter), or a list of base filters that are all applied with `AND` or `OR` logical operators
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** andAll **
Include results where all of the based filters match.
Type: Array of [RequestMetadataBaseFilters](API_RequestMetadataBaseFilters.md) objects
Array Members: Minimum number of 1 item. Maximum number of 16 items.
Required: No
** equals **
Include results where the key equals the value.
Type: String to string map
Map Entries: Maximum number of 1 item.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern: `[a-zA-Z0-9\s._:/=+$@-]{1,256}`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+$@-]{0,256}`
Required: No
** notEquals **
Include results where the key does not equal the value.
Type: String to string map
Map Entries: Maximum number of 1 item.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern: `[a-zA-Z0-9\s._:/=+$@-]{1,256}`
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern: `[a-zA-Z0-9\s._:/=+$@-]{0,256}`
Required: No
** orAll **
Include results where any of the base filters match.
Type: Array of [RequestMetadataBaseFilters](API_RequestMetadataBaseFilters.md) objects
Array Members: Minimum number of 1 item. Maximum number of 16 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RequestMetadataFilters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RequestMetadataFilters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RequestMetadataFilters)
# RerankingMetadataSelectiveModeConfiguration
Configuration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** fieldsToExclude **
A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
Type: Array of [FieldForReranking](API_FieldForReranking.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** fieldsToInclude **
A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
Type: Array of [FieldForReranking](API_FieldForReranking.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RerankingMetadataSelectiveModeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RerankingMetadataSelectiveModeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RerankingMetadataSelectiveModeConfiguration)
# RetrievalFilter
Specifies the filters to use on the metadata attributes/fields in the knowledge base data sources before returning results.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** andAll **
Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
Type: Array of [RetrievalFilter](#API_RetrievalFilter) objects
Array Members: Minimum number of 2 items.
Required: No
** equals **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value matches the value in this object.
The following example would return data sources with an animal attribute whose value is 'cat': `"equals": { "key": "animal", "value": "cat" }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** greaterThan **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than the value in this object.
The following example would return data sources with an year attribute whose value is greater than '1989': `"greaterThan": { "key": "year", "value": 1989 }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** greaterThanOrEquals **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is greater than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is greater than or equal to '1989': `"greaterThanOrEquals": { "key": "year", "value": 1989 }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** in **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is in the list specified in the value in this object.
The following example would return data sources with an animal attribute that is either 'cat' or 'dog': `"in": { "key": "animal", "value": ["cat", "dog"] }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** lessThan **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than the value in this object.
The following example would return data sources with an year attribute whose value is less than to '1989': `"lessThan": { "key": "year", "value": 1989 }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** lessThanOrEquals **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is less than or equal to the value in this object.
The following example would return data sources with an year attribute whose value is less than or equal to '1989': `"lessThanOrEquals": { "key": "year", "value": 1989 }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** listContains **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is a list that contains the value as one of its members.
The following example would return data sources with an animals attribute that is a list containing a cat member (for example, `["dog", "cat"]`): `"listContains": { "key": "animals", "value": "cat" }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** notEquals **
Knowledge base data sources that contain a metadata attribute whose name matches the key and whose value doesn't match the value in this object are returned.
The following example would return data sources that don't contain an animal attribute whose value is 'cat': `"notEquals": { "key": "animal", "value": "cat" }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** notIn **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value isn't in the list specified in the value in this object.
The following example would return data sources whose animal attribute is neither 'cat' nor 'dog': `"notIn": { "key": "animal", "value": ["cat", "dog"] }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** orAll **
Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
Type: Array of [RetrievalFilter](#API_RetrievalFilter) objects
Array Members: Minimum number of 2 items.
Required: No
** startsWith **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value starts with the value in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an animal attribute starts with 'ca' (for example, 'cat' or 'camel'). `"startsWith": { "key": "animal", "value": "ca" }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
** stringContains **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the key and whose value is one of the following:
A string that contains the value as a substring. The following example would return data sources with an animal attribute that contains the substring at (for example, 'cat'): `"stringContains": { "key": "animal", "value": "at" }`
A list with a member that contains the value as a substring. The following example would return data sources with an animals attribute that is a list containing a member that contains the substring at (for example, `["dog", "cat"]`): `"stringContains": { "key": "animals", "value": "at" }`
Type: [FilterAttribute](API_FilterAttribute.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RetrievalFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RetrievalFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RetrievalFilter)
# RetrieveAndGenerateConfiguration
Contains configuration details for a knowledge base retrieval and response generation.
## Contents
** type **
The type of resource that contains your data for retrieving information and generating responses.
If you choose to use `EXTERNAL_SOURCES`, then currently only Claude 3 Sonnet models for knowledge bases are supported.
Type: String
Valid Values: `KNOWLEDGE_BASE | EXTERNAL_SOURCES`
Required: Yes
** externalSourcesConfiguration **
The configuration for the external source wrapper object in the `retrieveAndGenerate` function.
Type: [ExternalSourcesRetrieveAndGenerateConfiguration](API_ExternalSourcesRetrieveAndGenerateConfiguration.md) object
Required: No
** knowledgeBaseConfiguration **
Contains configuration details for the knowledge base retrieval and response generation.
Type: [KnowledgeBaseRetrieveAndGenerateConfiguration](API_KnowledgeBaseRetrieveAndGenerateConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RetrieveAndGenerateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RetrieveAndGenerateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RetrieveAndGenerateConfiguration)
# RetrieveConfig
The configuration details for retrieving information from a knowledge base.
## Contents
** knowledgeBaseId **
The unique identifier of the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** knowledgeBaseRetrievalConfiguration **
Contains configuration details for knowledge base retrieval.
Type: [KnowledgeBaseRetrievalConfiguration](API_KnowledgeBaseRetrievalConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RetrieveConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RetrieveConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RetrieveConfig)
# RFTConfig
Configuration settings for reinforcement fine-tuning (RFT), including grader configuration and training hyperparameters.
## Contents
** graderConfig **
Configuration for the grader that evaluates model responses and provides reward signals during RFT training.
Type: [GraderConfig](API_GraderConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** hyperParameters **
Hyperparameters that control the reinforcement fine-tuning training process, including learning rate, batch size, and epoch count.
Type: [RFTHyperParameters](API_RFTHyperParameters.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RFTConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RFTConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RFTConfig)
# RFTHyperParameters
Hyperparameters for controlling the reinforcement fine-tuning training process, including learning settings and evaluation intervals.
## Contents
** batchSize **
Number of training samples processed in each batch during reinforcement fine-tuning (RFT) training. Larger batches may improve training stability.
Type: Integer
Valid Range: Minimum value of 16. Maximum value of 512.
Required: No
** epochCount **
Number of training epochs to run during reinforcement fine-tuning. Higher values may improve performance but increase training time.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 50.
Required: No
** evalInterval **
Interval between evaluation runs during RFT training, measured in training steps. More frequent evaluation provides better monitoring.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** inferenceMaxTokens **
Maximum number of tokens the model can generate in response to each prompt during RFT training.
Type: Integer
Required: No
** learningRate **
Learning rate for the reinforcement fine-tuning. Controls how quickly the model adapts to reward signals.
Type: Float
Valid Range: Minimum value of 1.0e-07. Maximum value of 0.001.
Required: No
** maxPromptLength **
Maximum length of input prompts during RFT training, measured in tokens. Longer prompts allow more context but increase memory usage and training-time.
Type: Integer
Required: No
** reasoningEffort **
Level of reasoning effort applied during RFT training. Higher values may improve response quality but increase training time.
Type: String
Valid Values: `low | medium | high`
Required: No
** trainingSamplePerPrompt **
Number of response samples generated per prompt during RFT training. More samples provide better reward signal estimation.
Type: Integer
Valid Range: Minimum value of 2. Maximum value of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RFTHyperParameters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RFTHyperParameters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RFTHyperParameters)
# RoutingCriteria
Routing criteria for a prompt router.
## Contents
** responseQualityDifference **
The criteria's response quality difference.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 100.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/RoutingCriteria)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/RoutingCriteria)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/RoutingCriteria)
# S3Config
S3 configuration for storing log data.
## Contents
** bucketName **
S3 bucket name.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Required: Yes
** keyPrefix **
S3 prefix.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/S3Config)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/S3Config)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/S3Config)
# S3DataSource
The Amazon S3 data source of the model to import. For the [CreateCustomModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html) API operation, you must specify the Amazon S3 URI for the Amazon-managed Amazon S3 bucket containing your model artifacts. SageMaker AI creates this bucket when you run your first SageMaker AI training job.
## Contents
** s3Uri **
The URI of the Amazon S3 data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/S3DataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/S3DataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/S3DataSource)
# S3ObjectDoc
The unique wrapper object of the document from the S3 location.
## Contents
** uri **
The S3 URI location for the wrapper object of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/S3ObjectDoc)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/S3ObjectDoc)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/S3ObjectDoc)
# SageMakerEndpoint
Specifies the configuration for a Amazon SageMaker endpoint.
## Contents
** executionRole **
The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on Amazon EC2 compute instances or for batch transform jobs.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+`
Required: Yes
** initialInstanceCount **
The number of Amazon EC2 compute instances to deploy for initial endpoint creation.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
** instanceType **
The Amazon EC2 compute instance type to deploy for hosting the model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes
** kmsEncryptionKey **
The AWS KMS key that Amazon SageMaker uses to encrypt data on the storage volume attached to the Amazon EC2 compute instance that hosts the endpoint.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)`
Required: No
** vpc **
The VPC configuration for the endpoint.
Type: [VpcConfig](API_VpcConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/SageMakerEndpoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/SageMakerEndpoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/SageMakerEndpoint)
# SelectiveContentGuarding
Selective content guarding controls for enforced guardrails.
## Contents
** messages **
Selective guarding mode for user messages.
Type: String
Valid Values: `SELECTIVE | COMPREHENSIVE`
Required: No
** system **
Selective guarding mode for system prompts.
Type: String
Valid Values: `SELECTIVE | COMPREHENSIVE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/SelectiveContentGuarding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/SelectiveContentGuarding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/SelectiveContentGuarding)
# StatusDetails
The status details for sub-tasks of a customization job. Possible statuses for each sub-task include the following:
+ NotStarted
+ InProgress
+ Completed
+ Stopping
+ Stopped
+ Failed
## Contents
** dataProcessingDetails **
For a Distillation job, the status details for the data processing sub-task of the customization job.
Type: [DataProcessingDetails](API_DataProcessingDetails.md) object
Required: No
** trainingDetails **
The status details for the training sub-task of the job.
Type: [TrainingDetails](API_TrainingDetails.md) object
Required: No
** validationDetails **
The status details for the validation sub-task of the job.
Type: [ValidationDetails](API_ValidationDetails.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/StatusDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/StatusDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/StatusDetails)
# SupportTerm
Describes a support term.
## Contents
** refundPolicyDescription **
Describes the refund policy.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/SupportTerm)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/SupportTerm)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/SupportTerm)
# Tag
Definition of the key/value pair for a tag.
## Contents
** key **
Key for the tag.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: Yes
** value **
Value for the tag.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/Tag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/Tag)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/Tag)
# TeacherModelConfig
Details about a teacher model used for model customization.
## Contents
** teacherModelIdentifier **
The identifier of the teacher model.
Type: String
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:((:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})|(([0-9a-zA-Z][_-]?)+)$)|([0-9]{12}:inference-profile/[a-zA-Z0-9-:.]+$)))|([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})`
Required: Yes
** maxResponseLengthForInference **
The maximum number of tokens requested when the customization job invokes the teacher model.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/TeacherModelConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/TeacherModelConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/TeacherModelConfig)
# TermDetails
Describes the usage terms of an offer.
## Contents
** legalTerm **
Describes the legal terms.
Type: [LegalTerm](API_LegalTerm.md) object
Required: Yes
** supportTerm **
Describes the support terms.
Type: [SupportTerm](API_SupportTerm.md) object
Required: Yes
** usageBasedPricingTerm **
Describes the pricing terms.
Type: [PricingTerm](API_PricingTerm.md) object
Required: Yes
** validityTerm **
Describes the validity terms.
Type: [ValidityTerm](API_ValidityTerm.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/TermDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/TermDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/TermDetails)
# TextInferenceConfig
The configuration details for text generation using a language model via the `RetrieveAndGenerate` function.
## Contents
** maxTokens **
The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitrary values, for actual values consult the limits defined by your specific model.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 65536.
Required: No
** stopSequences **
A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitrary values, for actual values consult the limits defined by your specific model.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 4 items.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
** temperature **
Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** topP **
A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/TextInferenceConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/TextInferenceConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/TextInferenceConfig)
# TrainingDataConfig
S3 Location of the training data.
## Contents
** invocationLogsConfig **
Settings for using invocation logs to customize a model.
Type: [InvocationLogsConfig](API_InvocationLogsConfig.md) object
Required: No
** s3Uri **
The S3 URI where the training data is stored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/TrainingDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/TrainingDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/TrainingDataConfig)
# TrainingDetails
The status details for the training sub-task of the customization job.
## Contents
** creationTime **
The start time of the training sub-task of the job.
Type: Timestamp
Required: No
** lastModifiedTime **
The latest update to the training sub-task of the job.
Type: Timestamp
Required: No
** status **
The status of the training sub-task of the job.
Type: String
Valid Values: `InProgress | Completed | Stopping | Stopped | Failed | NotStarted`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/TrainingDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/TrainingDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/TrainingDetails)
# TrainingMetrics
Metrics associated with the custom job.
## Contents
** trainingLoss **
Loss metric associated with the custom job.
Type: Float
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/TrainingMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/TrainingMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/TrainingMetrics)
# ValidationDataConfig
Array of up to 10 validators.
## Contents
** validators **
Information about the validators.
Type: Array of [Validator](API_Validator.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ValidationDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ValidationDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ValidationDataConfig)
# ValidationDetails
The status details for the validation sub-task of the customization job.
## Contents
** creationTime **
The start time of the validation sub-task of the job.
Type: Timestamp
Required: No
** lastModifiedTime **
The latest update to the validation sub-task of the job.
Type: Timestamp
Required: No
** status **
The status of the validation sub-task of the job.
Type: String
Valid Values: `InProgress | Completed | Stopping | Stopped | Failed | NotStarted`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ValidationDetails)
# Validator
Information about a validator.
## Contents
** s3Uri **
The S3 URI where the validation data is stored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][-.a-z0-9]{1,61}[a-z0-9](?:/[-!_*'().a-z0-9A-Z]+(?:/[-!_*'().a-z0-9A-Z]+)*)?/?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/Validator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/Validator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/Validator)
# ValidatorMetric
The metric for the validator.
## Contents
** validationLoss **
The validation loss associated with this validator.
Type: Float
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ValidatorMetric)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ValidatorMetric)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ValidatorMetric)
# ValidityTerm
Describes the validity terms.
## Contents
** agreementDuration **
Describes the agreement duration.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/ValidityTerm)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/ValidityTerm)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/ValidityTerm)
# VectorSearchBedrockRerankingConfiguration
Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models.
## Contents
** modelConfiguration **
Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.
Type: [VectorSearchBedrockRerankingModelConfiguration](API_VectorSearchBedrockRerankingModelConfiguration.md) object
Required: Yes
** metadataConfiguration **
Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.
Type: [MetadataConfigurationForReranking](API_MetadataConfigurationForReranking.md) object
Required: No
** numberOfRerankedResults **
The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/VectorSearchBedrockRerankingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/VectorSearchBedrockRerankingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/VectorSearchBedrockRerankingConfiguration)
# VectorSearchBedrockRerankingModelConfiguration
Configuration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model.
## Contents
** modelArn **
The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?`
Required: Yes
** additionalModelRequestFields **
A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/VectorSearchBedrockRerankingModelConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/VectorSearchBedrockRerankingModelConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/VectorSearchBedrockRerankingModelConfiguration)
# VectorSearchRerankingConfiguration
Configuration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.
## Contents
** type **
The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
Type: String
Valid Values: `BEDROCK_RERANKING_MODEL`
Required: Yes
** bedrockRerankingConfiguration **
Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.
Type: [VectorSearchBedrockRerankingConfiguration](API_VectorSearchBedrockRerankingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/VectorSearchRerankingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/VectorSearchRerankingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/VectorSearchRerankingConfiguration)
# VpcConfig
The configuration of a virtual private cloud (VPC). For more information, see [Protect your data using Amazon Virtual Private Cloud and AWS PrivateLink](https://docs.aws.amazon.com/bedrock/latest/userguide/usingVPC.html).
## Contents
** securityGroupIds **
An array of IDs for each security group in the VPC to use.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 0. Maximum length of 32.
Pattern: `[-0-9a-zA-Z]+`
Required: Yes
** subnetIds **
An array of IDs for each subnet in the VPC to use.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 16 items.
Length Constraints: Minimum length of 0. Maximum length of 32.
Pattern: `[-0-9a-zA-Z]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-2023-04-20/VpcConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-2023-04-20/VpcConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-2023-04-20/VpcConfig)
# Agents for Amazon Bedrock
The following data types are supported by Agents for Amazon Bedrock:
+ [ActionGroupExecutor](API_agent_ActionGroupExecutor.md)
+ [ActionGroupSummary](API_agent_ActionGroupSummary.md)
+ [Agent](API_agent_Agent.md)
+ [AgentActionGroup](API_agent_AgentActionGroup.md)
+ [AgentAlias](API_agent_AgentAlias.md)
+ [AgentAliasHistoryEvent](API_agent_AgentAliasHistoryEvent.md)
+ [AgentAliasRoutingConfigurationListItem](API_agent_AgentAliasRoutingConfigurationListItem.md)
+ [AgentAliasSummary](API_agent_AgentAliasSummary.md)
+ [AgentCollaborator](API_agent_AgentCollaborator.md)
+ [AgentCollaboratorSummary](API_agent_AgentCollaboratorSummary.md)
+ [AgentDescriptor](API_agent_AgentDescriptor.md)
+ [AgentFlowNodeConfiguration](API_agent_AgentFlowNodeConfiguration.md)
+ [AgentKnowledgeBase](API_agent_AgentKnowledgeBase.md)
+ [AgentKnowledgeBaseSummary](API_agent_AgentKnowledgeBaseSummary.md)
+ [AgentSummary](API_agent_AgentSummary.md)
+ [AgentVersion](API_agent_AgentVersion.md)
+ [AgentVersionSummary](API_agent_AgentVersionSummary.md)
+ [AnyToolChoice](API_agent_AnyToolChoice.md)
+ [APISchema](API_agent_APISchema.md)
+ [AudioConfiguration](API_agent_AudioConfiguration.md)
+ [AudioSegmentationConfiguration](API_agent_AudioSegmentationConfiguration.md)
+ [AutoToolChoice](API_agent_AutoToolChoice.md)
+ [BedrockDataAutomationConfiguration](API_agent_BedrockDataAutomationConfiguration.md)
+ [BedrockEmbeddingModelConfiguration](API_agent_BedrockEmbeddingModelConfiguration.md)
+ [BedrockFoundationModelConfiguration](API_agent_BedrockFoundationModelConfiguration.md)
+ [BedrockFoundationModelContextEnrichmentConfiguration](API_agent_BedrockFoundationModelContextEnrichmentConfiguration.md)
+ [ByteContentDoc](API_agent_ByteContentDoc.md)
+ [CachePointBlock](API_agent_CachePointBlock.md)
+ [ChatPromptTemplateConfiguration](API_agent_ChatPromptTemplateConfiguration.md)
+ [ChunkingConfiguration](API_agent_ChunkingConfiguration.md)
+ [CollectorFlowNodeConfiguration](API_agent_CollectorFlowNodeConfiguration.md)
+ [ConditionFlowNodeConfiguration](API_agent_ConditionFlowNodeConfiguration.md)
+ [ConfluenceCrawlerConfiguration](API_agent_ConfluenceCrawlerConfiguration.md)
+ [ConfluenceDataSourceConfiguration](API_agent_ConfluenceDataSourceConfiguration.md)
+ [ConfluenceSourceConfiguration](API_agent_ConfluenceSourceConfiguration.md)
+ [ContentBlock](API_agent_ContentBlock.md)
+ [ContextEnrichmentConfiguration](API_agent_ContextEnrichmentConfiguration.md)
+ [CrawlFilterConfiguration](API_agent_CrawlFilterConfiguration.md)
+ [CuratedQuery](API_agent_CuratedQuery.md)
+ [CustomContent](API_agent_CustomContent.md)
+ [CustomDocumentIdentifier](API_agent_CustomDocumentIdentifier.md)
+ [CustomOrchestration](API_agent_CustomOrchestration.md)
+ [CustomS3Location](API_agent_CustomS3Location.md)
+ [CustomTransformationConfiguration](API_agent_CustomTransformationConfiguration.md)
+ [CyclicConnectionFlowValidationDetails](API_agent_CyclicConnectionFlowValidationDetails.md)
+ [DataSource](API_agent_DataSource.md)
+ [DataSourceConfiguration](API_agent_DataSourceConfiguration.md)
+ [DataSourceSummary](API_agent_DataSourceSummary.md)
+ [DocumentContent](API_agent_DocumentContent.md)
+ [DocumentIdentifier](API_agent_DocumentIdentifier.md)
+ [DocumentMetadata](API_agent_DocumentMetadata.md)
+ [DuplicateConditionExpressionFlowValidationDetails](API_agent_DuplicateConditionExpressionFlowValidationDetails.md)
+ [DuplicateConnectionsFlowValidationDetails](API_agent_DuplicateConnectionsFlowValidationDetails.md)
+ [EmbeddingModelConfiguration](API_agent_EmbeddingModelConfiguration.md)
+ [EnrichmentStrategyConfiguration](API_agent_EnrichmentStrategyConfiguration.md)
+ [FieldForReranking](API_agent_FieldForReranking.md)
+ [FixedSizeChunkingConfiguration](API_agent_FixedSizeChunkingConfiguration.md)
+ [FlowAliasConcurrencyConfiguration](API_agent_FlowAliasConcurrencyConfiguration.md)
+ [FlowAliasRoutingConfigurationListItem](API_agent_FlowAliasRoutingConfigurationListItem.md)
+ [FlowAliasSummary](API_agent_FlowAliasSummary.md)
+ [FlowCondition](API_agent_FlowCondition.md)
+ [FlowConditionalConnectionConfiguration](API_agent_FlowConditionalConnectionConfiguration.md)
+ [FlowConnection](API_agent_FlowConnection.md)
+ [FlowConnectionConfiguration](API_agent_FlowConnectionConfiguration.md)
+ [FlowDataConnectionConfiguration](API_agent_FlowDataConnectionConfiguration.md)
+ [FlowDefinition](API_agent_FlowDefinition.md)
+ [FlowNode](API_agent_FlowNode.md)
+ [FlowNodeConfiguration](API_agent_FlowNodeConfiguration.md)
+ [FlowNodeInput](API_agent_FlowNodeInput.md)
+ [FlowNodeOutput](API_agent_FlowNodeOutput.md)
+ [FlowSummary](API_agent_FlowSummary.md)
+ [FlowValidation](API_agent_FlowValidation.md)
+ [FlowValidationDetails](API_agent_FlowValidationDetails.md)
+ [FlowVersionSummary](API_agent_FlowVersionSummary.md)
+ [Function](API_agent_Function.md)
+ [FunctionSchema](API_agent_FunctionSchema.md)
+ [GuardrailConfiguration](API_agent_GuardrailConfiguration.md)
+ [HierarchicalChunkingConfiguration](API_agent_HierarchicalChunkingConfiguration.md)
+ [HierarchicalChunkingLevelConfiguration](API_agent_HierarchicalChunkingLevelConfiguration.md)
+ [IncompatibleConnectionDataTypeFlowValidationDetails](API_agent_IncompatibleConnectionDataTypeFlowValidationDetails.md)
+ [InferenceConfiguration](API_agent_InferenceConfiguration.md)
+ [IngestionJob](API_agent_IngestionJob.md)
+ [IngestionJobFilter](API_agent_IngestionJobFilter.md)
+ [IngestionJobSortBy](API_agent_IngestionJobSortBy.md)
+ [IngestionJobStatistics](API_agent_IngestionJobStatistics.md)
+ [IngestionJobSummary](API_agent_IngestionJobSummary.md)
+ [InlineCodeFlowNodeConfiguration](API_agent_InlineCodeFlowNodeConfiguration.md)
+ [InlineContent](API_agent_InlineContent.md)
+ [InputFlowNodeConfiguration](API_agent_InputFlowNodeConfiguration.md)
+ [IntermediateStorage](API_agent_IntermediateStorage.md)
+ [InvalidLoopBoundaryFlowValidationDetails](API_agent_InvalidLoopBoundaryFlowValidationDetails.md)
+ [IteratorFlowNodeConfiguration](API_agent_IteratorFlowNodeConfiguration.md)
+ [KendraKnowledgeBaseConfiguration](API_agent_KendraKnowledgeBaseConfiguration.md)
+ [KnowledgeBase](API_agent_KnowledgeBase.md)
+ [KnowledgeBaseConfiguration](API_agent_KnowledgeBaseConfiguration.md)
+ [KnowledgeBaseDocument](API_agent_KnowledgeBaseDocument.md)
+ [KnowledgeBaseDocumentDetail](API_agent_KnowledgeBaseDocumentDetail.md)
+ [KnowledgeBaseFlowNodeConfiguration](API_agent_KnowledgeBaseFlowNodeConfiguration.md)
+ [KnowledgeBaseOrchestrationConfiguration](API_agent_KnowledgeBaseOrchestrationConfiguration.md)
+ [KnowledgeBasePromptTemplate](API_agent_KnowledgeBasePromptTemplate.md)
+ [KnowledgeBaseSummary](API_agent_KnowledgeBaseSummary.md)
+ [LambdaFunctionFlowNodeConfiguration](API_agent_LambdaFunctionFlowNodeConfiguration.md)
+ [LexFlowNodeConfiguration](API_agent_LexFlowNodeConfiguration.md)
+ [LoopControllerFlowNodeConfiguration](API_agent_LoopControllerFlowNodeConfiguration.md)
+ [LoopFlowNodeConfiguration](API_agent_LoopFlowNodeConfiguration.md)
+ [LoopIncompatibleNodeTypeFlowValidationDetails](API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.md)
+ [LoopInputFlowNodeConfiguration](API_agent_LoopInputFlowNodeConfiguration.md)
+ [MalformedConditionExpressionFlowValidationDetails](API_agent_MalformedConditionExpressionFlowValidationDetails.md)
+ [MalformedNodeInputExpressionFlowValidationDetails](API_agent_MalformedNodeInputExpressionFlowValidationDetails.md)
+ [MemoryConfiguration](API_agent_MemoryConfiguration.md)
+ [Message](API_agent_Message.md)
+ [MetadataAttribute](API_agent_MetadataAttribute.md)
+ [MetadataAttributeValue](API_agent_MetadataAttributeValue.md)
+ [MetadataConfigurationForReranking](API_agent_MetadataConfigurationForReranking.md)
+ [MismatchedNodeInputTypeFlowValidationDetails](API_agent_MismatchedNodeInputTypeFlowValidationDetails.md)
+ [MismatchedNodeOutputTypeFlowValidationDetails](API_agent_MismatchedNodeOutputTypeFlowValidationDetails.md)
+ [MissingConnectionConfigurationFlowValidationDetails](API_agent_MissingConnectionConfigurationFlowValidationDetails.md)
+ [MissingDefaultConditionFlowValidationDetails](API_agent_MissingDefaultConditionFlowValidationDetails.md)
+ [MissingEndingNodesFlowValidationDetails](API_agent_MissingEndingNodesFlowValidationDetails.md)
+ [MissingLoopControllerNodeFlowValidationDetails](API_agent_MissingLoopControllerNodeFlowValidationDetails.md)
+ [MissingLoopInputNodeFlowValidationDetails](API_agent_MissingLoopInputNodeFlowValidationDetails.md)
+ [MissingNodeConfigurationFlowValidationDetails](API_agent_MissingNodeConfigurationFlowValidationDetails.md)
+ [MissingNodeInputFlowValidationDetails](API_agent_MissingNodeInputFlowValidationDetails.md)
+ [MissingNodeOutputFlowValidationDetails](API_agent_MissingNodeOutputFlowValidationDetails.md)
+ [MissingStartingNodesFlowValidationDetails](API_agent_MissingStartingNodesFlowValidationDetails.md)
+ [MongoDbAtlasConfiguration](API_agent_MongoDbAtlasConfiguration.md)
+ [MongoDbAtlasFieldMapping](API_agent_MongoDbAtlasFieldMapping.md)
+ [MultipleLoopControllerNodesFlowValidationDetails](API_agent_MultipleLoopControllerNodesFlowValidationDetails.md)
+ [MultipleLoopInputNodesFlowValidationDetails](API_agent_MultipleLoopInputNodesFlowValidationDetails.md)
+ [MultipleNodeInputConnectionsFlowValidationDetails](API_agent_MultipleNodeInputConnectionsFlowValidationDetails.md)
+ [NeptuneAnalyticsConfiguration](API_agent_NeptuneAnalyticsConfiguration.md)
+ [NeptuneAnalyticsFieldMapping](API_agent_NeptuneAnalyticsFieldMapping.md)
+ [OpenSearchManagedClusterConfiguration](API_agent_OpenSearchManagedClusterConfiguration.md)
+ [OpenSearchManagedClusterFieldMapping](API_agent_OpenSearchManagedClusterFieldMapping.md)
+ [OpenSearchServerlessConfiguration](API_agent_OpenSearchServerlessConfiguration.md)
+ [OpenSearchServerlessFieldMapping](API_agent_OpenSearchServerlessFieldMapping.md)
+ [OrchestrationExecutor](API_agent_OrchestrationExecutor.md)
+ [OutputFlowNodeConfiguration](API_agent_OutputFlowNodeConfiguration.md)
+ [ParameterDetail](API_agent_ParameterDetail.md)
+ [ParsingConfiguration](API_agent_ParsingConfiguration.md)
+ [ParsingPrompt](API_agent_ParsingPrompt.md)
+ [PatternObjectFilter](API_agent_PatternObjectFilter.md)
+ [PatternObjectFilterConfiguration](API_agent_PatternObjectFilterConfiguration.md)
+ [PerformanceConfiguration](API_agent_PerformanceConfiguration.md)
+ [PineconeConfiguration](API_agent_PineconeConfiguration.md)
+ [PineconeFieldMapping](API_agent_PineconeFieldMapping.md)
+ [PromptAgentResource](API_agent_PromptAgentResource.md)
+ [PromptConfiguration](API_agent_PromptConfiguration.md)
+ [PromptFlowNodeConfiguration](API_agent_PromptFlowNodeConfiguration.md)
+ [PromptFlowNodeInlineConfiguration](API_agent_PromptFlowNodeInlineConfiguration.md)
+ [PromptFlowNodeResourceConfiguration](API_agent_PromptFlowNodeResourceConfiguration.md)
+ [PromptFlowNodeSourceConfiguration](API_agent_PromptFlowNodeSourceConfiguration.md)
+ [PromptGenAiResource](API_agent_PromptGenAiResource.md)
+ [PromptInferenceConfiguration](API_agent_PromptInferenceConfiguration.md)
+ [PromptInputVariable](API_agent_PromptInputVariable.md)
+ [PromptMetadataEntry](API_agent_PromptMetadataEntry.md)
+ [PromptModelInferenceConfiguration](API_agent_PromptModelInferenceConfiguration.md)
+ [PromptOverrideConfiguration](API_agent_PromptOverrideConfiguration.md)
+ [PromptSummary](API_agent_PromptSummary.md)
+ [PromptTemplateConfiguration](API_agent_PromptTemplateConfiguration.md)
+ [PromptVariant](API_agent_PromptVariant.md)
+ [QueryGenerationColumn](API_agent_QueryGenerationColumn.md)
+ [QueryGenerationConfiguration](API_agent_QueryGenerationConfiguration.md)
+ [QueryGenerationContext](API_agent_QueryGenerationContext.md)
+ [QueryGenerationTable](API_agent_QueryGenerationTable.md)
+ [RdsConfiguration](API_agent_RdsConfiguration.md)
+ [RdsFieldMapping](API_agent_RdsFieldMapping.md)
+ [RedisEnterpriseCloudConfiguration](API_agent_RedisEnterpriseCloudConfiguration.md)
+ [RedisEnterpriseCloudFieldMapping](API_agent_RedisEnterpriseCloudFieldMapping.md)
+ [RedshiftConfiguration](API_agent_RedshiftConfiguration.md)
+ [RedshiftProvisionedAuthConfiguration](API_agent_RedshiftProvisionedAuthConfiguration.md)
+ [RedshiftProvisionedConfiguration](API_agent_RedshiftProvisionedConfiguration.md)
+ [RedshiftQueryEngineAwsDataCatalogStorageConfiguration](API_agent_RedshiftQueryEngineAwsDataCatalogStorageConfiguration.md)
+ [RedshiftQueryEngineConfiguration](API_agent_RedshiftQueryEngineConfiguration.md)
+ [RedshiftQueryEngineRedshiftStorageConfiguration](API_agent_RedshiftQueryEngineRedshiftStorageConfiguration.md)
+ [RedshiftQueryEngineStorageConfiguration](API_agent_RedshiftQueryEngineStorageConfiguration.md)
+ [RedshiftServerlessAuthConfiguration](API_agent_RedshiftServerlessAuthConfiguration.md)
+ [RedshiftServerlessConfiguration](API_agent_RedshiftServerlessConfiguration.md)
+ [RerankingMetadataSelectiveModeConfiguration](API_agent_RerankingMetadataSelectiveModeConfiguration.md)
+ [RetrievalFlowNodeConfiguration](API_agent_RetrievalFlowNodeConfiguration.md)
+ [RetrievalFlowNodeS3Configuration](API_agent_RetrievalFlowNodeS3Configuration.md)
+ [RetrievalFlowNodeServiceConfiguration](API_agent_RetrievalFlowNodeServiceConfiguration.md)
+ [S3Content](API_agent_S3Content.md)
+ [S3DataSourceConfiguration](API_agent_S3DataSourceConfiguration.md)
+ [S3Identifier](API_agent_S3Identifier.md)
+ [S3Location](API_agent_S3Location.md)
+ [S3VectorsConfiguration](API_agent_S3VectorsConfiguration.md)
+ [SalesforceCrawlerConfiguration](API_agent_SalesforceCrawlerConfiguration.md)
+ [SalesforceDataSourceConfiguration](API_agent_SalesforceDataSourceConfiguration.md)
+ [SalesforceSourceConfiguration](API_agent_SalesforceSourceConfiguration.md)
+ [SeedUrl](API_agent_SeedUrl.md)
+ [SemanticChunkingConfiguration](API_agent_SemanticChunkingConfiguration.md)
+ [ServerSideEncryptionConfiguration](API_agent_ServerSideEncryptionConfiguration.md)
+ [SessionSummaryConfiguration](API_agent_SessionSummaryConfiguration.md)
+ [SharePointCrawlerConfiguration](API_agent_SharePointCrawlerConfiguration.md)
+ [SharePointDataSourceConfiguration](API_agent_SharePointDataSourceConfiguration.md)
+ [SharePointSourceConfiguration](API_agent_SharePointSourceConfiguration.md)
+ [SpecificToolChoice](API_agent_SpecificToolChoice.md)
+ [SqlKnowledgeBaseConfiguration](API_agent_SqlKnowledgeBaseConfiguration.md)
+ [StorageConfiguration](API_agent_StorageConfiguration.md)
+ [StorageFlowNodeConfiguration](API_agent_StorageFlowNodeConfiguration.md)
+ [StorageFlowNodeS3Configuration](API_agent_StorageFlowNodeS3Configuration.md)
+ [StorageFlowNodeServiceConfiguration](API_agent_StorageFlowNodeServiceConfiguration.md)
+ [SupplementalDataStorageConfiguration](API_agent_SupplementalDataStorageConfiguration.md)
+ [SupplementalDataStorageLocation](API_agent_SupplementalDataStorageLocation.md)
+ [SystemContentBlock](API_agent_SystemContentBlock.md)
+ [TextContentDoc](API_agent_TextContentDoc.md)
+ [TextPromptTemplateConfiguration](API_agent_TextPromptTemplateConfiguration.md)
+ [Tool](API_agent_Tool.md)
+ [ToolChoice](API_agent_ToolChoice.md)
+ [ToolConfiguration](API_agent_ToolConfiguration.md)
+ [ToolInputSchema](API_agent_ToolInputSchema.md)
+ [ToolSpecification](API_agent_ToolSpecification.md)
+ [Transformation](API_agent_Transformation.md)
+ [TransformationFunction](API_agent_TransformationFunction.md)
+ [TransformationLambdaConfiguration](API_agent_TransformationLambdaConfiguration.md)
+ [UnfulfilledNodeInputFlowValidationDetails](API_agent_UnfulfilledNodeInputFlowValidationDetails.md)
+ [UnknownConnectionConditionFlowValidationDetails](API_agent_UnknownConnectionConditionFlowValidationDetails.md)
+ [UnknownConnectionSourceFlowValidationDetails](API_agent_UnknownConnectionSourceFlowValidationDetails.md)
+ [UnknownConnectionSourceOutputFlowValidationDetails](API_agent_UnknownConnectionSourceOutputFlowValidationDetails.md)
+ [UnknownConnectionTargetFlowValidationDetails](API_agent_UnknownConnectionTargetFlowValidationDetails.md)
+ [UnknownConnectionTargetInputFlowValidationDetails](API_agent_UnknownConnectionTargetInputFlowValidationDetails.md)
+ [UnknownNodeInputFlowValidationDetails](API_agent_UnknownNodeInputFlowValidationDetails.md)
+ [UnknownNodeOutputFlowValidationDetails](API_agent_UnknownNodeOutputFlowValidationDetails.md)
+ [UnreachableNodeFlowValidationDetails](API_agent_UnreachableNodeFlowValidationDetails.md)
+ [UnsatisfiedConnectionConditionsFlowValidationDetails](API_agent_UnsatisfiedConnectionConditionsFlowValidationDetails.md)
+ [UnspecifiedFlowValidationDetails](API_agent_UnspecifiedFlowValidationDetails.md)
+ [UrlConfiguration](API_agent_UrlConfiguration.md)
+ [ValidationExceptionField](API_agent_ValidationExceptionField.md)
+ [VectorIngestionConfiguration](API_agent_VectorIngestionConfiguration.md)
+ [VectorKnowledgeBaseConfiguration](API_agent_VectorKnowledgeBaseConfiguration.md)
+ [VectorSearchBedrockRerankingConfiguration](API_agent_VectorSearchBedrockRerankingConfiguration.md)
+ [VectorSearchBedrockRerankingModelConfiguration](API_agent_VectorSearchBedrockRerankingModelConfiguration.md)
+ [VectorSearchRerankingConfiguration](API_agent_VectorSearchRerankingConfiguration.md)
+ [VideoConfiguration](API_agent_VideoConfiguration.md)
+ [VideoSegmentationConfiguration](API_agent_VideoSegmentationConfiguration.md)
+ [WebCrawlerConfiguration](API_agent_WebCrawlerConfiguration.md)
+ [WebCrawlerLimits](API_agent_WebCrawlerLimits.md)
+ [WebDataSourceConfiguration](API_agent_WebDataSourceConfiguration.md)
+ [WebSourceConfiguration](API_agent_WebSourceConfiguration.md)
# ActionGroupExecutor
Contains details about 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.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** customControl **
To return the action group invocation results directly in the `InvokeAgent` response, specify `RETURN_CONTROL`.
Type: String
Valid Values: `RETURN_CONTROL`
Required: No
** lambda **
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ActionGroupExecutor)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ActionGroupExecutor)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ActionGroupExecutor)
# ActionGroupSummary
Contains details about an action group.
## Contents
** actionGroupId **
The unique identifier of the action group.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** actionGroupName **
The name of the action group.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** actionGroupState **
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: Yes
** updatedAt **
The time at which the action group was last updated.
Type: Timestamp
Required: Yes
** description **
The description of the action group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ActionGroupSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ActionGroupSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ActionGroupSummary)
# Agent
Contains details about an agent.
## Contents
** agentArn **
The Amazon Resource Name (ARN) of the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}`
Required: Yes
** agentId **
The unique identifier of the agent.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** agentName **
The name of the agent.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** agentResourceRoleArn **
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
** agentStatus **
The status of the agent and whether it is ready for use. The following statuses are possible:
+ CREATING – The agent is being created.
+ PREPARING – The agent is being prepared.
+ PREPARED – The agent is prepared and ready to be invoked.
+ NOT\$1PREPARED – The agent has been created but not yet prepared.
+ FAILED – The agent API operation failed.
+ UPDATING – The agent is being updated.
+ DELETING – The agent is being deleted.
Type: String
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING`
Required: Yes
** agentVersion **
The version of the agent.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
** createdAt **
The time at which the agent was created.
Type: Timestamp
Required: Yes
** idleSessionTTLInSeconds **
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: Yes
** updatedAt **
The time at which the agent was last updated.
Type: Timestamp
Required: Yes
** agentCollaboration **
The agent's collaboration settings.
Type: String
Valid Values: `SUPERVISOR | SUPERVISOR_ROUTER | DISABLED`
Required: No
** clientToken **
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 **
The Amazon Resource Name (ARN) of the AWS KMS key that encrypts 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 **
Contains custom orchestration configurations for the agent.
Type: [CustomOrchestration](API_agent_CustomOrchestration.md) object
Required: No
** description **
The description of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** failureReasons **
Contains reasons that the agent-related API that you invoked failed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** foundationModel **
The foundation model used for orchestration by the agent.
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 **
Details about the guardrail associated with the agent.
Type: [GuardrailConfiguration](API_agent_GuardrailConfiguration.md) object
Required: No
** instruction **
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 **
Contains memory configuration for the agent.
Type: [MemoryConfiguration](API_agent_MemoryConfiguration.md) object
Required: No
** orchestrationType **
Specifies the orchestration strategy for the agent.
Type: String
Valid Values: `DEFAULT | CUSTOM_ORCHESTRATION`
Required: No
** preparedAt **
The time at which the agent was last prepared.
Type: Timestamp
Required: No
** promptOverrideConfiguration **
Contains configurations to override prompt templates 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
** recommendedActions **
Contains recommended actions to take for the agent-related API that you invoked to succeed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/Agent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/Agent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/Agent)
# AgentActionGroup
Contains details about an action group.
## Contents
** actionGroupId **
The unique identifier of the action group.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** actionGroupName **
The name of the action group.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** actionGroupState **
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: Yes
** agentId **
The unique identifier of the agent to which the action group belongs.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** agentVersion **
The version of the agent to which the action group belongs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
** createdAt **
The time at which the action group was created.
Type: Timestamp
Required: Yes
** updatedAt **
The time at which the action group was last updated.
Type: Timestamp
Required: Yes
** actionGroupExecutor **
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
** apiSchema **
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 **
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 **
The description of the action group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** functionSchema **
Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
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
** parentActionGroupSignatureParams **
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
** parentActionSignature **
If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task. The `description`, `apiSchema`, and `actionGroupExecutor` fields must be blank for this action group.
During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an [Observation](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
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentActionGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentActionGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentActionGroup)
# AgentAlias
Contains details about an alias of an agent.
## Contents
** agentAliasArn **
The Amazon Resource Name (ARN) of the alias of the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}`
Required: Yes
** agentAliasId **
The unique identifier of the alias of the agent.
Type: String
Length Constraints: Fixed length of 10.
Pattern: `(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** agentAliasName **
The name of the alias of the agent.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** agentAliasStatus **
The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
+ CREATING – The agent alias is being created.
+ PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
+ FAILED – The agent alias API operation failed.
+ UPDATING – The agent alias is being updated.
+ DELETING – The agent alias is being deleted.
+ DISSOCIATED - The agent alias has no version associated with it.
Type: String
Valid Values: `CREATING | PREPARED | FAILED | UPDATING | DELETING | DISSOCIATED`
Required: Yes
** agentId **
The unique identifier of the agent.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** createdAt **
The time at which the alias of the agent was created.
Type: Timestamp
Required: Yes
** routingConfiguration **
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: Yes
** updatedAt **
The time at which the alias was last updated.
Type: Timestamp
Required: Yes
** agentAliasHistoryEvents **
Contains details about the history of the alias.
Type: Array of [AgentAliasHistoryEvent](API_agent_AgentAliasHistoryEvent.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
** aliasInvocationState **
The invocation state for the agent alias. If the agent alias is running, the value is `ACCEPT_INVOCATIONS`. If the agent alias is paused, the value is `REJECT_INVOCATIONS`. Use the `UpdateAgentAlias` operation to change the invocation state.
Type: String
Valid Values: `ACCEPT_INVOCATIONS | REJECT_INVOCATIONS`
Required: No
** clientToken **
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 **
The description of the alias of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** failureReasons **
Information on the failure of Provisioned Throughput assigned to an agent alias.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentAlias)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentAlias)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentAlias)
# AgentAliasHistoryEvent
Contains details about the history of the alias.
## Contents
** endDate **
The date that the alias stopped being associated to the version in the `routingConfiguration` object
Type: Timestamp
Required: No
** routingConfiguration **
Contains details about the version of the agent with which the alias is associated.
Type: Array of [AgentAliasRoutingConfigurationListItem](API_agent_AgentAliasRoutingConfigurationListItem.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
** startDate **
The date that the alias began being associated to the version in the `routingConfiguration` object.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentAliasHistoryEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentAliasHistoryEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentAliasHistoryEvent)
# AgentAliasRoutingConfigurationListItem
Contains details about the routing configuration of the alias.
## Contents
** agentVersion **
The version of the agent with which the alias is associated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: No
** provisionedThroughput **
Information on the Provisioned Throughput assigned to an agent alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `((([0-9a-zA-Z][_-]?){1,63})|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:provisioned-model/[a-z0-9]{12}))`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentAliasRoutingConfigurationListItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentAliasRoutingConfigurationListItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentAliasRoutingConfigurationListItem)
# AgentAliasSummary
Contains details about an alias of an agent.
## Contents
** agentAliasId **
Contains details about
Type: String
Length Constraints: Fixed length of 10.
Pattern: `(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** agentAliasName **
The name of the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** agentAliasStatus **
The status of the alias.
Type: String
Valid Values: `CREATING | PREPARED | FAILED | UPDATING | DELETING | DISSOCIATED`
Required: Yes
** createdAt **
The time at which the alias of the agent was created.
Type: Timestamp
Required: Yes
** updatedAt **
The time at which the alias was last updated.
Type: Timestamp
Required: Yes
** aliasInvocationState **
The invocation state for the agent alias. If the agent alias is running, the value is `ACCEPT_INVOCATIONS`. If the agent alias is paused, the value is `REJECT_INVOCATIONS`. Use the `UpdateAgentAlias` operation to change the invocation state.
Type: String
Valid Values: `ACCEPT_INVOCATIONS | REJECT_INVOCATIONS`
Required: No
** description **
The description of the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** routingConfiguration **
Contains details about the version of the agent with which the alias is associated.
Type: Array of [AgentAliasRoutingConfigurationListItem](API_agent_AgentAliasRoutingConfigurationListItem.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentAliasSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentAliasSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentAliasSummary)
# AgentCollaborator
An agent collaborator.
## Contents
** agentDescriptor **
The collaborator's agent descriptor.
Type: [AgentDescriptor](API_agent_AgentDescriptor.md) object
Required: Yes
** agentId **
The collaborator's agent ID.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** agentVersion **
The collaborator's agent 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})`
Required: Yes
** collaborationInstruction **
The collaborator's instructions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Required: Yes
** collaboratorId **
The collaborator's collaborator ID.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** collaboratorName **
The collaborator's collaborator name.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** createdAt **
When the collaborator was created.
Type: Timestamp
Required: Yes
** lastUpdatedAt **
When the collaborator was updated.
Type: Timestamp
Required: Yes
** clientToken **
The collaborator's 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
** relayConversationHistory **
The collaborator's relay conversation history.
Type: String
Valid Values: `TO_COLLABORATOR | DISABLED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentCollaborator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentCollaborator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentCollaborator)
# AgentCollaboratorSummary
An agent collaborator summary.
## Contents
** agentDescriptor **
The collaborator's agent descriptor.
Type: [AgentDescriptor](API_agent_AgentDescriptor.md) object
Required: Yes
** agentId **
The collaborator's agent ID.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** agentVersion **
The collaborator's agent 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})`
Required: Yes
** collaborationInstruction **
The collaborator's collaboration instruction.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Required: Yes
** collaboratorId **
The collaborator's ID.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** collaboratorName **
The collaborator's name.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** createdAt **
When the collaborator was created.
Type: Timestamp
Required: Yes
** lastUpdatedAt **
When the collaborator was last updated.
Type: Timestamp
Required: Yes
** relayConversationHistory **
The collaborator's relay conversation history.
Type: String
Valid Values: `TO_COLLABORATOR | DISABLED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentCollaboratorSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentCollaboratorSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentCollaboratorSummary)
# AgentDescriptor
An agent descriptor.
## Contents
** aliasArn **
The agent's alias ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentDescriptor)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentDescriptor)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentDescriptor)
# AgentFlowNodeConfiguration
Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.
## Contents
** agentAliasArn **
The Amazon Resource Name (ARN) of the alias of the agent to invoke.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `$|^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentFlowNodeConfiguration)
# AgentKnowledgeBase
Contains details about a knowledge base that is associated with an agent.
## Contents
** agentId **
The unique identifier of the agent with which the knowledge base is associated.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** agentVersion **
The version of the agent with which the knowledge base is associated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
** createdAt **
The time at which the association between the agent and the knowledge base was created.
Type: Timestamp
Required: Yes
** description **
The description of the association between the agent and the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
** knowledgeBaseId **
The unique identifier of the association between the agent and the knowledge base.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** knowledgeBaseState **
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: Yes
** updatedAt **
The time at which the association between the agent and the knowledge base was last updated.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentKnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentKnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentKnowledgeBase)
# AgentKnowledgeBaseSummary
Contains details about a knowledge base associated with an agent.
## Contents
** knowledgeBaseId **
The unique identifier of the knowledge base associated with an agent.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** knowledgeBaseState **
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: Yes
** updatedAt **
The time at which the knowledge base associated with an agent was last updated.
Type: Timestamp
Required: Yes
** description **
The description of the knowledge base associated with an agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentKnowledgeBaseSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentKnowledgeBaseSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentKnowledgeBaseSummary)
# AgentSummary
Contains details about an agent.
## Contents
** agentId **
The unique identifier of the agent.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** agentName **
The name of the agent.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** agentStatus **
The status of the agent.
Type: String
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING`
Required: Yes
** updatedAt **
The time at which the agent was last updated.
Type: Timestamp
Required: Yes
** description **
The description of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** guardrailConfiguration **
Details about the guardrail associated with the agent.
Type: [GuardrailConfiguration](API_agent_GuardrailConfiguration.md) object
Required: No
** latestAgentVersion **
The latest 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})`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentSummary)
# AgentVersion
Contains details about a version of an agent.
## Contents
** agentArn **
The Amazon Resource Name (ARN) of the agent that the version belongs to.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}`
Required: Yes
** agentId **
The unique identifier of the agent that the version belongs to.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** agentName **
The name of the agent that the version belongs to.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** agentResourceRoleArn **
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
** agentStatus **
The status of the agent that the version belongs to.
Type: String
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING`
Required: Yes
** createdAt **
The time at which the version was created.
Type: Timestamp
Required: Yes
** idleSessionTTLInSeconds **
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: Yes
** updatedAt **
The time at which the version was last updated.
Type: Timestamp
Required: Yes
** version **
The version number.
Type: String
Pattern: `[0-9]{1,5}`
Required: Yes
** agentCollaboration **
The agent's collaboration settings.
Type: String
Valid Values: `SUPERVISOR | SUPERVISOR_ROUTER | DISABLED`
Required: No
** customerEncryptionKeyArn **
The Amazon Resource Name (ARN) of the AWS KMS key that encrypts 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
** description **
The description of the version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** failureReasons **
A list of reasons that the API operation on the version failed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** foundationModel **
The foundation model that the version invokes.
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 **
Details about the guardrail associated with the agent.
Type: [GuardrailConfiguration](API_agent_GuardrailConfiguration.md) object
Required: No
** instruction **
The instructions provided to the agent.
Type: String
Length Constraints: Minimum length of 40. Maximum length of 4000.
Required: No
** memoryConfiguration **
Contains details of the memory configuration on the version of the agent.
Type: [MemoryConfiguration](API_agent_MemoryConfiguration.md) object
Required: No
** promptOverrideConfiguration **
Contains configurations to override prompt templates 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
** recommendedActions **
A list of recommended actions to take for the failed API operation on the version to succeed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentVersion)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentVersion)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentVersion)
# AgentVersionSummary
Contains details about a version of an agent.
## Contents
** agentName **
The name of the agent to which the version belongs.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** agentStatus **
The status of the agent to which the version belongs.
Type: String
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING`
Required: Yes
** agentVersion **
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})`
Required: Yes
** createdAt **
The time at which the version was created.
Type: Timestamp
Required: Yes
** updatedAt **
The time at which the version was last updated.
Type: Timestamp
Required: Yes
** description **
The description of the version of the agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** guardrailConfiguration **
Details about the guardrail associated with the agent.
Type: [GuardrailConfiguration](API_agent_GuardrailConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AgentVersionSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AgentVersionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AgentVersionSummary)
# AnyToolChoice
Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AnyToolChoice)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AnyToolChoice)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AnyToolChoice)
# APISchema
Contains details about the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). You can either include the schema directly in the `payload` field or you can upload it to an S3 bucket and specify the S3 bucket location in the `s3` field.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** payload **
The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html).
Type: String
Required: No
** s3 **
Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html).
Type: [S3Identifier](API_agent_S3Identifier.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/APISchema)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/APISchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/APISchema)
# AudioConfiguration
Configuration settings for processing audio content in multimodal knowledge bases.
## Contents
** segmentationConfiguration **
Configuration for segmenting audio content during processing.
Type: [AudioSegmentationConfiguration](API_agent_AudioSegmentationConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AudioConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AudioConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AudioConfiguration)
# AudioSegmentationConfiguration
Configuration for segmenting audio content during multimodal knowledge base ingestion. Determines how audio files are divided into chunks for processing.
## Contents
** fixedLengthDuration **
The duration in seconds for each audio segment. Audio files will be divided into chunks of this length for processing.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 30.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AudioSegmentationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AudioSegmentationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AudioSegmentationConfiguration)
# AutoToolChoice
Defines tools. The model automatically decides whether to call a tool or to generate text instead. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/AutoToolChoice)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/AutoToolChoice)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/AutoToolChoice)
# BedrockDataAutomationConfiguration
Contains configurations for using Amazon Bedrock Data Automation as the parser for ingesting your data sources.
## Contents
** parsingModality **
Specifies whether to enable parsing of multimodal data, including both text and/or images.
Type: String
Valid Values: `MULTIMODAL`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/BedrockDataAutomationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/BedrockDataAutomationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/BedrockDataAutomationConfiguration)
# BedrockEmbeddingModelConfiguration
The vector configuration details for the Bedrock embeddings model.
## Contents
** audio **
Configuration settings for processing audio content in multimodal knowledge bases.
Type: Array of [AudioConfiguration](API_agent_AudioConfiguration.md) objects
Array Members: Fixed number of 1 item.
Required: No
** dimensions **
The dimensions details for the vector configuration used on the Bedrock embeddings model.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 4096.
Required: No
** embeddingDataType **
The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See [Supported embeddings models](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html) for information on the available models and their vector data types.
Type: String
Valid Values: `FLOAT32 | BINARY`
Required: No
** video **
Configuration settings for processing video content in multimodal knowledge bases.
Type: Array of [VideoConfiguration](API_agent_VideoConfiguration.md) objects
Array Members: Fixed number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/BedrockEmbeddingModelConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/BedrockEmbeddingModelConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/BedrockEmbeddingModelConfiguration)
# BedrockFoundationModelConfiguration
Settings for a foundation model used to parse documents for a data source.
## Contents
** modelArn **
The ARN of the foundation model to use for parsing.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]{1,12})?:(bedrock):[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
** parsingModality **
Specifies whether to enable parsing of multimodal data, including both text and/or images.
Type: String
Valid Values: `MULTIMODAL`
Required: No
** parsingPrompt **
Instructions for interpreting the contents of a document.
Type: [ParsingPrompt](API_agent_ParsingPrompt.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/BedrockFoundationModelConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/BedrockFoundationModelConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/BedrockFoundationModelConfiguration)
# BedrockFoundationModelContextEnrichmentConfiguration
Context enrichment configuration is used to provide additional context to the RAG application using Amazon Bedrock foundation models.
## Contents
** enrichmentStrategyConfiguration **
The enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses Amazon Bedrock foundation models to perform chunk entity extraction.
Type: [EnrichmentStrategyConfiguration](API_agent_EnrichmentStrategyConfiguration.md) object
Required: Yes
** modelArn **
The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]{1,12})?:(bedrock):[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
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/BedrockFoundationModelContextEnrichmentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/BedrockFoundationModelContextEnrichmentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/BedrockFoundationModelContextEnrichmentConfiguration)
# ByteContentDoc
Contains information about content defined inline in bytes.
## Contents
** data **
The base64-encoded string of the content.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 5242880.
Required: Yes
** mimeType **
The MIME type of the content. For a list of MIME types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). The following MIME types are supported:
+ text/plain
+ text/html
+ text/csv
+ text/vtt
+ message/rfc822
+ application/xhtml\$1xml
+ application/pdf
+ application/msword
+ application/vnd.ms-word.document.macroenabled.12
+ application/vnd.ms-word.template.macroenabled.12
+ application/vnd.ms-excel
+ application/vnd.ms-excel.addin.macroenabled.12
+ application/vnd.ms-excel.sheet.macroenabled.12
+ application/vnd.ms-excel.template.macroenabled.12
+ application/vnd.ms-excel.sheet.binary.macroenabled.12
+ application/vnd.ms-spreadsheetml
+ application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+ application/vnd.openxmlformats-officedocument.spreadsheetml.template
+ application/vnd.openxmlformats-officedocument.wordprocessingml.document
+ application/vnd.openxmlformats-officedocument.wordprocessingml.template
Type: String
Pattern: `.*[a-z]{1,20}/.{1,20}.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ByteContentDoc)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ByteContentDoc)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ByteContentDoc)
# CachePointBlock
Indicates where a cache checkpoint is located. All information before this checkpoint is cached to be accessed on subsequent requests.
## Contents
** type **
Indicates that the CachePointBlock is of the default type
Type: String
Valid Values: `default`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CachePointBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CachePointBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CachePointBlock)
# ChatPromptTemplateConfiguration
Contains configurations to use a prompt in a conversational format. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).
## Contents
** messages **
Contains messages in the chat for the prompt.
Type: Array of [Message](API_agent_Message.md) objects
Required: Yes
** inputVariables **
An array of the variables in the prompt template.
Type: Array of [PromptInputVariable](API_agent_PromptInputVariable.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
** system **
Contains system prompts to provide context to the model or to describe how it should behave.
Type: Array of [SystemContentBlock](API_agent_SystemContentBlock.md) objects
Required: No
** toolConfiguration **
Configuration information for the tools that the model can use when generating a response.
Type: [ToolConfiguration](API_agent_ToolConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ChatPromptTemplateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ChatPromptTemplateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ChatPromptTemplateConfiguration)
# ChunkingConfiguration
Details about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
## Contents
** chunkingStrategy **
Knowledge base can split your source data into chunks. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for `NONE`, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk.
+ `FIXED_SIZE` – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the `fixedSizeChunkingConfiguration`.
+ `HIERARCHICAL` – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
+ `SEMANTIC` – Split documents into chunks based on groups of similar content derived with natural language processing.
+ `NONE` – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
Type: String
Valid Values: `FIXED_SIZE | NONE | HIERARCHICAL | SEMANTIC`
Required: Yes
** fixedSizeChunkingConfiguration **
Configurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE`, exclude this field.
Type: [FixedSizeChunkingConfiguration](API_agent_FixedSizeChunkingConfiguration.md) object
Required: No
** hierarchicalChunkingConfiguration **
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
Type: [HierarchicalChunkingConfiguration](API_agent_HierarchicalChunkingConfiguration.md) object
Required: No
** semanticChunkingConfiguration **
Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.
Type: [SemanticChunkingConfiguration](API_agent_SemanticChunkingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ChunkingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ChunkingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ChunkingConfiguration)
# CollectorFlowNodeConfiguration
Defines a collector node in your flow. This node takes an iteration of inputs and consolidates them into an array in the output. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CollectorFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CollectorFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CollectorFlowNodeConfiguration)
# ConditionFlowNodeConfiguration
Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.
## Contents
** conditions **
An array of conditions. Each member contains the name of a condition and an expression that defines the condition.
Type: Array of [FlowCondition](API_agent_FlowCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ConditionFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ConditionFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ConditionFlowNodeConfiguration)
# ConfluenceCrawlerConfiguration
The configuration of the Confluence content. For example, configuring specific types of Confluence content.
## Contents
** filterConfiguration **
The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content.
Type: [CrawlFilterConfiguration](API_agent_CrawlFilterConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ConfluenceCrawlerConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ConfluenceCrawlerConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ConfluenceCrawlerConfiguration)
# ConfluenceDataSourceConfiguration
The configuration information to connect to Confluence as your data source.
## Contents
** sourceConfiguration **
The endpoint information to connect to your Confluence data source.
Type: [ConfluenceSourceConfiguration](API_agent_ConfluenceSourceConfiguration.md) object
Required: Yes
** crawlerConfiguration **
The configuration of the Confluence content. For example, configuring specific types of Confluence content.
Type: [ConfluenceCrawlerConfiguration](API_agent_ConfluenceCrawlerConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ConfluenceDataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ConfluenceDataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ConfluenceDataSourceConfiguration)
# ConfluenceSourceConfiguration
The endpoint information to connect to your Confluence data source.
## Contents
** authType **
The supported authentication type to authenticate and connect to your Confluence instance.
Type: String
Valid Values: `BASIC | OAUTH2_CLIENT_CREDENTIALS`
Required: Yes
** credentialsSecretArn **
The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see [Confluence connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector).
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: Yes
** hostType **
The supported host type, whether online/cloud or server/on-premises.
Type: String
Valid Values: `SAAS`
Required: Yes
** hostUrl **
The Confluence host URL or instance URL.
Type: String
Pattern: `https://[A-Za-z0-9][^\s]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ConfluenceSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ConfluenceSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ConfluenceSourceConfiguration)
# ContentBlock
Contains the content for the message you pass to, or receive from a model. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** cachePoint **
Creates a cache checkpoint within a message.
Type: [CachePointBlock](API_agent_CachePointBlock.md) object
Required: No
** text **
The text in the message.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ContentBlock)
# ContextEnrichmentConfiguration
Context enrichment configuration is used to provide additional context to the RAG application.
## Contents
** type **
The method used for context enrichment. It must be Amazon Bedrock foundation models.
Type: String
Valid Values: `BEDROCK_FOUNDATION_MODEL`
Required: Yes
** bedrockFoundationModelConfiguration **
The configuration of the Amazon Bedrock foundation model used for context enrichment.
Type: [BedrockFoundationModelContextEnrichmentConfiguration](API_agent_BedrockFoundationModelContextEnrichmentConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ContextEnrichmentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ContextEnrichmentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ContextEnrichmentConfiguration)
# CrawlFilterConfiguration
The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content.
## Contents
** type **
The type of filtering that you want to apply to certain objects or content of the data source. For example, the `PATTERN` type is regular expression patterns you can apply to filter your content.
Type: String
Valid Values: `PATTERN`
Required: Yes
** patternObjectFilter **
The configuration of filtering certain objects or content types of the data source.
Type: [PatternObjectFilterConfiguration](API_agent_PatternObjectFilterConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CrawlFilterConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CrawlFilterConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CrawlFilterConfiguration)
# CuratedQuery
Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
## Contents
** naturalLanguage **
An example natural language query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
** sql **
The SQL equivalent of the natural language query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CuratedQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CuratedQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CuratedQuery)
# CustomContent
Contains information about the content to ingest into a knowledge base connected to a custom data source. Choose a `sourceType` and include the field that corresponds to it.
## Contents
** customDocumentIdentifier **
A unique identifier for the document.
Type: [CustomDocumentIdentifier](API_agent_CustomDocumentIdentifier.md) object
Required: Yes
** sourceType **
The source of the data to ingest.
Type: String
Valid Values: `IN_LINE | S3_LOCATION`
Required: Yes
** inlineContent **
Contains information about content defined inline to ingest into a knowledge base.
Type: [InlineContent](API_agent_InlineContent.md) object
Required: No
** s3Location **
Contains information about the Amazon S3 location of the file from which to ingest data.
Type: [CustomS3Location](API_agent_CustomS3Location.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CustomContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CustomContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CustomContent)
# CustomDocumentIdentifier
Contains information about the identifier of the document to ingest into a custom data source.
## Contents
** id **
The identifier of the document to ingest into a custom data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CustomDocumentIdentifier)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CustomDocumentIdentifier)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CustomDocumentIdentifier)
# CustomOrchestration
Details of custom orchestration.
## Contents
** executor **
The structure of the executor invoking the actions in custom orchestration.
Type: [OrchestrationExecutor](API_agent_OrchestrationExecutor.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CustomOrchestration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CustomOrchestration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CustomOrchestration)
# CustomS3Location
Contains information about the Amazon S3 location of the file containing the content to ingest into a knowledge base connected to a custom data source.
## Contents
** uri **
The S3 URI of the file containing the content to ingest.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}`
Required: Yes
** bucketOwnerAccountId **
The identifier of the AWS account that owns the S3 bucket containing the content to ingest.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `[0-9]{12}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CustomS3Location)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CustomS3Location)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CustomS3Location)
# CustomTransformationConfiguration
Settings for customizing steps in the data source content ingestion pipeline.
You can configure the data source to process documents with a Lambda function after they are parsed and converted into chunks. When you add a post-chunking transformation, the service stores chunked documents in an S3 bucket and invokes a Lambda function to process them.
To process chunked documents with a Lambda function, define an S3 bucket path for input and output objects, and a transformation that specifies the Lambda function to invoke. You can use the Lambda function to customize how chunks are split, and the metadata for each chunk.
## Contents
** intermediateStorage **
An S3 bucket path for input and output objects.
Type: [IntermediateStorage](API_agent_IntermediateStorage.md) object
Required: Yes
** transformations **
A Lambda function that processes documents.
Type: Array of [Transformation](API_agent_Transformation.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CustomTransformationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CustomTransformationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CustomTransformationConfiguration)
# CyclicConnectionFlowValidationDetails
Details about a cyclic connection detected in the flow.
## Contents
** connection **
The name of the connection that causes the cycle in the flow.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/CyclicConnectionFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/CyclicConnectionFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/CyclicConnectionFlowValidationDetails)
# DataSource
Contains details about a data source.
## Contents
** createdAt **
The time at which the data source was created.
Type: Timestamp
Required: Yes
** dataSourceConfiguration **
The connection configuration for the data source.
Type: [DataSourceConfiguration](API_agent_DataSourceConfiguration.md) object
Required: Yes
** dataSourceId **
The unique identifier of the data source.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** knowledgeBaseId **
The unique identifier of the knowledge base to which the data source belongs.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** name **
The name of the data source.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** status **
The status of the data source. The following statuses are possible:
+ Available – The data source has been created and is ready for ingestion into the knowledge base.
+ Deleting – The data source is being deleted.
Type: String
Valid Values: `AVAILABLE | DELETING | DELETE_UNSUCCESSFUL`
Required: Yes
** updatedAt **
The time at which the data source was last updated.
Type: Timestamp
Required: Yes
** dataDeletionPolicy **
The data deletion policy for the data source.
Type: String
Valid Values: `RETAIN | DELETE`
Required: No
** description **
The description of the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** failureReasons **
The detailed reasons on the failure to delete a data source.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** serverSideEncryptionConfiguration **
Contains details about the configuration of the server-side encryption.
Type: [ServerSideEncryptionConfiguration](API_agent_ServerSideEncryptionConfiguration.md) object
Required: No
** vectorIngestionConfiguration **
Contains details about how to ingest the documents in the data source.
Type: [VectorIngestionConfiguration](API_agent_VectorIngestionConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DataSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DataSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DataSource)
# DataSourceConfiguration
The connection configuration for the data source.
## Contents
** type **
The type of data source.
Type: String
Valid Values: `S3 | WEB | CONFLUENCE | SALESFORCE | SHAREPOINT | CUSTOM | REDSHIFT_METADATA`
Required: Yes
** confluenceConfiguration **
The configuration information to connect to Confluence as your data source.
Confluence data source connector is in preview release and is subject to change.
Type: [ConfluenceDataSourceConfiguration](API_agent_ConfluenceDataSourceConfiguration.md) object
Required: No
** s3Configuration **
The configuration information to connect to Amazon S3 as your data source.
Type: [S3DataSourceConfiguration](API_agent_S3DataSourceConfiguration.md) object
Required: No
** salesforceConfiguration **
The configuration information to connect to Salesforce as your data source.
Salesforce data source connector is in preview release and is subject to change.
Type: [SalesforceDataSourceConfiguration](API_agent_SalesforceDataSourceConfiguration.md) object
Required: No
** sharePointConfiguration **
The configuration information to connect to SharePoint as your data source.
SharePoint data source connector is in preview release and is subject to change.
Type: [SharePointDataSourceConfiguration](API_agent_SharePointDataSourceConfiguration.md) object
Required: No
** webConfiguration **
The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs.
Crawling web URLs as your data source is in preview release and is subject to change.
Type: [WebDataSourceConfiguration](API_agent_WebDataSourceConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DataSourceConfiguration)
# DataSourceSummary
Contains details about a data source.
## Contents
** dataSourceId **
The unique identifier of the data source.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** knowledgeBaseId **
The unique identifier of the knowledge base to which the data source belongs.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** name **
The name of the data source.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** status **
The status of the data source.
Type: String
Valid Values: `AVAILABLE | DELETING | DELETE_UNSUCCESSFUL`
Required: Yes
** updatedAt **
The time at which the data source was last updated.
Type: Timestamp
Required: Yes
** description **
The description of the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DataSourceSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DataSourceSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DataSourceSummary)
# DocumentContent
Contains information about the content of a document. Choose a `dataSourceType` and include the field that corresponds to it.
## Contents
** dataSourceType **
The type of data source that is connected to the knowledge base to which to ingest this document.
Type: String
Valid Values: `CUSTOM | S3`
Required: Yes
** custom **
Contains information about the content to ingest into a knowledge base connected to a custom data source.
Type: [CustomContent](API_agent_CustomContent.md) object
Required: No
** s3 **
Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source
Type: [S3Content](API_agent_S3Content.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DocumentContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DocumentContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DocumentContent)
# DocumentIdentifier
Contains information that identifies the document.
## Contents
** dataSourceType **
The type of data source connected to the knowledge base that contains the document.
Type: String
Valid Values: `CUSTOM | S3`
Required: Yes
** custom **
Contains information that identifies the document in a custom data source.
Type: [CustomDocumentIdentifier](API_agent_CustomDocumentIdentifier.md) object
Required: No
** s3 **
Contains information that identifies the document in an S3 data source.
Type: [S3Location](API_agent_S3Location.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DocumentIdentifier)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DocumentIdentifier)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DocumentIdentifier)
# DocumentMetadata
Contains information about the metadata associate with the content to ingest into a knowledge base. Choose a `type` and include the field that corresponds to it.
## Contents
** type **
The type of the source source from which to add metadata.
Type: String
Valid Values: `IN_LINE_ATTRIBUTE | S3_LOCATION`
Required: Yes
** inlineAttributes **
An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.
Type: Array of [MetadataAttribute](API_agent_MetadataAttribute.md) objects
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Required: No
** s3Location **
The Amazon S3 location of the file containing metadata to associate with the content to ingest.
Type: [CustomS3Location](API_agent_CustomS3Location.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DocumentMetadata)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DocumentMetadata)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DocumentMetadata)
# DuplicateConditionExpressionFlowValidationDetails
Details about duplicate condition expressions found in a condition node.
## Contents
** expression **
The duplicated condition expression.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
** node **
The name of the node containing the duplicate condition expressions.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DuplicateConditionExpressionFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DuplicateConditionExpressionFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DuplicateConditionExpressionFlowValidationDetails)
# DuplicateConnectionsFlowValidationDetails
Details about duplicate connections found between two nodes in the flow.
## Contents
** source **
The name of the source node where the duplicate connection starts.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** target **
The name of the target node where the duplicate connection ends.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/DuplicateConnectionsFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/DuplicateConnectionsFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/DuplicateConnectionsFlowValidationDetails)
# EmbeddingModelConfiguration
The configuration details for the embeddings model.
## Contents
** bedrockEmbeddingModelConfiguration **
The vector configuration details on the Bedrock embeddings model.
Type: [BedrockEmbeddingModelConfiguration](API_agent_BedrockEmbeddingModelConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/EmbeddingModelConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/EmbeddingModelConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/EmbeddingModelConfiguration)
# EnrichmentStrategyConfiguration
The strategy used for performing context enrichment.
## Contents
** method **
The method used for the context enrichment strategy.
Type: String
Valid Values: `CHUNK_ENTITY_EXTRACTION`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/EnrichmentStrategyConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/EnrichmentStrategyConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/EnrichmentStrategyConfiguration)
# FieldForReranking
Specifies a metadata field to include or exclude during the reranking process.
## Contents
** fieldName **
The name of the metadata field to include or exclude during reranking.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FieldForReranking)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FieldForReranking)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FieldForReranking)
# FixedSizeChunkingConfiguration
Configurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE`, exclude this field.
## Contents
** maxTokens **
The maximum number of tokens to include in a chunk.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
** overlapPercentage **
The percentage of overlap between adjacent chunks of a data source.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 99.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FixedSizeChunkingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FixedSizeChunkingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FixedSizeChunkingConfiguration)
# FlowAliasConcurrencyConfiguration
Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance.
## Contents
** type **
The type of concurrency to use for parallel node execution. Specify one of the following options:
+ `Automatic` - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies.
+ `Manual` - You specify which nodes can be executed in parallel.
Type: String
Valid Values: `Automatic | Manual`
Required: Yes
** maxConcurrency **
The maximum number of nodes that can be executed concurrently in the flow.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowAliasConcurrencyConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowAliasConcurrencyConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowAliasConcurrencyConfiguration)
# FlowAliasRoutingConfigurationListItem
Contains information about a version that the alias maps to.
## Contents
** flowVersion **
The version that the alias maps to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowAliasRoutingConfigurationListItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowAliasRoutingConfigurationListItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowAliasRoutingConfigurationListItem)
# FlowAliasSummary
Contains information about an alias of a flow.
This data type is used in the following API operations:
+ [ListFlowAliases response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListFlowAliases.html#API_agent_ListFlowAliases_ResponseSyntax)
## Contents
** arn **
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})`
Required: Yes
** createdAt **
The time at which the alias was created.
Type: Timestamp
Required: Yes
** flowId **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** id **
The unique identifier of the alias of the flow.
Type: String
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})`
Required: Yes
** name **
The name of the alias.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** routingConfiguration **
A list of configurations about the versions that the alias maps to. Currently, you can only specify one.
Type: Array of [FlowAliasRoutingConfigurationListItem](API_agent_FlowAliasRoutingConfigurationListItem.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** updatedAt **
The time at which the alias was last updated.
Type: Timestamp
Required: Yes
** concurrencyConfiguration **
The configuration that specifies how nodes in the flow are executed concurrently.
Type: [FlowAliasConcurrencyConfiguration](API_agent_FlowAliasConcurrencyConfiguration.md) object
Required: No
** description **
A description of the alias.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowAliasSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowAliasSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowAliasSummary)
# FlowCondition
Defines a condition in the condition node.
## Contents
** name **
A name for the condition that you can reference.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** expression **
Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowCondition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowCondition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowCondition)
# FlowConditionalConnectionConfiguration
The configuration of a connection between a condition node and another node.
## Contents
** condition **
The condition that triggers this connection. For more information about how to write conditions, see the **Condition** node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowConditionalConnectionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowConditionalConnectionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowConditionalConnectionConfiguration)
# FlowConnection
Contains information about a connection between two nodes in the flow.
## Contents
** name **
A name for the connection that you can reference.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
** source **
The node that the connection starts at.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** target **
The node that the connection ends at.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** type **
Whether the source node that the connection begins from is a condition node (`Conditional`) or not (`Data`).
Type: String
Valid Values: `Data | Conditional`
Required: Yes
** configuration **
The configuration of the connection.
Type: [FlowConnectionConfiguration](API_agent_FlowConnectionConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowConnection)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowConnection)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowConnection)
# FlowConnectionConfiguration
The configuration of the connection.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** conditional **
The configuration of a connection originating from a Condition node.
Type: [FlowConditionalConnectionConfiguration](API_agent_FlowConditionalConnectionConfiguration.md) object
Required: No
** data **
The configuration of a connection originating from a node that isn't a Condition node.
Type: [FlowDataConnectionConfiguration](API_agent_FlowDataConnectionConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowConnectionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowConnectionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowConnectionConfiguration)
# FlowDataConnectionConfiguration
The configuration of a connection originating from a node that isn't a Condition node.
## Contents
** sourceOutput **
The name of the output in the source node that the connection begins from.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** targetInput **
The name of the input in the target node that the connection ends at.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowDataConnectionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowDataConnectionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowDataConnectionConfiguration)
# FlowDefinition
The definition of the nodes and connections between nodes in the flow.
## Contents
** connections **
An array of connection definitions in the flow.
Type: Array of [FlowConnection](API_agent_FlowConnection.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
** nodes **
An array of node definitions in the flow.
Type: Array of [FlowNode](API_agent_FlowNode.md) objects
Array Members: Minimum number of 0 items. Maximum number of 40 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowDefinition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowDefinition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowDefinition)
# FlowNode
Contains configurations about a node in the flow.
## Contents
** name **
A name for the node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** type **
The type of node. This value must match the name of the key that you provide in the configuration you provide in the `FlowNodeConfiguration` field.
Type: String
Valid Values: `Input | Output | KnowledgeBase | Condition | Lex | Prompt | LambdaFunction | Storage | Agent | Retrieval | Iterator | Collector | InlineCode | Loop | LoopInput | LoopController`
Required: Yes
** configuration **
Contains configurations for the node.
Type: [FlowNodeConfiguration](API_agent_FlowNodeConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** inputs **
An array of objects, each of which contains information about an input into the node.
Type: Array of [FlowNodeInput](API_agent_FlowNodeInput.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
** outputs **
A list of objects, each of which contains information about an output from the node.
Type: Array of [FlowNodeOutput](API_agent_FlowNodeOutput.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowNode)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowNode)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowNode)
# FlowNodeConfiguration
Contains configurations for a node in your flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** agent **
Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response.
Type: [AgentFlowNodeConfiguration](API_agent_AgentFlowNodeConfiguration.md) object
Required: No
** collector **
Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs.
Type: [CollectorFlowNodeConfiguration](API_agent_CollectorFlowNodeConfiguration.md) object
Required: No
** condition **
Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow.
Type: [ConditionFlowNodeConfiguration](API_agent_ConditionFlowNodeConfiguration.md) object
Required: No
** inlineCode **
Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
Type: [InlineCodeFlowNodeConfiguration](API_agent_InlineCodeFlowNodeConfiguration.md) object
Required: No
** input **
Contains configurations for an input flow node in your flow. The first node in the flow. `inputs` can't be specified for this node.
Type: [InputFlowNodeConfiguration](API_agent_InputFlowNodeConfiguration.md) object
Required: No
** iterator **
Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
Type: [IteratorFlowNodeConfiguration](API_agent_IteratorFlowNodeConfiguration.md) object
Required: No
** knowledgeBase **
Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response.
Type: [KnowledgeBaseFlowNodeConfiguration](API_agent_KnowledgeBaseFlowNodeConfiguration.md) object
Required: No
** lambdaFunction **
Contains configurations for a Lambda function node in your flow. Invokes an AWS Lambda function.
Type: [LambdaFunctionFlowNodeConfiguration](API_agent_LambdaFunctionFlowNodeConfiguration.md) object
Required: No
** lex **
Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output.
Type: [LexFlowNodeConfiguration](API_agent_LexFlowNodeConfiguration.md) object
Required: No
** loop **
Contains configurations for a DoWhile loop in your flow.
Type: [LoopFlowNodeConfiguration](API_agent_LoopFlowNodeConfiguration.md) object
Required: No
** loopController **
Contains controller node configurations for a DoWhile loop in your flow.
Type: [LoopControllerFlowNodeConfiguration](API_agent_LoopControllerFlowNodeConfiguration.md) object
Required: No
** loopInput **
Contains input node configurations for a DoWhile loop in your flow.
Type: [LoopInputFlowNodeConfiguration](API_agent_LoopInputFlowNodeConfiguration.md) object
Required: No
** output **
Contains configurations for an output flow node in your flow. The last node in the flow. `outputs` can't be specified for this node.
Type: [OutputFlowNodeConfiguration](API_agent_OutputFlowNodeConfiguration.md) object
Required: No
** prompt **
Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node.
Type: [PromptFlowNodeConfiguration](API_agent_PromptFlowNodeConfiguration.md) object
Required: No
** retrieval **
Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output.
Type: [RetrievalFlowNodeConfiguration](API_agent_RetrievalFlowNodeConfiguration.md) object
Required: No
** storage **
Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location.
Type: [StorageFlowNodeConfiguration](API_agent_StorageFlowNodeConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowNodeConfiguration)
# FlowNodeInput
Contains configurations for an input in an Amazon Bedrock Flows node.
## Contents
** expression **
An expression that formats the input for the node. For an explanation of how to create expressions, see [Expressions in Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
** name **
Specifies a name for the input that you can reference.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** type **
Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown.
Type: String
Valid Values: `String | Number | Boolean | Object | Array`
Required: Yes
** category **
Specifies how input data flows between iterations in a DoWhile loop.
+ `LoopCondition` - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue.
+ `ReturnValueToLoopStart` - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration.
+ `ExitLoop` - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop.
Type: String
Valid Values: `LoopCondition | ReturnValueToLoopStart | ExitLoop`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowNodeInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowNodeInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowNodeInput)
# FlowNodeOutput
Contains configurations for an output from a node.
## Contents
** name **
A name for the output that you can reference.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** type **
The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown.
Type: String
Valid Values: `String | Number | Boolean | Object | Array`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowNodeOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowNodeOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowNodeOutput)
# FlowSummary
Contains the definition of a flow.
## Contents
** arn **
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}`
Required: Yes
** createdAt **
The time at which the flow was created.
Type: Timestamp
Required: Yes
** id **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** name **
The name of the flow.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** status **
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`
Required: Yes
** updatedAt **
The time at which the flow was last updated.
Type: Timestamp
Required: Yes
** version **
The latest version of the flow.
Type: String
Length Constraints: Fixed length of 5.
Pattern: `DRAFT`
Required: Yes
** description **
A description of the flow.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowSummary)
# FlowValidation
Contains information about validation of the flow.
This data type is used in the following API operations:
+ [GetFlow response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html#API_agent_GetFlow_ResponseSyntax)
+ [GetFlowVersion response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax)
## Contents
** message **
A message describing the validation error.
Type: String
Pattern: `[\s\S]+`
Required: Yes
** severity **
The severity of the issue described in the message.
Type: String
Valid Values: `Warning | Error`
Required: Yes
** details **
Specific details about the validation issue encountered in the flow.
Type: [FlowValidationDetails](API_agent_FlowValidationDetails.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** type **
The type of validation issue encountered in the flow.
Type: String
Valid Values: `CyclicConnection | DuplicateConnections | DuplicateConditionExpression | UnreachableNode | UnknownConnectionSource | UnknownConnectionSourceOutput | UnknownConnectionTarget | UnknownConnectionTargetInput | UnknownConnectionCondition | MalformedConditionExpression | MalformedNodeInputExpression | MismatchedNodeInputType | MismatchedNodeOutputType | IncompatibleConnectionDataType | MissingConnectionConfiguration | MissingDefaultCondition | MissingEndingNodes | MissingNodeConfiguration | MissingNodeInput | MissingNodeOutput | MissingStartingNodes | MultipleNodeInputConnections | UnfulfilledNodeInput | UnsatisfiedConnectionConditions | Unspecified | UnknownNodeInput | UnknownNodeOutput | MissingLoopInputNode | MissingLoopControllerNode | MultipleLoopInputNodes | MultipleLoopControllerNodes | LoopIncompatibleNodeType | InvalidLoopBoundary`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowValidation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowValidation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowValidation)
# FlowValidationDetails
A union type containing various possible validation issues in the flow.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** cyclicConnection **
Details about a cyclic connection in the flow.
Type: [CyclicConnectionFlowValidationDetails](API_agent_CyclicConnectionFlowValidationDetails.md) object
Required: No
** duplicateConditionExpression **
Details about duplicate condition expressions in a node.
Type: [DuplicateConditionExpressionFlowValidationDetails](API_agent_DuplicateConditionExpressionFlowValidationDetails.md) object
Required: No
** duplicateConnections **
Details about duplicate connections between nodes.
Type: [DuplicateConnectionsFlowValidationDetails](API_agent_DuplicateConnectionsFlowValidationDetails.md) object
Required: No
** incompatibleConnectionDataType **
Details about incompatible data types in a connection.
Type: [IncompatibleConnectionDataTypeFlowValidationDetails](API_agent_IncompatibleConnectionDataTypeFlowValidationDetails.md) object
Required: No
** invalidLoopBoundary **
Details about a flow that includes connections that violate loop boundary rules.
Type: [InvalidLoopBoundaryFlowValidationDetails](API_agent_InvalidLoopBoundaryFlowValidationDetails.md) object
Required: No
** loopIncompatibleNodeType **
Details about a flow that includes incompatible node types in a DoWhile loop.
Type: [LoopIncompatibleNodeTypeFlowValidationDetails](API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.md) object
Required: No
** malformedConditionExpression **
Details about a malformed condition expression in a node.
Type: [MalformedConditionExpressionFlowValidationDetails](API_agent_MalformedConditionExpressionFlowValidationDetails.md) object
Required: No
** malformedNodeInputExpression **
Details about a malformed input expression in a node.
Type: [MalformedNodeInputExpressionFlowValidationDetails](API_agent_MalformedNodeInputExpressionFlowValidationDetails.md) object
Required: No
** mismatchedNodeInputType **
Details about mismatched input data types in a node.
Type: [MismatchedNodeInputTypeFlowValidationDetails](API_agent_MismatchedNodeInputTypeFlowValidationDetails.md) object
Required: No
** mismatchedNodeOutputType **
Details about mismatched output data types in a node.
Type: [MismatchedNodeOutputTypeFlowValidationDetails](API_agent_MismatchedNodeOutputTypeFlowValidationDetails.md) object
Required: No
** missingConnectionConfiguration **
Details about missing configuration for a connection.
Type: [MissingConnectionConfigurationFlowValidationDetails](API_agent_MissingConnectionConfigurationFlowValidationDetails.md) object
Required: No
** missingDefaultCondition **
Details about a missing default condition in a conditional node.
Type: [MissingDefaultConditionFlowValidationDetails](API_agent_MissingDefaultConditionFlowValidationDetails.md) object
Required: No
** missingEndingNodes **
Details about missing ending nodes in the flow.
Type: [MissingEndingNodesFlowValidationDetails](API_agent_MissingEndingNodesFlowValidationDetails.md) object
Required: No
** missingLoopControllerNode **
Details about a flow that's missing a required `LoopController` node in a DoWhile loop.
Type: [MissingLoopControllerNodeFlowValidationDetails](API_agent_MissingLoopControllerNodeFlowValidationDetails.md) object
Required: No
** missingLoopInputNode **
Details about a flow that's missing a required `LoopInput` node in a DoWhile loop.
Type: [MissingLoopInputNodeFlowValidationDetails](API_agent_MissingLoopInputNodeFlowValidationDetails.md) object
Required: No
** missingNodeConfiguration **
Details about missing configuration for a node.
Type: [MissingNodeConfigurationFlowValidationDetails](API_agent_MissingNodeConfigurationFlowValidationDetails.md) object
Required: No
** missingNodeInput **
Details about a missing required input in a node.
Type: [MissingNodeInputFlowValidationDetails](API_agent_MissingNodeInputFlowValidationDetails.md) object
Required: No
** missingNodeOutput **
Details about a missing required output in a node.
Type: [MissingNodeOutputFlowValidationDetails](API_agent_MissingNodeOutputFlowValidationDetails.md) object
Required: No
** missingStartingNodes **
Details about missing starting nodes in the flow.
Type: [MissingStartingNodesFlowValidationDetails](API_agent_MissingStartingNodesFlowValidationDetails.md) object
Required: No
** multipleLoopControllerNodes **
Details about a flow that contains multiple `LoopController` nodes in a DoWhile loop.
Type: [MultipleLoopControllerNodesFlowValidationDetails](API_agent_MultipleLoopControllerNodesFlowValidationDetails.md) object
Required: No
** multipleLoopInputNodes **
Details about a flow that contains multiple `LoopInput` nodes in a DoWhile loop.
Type: [MultipleLoopInputNodesFlowValidationDetails](API_agent_MultipleLoopInputNodesFlowValidationDetails.md) object
Required: No
** multipleNodeInputConnections **
Details about multiple connections to a single node input.
Type: [MultipleNodeInputConnectionsFlowValidationDetails](API_agent_MultipleNodeInputConnectionsFlowValidationDetails.md) object
Required: No
** unfulfilledNodeInput **
Details about an unfulfilled node input with no valid connections.
Type: [UnfulfilledNodeInputFlowValidationDetails](API_agent_UnfulfilledNodeInputFlowValidationDetails.md) object
Required: No
** unknownConnectionCondition **
Details about an unknown condition for a connection.
Type: [UnknownConnectionConditionFlowValidationDetails](API_agent_UnknownConnectionConditionFlowValidationDetails.md) object
Required: No
** unknownConnectionSource **
Details about an unknown source node for a connection.
Type: [UnknownConnectionSourceFlowValidationDetails](API_agent_UnknownConnectionSourceFlowValidationDetails.md) object
Required: No
** unknownConnectionSourceOutput **
Details about an unknown source output for a connection.
Type: [UnknownConnectionSourceOutputFlowValidationDetails](API_agent_UnknownConnectionSourceOutputFlowValidationDetails.md) object
Required: No
** unknownConnectionTarget **
Details about an unknown target node for a connection.
Type: [UnknownConnectionTargetFlowValidationDetails](API_agent_UnknownConnectionTargetFlowValidationDetails.md) object
Required: No
** unknownConnectionTargetInput **
Details about an unknown target input for a connection.
Type: [UnknownConnectionTargetInputFlowValidationDetails](API_agent_UnknownConnectionTargetInputFlowValidationDetails.md) object
Required: No
** unknownNodeInput **
Details about an unknown input for a node.
Type: [UnknownNodeInputFlowValidationDetails](API_agent_UnknownNodeInputFlowValidationDetails.md) object
Required: No
** unknownNodeOutput **
Details about an unknown output for a node.
Type: [UnknownNodeOutputFlowValidationDetails](API_agent_UnknownNodeOutputFlowValidationDetails.md) object
Required: No
** unreachableNode **
Details about an unreachable node in the flow.
Type: [UnreachableNodeFlowValidationDetails](API_agent_UnreachableNodeFlowValidationDetails.md) object
Required: No
** unsatisfiedConnectionConditions **
Details about unsatisfied conditions for a connection.
Type: [UnsatisfiedConnectionConditionsFlowValidationDetails](API_agent_UnsatisfiedConnectionConditionsFlowValidationDetails.md) object
Required: No
** unspecified **
Details about an unspecified validation.
Type: [UnspecifiedFlowValidationDetails](API_agent_UnspecifiedFlowValidationDetails.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowValidationDetails)
# FlowVersionSummary
Contains information about a version of a flow.
This data type is used in the following API operations:
+ [ListFlowVersions response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListFlowVersions.html#API_agent_ListFlowVersions_ResponseSyntax)
## Contents
** arn **
The Amazon Resource Name (ARN) of the flow that the version belongs to.
Type: String
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}`
Required: Yes
** createdAt **
The time at the version was created.
Type: Timestamp
Required: Yes
** id **
The unique identifier of the flow.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** status **
The status of the flow.
Type: String
Valid Values: `Failed | Prepared | Preparing | NotPrepared`
Required: Yes
** version **
The version of the flow.
Type: String
Pattern: `[0-9]{1,5}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FlowVersionSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FlowVersionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FlowVersionSummary)
# Function
Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
This data type is used in the following API operations:
+ [CreateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax)
+ [CreateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax)
+ [UpdateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax)
+ [UpdateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax)
+ [GetAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax)
## Contents
** name **
A name for the function.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** description **
A description of the function and its purpose.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1200.
Required: No
** parameters **
The parameters that the agent elicits from the user to fulfill the function.
Type: String to [ParameterDetail](API_agent_ParameterDetail.md) object map
Key Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** requireConfirmation **
Contains information if user confirmation is required to invoke the function.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/Function)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/Function)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/Function)
# FunctionSchema
Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.
This data type is used in the following API operations:
+ [CreateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax)
+ [CreateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax)
+ [UpdateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax)
+ [UpdateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax)
+ [GetAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax)
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** functions **
A list of functions that each define an action in the action group.
Type: Array of [Function](API_agent_Function.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/FunctionSchema)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/FunctionSchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/FunctionSchema)
# GuardrailConfiguration
Details about a guardrail associated with a resource.
## Contents
** guardrailIdentifier **
The unique identifier of the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: No
** guardrailVersion **
The version of the guardrail.
Type: String
Pattern: `(([0-9]{1,8})|(DRAFT))`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/GuardrailConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/GuardrailConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/GuardrailConfiguration)
# HierarchicalChunkingConfiguration
Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer.
You configure the number of tokens to overlap, or repeat across adjacent chunks. For example, if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk.
## Contents
** levelConfigurations **
Token settings for each layer.
Type: Array of [HierarchicalChunkingLevelConfiguration](API_agent_HierarchicalChunkingLevelConfiguration.md) objects
Array Members: Fixed number of 2 items.
Required: Yes
** overlapTokens **
The number of tokens to repeat across chunks in the same layer.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/HierarchicalChunkingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/HierarchicalChunkingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/HierarchicalChunkingConfiguration)
# HierarchicalChunkingLevelConfiguration
Token settings for a layer in a hierarchical chunking configuration.
## Contents
** maxTokens **
The maximum number of tokens that a chunk can contain in this layer.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 8192.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/HierarchicalChunkingLevelConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/HierarchicalChunkingLevelConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/HierarchicalChunkingLevelConfiguration)
# IncompatibleConnectionDataTypeFlowValidationDetails
Details about incompatible data types in a connection between nodes.
## Contents
** connection **
The name of the connection with incompatible data types.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IncompatibleConnectionDataTypeFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IncompatibleConnectionDataTypeFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IncompatibleConnectionDataTypeFlowValidationDetails)
# InferenceConfiguration
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType`. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
## Contents
** maximumLength **
The maximum number of tokens to allow in the generated response.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** stopSequences **
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 4 items.
Required: No
** temperature **
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** topK **
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for `topK` is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set `topK` to 50, the model selects the next token from among the top 50 most likely choices.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 500.
Required: No
** topP **
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for `Top P` determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set `topP` to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/InferenceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/InferenceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/InferenceConfiguration)
# IngestionJob
Contains details about a data ingestion job. Data sources are ingested into a knowledge base so that Large Language Models (LLMs) can use your data.
This data type is used in the following API operations:
+ [StartIngestionJob response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_StartIngestionJob.html#API_agent_StartIngestionJob_ResponseSyntax)
+ [GetIngestionJob response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetIngestionJob.html#API_agent_GetIngestionJob_ResponseSyntax)
+ [ListIngestionJob response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax)
## Contents
** dataSourceId **
The unique identifier of the data source for the data ingestion job.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** ingestionJobId **
The unique identifier of the data ingestion job.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** knowledgeBaseId **
The unique identifier of the knowledge for the data ingestion job.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** startedAt **
The time the data ingestion job started.
If you stop a data ingestion job, the `startedAt` time is the time the job was started before the job was stopped.
Type: Timestamp
Required: Yes
** status **
The status of the data ingestion job.
Type: String
Valid Values: `STARTING | IN_PROGRESS | COMPLETE | FAILED | STOPPING | STOPPED`
Required: Yes
** updatedAt **
The time the data ingestion job was last updated.
If you stop a data ingestion job, the `updatedAt` time is the time the job was stopped.
Type: Timestamp
Required: Yes
** description **
The description of the data ingestion job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** failureReasons **
A list of reasons that the data ingestion job failed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** statistics **
Contains statistics about the data ingestion job.
Type: [IngestionJobStatistics](API_agent_IngestionJobStatistics.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IngestionJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IngestionJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IngestionJob)
# IngestionJobFilter
The definition of a filter to filter the data.
## Contents
** attribute **
The name of field or attribute to apply the filter.
Type: String
Valid Values: `STATUS`
Required: Yes
** operator **
The operation to apply to the field or attribute.
Type: String
Valid Values: `EQ`
Required: Yes
** values **
A list of values that belong to the field or attribute.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Length Constraints: Minimum length of 0. Maximum length of 100.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IngestionJobFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IngestionJobFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IngestionJobFilter)
# IngestionJobSortBy
The parameters of sorting the data.
## Contents
** attribute **
The name of field or attribute to apply sorting of data.
Type: String
Valid Values: `STATUS | STARTED_AT`
Required: Yes
** order **
The order for sorting the data.
Type: String
Valid Values: `ASCENDING | DESCENDING`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IngestionJobSortBy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IngestionJobSortBy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IngestionJobSortBy)
# IngestionJobStatistics
Contains the statistics for the data ingestion job.
## Contents
** numberOfDocumentsDeleted **
The number of source documents that were deleted.
Type: Long
Required: No
** numberOfDocumentsFailed **
The number of source documents that failed to be ingested.
Type: Long
Required: No
** numberOfDocumentsScanned **
The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
Type: Long
Required: No
** numberOfMetadataDocumentsModified **
The number of metadata files that were updated or deleted.
Type: Long
Required: No
** numberOfMetadataDocumentsScanned **
The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
Type: Long
Required: No
** numberOfModifiedDocumentsIndexed **
The number of modified source documents in the data source that were successfully indexed.
Type: Long
Required: No
** numberOfNewDocumentsIndexed **
The number of new source documents in the data source that were successfully indexed.
Type: Long
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IngestionJobStatistics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IngestionJobStatistics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IngestionJobStatistics)
# IngestionJobSummary
Contains details about a data ingestion job.
## Contents
** dataSourceId **
The unique identifier of the data source for the data ingestion job.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** ingestionJobId **
The unique identifier of the data ingestion job.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** knowledgeBaseId **
The unique identifier of the knowledge base for the data ingestion job.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** startedAt **
The time the data ingestion job started.
Type: Timestamp
Required: Yes
** status **
The status of the data ingestion job.
Type: String
Valid Values: `STARTING | IN_PROGRESS | COMPLETE | FAILED | STOPPING | STOPPED`
Required: Yes
** updatedAt **
The time the data ingestion job was last updated.
Type: Timestamp
Required: Yes
** description **
The description of the data ingestion job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** statistics **
Contains statistics for the data ingestion job.
Type: [IngestionJobStatistics](API_agent_IngestionJobStatistics.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IngestionJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IngestionJobSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IngestionJobSummary)
# InlineCodeFlowNodeConfiguration
Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function.
## Contents
** code **
The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow.
The code must be valid in the programming `language` that you specify.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 5000000.
Required: Yes
** language **
The programming language used by your inline code node.
The code must be valid in the programming `language` that you specify. Currently, only Python 3 (`Python_3`) is supported.
Type: String
Valid Values: `Python_3`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/InlineCodeFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/InlineCodeFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/InlineCodeFlowNodeConfiguration)
# InlineContent
Contains information about content defined inline to ingest into a data source. Choose a `type` and include the field that corresponds to it.
## Contents
** type **
The type of inline content to define.
Type: String
Valid Values: `BYTE | TEXT`
Required: Yes
** byteContent **
Contains information about content defined inline in bytes.
Type: [ByteContentDoc](API_agent_ByteContentDoc.md) object
Required: No
** textContent **
Contains information about content defined inline in text.
Type: [TextContentDoc](API_agent_TextContentDoc.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/InlineContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/InlineContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/InlineContent)
# InputFlowNodeConfiguration
Contains configurations for the input flow node for a flow. This node takes the input from flow invocation and passes it to the next node in the data type that you specify.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/InputFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/InputFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/InputFlowNodeConfiguration)
# IntermediateStorage
A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline.
## Contents
** s3Location **
An S3 bucket path.
Type: [S3Location](API_agent_S3Location.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IntermediateStorage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IntermediateStorage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IntermediateStorage)
# InvalidLoopBoundaryFlowValidationDetails
Details about a flow that contains connections that violate loop boundary rules.
## Contents
** connection **
The name of the connection that violates loop boundary rules.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
** source **
The source node of the connection that violates DoWhile loop boundary rules.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** target **
The target node of the connection that violates DoWhile loop boundary rules.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/InvalidLoopBoundaryFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/InvalidLoopBoundaryFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/InvalidLoopBoundaryFlowValidationDetails)
# IteratorFlowNodeConfiguration
Contains configurations for an iterator node in a flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output.
The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/IteratorFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/IteratorFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/IteratorFlowNodeConfiguration)
# KendraKnowledgeBaseConfiguration
Settings for an Amazon Kendra knowledge base.
## Contents
** kendraIndexArn **
The ARN of the Amazon Kendra index.
Type: String
Pattern: `arn:aws(|-cn|-us-gov):kendra:[a-z0-9-]{1,20}:([0-9]{12}|):index/([a-zA-Z0-9][a-zA-Z0-9-]{35}|[a-zA-Z0-9][a-zA-Z0-9-]{35}-[a-zA-Z0-9][a-zA-Z0-9-]{35})`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KendraKnowledgeBaseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KendraKnowledgeBaseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KendraKnowledgeBaseConfiguration)
# KnowledgeBase
Contains information about a knowledge base.
## Contents
** createdAt **
The time the knowledge base was created.
Type: Timestamp
Required: Yes
** knowledgeBaseArn **
The Amazon Resource Name (ARN) of the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+`
Required: Yes
** knowledgeBaseConfiguration **
Contains details about the embeddings configuration of the knowledge base.
Type: [KnowledgeBaseConfiguration](API_agent_KnowledgeBaseConfiguration.md) object
Required: Yes
** knowledgeBaseId **
The unique identifier of the knowledge base.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** name **
The name of the knowledge base.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** roleArn **
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
** status **
The status of the knowledge base. The following statuses are possible:
+ CREATING – The knowledge base is being created.
+ ACTIVE – The knowledge base is ready to be queried.
+ DELETING – The knowledge base is being deleted.
+ UPDATING – The knowledge base is being updated.
+ FAILED – The knowledge base API operation failed.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | UPDATING | FAILED | DELETE_UNSUCCESSFUL`
Required: Yes
** updatedAt **
The time the knowledge base was last updated.
Type: Timestamp
Required: Yes
** description **
The description of the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** failureReasons **
A list of reasons that the API operation on the knowledge base failed.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2048 items.
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** storageConfiguration **
Contains details about the storage configuration of the knowledge base.
Type: [StorageConfiguration](API_agent_StorageConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KnowledgeBase)
# KnowledgeBaseConfiguration
Contains details about the vector embeddings configuration of the knowledge base.
## Contents
** type **
The type of data that the data source is converted into for the knowledge base.
Type: String
Valid Values: `VECTOR | KENDRA | SQL`
Required: Yes
** kendraKnowledgeBaseConfiguration **
Settings for an Amazon Kendra knowledge base.
Type: [KendraKnowledgeBaseConfiguration](API_agent_KendraKnowledgeBaseConfiguration.md) object
Required: No
** sqlKnowledgeBaseConfiguration **
Specifies configurations for a knowledge base connected to an SQL database.
Type: [SqlKnowledgeBaseConfiguration](API_agent_SqlKnowledgeBaseConfiguration.md) object
Required: No
** vectorKnowledgeBaseConfiguration **
Contains details about the model that's used to convert the data source into vector embeddings.
Type: [VectorKnowledgeBaseConfiguration](API_agent_VectorKnowledgeBaseConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KnowledgeBaseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KnowledgeBaseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KnowledgeBaseConfiguration)
# KnowledgeBaseDocument
Contains information about a document to ingest into a knowledge base and metadata to associate with it.
## Contents
** content **
Contains the content of the document.
Type: [DocumentContent](API_agent_DocumentContent.md) object
Required: Yes
** metadata **
Contains the metadata to associate with the document.
Type: [DocumentMetadata](API_agent_DocumentMetadata.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KnowledgeBaseDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KnowledgeBaseDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KnowledgeBaseDocument)
# KnowledgeBaseDocumentDetail
Contains the details for a document that was ingested or deleted.
## Contents
** dataSourceId **
The identifier of the data source connected to the knowledge base that the document was ingested into or deleted from.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** identifier **
Contains information that identifies the document.
Type: [DocumentIdentifier](API_agent_DocumentIdentifier.md) object
Required: Yes
** knowledgeBaseId **
The identifier of the knowledge base that the document was ingested into or deleted from.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** status **
The ingestion status of the document. The following statuses are possible:
+ STARTING – You submitted the ingestion job containing the document.
+ PENDING – The document is waiting to be ingested.
+ IN\$1PROGRESS – The document is being ingested.
+ INDEXED – The document was successfully indexed.
+ PARTIALLY\$1INDEXED – The document was partially indexed.
+ METADATA\$1PARTIALLY\$1INDEXED – You submitted metadata for an existing document and it was partially indexed.
+ METADATA\$1UPDATE\$1FAILED – You submitted a metadata update for an existing document but it failed.
+ FAILED – The document failed to be ingested.
+ NOT\$1FOUND – The document wasn't found.
+ IGNORED – The document was ignored during ingestion.
+ DELETING – You submitted the delete job containing the document.
+ DELETE\$1IN\$1PROGRESS – The document is being deleted.
Type: String
Valid Values: `INDEXED | PARTIALLY_INDEXED | PENDING | FAILED | METADATA_PARTIALLY_INDEXED | METADATA_UPDATE_FAILED | IGNORED | NOT_FOUND | STARTING | IN_PROGRESS | DELETING | DELETE_IN_PROGRESS`
Required: Yes
** statusReason **
The reason for the status. Appears alongside the status `IGNORED`.
Type: String
Required: No
** updatedAt **
The date and time at which the document was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KnowledgeBaseDocumentDetail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KnowledgeBaseDocumentDetail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KnowledgeBaseDocumentDetail)
# KnowledgeBaseFlowNodeConfiguration
Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.
## Contents
** knowledgeBaseId **
The unique identifier of the knowledge base to query.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `$|^[0-9a-zA-Z]+`
Required: Yes
** guardrailConfiguration **
Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration.
Type: [GuardrailConfiguration](API_agent_GuardrailConfiguration.md) object
Required: No
** inferenceConfiguration **
Contains inference configurations for the prompt.
Type: [PromptInferenceConfiguration](API_agent_PromptInferenceConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** modelId **
The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array.
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
** numberOfResults **
The number of results to retrieve from the knowledge base.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** orchestrationConfiguration **
The configuration for orchestrating the retrieval and generation process in the knowledge base node.
Type: [KnowledgeBaseOrchestrationConfiguration](API_agent_KnowledgeBaseOrchestrationConfiguration.md) object
Required: No
** promptTemplate **
A custom prompt template to use with the knowledge base for generating responses.
Type: [KnowledgeBasePromptTemplate](API_agent_KnowledgeBasePromptTemplate.md) object
Required: No
** rerankingConfiguration **
The configuration for reranking the retrieved results from the knowledge base to improve relevance.
Type: [VectorSearchRerankingConfiguration](API_agent_VectorSearchRerankingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KnowledgeBaseFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KnowledgeBaseFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KnowledgeBaseFlowNodeConfiguration)
# KnowledgeBaseOrchestrationConfiguration
Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.
## Contents
** additionalModelRequestFields **
The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** inferenceConfig **
Contains inference configurations for the prompt.
Type: [PromptInferenceConfiguration](API_agent_PromptInferenceConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** performanceConfig **
The performance configuration options for the knowledge base retrieval and generation process.
Type: [PerformanceConfiguration](API_agent_PerformanceConfiguration.md) object
Required: No
** promptTemplate **
A custom prompt template for orchestrating the retrieval and generation process.
Type: [KnowledgeBasePromptTemplate](API_agent_KnowledgeBasePromptTemplate.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KnowledgeBaseOrchestrationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KnowledgeBaseOrchestrationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KnowledgeBaseOrchestrationConfiguration)
# KnowledgeBasePromptTemplate
Defines a custom prompt template for orchestrating the retrieval and generation process.
## Contents
** textPromptTemplate **
The text of the prompt template.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KnowledgeBasePromptTemplate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KnowledgeBasePromptTemplate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KnowledgeBasePromptTemplate)
# KnowledgeBaseSummary
Contains details about a knowledge base.
## Contents
** knowledgeBaseId **
The unique identifier of the knowledge base.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** name **
The name of the knowledge base.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** status **
The status of the knowledge base.
Type: String
Valid Values: `CREATING | ACTIVE | DELETING | UPDATING | FAILED | DELETE_UNSUCCESSFUL`
Required: Yes
** updatedAt **
The time the knowledge base was last updated.
Type: Timestamp
Required: Yes
** description **
The description of the knowledge base.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/KnowledgeBaseSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/KnowledgeBaseSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/KnowledgeBaseSummary)
# LambdaFunctionFlowNodeConfiguration
Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.
## Contents
** lambdaArn **
The Amazon Resource Name (ARN) of the Lambda function to invoke.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `$|^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:lambda:([a-z]{2,}-){2,}\d:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/LambdaFunctionFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/LambdaFunctionFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/LambdaFunctionFlowNodeConfiguration)
# LexFlowNodeConfiguration
Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.
## Contents
** botAliasArn **
The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 78.
Pattern: `$|^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:lex:([a-z]{2,}-){2,}\d:\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+`
Required: Yes
** localeId **
The Region to invoke the Amazon Lex bot in.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/LexFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/LexFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/LexFlowNodeConfiguration)
# LoopControllerFlowNodeConfiguration
Contains configurations for the controller node of a DoWhile loop in the flow.
## Contents
** continueCondition **
Specifies the condition that determines when the flow exits the DoWhile loop. The loop executes until this condition evaluates to true.
Type: [FlowCondition](API_agent_FlowCondition.md) object
Required: Yes
** maxIterations **
Specifies the maximum number of times the DoWhile loop can iterate before the flow exits the loop.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/LoopControllerFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/LoopControllerFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/LoopControllerFlowNodeConfiguration)
# LoopFlowNodeConfiguration
Contains configurations for the nodes of a DoWhile loop in your flow.
A DoWhile loop is made up of the following nodes:
+ `Loop` - The container node that holds the loop's flow definition. This node encompasses the entire loop structure.
+ `LoopInput` - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations.
+ Body nodes - The processing nodes that execute within each loop iteration. These can be nodes for handling data in your flow, such as a prompt or Lambda function nodes. Some node types aren't supported inside a DoWhile loop body. For more information, see [LoopIncompatibleNodeTypeFlowValidationDetails](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.html).
+ `LoopController` - The node that evaluates whether the loop should continue or exit based on a condition.
These nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached.
## Contents
** definition **
The definition of the DoWhile loop nodes and connections between nodes in the flow.
Type: [FlowDefinition](API_agent_FlowDefinition.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/LoopFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/LoopFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/LoopFlowNodeConfiguration)
# LoopIncompatibleNodeTypeFlowValidationDetails
Details about a flow that contains an incompatible node in a DoWhile loop.
## Contents
** incompatibleNodeName **
The node that's incompatible in the DoWhile loop.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** incompatibleNodeType **
The node type of the incompatible node in the DoWhile loop. Some node types, like a condition node, aren't allowed in a DoWhile loop.
Type: String
Valid Values: `Input | Condition | Iterator | Collector`
Required: Yes
** node **
The `Loop` container node that contains an incompatible node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/LoopIncompatibleNodeTypeFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/LoopIncompatibleNodeTypeFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/LoopIncompatibleNodeTypeFlowValidationDetails)
# LoopInputFlowNodeConfiguration
Contains configurations for the input node of a DoWhile loop in the flow.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/LoopInputFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/LoopInputFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/LoopInputFlowNodeConfiguration)
# MalformedConditionExpressionFlowValidationDetails
Details about a malformed condition expression in a node.
## Contents
** cause **
The error message describing why the condition expression is malformed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
** condition **
The name of the malformed condition.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** node **
The name of the node containing the malformed condition expression.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MalformedConditionExpressionFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MalformedConditionExpressionFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MalformedConditionExpressionFlowValidationDetails)
# MalformedNodeInputExpressionFlowValidationDetails
Details about a malformed input expression in a node.
## Contents
** cause **
The error message describing why the input expression is malformed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: Yes
** input **
The name of the input with the malformed expression.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** node **
The name of the node containing the malformed input expression.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MalformedNodeInputExpressionFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MalformedNodeInputExpressionFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MalformedNodeInputExpressionFlowValidationDetails)
# MemoryConfiguration
Details of the memory configuration.
## Contents
** enabledMemoryTypes **
The type of memory that is stored.
Type: Array of strings
Array Members: Fixed number of 1 item.
Valid Values: `SESSION_SUMMARY`
Required: Yes
** sessionSummaryConfiguration **
Contains the configuration for SESSION\$1SUMMARY memory type enabled for the agent.
Type: [SessionSummaryConfiguration](API_agent_SessionSummaryConfiguration.md) object
Required: No
** storageDays **
The number of days the agent is configured to retain the conversational context.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 365.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MemoryConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MemoryConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MemoryConfiguration)
# Message
A message input or response from a model. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).
## Contents
** content **
The content in the message.
Type: Array of [ContentBlock](API_agent_ContentBlock.md) objects
Required: Yes
** role **
The role that the message belongs to.
Type: String
Valid Values: `user | assistant`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/Message)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/Message)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/Message)
# MetadataAttribute
Contains information about a metadata attribute.
## Contents
** key **
The key of the metadata attribute.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
** value **
Contains the value of the metadata attribute.
Type: [MetadataAttributeValue](API_agent_MetadataAttributeValue.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MetadataAttribute)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MetadataAttribute)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MetadataAttribute)
# MetadataAttributeValue
Contains the value of the metadata attribute. Choose a `type` and include the field that corresponds to it.
## Contents
** type **
The type of the metadata attribute.
Type: String
Valid Values: `BOOLEAN | NUMBER | STRING | STRING_LIST`
Required: Yes
** booleanValue **
The value of the Boolean metadata attribute.
Type: Boolean
Required: No
** numberValue **
The value of the numeric metadata attribute.
Type: Double
Required: No
** stringListValue **
An array of strings that define the value of the metadata attribute.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
** stringValue **
The value of the string metadata attribute.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MetadataAttributeValue)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MetadataAttributeValue)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MetadataAttributeValue)
# MetadataConfigurationForReranking
Specifies how metadata fields should be handled during the reranking process.
## Contents
** selectionMode **
The mode for selecting metadata fields for reranking.
Type: String
Valid Values: `SELECTIVE | ALL`
Required: Yes
** selectiveModeConfiguration **
The configuration for selective metadata field inclusion or exclusion during reranking.
Type: [RerankingMetadataSelectiveModeConfiguration](API_agent_RerankingMetadataSelectiveModeConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MetadataConfigurationForReranking)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MetadataConfigurationForReranking)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MetadataConfigurationForReranking)
# MismatchedNodeInputTypeFlowValidationDetails
Details about mismatched input data types in a node.
## Contents
** expectedType **
The expected data type for the node input.
Type: String
Valid Values: `String | Number | Boolean | Object | Array`
Required: Yes
** input **
The name of the input with the mismatched data type.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** node **
The name of the node containing the input with the mismatched data type.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MismatchedNodeInputTypeFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MismatchedNodeInputTypeFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MismatchedNodeInputTypeFlowValidationDetails)
# MismatchedNodeOutputTypeFlowValidationDetails
Details about mismatched output data types in a node.
## Contents
** expectedType **
The expected data type for the node output.
Type: String
Valid Values: `String | Number | Boolean | Object | Array`
Required: Yes
** node **
The name of the node containing the output with the mismatched data type.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** output **
The name of the output with the mismatched data type.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MismatchedNodeOutputTypeFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MismatchedNodeOutputTypeFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MismatchedNodeOutputTypeFlowValidationDetails)
# MissingConnectionConfigurationFlowValidationDetails
Details about a connection missing required configuration.
## Contents
** connection **
The name of the connection missing configuration.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingConnectionConfigurationFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingConnectionConfigurationFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingConnectionConfigurationFlowValidationDetails)
# MissingDefaultConditionFlowValidationDetails
Details about a missing default condition in a conditional node.
## Contents
** node **
The name of the node missing the default condition.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingDefaultConditionFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingDefaultConditionFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingDefaultConditionFlowValidationDetails)
# MissingEndingNodesFlowValidationDetails
Details about missing ending nodes (such as FlowOutputNode) in the flow.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingEndingNodesFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingEndingNodesFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingEndingNodesFlowValidationDetails)
# MissingLoopControllerNodeFlowValidationDetails
Details about a flow that's missing a required `LoopController` node in a DoWhile loop.
## Contents
** loopNode **
The DoWhile loop in a flow that's missing a required `LoopController` node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingLoopControllerNodeFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingLoopControllerNodeFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingLoopControllerNodeFlowValidationDetails)
# MissingLoopInputNodeFlowValidationDetails
Details about a flow that's missing a required `LoopInput` node in a DoWhile loop.
## Contents
** loopNode **
The DoWhile loop in a flow that's missing a required `LoopInput` node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingLoopInputNodeFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingLoopInputNodeFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingLoopInputNodeFlowValidationDetails)
# MissingNodeConfigurationFlowValidationDetails
Details about a node missing a required configuration.
## Contents
** node **
The name of the node missing a required configuration.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingNodeConfigurationFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingNodeConfigurationFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingNodeConfigurationFlowValidationDetails)
# MissingNodeInputFlowValidationDetails
Details about a missing required input in a node.
## Contents
** input **
The name of the missing input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** node **
The name of the node missing the required input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingNodeInputFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingNodeInputFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingNodeInputFlowValidationDetails)
# MissingNodeOutputFlowValidationDetails
Details about a missing required output in a node.
## Contents
** node **
The name of the node missing the required output.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** output **
The name of the missing output.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingNodeOutputFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingNodeOutputFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingNodeOutputFlowValidationDetails)
# MissingStartingNodesFlowValidationDetails
Details about missing starting nodes (such as FlowInputNode) in the flow.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MissingStartingNodesFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MissingStartingNodesFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MissingStartingNodesFlowValidationDetails)
# MongoDbAtlasConfiguration
Contains details about the storage configuration of the knowledge base in MongoDB Atlas.
## Contents
** collectionName **
The collection name of the knowledge base in MongoDB Atlas.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `.*`
Required: Yes
** credentialsSecretArn **
The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: Yes
** databaseName **
The database name in your MongoDB Atlas cluster for your knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `.*`
Required: Yes
** endpoint **
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** fieldMapping **
Contains the names of the fields to which to map information about the vector store.
Type: [MongoDbAtlasFieldMapping](API_agent_MongoDbAtlasFieldMapping.md) object
Required: Yes
** vectorIndexName **
The name of the MongoDB Atlas vector search index.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** endpointServiceName **
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: `(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)`
Required: No
** textIndexName **
The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MongoDbAtlasConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MongoDbAtlasConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MongoDbAtlasConfiguration)
# MongoDbAtlasFieldMapping
Contains the names of the fields to which to map information about the vector store.
## Contents
** metadataField **
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** textField **
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** vectorField **
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MongoDbAtlasFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MongoDbAtlasFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MongoDbAtlasFieldMapping)
# MultipleLoopControllerNodesFlowValidationDetails
Details about a flow that contains multiple `LoopController` nodes in a DoWhile loop.
## Contents
** loopNode **
The DoWhile loop in a flow that contains multiple `LoopController` nodes.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MultipleLoopControllerNodesFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MultipleLoopControllerNodesFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MultipleLoopControllerNodesFlowValidationDetails)
# MultipleLoopInputNodesFlowValidationDetails
Details about a flow that contains multiple `LoopInput` nodes in a DoWhile loop.
## Contents
** loopNode **
The DoWhile loop in a flow that contains multiple `LoopInput` nodes.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MultipleLoopInputNodesFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MultipleLoopInputNodesFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MultipleLoopInputNodesFlowValidationDetails)
# MultipleNodeInputConnectionsFlowValidationDetails
Details about multiple connections to a single node input.
## Contents
** input **
The name of the input with multiple connections to it.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** node **
The name of the node containing the input with multiple connections.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/MultipleNodeInputConnectionsFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/MultipleNodeInputConnectionsFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/MultipleNodeInputConnectionsFlowValidationDetails)
# NeptuneAnalyticsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon Neptune Analytics. For more information, see [Create a vector index in Amazon Neptune Analytics](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html).
## Contents
** fieldMapping **
Contains the names of the fields to which to map information about the vector store.
Type: [NeptuneAnalyticsFieldMapping](API_agent_NeptuneAnalyticsFieldMapping.md) object
Required: Yes
** graphArn **
The Amazon Resource Name (ARN) of the Neptune Analytics vector store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: `arn:aws(|-cn|-us-gov):neptune-graph:[a-zA-Z0-9-]*:[0-9]{12}:graph/g-[a-zA-Z0-9]{10}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/NeptuneAnalyticsConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/NeptuneAnalyticsConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/NeptuneAnalyticsConfiguration)
# NeptuneAnalyticsFieldMapping
Contains the names of the fields to which to map information about the vector store.
## Contents
** metadataField **
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** textField **
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/NeptuneAnalyticsFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/NeptuneAnalyticsFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/NeptuneAnalyticsFieldMapping)
# OpenSearchManagedClusterConfiguration
Contains details about the Managed Cluster configuration of the knowledge base in Amazon OpenSearch Service. For more information, see [Create a vector index in OpenSearch Managed Cluster](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html).
## Contents
** domainArn **
The Amazon Resource Name (ARN) of the OpenSearch domain.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov|-iso):es:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:domain/[a-z][a-z0-9-]{3,28}`
Required: Yes
** domainEndpoint **
The endpoint URL the OpenSearch domain.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `https://.*`
Required: Yes
** fieldMapping **
Contains the names of the fields to which to map information about the vector store.
Type: [OpenSearchManagedClusterFieldMapping](API_agent_OpenSearchManagedClusterFieldMapping.md) object
Required: Yes
** vectorIndexName **
The name of the vector store.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(?![\-_+.])[a-z0-9][a-z0-9\-_\.]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/OpenSearchManagedClusterConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/OpenSearchManagedClusterConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/OpenSearchManagedClusterConfiguration)
# OpenSearchManagedClusterFieldMapping
Contains the names of the fields to which to map information about the vector store.
## Contents
** metadataField **
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** textField **
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** vectorField **
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/OpenSearchManagedClusterFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/OpenSearchManagedClusterFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/OpenSearchManagedClusterFieldMapping)
# OpenSearchServerlessConfiguration
Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html).
## Contents
** collectionArn **
The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws:aoss:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:collection/[a-z0-9-]{3,32}`
Required: Yes
** fieldMapping **
Contains the names of the fields to which to map information about the vector store.
Type: [OpenSearchServerlessFieldMapping](API_agent_OpenSearchServerlessFieldMapping.md) object
Required: Yes
** vectorIndexName **
The name of the vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/OpenSearchServerlessConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/OpenSearchServerlessConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/OpenSearchServerlessConfiguration)
# OpenSearchServerlessFieldMapping
Contains the names of the fields to which to map information about the vector store.
## Contents
** metadataField **
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** textField **
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** vectorField **
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/OpenSearchServerlessFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/OpenSearchServerlessFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/OpenSearchServerlessFieldMapping)
# OrchestrationExecutor
Contains details about the Lambda function containing the orchestration logic carried out upon invoking the custom orchestration.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** lambda **
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/OrchestrationExecutor)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/OrchestrationExecutor)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/OrchestrationExecutor)
# OutputFlowNodeConfiguration
Contains configurations for an output flow node in the flow. You specify the data type expected for the input into the node in the `type` field and how to return the final output in the `expression` field.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/OutputFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/OutputFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/OutputFlowNodeConfiguration)
# ParameterDetail
Contains details about a parameter in a function for an action group.
This data type is used in the following API operations:
+ [CreateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax)
+ [CreateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax)
+ [UpdateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax)
+ [UpdateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax)
+ [GetAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax)
## Contents
** type **
The data type of the parameter.
Type: String
Valid Values: `string | number | integer | boolean | array`
Required: Yes
** description **
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
** required **
Whether the parameter is required for the agent to complete the function for action group invocation.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ParameterDetail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ParameterDetail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ParameterDetail)
# ParsingConfiguration
Settings for parsing document contents. If you exclude this field, the default parser converts the contents of each document into text before splitting it into chunks. Specify the parsing strategy to use in the `parsingStrategy` field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see [Parsing options for your data source](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html).
**Note**
If you specify `BEDROCK_DATA_AUTOMATION` or `BEDROCK_FOUNDATION_MODEL` and it fails to parse a file, the Amazon Bedrock default parser will be used instead.
## Contents
** parsingStrategy **
The parsing strategy for the data source.
Type: String
Valid Values: `BEDROCK_FOUNDATION_MODEL | BEDROCK_DATA_AUTOMATION`
Required: Yes
** bedrockDataAutomationConfiguration **
If you specify `BEDROCK_DATA_AUTOMATION` as the parsing strategy for ingesting your data source, use this object to modify configurations for using the Amazon Bedrock Data Automation parser.
Type: [BedrockDataAutomationConfiguration](API_agent_BedrockDataAutomationConfiguration.md) object
Required: No
** bedrockFoundationModelConfiguration **
If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents.
Type: [BedrockFoundationModelConfiguration](API_agent_BedrockFoundationModelConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ParsingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ParsingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ParsingConfiguration)
# ParsingPrompt
Instructions for interpreting the contents of a document.
## Contents
** parsingPromptText **
Instructions for interpreting the contents of a document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ParsingPrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ParsingPrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ParsingPrompt)
# PatternObjectFilter
The specific filters applied to your data source content. You can filter out or include certain content.
## Contents
** objectType **
The supported object type or content type of the data source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes
** exclusionFilters **
A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
** inclusionFilters **
A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PatternObjectFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PatternObjectFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PatternObjectFilter)
# PatternObjectFilterConfiguration
The configuration of filtering certain objects or content types of the data source.
## Contents
** filters **
The configuration of specific filters applied to your data source content. You can filter out or include certain content.
Type: Array of [PatternObjectFilter](API_agent_PatternObjectFilter.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PatternObjectFilterConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PatternObjectFilterConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PatternObjectFilterConfiguration)
# PerformanceConfiguration
The performance-related configuration options for the knowledge base retrieval and generation process.
## Contents
** latency **
The latency optimization setting.
Type: String
Valid Values: `standard | optimized`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PerformanceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PerformanceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PerformanceConfiguration)
# PineconeConfiguration
Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see [Create a vector index in Pinecone](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html).
## Contents
** connectionString **
The endpoint URL for your index management page.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** credentialsSecretArn **
The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: Yes
** fieldMapping **
Contains the names of the fields to which to map information about the vector store.
Type: [PineconeFieldMapping](API_agent_PineconeFieldMapping.md) object
Required: Yes
** namespace **
The namespace to be used to write new data to your database.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PineconeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PineconeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PineconeConfiguration)
# PineconeFieldMapping
Contains the names of the fields to which to map information about the vector store.
## Contents
** metadataField **
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** textField **
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PineconeFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PineconeFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PineconeFieldMapping)
# PromptAgentResource
Contains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and [Automate tasks in your application using conversational agents](https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html).
## Contents
** agentIdentifier **
The ARN of the agent with which to use the prompt.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptAgentResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptAgentResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptAgentResource)
# PromptConfiguration
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
## Contents
** additionalModelRequestFields **
If the Converse or ConverseStream operations support the model, `additionalModelRequestFields` contains additional inference parameters, beyond the base set of inference parameters in the `inferenceConfiguration` field.
For more information, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: JSON value
Required: No
** basePromptTemplate **
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see [Prompt template placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html). For more information, see [Configure the prompt templates](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
** foundationModel **
The agent's foundation model.
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
** inferenceConfiguration **
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType`. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: [InferenceConfiguration](API_agent_InferenceConfiguration.md) object
Required: No
** parserMode **
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`. If you set the field as `OVERRIDDEN`, the `overrideLambda` field in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) must be specified with the ARN of a Lambda function.
Type: String
Valid Values: `DEFAULT | OVERRIDDEN`
Required: No
** promptCreationMode **
Specifies whether to override the default prompt template for this `promptType`. Set this value to `OVERRIDDEN` to use the prompt that you provide in the `basePromptTemplate`. If you leave it as `DEFAULT`, the agent uses a default prompt template.
Type: String
Valid Values: `DEFAULT | OVERRIDDEN`
Required: No
** promptState **
Specifies whether to allow the agent to carry out the step specified in the `promptType`. If you set this value to `DISABLED`, the agent skips that step. The default state for each `promptType` is as follows.
+ `PRE_PROCESSING` – `DISABLED`
+ `ORCHESTRATION` – `ENABLED`
+ `KNOWLEDGE_BASE_RESPONSE_GENERATION` – `ENABLED`
+ `POST_PROCESSING` – `DISABLED`
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
** promptType **
The step in the agent sequence that this prompt configuration applies to.
Type: String
Valid Values: `PRE_PROCESSING | ORCHESTRATION | POST_PROCESSING | KNOWLEDGE_BASE_RESPONSE_GENERATION | MEMORY_SUMMARIZATION`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptConfiguration)
# PromptFlowNodeConfiguration
Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide.
## Contents
** sourceConfiguration **
Specifies whether the prompt is from Prompt management or defined inline.
Type: [PromptFlowNodeSourceConfiguration](API_agent_PromptFlowNodeSourceConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** guardrailConfiguration **
Contains configurations for a guardrail to apply to the prompt in this node and the response generated from it.
Type: [GuardrailConfiguration](API_agent_GuardrailConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptFlowNodeConfiguration)
# PromptFlowNodeInlineConfiguration
Contains configurations for a prompt defined inline in the node.
## Contents
** modelId **
The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to run inference with.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `$|^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:(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
** templateConfiguration **
Contains a prompt and variables in the prompt that can be replaced with values at runtime.
Type: [PromptTemplateConfiguration](API_agent_PromptTemplateConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** templateType **
The type of prompt template.
Type: String
Valid Values: `TEXT | CHAT`
Required: Yes
** additionalModelRequestFields **
Additional fields to be included in the model request for the Prompt node.
Type: JSON value
Required: No
** inferenceConfiguration **
Contains inference configurations for the prompt.
Type: [PromptInferenceConfiguration](API_agent_PromptInferenceConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptFlowNodeInlineConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptFlowNodeInlineConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptFlowNodeInlineConfiguration)
# PromptFlowNodeResourceConfiguration
Contains configurations for a prompt from Prompt management to use in a node.
## Contents
** promptArn **
The Amazon Resource Name (ARN) of the prompt from Prompt management.
Type: String
Pattern: `$|^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptFlowNodeResourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptFlowNodeResourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptFlowNodeResourceConfiguration)
# PromptFlowNodeSourceConfiguration
Contains configurations for a prompt and whether it is from Prompt management or defined inline.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** inline **
Contains configurations for a prompt that is defined inline
Type: [PromptFlowNodeInlineConfiguration](API_agent_PromptFlowNodeInlineConfiguration.md) object
Required: No
** resource **
Contains configurations for a prompt from Prompt management.
Type: [PromptFlowNodeResourceConfiguration](API_agent_PromptFlowNodeResourceConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptFlowNodeSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptFlowNodeSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptFlowNodeSourceConfiguration)
# PromptGenAiResource
Contains specifications for a generative AI resource with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** agent **
Specifies an Amazon Bedrock agent with which to use the prompt.
Type: [PromptAgentResource](API_agent_PromptAgentResource.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptGenAiResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptGenAiResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptGenAiResource)
# PromptInferenceConfiguration
Contains inference configurations for the prompt.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** text **
Contains inference configurations for a text prompt.
Type: [PromptModelInferenceConfiguration](API_agent_PromptModelInferenceConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptInferenceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptInferenceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptInferenceConfiguration)
# PromptInputVariable
Contains information about a variable in the prompt.
## Contents
** name **
The name of the variable.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptInputVariable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptInputVariable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptInputVariable)
# PromptMetadataEntry
Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).
## Contents
** key **
The key of a metadata tag for a prompt variant.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: Yes
** value **
The value of a metadata tag for a prompt variant.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptMetadataEntry)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptMetadataEntry)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptMetadataEntry)
# PromptModelInferenceConfiguration
Contains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html).
## Contents
** maxTokens **
The maximum number of tokens to return in the response.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** stopSequences **
A list of strings that define sequences after which the model will stop generating.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 4 items.
Required: No
** temperature **
Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** topP **
The percentage of most-likely candidates that the model considers for the next token.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptModelInferenceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptModelInferenceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptModelInferenceConfiguration)
# PromptOverrideConfiguration
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).
## Contents
** promptConfigurations **
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
Type: Array of [PromptConfiguration](API_agent_PromptConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
** overrideLambda **
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the `promptConfigurations` must contain a `parserMode` value that is set to `OVERRIDDEN`. For more information, see [Parser Lambda function in Amazon Bedrock Agents](https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptOverrideConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptOverrideConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptOverrideConfiguration)
# PromptSummary
Contains information about a prompt in your Prompt management tool.
This data type is used in the following API operations:
+ [ListPrompts response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListPrompts.html#API_agent_ListPrompts_ResponseSyntax)
## Contents
** arn **
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})?)`
Required: Yes
** createdAt **
The time at which the prompt was created.
Type: Timestamp
Required: Yes
** id **
The unique identifier of the prompt.
Type: String
Pattern: `[0-9a-zA-Z]{10}`
Required: Yes
** name **
The name of the prompt.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** updatedAt **
The time at which the prompt was last updated.
Type: Timestamp
Required: Yes
** version **
The version of the prompt that this summary applies to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
** description **
The description of the prompt.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptSummary)
# PromptTemplateConfiguration
Contains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** chat **
Contains configurations to use the prompt in a conversational format.
Type: [ChatPromptTemplateConfiguration](API_agent_ChatPromptTemplateConfiguration.md) object
Required: No
** text **
Contains configurations for the text in a message for a prompt.
Type: [TextPromptTemplateConfiguration](API_agent_TextPromptTemplateConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptTemplateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptTemplateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptTemplateConfiguration)
# PromptVariant
Contains details about a variant of the prompt.
## Contents
** name **
The name of the prompt variant.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** templateConfiguration **
Contains configurations for the prompt template.
Type: [PromptTemplateConfiguration](API_agent_PromptTemplateConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** templateType **
The type of prompt template to use.
Type: String
Valid Values: `TEXT | CHAT`
Required: Yes
** additionalModelRequestFields **
Contains model-specific inference configurations that aren't in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: JSON value
Required: No
** genAiResource **
Specifies a generative AI resource with which to use the prompt.
Type: [PromptGenAiResource](API_agent_PromptGenAiResource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** inferenceConfiguration **
Contains inference configurations for the prompt variant.
Type: [PromptInferenceConfiguration](API_agent_PromptInferenceConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** metadata **
An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
Type: Array of [PromptMetadataEntry](API_agent_PromptMetadataEntry.md) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
** modelId **
The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) with which to run inference on the prompt.
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
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/PromptVariant)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/PromptVariant)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/PromptVariant)
# QueryGenerationColumn
Contains information about a column in the current table for the query engine to consider.
## Contents
** description **
A description of the column that helps the query engine understand the contents of the column.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** inclusion **
Specifies whether to include or exclude the column during query generation. If you specify `EXCLUDE`, the column will be ignored. If you specify `INCLUDE`, all other columns in the table will be ignored.
Type: String
Valid Values: `INCLUDE | EXCLUDE`
Required: No
** name **
The name of the column for which the other fields in this object apply.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/QueryGenerationColumn)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/QueryGenerationColumn)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/QueryGenerationColumn)
# QueryGenerationConfiguration
Contains configurations for query generation. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide..
## Contents
** executionTimeoutSeconds **
The time after which query generation will time out.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 200.
Required: No
** generationContext **
Specifies configurations for context to use during query generation.
Type: [QueryGenerationContext](API_agent_QueryGenerationContext.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/QueryGenerationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/QueryGenerationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/QueryGenerationConfiguration)
# QueryGenerationContext
>Contains configurations for context to use during query generation.
## Contents
** curatedQueries **
An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
Type: Array of [CuratedQuery](API_agent_CuratedQuery.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: No
** tables **
An array of objects, each of which defines information about a table in the database.
Type: Array of [QueryGenerationTable](API_agent_QueryGenerationTable.md) objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/QueryGenerationContext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/QueryGenerationContext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/QueryGenerationContext)
# QueryGenerationTable
Contains information about a table for the query engine to consider.
## Contents
** name **
The name of the table for which the other fields in this object apply.
Type: String
Pattern: `.*\..*\..*`
Required: Yes
** columns **
An array of objects, each of which defines information about a column in the table.
Type: Array of [QueryGenerationColumn](API_agent_QueryGenerationColumn.md) objects
Required: No
** description **
A description of the table that helps the query engine understand the contents of the table.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** inclusion **
Specifies whether to include or exclude the table during query generation. If you specify `EXCLUDE`, the table will be ignored. If you specify `INCLUDE`, all other tables will be ignored.
Type: String
Valid Values: `INCLUDE | EXCLUDE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/QueryGenerationTable)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/QueryGenerationTable)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/QueryGenerationTable)
# RdsConfiguration
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html).
## Contents
** credentialsSecretArn **
The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: Yes
** databaseName **
The name of your Amazon RDS database.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `[a-zA-Z0-9_\-]+`
Required: Yes
** fieldMapping **
Contains the names of the fields to which to map information about the vector store.
Type: [RdsFieldMapping](API_agent_RdsFieldMapping.md) object
Required: Yes
** resourceArn **
The Amazon Resource Name (ARN) of the vector store.
Type: String
Pattern: `arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}`
Required: Yes
** tableName **
The name of the table in the database.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `[a-zA-Z0-9_\.\-]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RdsConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RdsConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RdsConfiguration)
# RdsFieldMapping
Contains the names of the fields to which to map information about the vector store.
## Contents
** metadataField **
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `[a-zA-Z0-9_\-]+`
Required: Yes
** primaryKeyField **
The name of the field in which Amazon Bedrock stores the ID for each entry.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `[a-zA-Z0-9_\-]+`
Required: Yes
** textField **
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `[a-zA-Z0-9_\-]+`
Required: Yes
** vectorField **
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `[a-zA-Z0-9_\-]+`
Required: Yes
** customMetadataField **
Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `[a-zA-Z0-9_\-]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RdsFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RdsFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RdsFieldMapping)
# RedisEnterpriseCloudConfiguration
Contains details about the storage configuration of the knowledge base in Redis Enterprise Cloud. For more information, see [Create a vector index in Redis Enterprise Cloud](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html).
## Contents
** credentialsSecretArn **
The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Redis Enterprise Cloud database.
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: Yes
** endpoint **
The endpoint URL of the Redis Enterprise Cloud database.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** fieldMapping **
Contains the names of the fields to which to map information about the vector store.
Type: [RedisEnterpriseCloudFieldMapping](API_agent_RedisEnterpriseCloudFieldMapping.md) object
Required: Yes
** vectorIndexName **
The name of the vector index.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedisEnterpriseCloudConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedisEnterpriseCloudConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedisEnterpriseCloudConfiguration)
# RedisEnterpriseCloudFieldMapping
Contains the names of the fields to which to map information about the vector store.
## Contents
** metadataField **
The name of the field in which Amazon Bedrock stores metadata about the vector store.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** textField **
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
** vectorField **
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedisEnterpriseCloudFieldMapping)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedisEnterpriseCloudFieldMapping)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedisEnterpriseCloudFieldMapping)
# RedshiftConfiguration
Contains configurations for an Amazon Redshift database. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.
## Contents
** queryEngineConfiguration **
Specifies configurations for an Amazon Redshift query engine.
Type: [RedshiftQueryEngineConfiguration](API_agent_RedshiftQueryEngineConfiguration.md) object
Required: Yes
** storageConfigurations **
Specifies configurations for Amazon Redshift database storage.
Type: Array of [RedshiftQueryEngineStorageConfiguration](API_agent_RedshiftQueryEngineStorageConfiguration.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** queryGenerationConfiguration **
Specifies configurations for generating queries.
Type: [QueryGenerationConfiguration](API_agent_QueryGenerationConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftConfiguration)
# RedshiftProvisionedAuthConfiguration
Contains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the `type` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.
## Contents
** type **
The type of authentication to use.
Type: String
Valid Values: `IAM | USERNAME_PASSWORD | USERNAME`
Required: Yes
** databaseUser **
The database username for authentication to an Amazon Redshift provisioned data warehouse.
Type: String
Required: No
** usernamePasswordSecretArn **
The ARN of an Secrets Manager secret for authentication.
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftProvisionedAuthConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftProvisionedAuthConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftProvisionedAuthConfiguration)
# RedshiftProvisionedConfiguration
Contains configurations for a provisioned Amazon Redshift query engine.
## Contents
** authConfiguration **
Specifies configurations for authentication to Amazon Redshift.
Type: [RedshiftProvisionedAuthConfiguration](API_agent_RedshiftProvisionedAuthConfiguration.md) object
Required: Yes
** clusterIdentifier **
The ID of the Amazon Redshift cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftProvisionedConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftProvisionedConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftProvisionedConfiguration)
# RedshiftQueryEngineAwsDataCatalogStorageConfiguration
Contains configurations for storage in AWS Glue Data Catalog.
## Contents
** tableNames **
A list of names of the tables to use.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 1000 items.
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: `.*\.*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftQueryEngineAwsDataCatalogStorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftQueryEngineAwsDataCatalogStorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftQueryEngineAwsDataCatalogStorageConfiguration)
# RedshiftQueryEngineConfiguration
Contains configurations for an Amazon Redshift query engine. Specify the type of query engine in `type` and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.
## Contents
** type **
The type of query engine.
Type: String
Valid Values: `SERVERLESS | PROVISIONED`
Required: Yes
** provisionedConfiguration **
Specifies configurations for a provisioned Amazon Redshift query engine.
Type: [RedshiftProvisionedConfiguration](API_agent_RedshiftProvisionedConfiguration.md) object
Required: No
** serverlessConfiguration **
Specifies configurations for a serverless Amazon Redshift query engine.
Type: [RedshiftServerlessConfiguration](API_agent_RedshiftServerlessConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftQueryEngineConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftQueryEngineConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftQueryEngineConfiguration)
# RedshiftQueryEngineRedshiftStorageConfiguration
Contains configurations for storage in Amazon Redshift.
## Contents
** databaseName **
The name of the Amazon Redshift database.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftQueryEngineRedshiftStorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftQueryEngineRedshiftStorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftQueryEngineRedshiftStorageConfiguration)
# RedshiftQueryEngineStorageConfiguration
Contains configurations for Amazon Redshift data storage. Specify the data storage service to use in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.
## Contents
** type **
The data storage service to use.
Type: String
Valid Values: `REDSHIFT | AWS_DATA_CATALOG`
Required: Yes
** awsDataCatalogConfiguration **
Specifies configurations for storage in AWS Glue Data Catalog.
Type: [RedshiftQueryEngineAwsDataCatalogStorageConfiguration](API_agent_RedshiftQueryEngineAwsDataCatalogStorageConfiguration.md) object
Required: No
** redshiftConfiguration **
Specifies configurations for storage in Amazon Redshift.
Type: [RedshiftQueryEngineRedshiftStorageConfiguration](API_agent_RedshiftQueryEngineRedshiftStorageConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftQueryEngineStorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftQueryEngineStorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftQueryEngineStorageConfiguration)
# RedshiftServerlessAuthConfiguration
Specifies configurations for authentication to a Redshift Serverless. Specify the type of authentication to use in the `type` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.
## Contents
** type **
The type of authentication to use.
Type: String
Valid Values: `IAM | USERNAME_PASSWORD`
Required: Yes
** usernamePasswordSecretArn **
The ARN of an Secrets Manager secret for authentication.
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftServerlessAuthConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftServerlessAuthConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftServerlessAuthConfiguration)
# RedshiftServerlessConfiguration
Contains configurations for authentication to Amazon Redshift Serverless.
## Contents
** authConfiguration **
Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse.
Type: [RedshiftServerlessAuthConfiguration](API_agent_RedshiftServerlessAuthConfiguration.md) object
Required: Yes
** workgroupArn **
The ARN of the Amazon Redshift workgroup.
Type: String
Pattern: `(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RedshiftServerlessConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RedshiftServerlessConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RedshiftServerlessConfiguration)
# RerankingMetadataSelectiveModeConfiguration
Configures the metadata fields to include or exclude during the reranking process when using selective mode.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** fieldsToExclude **
Specifies the metadata fields to exclude from the reranking process.
Type: Array of [FieldForReranking](API_agent_FieldForReranking.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** fieldsToInclude **
Specifies the metadata fields to include in the reranking process.
Type: Array of [FieldForReranking](API_agent_FieldForReranking.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RerankingMetadataSelectiveModeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RerankingMetadataSelectiveModeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RerankingMetadataSelectiveModeConfiguration)
# RetrievalFlowNodeConfiguration
Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output.
## Contents
** serviceConfiguration **
Contains configurations for the service to use for retrieving data to return as the output from the node.
Type: [RetrievalFlowNodeServiceConfiguration](API_agent_RetrievalFlowNodeServiceConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RetrievalFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RetrievalFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RetrievalFlowNodeConfiguration)
# RetrievalFlowNodeS3Configuration
Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
## Contents
** bucketName **
The name of the Amazon S3 bucket from which to retrieve data.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `$|^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RetrievalFlowNodeS3Configuration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RetrievalFlowNodeS3Configuration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RetrievalFlowNodeS3Configuration)
# RetrievalFlowNodeServiceConfiguration
Contains configurations for the service to use for retrieving data to return as the output from the node.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3 **
Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
Type: [RetrievalFlowNodeS3Configuration](API_agent_RetrievalFlowNodeS3Configuration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/RetrievalFlowNodeServiceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/RetrievalFlowNodeServiceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/RetrievalFlowNodeServiceConfiguration)
# S3Content
Contains information about the content to ingest into a knowledge base connected to an Amazon S3 data source.
## Contents
** s3Location **
The S3 location of the file containing the content to ingest.
Type: [S3Location](API_agent_S3Location.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/S3Content)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/S3Content)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/S3Content)
# S3DataSourceConfiguration
The configuration information to connect to Amazon S3 as your data source.
## Contents
** bucketArn **
The Amazon Resource Name (ARN) of the S3 bucket that contains your data.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(|-cn|-us-gov):s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]`
Required: Yes
** bucketOwnerAccountId **
The account ID for the owner of the S3 bucket.
Type: String
Length Constraints: Fixed length of 12.
Pattern: `[0-9]{12}`
Required: No
** inclusionPrefixes **
A list of S3 prefixes to include certain files or content. For more information, see [Organizing objects using prefixes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html).
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/S3DataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/S3DataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/S3DataSourceConfiguration)
# S3Identifier
The identifier information for an Amazon S3 bucket.
## Contents
** s3BucketName **
The name of the S3 bucket.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`
Required: No
** s3ObjectKey **
The S3 object key for the S3 resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `[\.\-\!\*\_\'\(\)a-zA-Z0-9][\.\-\!\*\_\'\(\)\/a-zA-Z0-9]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/S3Identifier)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/S3Identifier)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/S3Identifier)
# S3Location
An Amazon S3 location.
## Contents
** uri **
The location's URI. For example, `s3://my-bucket/chunk-processor/`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `s3://.{1,128}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/S3Location)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/S3Location)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/S3Location)
# S3VectorsConfiguration
Contains the storage configuration of the knowledge base for S3 vectors.
## Contents
** indexArn **
The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock.
Type: String
Required: No
** indexName **
The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Required: No
** vectorBucketArn **
The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/S3VectorsConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/S3VectorsConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/S3VectorsConfiguration)
# SalesforceCrawlerConfiguration
The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.
## Contents
** filterConfiguration **
The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content.
Type: [CrawlFilterConfiguration](API_agent_CrawlFilterConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SalesforceCrawlerConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SalesforceCrawlerConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SalesforceCrawlerConfiguration)
# SalesforceDataSourceConfiguration
The configuration information to connect to Salesforce as your data source.
## Contents
** sourceConfiguration **
The endpoint information to connect to your Salesforce data source.
Type: [SalesforceSourceConfiguration](API_agent_SalesforceSourceConfiguration.md) object
Required: Yes
** crawlerConfiguration **
The configuration of the Salesforce content. For example, configuring specific types of Salesforce content.
Type: [SalesforceCrawlerConfiguration](API_agent_SalesforceCrawlerConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SalesforceDataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SalesforceDataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SalesforceDataSourceConfiguration)
# SalesforceSourceConfiguration
The endpoint information to connect to your Salesforce data source.
## Contents
** authType **
The supported authentication type to authenticate and connect to your Salesforce instance.
Type: String
Valid Values: `OAUTH2_CLIENT_CREDENTIALS`
Required: Yes
** credentialsSecretArn **
The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see [Salesforce connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector).
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: Yes
** hostUrl **
The Salesforce host URL or instance URL.
Type: String
Pattern: `https://[A-Za-z0-9][^\s]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SalesforceSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SalesforceSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SalesforceSourceConfiguration)
# SeedUrl
The seed or starting point URL. You should be authorized to crawl the URL.
## Contents
** url **
A seed or starting point URL.
Type: String
Pattern: `https?://[A-Za-z0-9][^\s]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SeedUrl)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SeedUrl)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SeedUrl)
# SemanticChunkingConfiguration
Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing.
With semantic chunking, each sentence is compared to the next to determine how similar they are. You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences, 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These chunks are further split if they exceed the max token size.
You must also specify a buffer size, which determines whether sentences are compared in isolation, or within a moving context window that includes the previous and following sentence. For example, if you set the buffer size to `1`, the embedding for sentence 10 is derived from sentences 9, 10, and 11 combined.
## Contents
** breakpointPercentileThreshold **
The dissimilarity threshold for splitting chunks.
Type: Integer
Valid Range: Minimum value of 50. Maximum value of 99.
Required: Yes
** bufferSize **
The buffer size.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
** maxTokens **
The maximum number of tokens that a chunk can contain.
Type: Integer
Valid Range: Minimum value of 1.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SemanticChunkingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SemanticChunkingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SemanticChunkingConfiguration)
# ServerSideEncryptionConfiguration
Contains the configuration for server-side encryption.
## Contents
** kmsKeyArn **
The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the resource.
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
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ServerSideEncryptionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ServerSideEncryptionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ServerSideEncryptionConfiguration)
# SessionSummaryConfiguration
Configuration for SESSION\$1SUMMARY memory type enabled for the agent.
## Contents
** maxRecentSessions **
Maximum number of recent session summaries to include in the agent's prompt context.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SessionSummaryConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SessionSummaryConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SessionSummaryConfiguration)
# SharePointCrawlerConfiguration
The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.
## Contents
** filterConfiguration **
The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content.
Type: [CrawlFilterConfiguration](API_agent_CrawlFilterConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SharePointCrawlerConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SharePointCrawlerConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SharePointCrawlerConfiguration)
# SharePointDataSourceConfiguration
The configuration information to connect to SharePoint as your data source.
## Contents
** sourceConfiguration **
The endpoint information to connect to your SharePoint data source.
Type: [SharePointSourceConfiguration](API_agent_SharePointSourceConfiguration.md) object
Required: Yes
** crawlerConfiguration **
The configuration of the SharePoint content. For example, configuring specific types of SharePoint content.
Type: [SharePointCrawlerConfiguration](API_agent_SharePointCrawlerConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SharePointDataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SharePointDataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SharePointDataSourceConfiguration)
# SharePointSourceConfiguration
The endpoint information to connect to your SharePoint data source.
## Contents
** authType **
The supported authentication type to authenticate and connect to your SharePoint site/sites.
Type: String
Valid Values: `OAUTH2_CLIENT_CREDENTIALS | OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS`
Required: Yes
** credentialsSecretArn **
The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see [SharePoint connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector).
Type: String
Pattern: `arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}`
Required: Yes
** domain **
The domain of your SharePoint instance or site URL/URLs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Required: Yes
** hostType **
The supported host type, whether online/cloud or server/on-premises.
Type: String
Valid Values: `ONLINE`
Required: Yes
** siteUrls **
A list of one or more SharePoint site URLs.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern: `https://[A-Za-z0-9][^\s]*`
Required: Yes
** tenantId **
The identifier of your Microsoft 365 tenant.
Type: String
Length Constraints: Fixed length of 36.
Pattern: `[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SharePointSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SharePointSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SharePointSourceConfiguration)
# SpecificToolChoice
Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
## Contents
** name **
The name of the tool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z][a-zA-Z0-9_]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SpecificToolChoice)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SpecificToolChoice)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SpecificToolChoice)
# SqlKnowledgeBaseConfiguration
Contains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.
## Contents
** type **
The type of SQL database to connect to the knowledge base.
Type: String
Valid Values: `REDSHIFT`
Required: Yes
** redshiftConfiguration **
Specifies configurations for a knowledge base connected to an Amazon Redshift database.
Type: [RedshiftConfiguration](API_agent_RedshiftConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SqlKnowledgeBaseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SqlKnowledgeBaseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SqlKnowledgeBaseConfiguration)
# StorageConfiguration
Contains the storage configuration of the knowledge base.
## Contents
** type **
The vector store service in which the knowledge base is stored.
Type: String
Valid Values: `OPENSEARCH_SERVERLESS | PINECONE | REDIS_ENTERPRISE_CLOUD | RDS | MONGO_DB_ATLAS | NEPTUNE_ANALYTICS | OPENSEARCH_MANAGED_CLUSTER | S3_VECTORS`
Required: Yes
** mongoDbAtlasConfiguration **
Contains the storage configuration of the knowledge base in MongoDB Atlas.
Type: [MongoDbAtlasConfiguration](API_agent_MongoDbAtlasConfiguration.md) object
Required: No
** neptuneAnalyticsConfiguration **
Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html).
Type: [NeptuneAnalyticsConfiguration](API_agent_NeptuneAnalyticsConfiguration.md) object
Required: No
** opensearchManagedClusterConfiguration **
Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html).
Type: [OpenSearchManagedClusterConfiguration](API_agent_OpenSearchManagedClusterConfiguration.md) object
Required: No
** opensearchServerlessConfiguration **
Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
Type: [OpenSearchServerlessConfiguration](API_agent_OpenSearchServerlessConfiguration.md) object
Required: No
** pineconeConfiguration **
Contains the storage configuration of the knowledge base in Pinecone.
Type: [PineconeConfiguration](API_agent_PineconeConfiguration.md) object
Required: No
** rdsConfiguration **
Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html).
Type: [RdsConfiguration](API_agent_RdsConfiguration.md) object
Required: No
** redisEnterpriseCloudConfiguration **
Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
Type: [RedisEnterpriseCloudConfiguration](API_agent_RedisEnterpriseCloudConfiguration.md) object
Required: No
** s3VectorsConfiguration **
The configuration settings for storing knowledge base data using S3 vectors. This includes vector index information and S3 bucket details for vector storage.
Type: [S3VectorsConfiguration](API_agent_S3VectorsConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/StorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/StorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/StorageConfiguration)
# StorageFlowNodeConfiguration
Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify.
## Contents
** serviceConfiguration **
Contains configurations for the service to use for storing the input into the node.
Type: [StorageFlowNodeServiceConfiguration](API_agent_StorageFlowNodeServiceConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/StorageFlowNodeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/StorageFlowNodeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/StorageFlowNodeConfiguration)
# StorageFlowNodeS3Configuration
Contains configurations for the Amazon S3 location in which to store the input into the node.
## Contents
** bucketName **
The name of the Amazon S3 bucket in which to store the input into the node.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern: `$|^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/StorageFlowNodeS3Configuration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/StorageFlowNodeS3Configuration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/StorageFlowNodeS3Configuration)
# StorageFlowNodeServiceConfiguration
Contains configurations for the service to use for storing the input into the node.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3 **
Contains configurations for the Amazon S3 location in which to store the input into the node.
Type: [StorageFlowNodeS3Configuration](API_agent_StorageFlowNodeS3Configuration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/StorageFlowNodeServiceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/StorageFlowNodeServiceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/StorageFlowNodeServiceConfiguration)
# SupplementalDataStorageConfiguration
Specifies configurations for the storage location of multimedia content (images, audio, and video) extracted from multimodal documents in your data source. This content can be retrieved and returned to the end user with timestamp references for audio and video segments.
## Contents
** storageLocations **
A list of objects specifying storage locations for multimedia content (images, audio, and video) extracted from multimodal documents in your data source.
Type: Array of [SupplementalDataStorageLocation](API_agent_SupplementalDataStorageLocation.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SupplementalDataStorageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SupplementalDataStorageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SupplementalDataStorageConfiguration)
# SupplementalDataStorageLocation
Contains information about a storage location for multimedia content (images, audio, and video) extracted from multimodal documents in your data source.
## Contents
** type **
Specifies the storage service used for this location.
Type: String
Valid Values: `S3`
Required: Yes
** s3Location **
Contains information about the Amazon S3 location for the extracted multimedia content.
Type: [S3Location](API_agent_S3Location.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SupplementalDataStorageLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SupplementalDataStorageLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SupplementalDataStorageLocation)
# SystemContentBlock
Contains a system prompt to provide context to the model or to describe how it should behave. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** cachePoint **
Creates a cache checkpoint within a tool designation
Type: [CachePointBlock](API_agent_CachePointBlock.md) object
Required: No
** text **
The text in the system prompt.
Type: String
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/SystemContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/SystemContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/SystemContentBlock)
# TextContentDoc
Contains information about content defined inline in text.
## Contents
** data **
The text of the content.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5242880.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/TextContentDoc)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/TextContentDoc)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/TextContentDoc)
# TextPromptTemplateConfiguration
Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`.
## Contents
** text **
The message for the prompt.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** cachePoint **
A cache checkpoint within a template configuration.
Type: [CachePointBlock](API_agent_CachePointBlock.md) object
Required: No
** inputVariables **
An array of the variables in the prompt template.
Type: Array of [PromptInputVariable](API_agent_PromptInputVariable.md) objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/TextPromptTemplateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/TextPromptTemplateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/TextPromptTemplateConfiguration)
# Tool
Contains configurations for a tool that a model can use when generating a response. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** cachePoint **
Creates a cache checkpoint within a tool designation
Type: [CachePointBlock](API_agent_CachePointBlock.md) object
Required: No
** toolSpec **
The specification for the tool.
Type: [ToolSpecification](API_agent_ToolSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/Tool)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/Tool)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/Tool)
# ToolChoice
Defines which tools the model should request when invoked. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** any **
Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response.
Type: [AnyToolChoice](API_agent_AnyToolChoice.md) object
Required: No
** auto **
Defines tools. The model automatically decides whether to call a tool or to generate text instead.
Type: [AutoToolChoice](API_agent_AutoToolChoice.md) object
Required: No
** tool **
Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response.
Type: [SpecificToolChoice](API_agent_SpecificToolChoice.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ToolChoice)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ToolChoice)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ToolChoice)
# ToolConfiguration
Configuration information for the tools that the model can use when generating a response. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
## Contents
** tools **
An array of tools to pass to a model.
Type: Array of [Tool](API_agent_Tool.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
** toolChoice **
Defines which tools the model should request when invoked.
Type: [ToolChoice](API_agent_ToolChoice.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ToolConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ToolConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ToolConfiguration)
# ToolInputSchema
The input schema for the tool. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** json **
A JSON object defining the input schema for the tool.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ToolInputSchema)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ToolInputSchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ToolInputSchema)
# ToolSpecification
Contains a specification for a tool. For more information, see [Use a tool to complete an Amazon Bedrock model response](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html).
## Contents
** inputSchema **
The input schema for the tool.
Type: [ToolInputSchema](API_agent_ToolInputSchema.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** name **
The name of the tool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z][a-zA-Z0-9_]*`
Required: Yes
** description **
The description of the tool.
Type: String
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ToolSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ToolSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ToolSpecification)
# Transformation
A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to `POST_CHUNKING`.
## Contents
** stepToApply **
When the service applies the transformation.
Type: String
Valid Values: `POST_CHUNKING`
Required: Yes
** transformationFunction **
A Lambda function that processes documents.
Type: [TransformationFunction](API_agent_TransformationFunction.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/Transformation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/Transformation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/Transformation)
# TransformationFunction
A Lambda function that processes documents.
## Contents
** transformationLambdaConfiguration **
The Lambda function.
Type: [TransformationLambdaConfiguration](API_agent_TransformationLambdaConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/TransformationFunction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/TransformationFunction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/TransformationFunction)
# TransformationLambdaConfiguration
A Lambda function that processes documents.
## Contents
** lambdaArn **
The function's ARN identifier.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/TransformationLambdaConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/TransformationLambdaConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/TransformationLambdaConfiguration)
# UnfulfilledNodeInputFlowValidationDetails
Details about an unfulfilled node input with no valid connections.
## Contents
** input **
The name of the unfulfilled input. An input is unfulfilled if there are no data connections to it.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** node **
The name of the node containing the unfulfilled input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnfulfilledNodeInputFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnfulfilledNodeInputFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnfulfilledNodeInputFlowValidationDetails)
# UnknownConnectionConditionFlowValidationDetails
Details about an unknown condition for a connection.
## Contents
** connection **
The name of the connection with the unknown condition.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnknownConnectionConditionFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnknownConnectionConditionFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnknownConnectionConditionFlowValidationDetails)
# UnknownConnectionSourceFlowValidationDetails
Details about an unknown source node for a connection.
## Contents
** connection **
The name of the connection with the unknown source.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnknownConnectionSourceFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnknownConnectionSourceFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnknownConnectionSourceFlowValidationDetails)
# UnknownConnectionSourceOutputFlowValidationDetails
Details about an unknown source output for a connection.
## Contents
** connection **
The name of the connection with the unknown source output.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnknownConnectionSourceOutputFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnknownConnectionSourceOutputFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnknownConnectionSourceOutputFlowValidationDetails)
# UnknownConnectionTargetFlowValidationDetails
Details about an unknown target node for a connection.
## Contents
** connection **
The name of the connection with the unknown target.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnknownConnectionTargetFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnknownConnectionTargetFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnknownConnectionTargetFlowValidationDetails)
# UnknownConnectionTargetInputFlowValidationDetails
Details about an unknown target input for a connection.
## Contents
** connection **
The name of the connection with the unknown target input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnknownConnectionTargetInputFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnknownConnectionTargetInputFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnknownConnectionTargetInputFlowValidationDetails)
# UnknownNodeInputFlowValidationDetails
Details about an unknown input for a node.
## Contents
** input **
The name of the node with the unknown input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** node **
The name of the unknown input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnknownNodeInputFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnknownNodeInputFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnknownNodeInputFlowValidationDetails)
# UnknownNodeOutputFlowValidationDetails
Details about an unknown output for a node.
## Contents
** node **
The name of the node with the unknown output.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** output **
The name of the unknown output.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnknownNodeOutputFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnknownNodeOutputFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnknownNodeOutputFlowValidationDetails)
# UnreachableNodeFlowValidationDetails
Details about an unreachable node in the flow. A node is unreachable when there are no paths to it from any starting node.
## Contents
** node **
The name of the unreachable node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnreachableNodeFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnreachableNodeFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnreachableNodeFlowValidationDetails)
# UnsatisfiedConnectionConditionsFlowValidationDetails
Details about unsatisfied conditions for a connection. A condition is unsatisfied if it can never be true, for example two branches of condition node cannot be simultaneously true.
## Contents
** connection **
The name of the connection with unsatisfied conditions.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnsatisfiedConnectionConditionsFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnsatisfiedConnectionConditionsFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnsatisfiedConnectionConditionsFlowValidationDetails)
# UnspecifiedFlowValidationDetails
Details about an unspecified validation that doesn't fit other categories.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UnspecifiedFlowValidationDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UnspecifiedFlowValidationDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UnspecifiedFlowValidationDetails)
# UrlConfiguration
The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.
## Contents
** seedUrls **
One or more seed or starting point URLs.
Type: Array of [SeedUrl](API_agent_SeedUrl.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/UrlConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/UrlConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/UrlConfiguration)
# ValidationExceptionField
Stores information about a field passed inside a request that resulted in an validation error.
## Contents
** message **
A message describing why this field failed validation.
Type: String
Pattern: `[\s\S]+`
Required: Yes
** name **
The name of the field.
Type: String
Pattern: `[\s\S]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/ValidationExceptionField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/ValidationExceptionField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/ValidationExceptionField)
# VectorIngestionConfiguration
Contains details about how to ingest the documents in a data source.
## Contents
** chunkingConfiguration **
Details about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
Type: [ChunkingConfiguration](API_agent_ChunkingConfiguration.md) object
Required: No
** contextEnrichmentConfiguration **
The context enrichment configuration used for ingestion of the data into the vector store.
Type: [ContextEnrichmentConfiguration](API_agent_ContextEnrichmentConfiguration.md) object
Required: No
** customTransformationConfiguration **
A custom document transformer for parsed data source documents.
Type: [CustomTransformationConfiguration](API_agent_CustomTransformationConfiguration.md) object
Required: No
** parsingConfiguration **
Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used.
Type: [ParsingConfiguration](API_agent_ParsingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/VectorIngestionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/VectorIngestionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/VectorIngestionConfiguration)
# VectorKnowledgeBaseConfiguration
Contains details about the model used to create vector embeddings for the knowledge base.
## Contents
** embeddingModelArn **
The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.
Type: String
Length Constraints: Minimum length of 20. 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
** embeddingModelConfiguration **
The embeddings model configuration details for the vector model used in Knowledge Base.
Type: [EmbeddingModelConfiguration](API_agent_EmbeddingModelConfiguration.md) object
Required: No
** supplementalDataStorageConfiguration **
If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using [RetrieveAndGenerate](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html).
Type: [SupplementalDataStorageConfiguration](API_agent_SupplementalDataStorageConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/VectorKnowledgeBaseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/VectorKnowledgeBaseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/VectorKnowledgeBaseConfiguration)
# VectorSearchBedrockRerankingConfiguration
Configures the Amazon Bedrock reranker model to improve the relevance of retrieved results.
## Contents
** modelConfiguration **
Specifies the configuration for the Amazon Bedrock reranker model.
Type: [VectorSearchBedrockRerankingModelConfiguration](API_agent_VectorSearchBedrockRerankingModelConfiguration.md) object
Required: Yes
** metadataConfiguration **
Specifies how metadata fields should be handled during the reranking process.
Type: [MetadataConfigurationForReranking](API_agent_MetadataConfigurationForReranking.md) object
Required: No
** numberOfRerankedResults **
Specifies the number of results to return after reranking.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingConfiguration)
# VectorSearchBedrockRerankingModelConfiguration
Configures the Amazon Bedrock model used for reranking retrieved results.
## Contents
** modelArn **
The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?`
Required: Yes
** additionalModelRequestFields **
Specifies additional model-specific request parameters as key-value pairs that are included in the request to the Amazon Bedrock reranker model.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingModelConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingModelConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingModelConfiguration)
# VectorSearchRerankingConfiguration
Specifies how retrieved results from a knowledge base are reranked to improve relevance.
## Contents
** type **
Specifies the type of reranking model to use. Currently, the only supported value is `BEDROCK_RERANKING_MODEL`.
Type: String
Valid Values: `BEDROCK_RERANKING_MODEL`
Required: Yes
** bedrockRerankingConfiguration **
Specifies the configuration for using an Amazon Bedrock reranker model to rerank retrieved results.
Type: [VectorSearchBedrockRerankingConfiguration](API_agent_VectorSearchBedrockRerankingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/VectorSearchRerankingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/VectorSearchRerankingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/VectorSearchRerankingConfiguration)
# VideoConfiguration
Configuration settings for processing video content in multimodal knowledge bases.
## Contents
** segmentationConfiguration **
Configuration for segmenting video content during processing.
Type: [VideoSegmentationConfiguration](API_agent_VideoSegmentationConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/VideoConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/VideoConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/VideoConfiguration)
# VideoSegmentationConfiguration
Configuration for segmenting video content during multimodal knowledge base ingestion. Determines how video files are divided into chunks for processing.
## Contents
** fixedLengthDuration **
The duration in seconds for each video segment. Video files will be divided into chunks of this length for processing.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 30.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/VideoSegmentationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/VideoSegmentationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/VideoSegmentationConfiguration)
# WebCrawlerConfiguration
The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs.
## Contents
** crawlerLimits **
The configuration of crawl limits for the web URLs.
Type: [WebCrawlerLimits](API_agent_WebCrawlerLimits.md) object
Required: No
** exclusionFilters **
A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
** inclusionFilters **
A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
** scope **
The scope of what is crawled for your URLs.
You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com".
Type: String
Valid Values: `HOST_ONLY | SUBDOMAINS`
Required: No
** userAgent **
Returns the user agent suffix for your web crawler.
Type: String
Length Constraints: Minimum length of 15. Maximum length of 40.
Required: No
** userAgentHeader **
A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the `bedrockbot`, UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to `bedrockbot_UUID`. You can optionally append a custom suffix to `bedrockbot_UUID` to allowlist a specific user agent permitted to access your source URLs.
Type: String
Length Constraints: Minimum length of 61. Maximum length of 86.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/WebCrawlerConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/WebCrawlerConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/WebCrawlerConfiguration)
# WebCrawlerLimits
The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs.
## Contents
** maxPages **
The max number of web pages crawled from your source URLs, up to 25,000 pages. If the web pages exceed this limit, the data source sync will fail and no web pages will be ingested.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** rateLimit **
The max rate at which pages are crawled, up to 300 per minute per host.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 300.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/WebCrawlerLimits)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/WebCrawlerLimits)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/WebCrawlerLimits)
# WebDataSourceConfiguration
The configuration details for the web data source.
## Contents
** sourceConfiguration **
The source configuration details for the web data source.
Type: [WebSourceConfiguration](API_agent_WebSourceConfiguration.md) object
Required: Yes
** crawlerConfiguration **
The Web Crawler configuration details for the web data source.
Type: [WebCrawlerConfiguration](API_agent_WebCrawlerConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/WebDataSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/WebDataSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/WebDataSourceConfiguration)
# WebSourceConfiguration
The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs.
## Contents
** urlConfiguration **
The configuration of the URL/URLs.
Type: [UrlConfiguration](API_agent_UrlConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-2023-06-05/WebSourceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-2023-06-05/WebSourceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-2023-06-05/WebSourceConfiguration)
# Agents for Amazon Bedrock Runtime
The following data types are supported by Agents for Amazon Bedrock Runtime:
+ [ActionGroupExecutor](API_agent-runtime_ActionGroupExecutor.md)
+ [ActionGroupInvocationInput](API_agent-runtime_ActionGroupInvocationInput.md)
+ [ActionGroupInvocationOutput](API_agent-runtime_ActionGroupInvocationOutput.md)
+ [AgentActionGroup](API_agent-runtime_AgentActionGroup.md)
+ [AgentCollaboratorInputPayload](API_agent-runtime_AgentCollaboratorInputPayload.md)
+ [AgentCollaboratorInvocationInput](API_agent-runtime_AgentCollaboratorInvocationInput.md)
+ [AgentCollaboratorInvocationOutput](API_agent-runtime_AgentCollaboratorInvocationOutput.md)
+ [AgentCollaboratorOutputPayload](API_agent-runtime_AgentCollaboratorOutputPayload.md)
+ [AnalyzePromptEvent](API_agent-runtime_AnalyzePromptEvent.md)
+ [ApiInvocationInput](API_agent-runtime_ApiInvocationInput.md)
+ [ApiParameter](API_agent-runtime_ApiParameter.md)
+ [ApiRequestBody](API_agent-runtime_ApiRequestBody.md)
+ [ApiResult](API_agent-runtime_ApiResult.md)
+ [APISchema](API_agent-runtime_APISchema.md)
+ [Attribution](API_agent-runtime_Attribution.md)
+ [AudioSegment](API_agent-runtime_AudioSegment.md)
+ [BedrockModelConfigurations](API_agent-runtime_BedrockModelConfigurations.md)
+ [BedrockRerankingConfiguration](API_agent-runtime_BedrockRerankingConfiguration.md)
+ [BedrockRerankingModelConfiguration](API_agent-runtime_BedrockRerankingModelConfiguration.md)
+ [BedrockSessionContentBlock](API_agent-runtime_BedrockSessionContentBlock.md)
+ [ByteContentDoc](API_agent-runtime_ByteContentDoc.md)
+ [ByteContentFile](API_agent-runtime_ByteContentFile.md)
+ [Caller](API_agent-runtime_Caller.md)
+ [Citation](API_agent-runtime_Citation.md)
+ [CitationEvent](API_agent-runtime_CitationEvent.md)
+ [CodeInterpreterInvocationInput](API_agent-runtime_CodeInterpreterInvocationInput.md)
+ [CodeInterpreterInvocationOutput](API_agent-runtime_CodeInterpreterInvocationOutput.md)
+ [Collaborator](API_agent-runtime_Collaborator.md)
+ [CollaboratorConfiguration](API_agent-runtime_CollaboratorConfiguration.md)
+ [ConditionResultEvent](API_agent-runtime_ConditionResultEvent.md)
+ [ContentBlock](API_agent-runtime_ContentBlock.md)
+ [ContentBody](API_agent-runtime_ContentBody.md)
+ [ConversationHistory](API_agent-runtime_ConversationHistory.md)
+ [CustomOrchestration](API_agent-runtime_CustomOrchestration.md)
+ [CustomOrchestrationTrace](API_agent-runtime_CustomOrchestrationTrace.md)
+ [CustomOrchestrationTraceEvent](API_agent-runtime_CustomOrchestrationTraceEvent.md)
+ [ExternalSource](API_agent-runtime_ExternalSource.md)
+ [ExternalSourcesGenerationConfiguration](API_agent-runtime_ExternalSourcesGenerationConfiguration.md)
+ [ExternalSourcesRetrieveAndGenerateConfiguration](API_agent-runtime_ExternalSourcesRetrieveAndGenerateConfiguration.md)
+ [FailureTrace](API_agent-runtime_FailureTrace.md)
+ [FieldForReranking](API_agent-runtime_FieldForReranking.md)
+ [FilePart](API_agent-runtime_FilePart.md)
+ [FileSource](API_agent-runtime_FileSource.md)
+ [FilterAttribute](API_agent-runtime_FilterAttribute.md)
+ [FinalResponse](API_agent-runtime_FinalResponse.md)
+ [FlowCompletionEvent](API_agent-runtime_FlowCompletionEvent.md)
+ [FlowExecutionContent](API_agent-runtime_FlowExecutionContent.md)
+ [FlowExecutionError](API_agent-runtime_FlowExecutionError.md)
+ [FlowExecutionEvent](API_agent-runtime_FlowExecutionEvent.md)
+ [FlowExecutionInputEvent](API_agent-runtime_FlowExecutionInputEvent.md)
+ [FlowExecutionOutputEvent](API_agent-runtime_FlowExecutionOutputEvent.md)
+ [FlowExecutionSummary](API_agent-runtime_FlowExecutionSummary.md)
+ [FlowFailureEvent](API_agent-runtime_FlowFailureEvent.md)
+ [FlowInput](API_agent-runtime_FlowInput.md)
+ [FlowInputContent](API_agent-runtime_FlowInputContent.md)
+ [FlowInputField](API_agent-runtime_FlowInputField.md)
+ [FlowMultiTurnInputContent](API_agent-runtime_FlowMultiTurnInputContent.md)
+ [FlowMultiTurnInputRequestEvent](API_agent-runtime_FlowMultiTurnInputRequestEvent.md)
+ [FlowOutputContent](API_agent-runtime_FlowOutputContent.md)
+ [FlowOutputEvent](API_agent-runtime_FlowOutputEvent.md)
+ [FlowOutputField](API_agent-runtime_FlowOutputField.md)
+ [FlowResponseStream](API_agent-runtime_FlowResponseStream.md)
+ [FlowTrace](API_agent-runtime_FlowTrace.md)
+ [FlowTraceCondition](API_agent-runtime_FlowTraceCondition.md)
+ [FlowTraceConditionNodeResultEvent](API_agent-runtime_FlowTraceConditionNodeResultEvent.md)
+ [FlowTraceDependencyEvent](API_agent-runtime_FlowTraceDependencyEvent.md)
+ [FlowTraceEvent](API_agent-runtime_FlowTraceEvent.md)
+ [FlowTraceNodeActionEvent](API_agent-runtime_FlowTraceNodeActionEvent.md)
+ [FlowTraceNodeInputContent](API_agent-runtime_FlowTraceNodeInputContent.md)
+ [FlowTraceNodeInputEvent](API_agent-runtime_FlowTraceNodeInputEvent.md)
+ [FlowTraceNodeInputExecutionChainItem](API_agent-runtime_FlowTraceNodeInputExecutionChainItem.md)
+ [FlowTraceNodeInputField](API_agent-runtime_FlowTraceNodeInputField.md)
+ [FlowTraceNodeInputSource](API_agent-runtime_FlowTraceNodeInputSource.md)
+ [FlowTraceNodeOutputContent](API_agent-runtime_FlowTraceNodeOutputContent.md)
+ [FlowTraceNodeOutputEvent](API_agent-runtime_FlowTraceNodeOutputEvent.md)
+ [FlowTraceNodeOutputField](API_agent-runtime_FlowTraceNodeOutputField.md)
+ [FlowTraceNodeOutputNext](API_agent-runtime_FlowTraceNodeOutputNext.md)
+ [FunctionDefinition](API_agent-runtime_FunctionDefinition.md)
+ [FunctionInvocationInput](API_agent-runtime_FunctionInvocationInput.md)
+ [FunctionParameter](API_agent-runtime_FunctionParameter.md)
+ [FunctionResult](API_agent-runtime_FunctionResult.md)
+ [FunctionSchema](API_agent-runtime_FunctionSchema.md)
+ [GeneratedQuery](API_agent-runtime_GeneratedQuery.md)
+ [GeneratedResponsePart](API_agent-runtime_GeneratedResponsePart.md)
+ [GenerationConfiguration](API_agent-runtime_GenerationConfiguration.md)
+ [GuardrailAssessment](API_agent-runtime_GuardrailAssessment.md)
+ [GuardrailConfiguration](API_agent-runtime_GuardrailConfiguration.md)
+ [GuardrailConfigurationWithArn](API_agent-runtime_GuardrailConfigurationWithArn.md)
+ [GuardrailContentFilter](API_agent-runtime_GuardrailContentFilter.md)
+ [GuardrailContentPolicyAssessment](API_agent-runtime_GuardrailContentPolicyAssessment.md)
+ [GuardrailCustomWord](API_agent-runtime_GuardrailCustomWord.md)
+ [GuardrailEvent](API_agent-runtime_GuardrailEvent.md)
+ [GuardrailManagedWord](API_agent-runtime_GuardrailManagedWord.md)
+ [GuardrailPiiEntityFilter](API_agent-runtime_GuardrailPiiEntityFilter.md)
+ [GuardrailRegexFilter](API_agent-runtime_GuardrailRegexFilter.md)
+ [GuardrailSensitiveInformationPolicyAssessment](API_agent-runtime_GuardrailSensitiveInformationPolicyAssessment.md)
+ [GuardrailTopic](API_agent-runtime_GuardrailTopic.md)
+ [GuardrailTopicPolicyAssessment](API_agent-runtime_GuardrailTopicPolicyAssessment.md)
+ [GuardrailTrace](API_agent-runtime_GuardrailTrace.md)
+ [GuardrailWordPolicyAssessment](API_agent-runtime_GuardrailWordPolicyAssessment.md)
+ [ImageBlock](API_agent-runtime_ImageBlock.md)
+ [ImageInput](API_agent-runtime_ImageInput.md)
+ [ImageInputSource](API_agent-runtime_ImageInputSource.md)
+ [ImageSource](API_agent-runtime_ImageSource.md)
+ [ImplicitFilterConfiguration](API_agent-runtime_ImplicitFilterConfiguration.md)
+ [InferenceConfig](API_agent-runtime_InferenceConfig.md)
+ [InferenceConfiguration](API_agent-runtime_InferenceConfiguration.md)
+ [InlineAgentFilePart](API_agent-runtime_InlineAgentFilePart.md)
+ [InlineAgentPayloadPart](API_agent-runtime_InlineAgentPayloadPart.md)
+ [InlineAgentResponseStream](API_agent-runtime_InlineAgentResponseStream.md)
+ [InlineAgentReturnControlPayload](API_agent-runtime_InlineAgentReturnControlPayload.md)
+ [InlineAgentTracePart](API_agent-runtime_InlineAgentTracePart.md)
+ [InlineBedrockModelConfigurations](API_agent-runtime_InlineBedrockModelConfigurations.md)
+ [InlineSessionState](API_agent-runtime_InlineSessionState.md)
+ [InputFile](API_agent-runtime_InputFile.md)
+ [InputImage](API_agent-runtime_InputImage.md)
+ [InputPrompt](API_agent-runtime_InputPrompt.md)
+ [InvocationInput](API_agent-runtime_InvocationInput.md)
+ [InvocationInputMember](API_agent-runtime_InvocationInputMember.md)
+ [InvocationResultMember](API_agent-runtime_InvocationResultMember.md)
+ [InvocationStep](API_agent-runtime_InvocationStep.md)
+ [InvocationStepPayload](API_agent-runtime_InvocationStepPayload.md)
+ [InvocationStepSummary](API_agent-runtime_InvocationStepSummary.md)
+ [InvocationSummary](API_agent-runtime_InvocationSummary.md)
+ [KnowledgeBase](API_agent-runtime_KnowledgeBase.md)
+ [KnowledgeBaseConfiguration](API_agent-runtime_KnowledgeBaseConfiguration.md)
+ [KnowledgeBaseLookupInput](API_agent-runtime_KnowledgeBaseLookupInput.md)
+ [KnowledgeBaseLookupOutput](API_agent-runtime_KnowledgeBaseLookupOutput.md)
+ [KnowledgeBaseQuery](API_agent-runtime_KnowledgeBaseQuery.md)
+ [KnowledgeBaseRetrievalConfiguration](API_agent-runtime_KnowledgeBaseRetrievalConfiguration.md)
+ [KnowledgeBaseRetrievalResult](API_agent-runtime_KnowledgeBaseRetrievalResult.md)
+ [KnowledgeBaseRetrieveAndGenerateConfiguration](API_agent-runtime_KnowledgeBaseRetrieveAndGenerateConfiguration.md)
+ [KnowledgeBaseVectorSearchConfiguration](API_agent-runtime_KnowledgeBaseVectorSearchConfiguration.md)
+ [Memory](API_agent-runtime_Memory.md)
+ [MemorySessionSummary](API_agent-runtime_MemorySessionSummary.md)
+ [Message](API_agent-runtime_Message.md)
+ [Metadata](API_agent-runtime_Metadata.md)
+ [MetadataAttributeSchema](API_agent-runtime_MetadataAttributeSchema.md)
+ [MetadataConfigurationForReranking](API_agent-runtime_MetadataConfigurationForReranking.md)
+ [ModelInvocationInput](API_agent-runtime_ModelInvocationInput.md)
+ [ModelPerformanceConfiguration](API_agent-runtime_ModelPerformanceConfiguration.md)
+ [NodeActionEvent](API_agent-runtime_NodeActionEvent.md)
+ [NodeDependencyEvent](API_agent-runtime_NodeDependencyEvent.md)
+ [NodeExecutionContent](API_agent-runtime_NodeExecutionContent.md)
+ [NodeFailureEvent](API_agent-runtime_NodeFailureEvent.md)
+ [NodeInputEvent](API_agent-runtime_NodeInputEvent.md)
+ [NodeInputExecutionChainItem](API_agent-runtime_NodeInputExecutionChainItem.md)
+ [NodeInputField](API_agent-runtime_NodeInputField.md)
+ [NodeInputSource](API_agent-runtime_NodeInputSource.md)
+ [NodeOutputEvent](API_agent-runtime_NodeOutputEvent.md)
+ [NodeOutputField](API_agent-runtime_NodeOutputField.md)
+ [NodeOutputNext](API_agent-runtime_NodeOutputNext.md)
+ [NodeTraceElements](API_agent-runtime_NodeTraceElements.md)
+ [Observation](API_agent-runtime_Observation.md)
+ [OptimizedPrompt](API_agent-runtime_OptimizedPrompt.md)
+ [OptimizedPromptEvent](API_agent-runtime_OptimizedPromptEvent.md)
+ [OptimizedPromptStream](API_agent-runtime_OptimizedPromptStream.md)
+ [OrchestrationConfiguration](API_agent-runtime_OrchestrationConfiguration.md)
+ [OrchestrationExecutor](API_agent-runtime_OrchestrationExecutor.md)
+ [OrchestrationModelInvocationOutput](API_agent-runtime_OrchestrationModelInvocationOutput.md)
+ [OrchestrationTrace](API_agent-runtime_OrchestrationTrace.md)
+ [OutputFile](API_agent-runtime_OutputFile.md)
+ [Parameter](API_agent-runtime_Parameter.md)
+ [ParameterDetail](API_agent-runtime_ParameterDetail.md)
+ [PayloadPart](API_agent-runtime_PayloadPart.md)
+ [PerformanceConfiguration](API_agent-runtime_PerformanceConfiguration.md)
+ [PostProcessingModelInvocationOutput](API_agent-runtime_PostProcessingModelInvocationOutput.md)
+ [PostProcessingParsedResponse](API_agent-runtime_PostProcessingParsedResponse.md)
+ [PostProcessingTrace](API_agent-runtime_PostProcessingTrace.md)
+ [PreProcessingModelInvocationOutput](API_agent-runtime_PreProcessingModelInvocationOutput.md)
+ [PreProcessingParsedResponse](API_agent-runtime_PreProcessingParsedResponse.md)
+ [PreProcessingTrace](API_agent-runtime_PreProcessingTrace.md)
+ [PromptConfiguration](API_agent-runtime_PromptConfiguration.md)
+ [PromptCreationConfigurations](API_agent-runtime_PromptCreationConfigurations.md)
+ [PromptOverrideConfiguration](API_agent-runtime_PromptOverrideConfiguration.md)
+ [PromptTemplate](API_agent-runtime_PromptTemplate.md)
+ [PropertyParameters](API_agent-runtime_PropertyParameters.md)
+ [QueryGenerationInput](API_agent-runtime_QueryGenerationInput.md)
+ [QueryTransformationConfiguration](API_agent-runtime_QueryTransformationConfiguration.md)
+ [Rationale](API_agent-runtime_Rationale.md)
+ [RawResponse](API_agent-runtime_RawResponse.md)
+ [ReasoningContentBlock](API_agent-runtime_ReasoningContentBlock.md)
+ [ReasoningTextBlock](API_agent-runtime_ReasoningTextBlock.md)
+ [RepromptResponse](API_agent-runtime_RepromptResponse.md)
+ [RequestBody](API_agent-runtime_RequestBody.md)
+ [RerankDocument](API_agent-runtime_RerankDocument.md)
+ [RerankingConfiguration](API_agent-runtime_RerankingConfiguration.md)
+ [RerankingMetadataSelectiveModeConfiguration](API_agent-runtime_RerankingMetadataSelectiveModeConfiguration.md)
+ [RerankQuery](API_agent-runtime_RerankQuery.md)
+ [RerankResult](API_agent-runtime_RerankResult.md)
+ [RerankSource](API_agent-runtime_RerankSource.md)
+ [RerankTextDocument](API_agent-runtime_RerankTextDocument.md)
+ [ResponseStream](API_agent-runtime_ResponseStream.md)
+ [RetrievalFilter](API_agent-runtime_RetrievalFilter.md)
+ [RetrievalResultConfluenceLocation](API_agent-runtime_RetrievalResultConfluenceLocation.md)
+ [RetrievalResultContent](API_agent-runtime_RetrievalResultContent.md)
+ [RetrievalResultContentColumn](API_agent-runtime_RetrievalResultContentColumn.md)
+ [RetrievalResultCustomDocumentLocation](API_agent-runtime_RetrievalResultCustomDocumentLocation.md)
+ [RetrievalResultKendraDocumentLocation](API_agent-runtime_RetrievalResultKendraDocumentLocation.md)
+ [RetrievalResultLocation](API_agent-runtime_RetrievalResultLocation.md)
+ [RetrievalResultS3Location](API_agent-runtime_RetrievalResultS3Location.md)
+ [RetrievalResultSalesforceLocation](API_agent-runtime_RetrievalResultSalesforceLocation.md)
+ [RetrievalResultSharePointLocation](API_agent-runtime_RetrievalResultSharePointLocation.md)
+ [RetrievalResultSqlLocation](API_agent-runtime_RetrievalResultSqlLocation.md)
+ [RetrievalResultWebLocation](API_agent-runtime_RetrievalResultWebLocation.md)
+ [RetrieveAndGenerateConfiguration](API_agent-runtime_RetrieveAndGenerateConfiguration.md)
+ [RetrieveAndGenerateInput](API_agent-runtime_RetrieveAndGenerateInput.md)
+ [RetrieveAndGenerateOutput](API_agent-runtime_RetrieveAndGenerateOutput.md)
+ [RetrieveAndGenerateOutputEvent](API_agent-runtime_RetrieveAndGenerateOutputEvent.md)
+ [RetrieveAndGenerateSessionConfiguration](API_agent-runtime_RetrieveAndGenerateSessionConfiguration.md)
+ [RetrieveAndGenerateStreamResponseOutput](API_agent-runtime_RetrieveAndGenerateStreamResponseOutput.md)
+ [RetrievedReference](API_agent-runtime_RetrievedReference.md)
+ [ReturnControlPayload](API_agent-runtime_ReturnControlPayload.md)
+ [ReturnControlResults](API_agent-runtime_ReturnControlResults.md)
+ [RoutingClassifierModelInvocationOutput](API_agent-runtime_RoutingClassifierModelInvocationOutput.md)
+ [RoutingClassifierTrace](API_agent-runtime_RoutingClassifierTrace.md)
+ [S3Identifier](API_agent-runtime_S3Identifier.md)
+ [S3Location](API_agent-runtime_S3Location.md)
+ [S3ObjectDoc](API_agent-runtime_S3ObjectDoc.md)
+ [S3ObjectFile](API_agent-runtime_S3ObjectFile.md)
+ [SatisfiedCondition](API_agent-runtime_SatisfiedCondition.md)
+ [SessionState](API_agent-runtime_SessionState.md)
+ [SessionSummary](API_agent-runtime_SessionSummary.md)
+ [Span](API_agent-runtime_Span.md)
+ [StreamingConfigurations](API_agent-runtime_StreamingConfigurations.md)
+ [TextInferenceConfig](API_agent-runtime_TextInferenceConfig.md)
+ [TextPrompt](API_agent-runtime_TextPrompt.md)
+ [TextResponsePart](API_agent-runtime_TextResponsePart.md)
+ [TextToSqlConfiguration](API_agent-runtime_TextToSqlConfiguration.md)
+ [TextToSqlKnowledgeBaseConfiguration](API_agent-runtime_TextToSqlKnowledgeBaseConfiguration.md)
+ [Trace](API_agent-runtime_Trace.md)
+ [TraceElements](API_agent-runtime_TraceElements.md)
+ [TracePart](API_agent-runtime_TracePart.md)
+ [TransformationConfiguration](API_agent-runtime_TransformationConfiguration.md)
+ [Usage](API_agent-runtime_Usage.md)
+ [VectorSearchBedrockRerankingConfiguration](API_agent-runtime_VectorSearchBedrockRerankingConfiguration.md)
+ [VectorSearchBedrockRerankingModelConfiguration](API_agent-runtime_VectorSearchBedrockRerankingModelConfiguration.md)
+ [VectorSearchRerankingConfiguration](API_agent-runtime_VectorSearchRerankingConfiguration.md)
+ [VideoSegment](API_agent-runtime_VideoSegment.md)
# ActionGroupExecutor
Contains details about 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.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** customControl **
To return the action group invocation results directly in the `InvokeInlineAgent` response, specify `RETURN_CONTROL`.
Type: String
Valid Values: `RETURN_CONTROL`
Required: No
** lambda **
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ActionGroupExecutor)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ActionGroupExecutor)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ActionGroupExecutor)
# ActionGroupInvocationInput
Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in [OrchestrationTrace](https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html) in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
## Contents
** actionGroupName **
The name of the action group.
Type: String
Required: No
** apiPath **
The path to the API to call, based off the action group.
Type: String
Required: No
** executionType **
How fulfillment of the action is handled. For more information, see [Handling fulfillment of the action](https://docs.aws.amazon.com/bedrock/latest/userguide/action-handle.html).
Type: String
Valid Values: `LAMBDA | RETURN_CONTROL`
Required: No
** function **
The function in the action group to call.
Type: String
Required: No
** invocationId **
The unique identifier of the invocation. Only returned if the `executionType` is `RETURN_CONTROL`.
Type: String
Required: No
** parameters **
The parameters in the Lambda input event.
Type: Array of [Parameter](API_agent-runtime_Parameter.md) objects
Required: No
** requestBody **
The parameters in the request body for the Lambda input event.
Type: [RequestBody](API_agent-runtime_RequestBody.md) object
Required: No
** verb **
The API method being used, based off the action group.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ActionGroupInvocationInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ActionGroupInvocationInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ActionGroupInvocationInput)
# ActionGroupInvocationOutput
Contains the JSON-formatted string returned by the API invoked by the action group.
## Contents
** metadata **
Contains information about the action group output.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** text **
The JSON-formatted string returned by the API invoked by the action group.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ActionGroupInvocationOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ActionGroupInvocationOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ActionGroupInvocationOutput)
# AgentActionGroup
Contains details of the inline agent's action group.
## Contents
** actionGroupName **
The name of the action group.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** actionGroupExecutor **
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-runtime_ActionGroupExecutor.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** apiSchema **
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-runtime_APISchema.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** description **
A description of the action group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: No
** functionSchema **
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
Type: [FunctionSchema](API_agent-runtime_FunctionSchema.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** parentActionGroupSignature **
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/agent-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 **
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/agent-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
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/AgentActionGroup)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/AgentActionGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/AgentActionGroup)
# AgentCollaboratorInputPayload
Input for an agent collaborator. The input can be text or an action invocation result.
## Contents
** returnControlResults **
An action invocation result.
Type: [ReturnControlResults](API_agent-runtime_ReturnControlResults.md) object
Required: No
** text **
Input text.
Type: String
Required: No
** type **
The input type.
Type: String
Valid Values: `TEXT | RETURN_CONTROL`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInputPayload)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInputPayload)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInputPayload)
# AgentCollaboratorInvocationInput
An agent collaborator invocation input.
## Contents
** agentCollaboratorAliasArn **
The collaborator's alias ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}`
Required: No
** agentCollaboratorName **
The collaborator's name.
Type: String
Required: No
** input **
Text or action invocation result input for the collaborator.
Type: [AgentCollaboratorInputPayload](API_agent-runtime_AgentCollaboratorInputPayload.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInvocationInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInvocationInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInvocationInput)
# AgentCollaboratorInvocationOutput
Output from an agent collaborator.
## Contents
** agentCollaboratorAliasArn **
The output's agent collaborator alias ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}`
Required: No
** agentCollaboratorName **
The output's agent collaborator name.
Type: String
Required: No
** metadata **
Contains information about the output from the agent collaborator.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** output **
The output's output.
Type: [AgentCollaboratorOutputPayload](API_agent-runtime_AgentCollaboratorOutputPayload.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInvocationOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInvocationOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInvocationOutput)
# AgentCollaboratorOutputPayload
Output from an agent collaborator. The output can be text or an action invocation result.
## Contents
** returnControlPayload **
An action invocation result.
Type: [ReturnControlPayload](API_agent-runtime_ReturnControlPayload.md) object
Required: No
** text **
Text output.
Type: String
Required: No
** type **
The type of output.
Type: String
Valid Values: `TEXT | RETURN_CONTROL`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/AgentCollaboratorOutputPayload)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/AgentCollaboratorOutputPayload)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/AgentCollaboratorOutputPayload)
# AnalyzePromptEvent
An event in which the prompt was analyzed in preparation for optimization.
## Contents
** message **
A message describing the analysis of the prompt.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/AnalyzePromptEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/AnalyzePromptEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/AnalyzePromptEvent)
# ApiInvocationInput
Contains information about the API operation that the agent predicts should be called.
This data type is used in the following API operations:
+ In the `returnControl` field of the [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax)
## Contents
** actionGroup **
The action group that the API operation belongs to.
Type: String
Required: Yes
** actionInvocationType **
Contains information about the API operation to invoke.
Type: String
Valid Values: `RESULT | USER_CONFIRMATION | USER_CONFIRMATION_AND_RESULT`
Required: No
** agentId **
The agent's ID.
Type: String
Required: No
** apiPath **
The path to the API operation.
Type: String
Required: No
** collaboratorName **
The agent collaborator's name.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** httpMethod **
The HTTP method of the API operation.
Type: String
Required: No
** parameters **
The parameters to provide for the API request, as the agent elicited from the user.
Type: Array of [ApiParameter](API_agent-runtime_ApiParameter.md) objects
Required: No
** requestBody **
The request body to provide for the API request, as the agent elicited from the user.
Type: [ApiRequestBody](API_agent-runtime_ApiRequestBody.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ApiInvocationInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ApiInvocationInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ApiInvocationInput)
# ApiParameter
Information about a parameter to provide to the API request.
This data type is used in the following API operations:
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax)
## Contents
** name **
The name of the parameter.
Type: String
Required: No
** type **
The data type for the parameter.
Type: String
Required: No
** value **
The value of the parameter.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ApiParameter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ApiParameter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ApiParameter)
# ApiRequestBody
The request body to provide for the API request, as the agent elicited from the user.
This data type is used in the following API operations:
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax)
## Contents
** content **
The content of the request body. The key of the object in this field is a media type defining the format of the request body.
Type: String to [PropertyParameters](API_agent-runtime_PropertyParameters.md) object map
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ApiRequestBody)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ApiRequestBody)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ApiRequestBody)
# ApiResult
Contains information about the API operation that was called from the action group and the response body that was returned.
This data type is used in the following API operations:
+ In the `returnControlInvocationResults` of the [InvokeAgent request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax)
## Contents
** actionGroup **
The action group that the API operation belongs to.
Type: String
Required: Yes
** agentId **
The agent's ID.
Type: String
Required: No
** apiPath **
The path to the API operation.
Type: String
Required: No
** confirmationState **
Controls the API operations or functions to invoke based on the user confirmation.
Type: String
Valid Values: `CONFIRM | DENY`
Required: No
** httpMethod **
The HTTP method for the API operation.
Type: String
Required: No
** httpStatusCode **
http status code from API execution response (for example: 200, 400, 500).
Type: Integer
Required: No
** responseBody **
The response body from the API operation. The key of the object is the content type (currently, only `TEXT` is supported). The response may be returned directly or from the Lambda function.
Type: String to [ContentBody](API_agent-runtime_ContentBody.md) object map
Required: No
** responseState **
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
Type: String
Valid Values: `FAILURE | REPROMPT`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ApiResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ApiResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ApiResult)
# APISchema
Contains details about the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** payload **
The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
Type: String
Required: No
** s3 **
Contains details about the S3 object containing the OpenAPI schema for the action group.
Type: [S3Identifier](API_agent-runtime_S3Identifier.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/APISchema)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/APISchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/APISchema)
# Attribution
Contains citations for a part of an agent response.
## Contents
** citations **
A list of citations and related information for a part of an agent response.
Type: Array of [Citation](API_agent-runtime_Citation.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Attribution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Attribution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Attribution)
# AudioSegment
Contains information about an audio segment retrieved from a knowledge base, including its location and transcription.
This data type is used in the following API operations:
+ [Retrieve response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the `audio` field
## Contents
** s3Uri **
The S3 URI where this specific audio segment is stored in the multimodal storage destination.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** transcription **
The text transcription of the audio segment content.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/AudioSegment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/AudioSegment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/AudioSegment)
# BedrockModelConfigurations
Settings for a model called with [InvokeAgent](API_agent-runtime_InvokeAgent.md).
## Contents
** performanceConfig **
The performance configuration for the model.
Type: [PerformanceConfiguration](API_agent-runtime_PerformanceConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/BedrockModelConfigurations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/BedrockModelConfigurations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/BedrockModelConfigurations)
# BedrockRerankingConfiguration
Contains configurations for an Amazon Bedrock reranker model.
## Contents
** modelConfiguration **
Contains configurations for a reranker model.
Type: [BedrockRerankingModelConfiguration](API_agent-runtime_BedrockRerankingModelConfiguration.md) object
Required: Yes
** numberOfResults **
The number of results to return after reranking.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/BedrockRerankingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/BedrockRerankingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/BedrockRerankingConfiguration)
# BedrockRerankingModelConfiguration
Contains configurations for a reranker model.
## Contents
** modelArn **
The ARN of the reranker model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?`
Required: Yes
** additionalModelRequestFields **
A JSON object whose keys are request fields for the model and whose values are values for those fields.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/BedrockRerankingModelConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/BedrockRerankingModelConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/BedrockRerankingModelConfiguration)
# BedrockSessionContentBlock
A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a session in the `payLoad` of the [PutInvocationStep](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PutInvocationStep.html) API operation. You retrieve the content with the [GetInvocationStep](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetInvocationStep.html) API operation.
For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** image **
The image in the invocation step.
Type: [ImageBlock](API_agent-runtime_ImageBlock.md) object
Required: No
** text **
The text in the invocation step.
Type: String
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/BedrockSessionContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/BedrockSessionContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/BedrockSessionContentBlock)
# ByteContentDoc
This property contains the document to chat with, along with its attributes.
## Contents
** contentType **
The MIME type of the document contained in the wrapper object.
Type: String
Pattern: `.*[a-z]{1,20}/.{1,20}.*`
Required: Yes
** data **
The byte value of the file to upload, encoded as a Base-64 string.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 10485760.
Required: Yes
** identifier **
The file name of the document contained in the wrapper object.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ByteContentDoc)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ByteContentDoc)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ByteContentDoc)
# ByteContentFile
The property contains the file to chat with, along with its attributes.
## Contents
** data **
The raw bytes of the file to attach. The maximum size of all files that is attached is 10MB. You can attach a maximum of 5 files.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 10485760.
Required: Yes
** mediaType **
The MIME type of data contained in the file used for chat.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ByteContentFile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ByteContentFile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ByteContentFile)
# Caller
Details about a caller.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** agentAliasArn **
The caller's agent alias ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Caller)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Caller)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Caller)
# Citation
An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.
This data type is used in the following API operations:
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the `citations` field
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `citations` field
## Contents
** generatedResponsePart **
Contains the generated response and metadata
Type: [GeneratedResponsePart](API_agent-runtime_GeneratedResponsePart.md) object
Required: No
** retrievedReferences **
Contains metadata about the sources cited for the generated response.
Type: Array of [RetrievedReference](API_agent-runtime_RetrievedReference.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Citation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Citation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Citation)
# CitationEvent
A citation event.
## Contents
** citation **
*This member has been deprecated.*
The citation.
Type: [Citation](API_agent-runtime_Citation.md) object
Required: No
** generatedResponsePart **
The generated response to the citation event.
Type: [GeneratedResponsePart](API_agent-runtime_GeneratedResponsePart.md) object
Required: No
** retrievedReferences **
The retrieved references of the citation event.
Type: Array of [RetrievedReference](API_agent-runtime_RetrievedReference.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CitationEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CitationEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CitationEvent)
# CodeInterpreterInvocationInput
Contains information about the code interpreter being invoked.
## Contents
** code **
The code for the code interpreter to use.
Type: String
Required: No
** files **
Files that are uploaded for code interpreter to use.
Type: Array of strings
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationInput)
# CodeInterpreterInvocationOutput
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
## Contents
** executionError **
Contains the error returned from code execution.
Type: String
Required: No
** executionOutput **
Contains the successful output returned from code execution
Type: String
Required: No
** executionTimeout **
Indicates if the execution of the code timed out.
Type: Boolean
Required: No
** files **
Contains output files, if generated by code execution.
Type: Array of strings
Required: No
** metadata **
Contains information about the output from the code interpreter.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationOutput)
# Collaborator
List of inline collaborators.
## Contents
** foundationModel **
The foundation model used by the inline collaborator agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `.*(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)`
Required: Yes
** instruction **
Instruction that tell the inline collaborator agent what it should do and how it should interact with users.
Type: String
Length Constraints: Minimum length of 40.
Required: Yes
** actionGroups **
List of action groups with each action group defining tasks the inline collaborator agent needs to carry out.
Type: Array of [AgentActionGroup](API_agent-runtime_AgentActionGroup.md) objects
Required: No
** agentCollaboration **
Defines how the inline supervisor agent handles information across multiple collaborator agents to coordinate a final response.
Type: String
Valid Values: `SUPERVISOR | SUPERVISOR_ROUTER | DISABLED`
Required: No
** agentName **
Name of the inline collaborator agent which must be the same name as specified for `collaboratorName`.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** collaboratorConfigurations **
Settings of the collaborator agent.
Type: Array of [CollaboratorConfiguration](API_agent-runtime_CollaboratorConfiguration.md) objects
Required: No
** customerEncryptionKeyArn **
The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the inline collaborator.
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
** guardrailConfiguration **
Details of the guardwrail associated with the inline collaborator.
Type: [GuardrailConfigurationWithArn](API_agent-runtime_GuardrailConfigurationWithArn.md) object
Required: No
** idleSessionTTLInSeconds **
The number of seconds for which the Amazon Bedrock keeps information about the user's conversation with the inline collaborator 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 3600.
Required: No
** knowledgeBases **
Knowledge base associated with the inline collaborator agent.
Type: Array of [KnowledgeBase](API_agent-runtime_KnowledgeBase.md) objects
Required: No
** promptOverrideConfiguration **
Contains configurations to override prompt templates in different parts of an inline collaborator sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
Type: [PromptOverrideConfiguration](API_agent-runtime_PromptOverrideConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Collaborator)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Collaborator)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Collaborator)
# CollaboratorConfiguration
Settings of an inline collaborator agent.
## Contents
** collaboratorInstruction **
Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Required: Yes
** collaboratorName **
Name of the inline collaborator agent which must be the same name as specified for `agentName`.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** agentAliasArn **
The Amazon Resource Name (ARN) of the inline collaborator agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}`
Required: No
** relayConversationHistory **
A relay conversation history for the inline collaborator agent.
Type: String
Valid Values: `TO_COLLABORATOR | DISABLED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CollaboratorConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CollaboratorConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CollaboratorConfiguration)
# ConditionResultEvent
Contains information about a condition evaluation result during a flow execution. This event is generated when a condition node in the flow evaluates its conditions.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** nodeName **
The name of the condition node that evaluated the conditions.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** satisfiedConditions **
A list of conditions that were satisfied during the evaluation.
Type: Array of [SatisfiedCondition](API_agent-runtime_SatisfiedCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** timestamp **
The timestamp when the condition evaluation occurred.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ConditionResultEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ConditionResultEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ConditionResultEvent)
# ContentBlock
A content block.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** text **
The block's text.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ContentBlock)
# ContentBody
Contains the body of the API response.
This data type is used in the following API operations:
+ In the `returnControlInvocationResults` field of the [InvokeAgent request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax)
## Contents
** body **
The body of the API response.
Type: String
Required: No
** images **
Lists details, including format and source, for the image in the response from the function call. You can specify only one image and the function in the `returnControlInvocationResults` must be a computer use action. For more information, see [Configure an Amazon Bedrock Agent to complete tasks with computer use tools](https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html).
Type: Array of [ImageInput](API_agent-runtime_ImageInput.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ContentBody)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ContentBody)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ContentBody)
# ConversationHistory
A conversation history.
## Contents
** messages **
The conversation's messages.
Type: Array of [Message](API_agent-runtime_Message.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ConversationHistory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ConversationHistory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ConversationHistory)
# CustomOrchestration
Contains details of the custom orchestration configured for the agent.
## Contents
** executor **
The structure of the executor invoking the actions in custom orchestration.
Type: [OrchestrationExecutor](API_agent-runtime_OrchestrationExecutor.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CustomOrchestration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CustomOrchestration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CustomOrchestration)
# CustomOrchestrationTrace
The trace behavior for the custom orchestration.
## Contents
** event **
The event details used with the custom orchestration.
Type: [CustomOrchestrationTraceEvent](API_agent-runtime_CustomOrchestrationTraceEvent.md) object
Required: No
** traceId **
The unique identifier of the trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CustomOrchestrationTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CustomOrchestrationTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CustomOrchestrationTrace)
# CustomOrchestrationTraceEvent
The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
## Contents
** text **
The text that prompted the event at this step.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/CustomOrchestrationTraceEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/CustomOrchestrationTraceEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/CustomOrchestrationTraceEvent)
# ExternalSource
The unique external source of the content contained in the wrapper object.
## Contents
** sourceType **
The source type of the external source wrapper object.
Type: String
Valid Values: `S3 | BYTE_CONTENT`
Required: Yes
** byteContent **
The identifier, contentType, and data of the external source wrapper object.
Type: [ByteContentDoc](API_agent-runtime_ByteContentDoc.md) object
Required: No
** s3Location **
The S3 location of the external source wrapper object.
Type: [S3ObjectDoc](API_agent-runtime_S3ObjectDoc.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ExternalSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ExternalSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ExternalSource)
# ExternalSourcesGenerationConfiguration
Contains the generation configuration of the external source wrapper object.
## Contents
** additionalModelRequestFields **
Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** guardrailConfiguration **
The configuration details for the guardrail.
Type: [GuardrailConfiguration](API_agent-runtime_GuardrailConfiguration.md) object
Required: No
** inferenceConfig **
Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
Type: [InferenceConfig](API_agent-runtime_InferenceConfig.md) object
Required: No
** performanceConfig **
The latency configuration for the model.
Type: [PerformanceConfiguration](API_agent-runtime_PerformanceConfiguration.md) object
Required: No
** promptTemplate **
Contain the textPromptTemplate string for the external source wrapper object.
Type: [PromptTemplate](API_agent-runtime_PromptTemplate.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ExternalSourcesGenerationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ExternalSourcesGenerationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ExternalSourcesGenerationConfiguration)
# ExternalSourcesRetrieveAndGenerateConfiguration
The configurations of the external source wrapper object in the `retrieveAndGenerate` function.
## Contents
** modelArn **
The model Amazon Resource Name (ARN) for the external source wrapper object in the `retrieveAndGenerate` function.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?`
Required: Yes
** sources **
The document for the external source wrapper object in the `retrieveAndGenerate` function.
Type: Array of [ExternalSource](API_agent-runtime_ExternalSource.md) objects
Array Members: Fixed number of 1 item.
Required: Yes
** generationConfiguration **
The prompt used with the external source wrapper object with the `retrieveAndGenerate` function.
Type: [ExternalSourcesGenerationConfiguration](API_agent-runtime_ExternalSourcesGenerationConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ExternalSourcesRetrieveAndGenerateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ExternalSourcesRetrieveAndGenerateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ExternalSourcesRetrieveAndGenerateConfiguration)
# FailureTrace
Contains information about the failure of the interaction.
## Contents
** failureCode **
The failure code for the trace.
Type: Integer
Required: No
** failureReason **
The reason the interaction failed.
Type: String
Required: No
** metadata **
Information about the failure that occurred.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** traceId **
The unique identifier of the trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FailureTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FailureTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FailureTrace)
# FieldForReranking
Contains information for a metadata field to include in or exclude from consideration when reranking.
## Contents
** fieldName **
The name of a metadata field to include in or exclude from consideration when reranking.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FieldForReranking)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FieldForReranking)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FieldForReranking)
# FilePart
Contains intermediate response for code interpreter if any files have been generated.
## Contents
** files **
Files containing intermediate response for the user.
Type: Array of [OutputFile](API_agent-runtime_OutputFile.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FilePart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FilePart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FilePart)
# FileSource
The source file of the content contained in the wrapper object.
## Contents
** sourceType **
The source type of the files to attach.
Type: String
Valid Values: `S3 | BYTE_CONTENT`
Required: Yes
** byteContent **
The data and the text of the attached files.
Type: [ByteContentFile](API_agent-runtime_ByteContentFile.md) object
Required: No
** s3Location **
The s3 location of the files to attach.
Type: [S3ObjectFile](API_agent-runtime_S3ObjectFile.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FileSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FileSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FileSource)
# FilterAttribute
Specifies the name that the metadata attribute must match and the value to which to compare the value of the metadata attribute. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
This data type is used in the following API operations:
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax)
## Contents
** key **
The name that the metadata attribute must match.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
** value **
The value to whcih to compare the value of the metadata attribute.
Type: JSON value
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FilterAttribute)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FilterAttribute)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FilterAttribute)
# FinalResponse
Contains details about the response to the user.
## Contents
** metadata **
Contains information about the invoke agent operation.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** text **
The text in the response to the user.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FinalResponse)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FinalResponse)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FinalResponse)
# FlowCompletionEvent
Contains information about why a flow completed.
## Contents
** completionReason **
The reason that the flow completed.
Type: String
Valid Values: `SUCCESS | INPUT_REQUIRED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowCompletionEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowCompletionEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowCompletionEvent)
# FlowExecutionContent
Contains the content of an flow execution input or output field.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** document **
The document content of the field, which can contain text or structured data.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowExecutionContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowExecutionContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowExecutionContent)
# FlowExecutionError
Contains information about an error that occurred during an flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** error **
The error code for the type of error that occurred.
Type: String
Valid Values: `ExecutionTimedOut`
Required: No
** message **
A descriptive message that provides details about the error.
Type: String
Required: No
** nodeName **
The name of the node in the flow where the error occurred (if applicable).
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowExecutionError)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowExecutionError)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowExecutionError)
# FlowExecutionEvent
Represents an event that occurred during an flow execution. This is a union type that can contain one of several event types, such as node input and output events; flow input and output events; condition node result events, or failure events.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** conditionResultEvent **
Contains information about a condition evaluation result during the flow execution. This event is generated when a condition node in the flow evaluates its conditions.
Type: [ConditionResultEvent](API_agent-runtime_ConditionResultEvent.md) object
Required: No
** flowFailureEvent **
Contains information about a failure that occurred at the flow level during execution.
Type: [FlowFailureEvent](API_agent-runtime_FlowFailureEvent.md) object
Required: No
** flowInputEvent **
Contains information about the inputs provided to the flow at the start of execution.
Type: [FlowExecutionInputEvent](API_agent-runtime_FlowExecutionInputEvent.md) object
Required: No
** flowOutputEvent **
Contains information about the outputs produced by the flow at the end of execution.
Type: [FlowExecutionOutputEvent](API_agent-runtime_FlowExecutionOutputEvent.md) object
Required: No
** nodeActionEvent **
Contains information about an action (operation) called by a node during execution.
Type: [NodeActionEvent](API_agent-runtime_NodeActionEvent.md) object
Required: No
** nodeDependencyEvent **
Contains information about an internal trace of a specific node during execution.
Type: [NodeDependencyEvent](API_agent-runtime_NodeDependencyEvent.md) object
Required: No
** nodeFailureEvent **
Contains information about a failure that occurred at a specific node during execution.
Type: [NodeFailureEvent](API_agent-runtime_NodeFailureEvent.md) object
Required: No
** nodeInputEvent **
Contains information about the inputs provided to a specific node during execution.
Type: [NodeInputEvent](API_agent-runtime_NodeInputEvent.md) object
Required: No
** nodeOutputEvent **
Contains information about the outputs produced by a specific node during execution.
Type: [NodeOutputEvent](API_agent-runtime_NodeOutputEvent.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowExecutionEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowExecutionEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowExecutionEvent)
# FlowExecutionInputEvent
Contains information about the inputs provided to the flow at the start of a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** fields **
A list of input fields provided to the flow.
Type: Array of [FlowInputField](API_agent-runtime_FlowInputField.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** nodeName **
The name of the node that receives the inputs.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The timestamp when the inputs are provided.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowExecutionInputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowExecutionInputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowExecutionInputEvent)
# FlowExecutionOutputEvent
Contains information about the outputs produced by the flow during a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** fields **
A list of output fields produced by the flow.
Type: Array of [FlowOutputField](API_agent-runtime_FlowOutputField.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** nodeName **
The name of the node that produces the outputs.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The timestamp when the outputs are produced.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowExecutionOutputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowExecutionOutputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowExecutionOutputEvent)
# FlowExecutionSummary
Contains summary information about a flow execution, including its status, timestamps, and identifiers.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** createdAt **
The timestamp when the flow execution was created.
Type: Timestamp
Required: Yes
** executionArn **
The Amazon Resource Name (ARN) that uniquely identifies the flow execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `[a-zA-Z0-9-]{1,36}$|^(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10}/execution/[a-zA-Z0-9-]{1,36})`
Required: Yes
** flowAliasIdentifier **
The unique identifier of the flow alias used for the execution.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}/alias/[0-9a-zA-Z]{10})|(\bTSTALIASID\b|[0-9a-zA-Z]+)`
Required: Yes
** flowIdentifier **
The unique identifier of the flow.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
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 **
The version of the flow used for the execution.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})`
Required: Yes
** status **
The current status of the flow execution.
Flow executions time out after 24 hours.
Type: String
Valid Values: `Running | Succeeded | Failed | TimedOut | Aborted`
Required: Yes
** endedAt **
The timestamp when the flow execution ended. This field is only populated when the execution has completed, failed, timed out, or been aborted.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowExecutionSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowExecutionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowExecutionSummary)
# FlowFailureEvent
Contains information about a failure that occurred at the flow level during a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** errorCode **
The error code that identifies the type of failure that occurred.
Type: String
Valid Values: `VALIDATION | INTERNAL_SERVER | NODE_EXECUTION_FAILED`
Required: Yes
** errorMessage **
A descriptive message that provides details about the failure.
Type: String
Required: Yes
** timestamp **
The timestamp when the failure occurred.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowFailureEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowFailureEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowFailureEvent)
# FlowInput
Contains information about an input into the prompt flow and where to send it.
## Contents
** content **
Contains information about an input into the prompt flow.
Type: [FlowInputContent](API_agent-runtime_FlowInputContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** nodeName **
The name of the flow input node that begins the prompt flow.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** nodeInputName **
The name of the input from the flow input node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: No
** nodeOutputName **
The name of the output from the flow input node that begins the prompt flow.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowInput)
# FlowInputContent
Contains information about an input into the flow.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** document **
The input to send to the prompt flow input node.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowInputContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowInputContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowInputContent)
# FlowInputField
Represents an input field provided to a flow during a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** content **
The content of the input field, which can contain text or structured data.
Type: [FlowExecutionContent](API_agent-runtime_FlowExecutionContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** name **
The name of the input field as defined in the flow's input schema.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowInputField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowInputField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowInputField)
# FlowMultiTurnInputContent
The content structure containing input information for multi-turn flow interactions.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** document **
The requested additional input to send back to the multi-turn flow node.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowMultiTurnInputContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowMultiTurnInputContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowMultiTurnInputContent)
# FlowMultiTurnInputRequestEvent
Response object from the flow multi-turn node requesting additional information.
## Contents
** content **
The content payload containing the input request details for the multi-turn interaction.
Type: [FlowMultiTurnInputContent](API_agent-runtime_FlowMultiTurnInputContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** nodeName **
The name of the node in the flow that is requesting the input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** nodeType **
The type of the node in the flow that is requesting the input.
Type: String
Valid Values: `FlowInputNode | FlowOutputNode | LambdaFunctionNode | KnowledgeBaseNode | PromptNode | ConditionNode | LexNode`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowMultiTurnInputRequestEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowMultiTurnInputRequestEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowMultiTurnInputRequestEvent)
# FlowOutputContent
Contains information about the content in an output from prompt flow invocation.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** document **
The content in the output.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowOutputContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowOutputContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowOutputContent)
# FlowOutputEvent
Contains information about an output from prompt flow invoction.
## Contents
** content **
The content in the output.
Type: [FlowOutputContent](API_agent-runtime_FlowOutputContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** nodeName **
The name of the flow output node that the output is from.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** nodeType **
The type of the node that the output is from.
Type: String
Valid Values: `FlowInputNode | FlowOutputNode | LambdaFunctionNode | KnowledgeBaseNode | PromptNode | ConditionNode | LexNode`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowOutputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowOutputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowOutputEvent)
# FlowOutputField
Represents an output field produced by a flow during a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** content **
The content of the output field, which can contain text or structured data.
Type: [FlowExecutionContent](API_agent-runtime_FlowExecutionContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** name **
The name of the output field as defined in the flow's output schema.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowOutputField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowOutputField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowOutputField)
# FlowResponseStream
The output of the flow.
## Contents
** accessDeniedException **
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403
Required: No
** badGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502
Required: No
** conflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
Type: Exception
HTTP Status Code: 409
Required: No
** dependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424
Required: No
** flowCompletionEvent **
Contains information about why the flow completed.
Type: [FlowCompletionEvent](API_agent-runtime_FlowCompletionEvent.md) object
Required: No
** flowMultiTurnInputRequestEvent **
The event stream containing the multi-turn input request information from the flow.
Type: [FlowMultiTurnInputRequestEvent](API_agent-runtime_FlowMultiTurnInputRequestEvent.md) object
Required: No
** flowOutputEvent **
Contains information about an output from flow invocation.
Type: [FlowOutputEvent](API_agent-runtime_FlowOutputEvent.md) object
Required: No
** flowTraceEvent **
Contains information about a trace, which tracks an input or output for a node in the flow.
Type: [FlowTraceEvent](API_agent-runtime_FlowTraceEvent.md) object
Required: No
** internalServerException **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
Required: No
** resourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
Type: Exception
HTTP Status Code: 404
Required: No
** serviceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
Type: Exception
HTTP Status Code: 400
Required: No
** throttlingException **
The number of requests exceeds the limit. Resubmit your request later.
Type: Exception
HTTP Status Code: 429
Required: No
** validationException **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowResponseStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowResponseStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowResponseStream)
# FlowTrace
Contains information about an input or output for a node in the flow. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** conditionNodeResultTrace **
Contains information about an output from a condition node.
Type: [FlowTraceConditionNodeResultEvent](API_agent-runtime_FlowTraceConditionNodeResultEvent.md) object
Required: No
** nodeActionTrace **
Contains information about an action (operation) called by a node.
Type: [FlowTraceNodeActionEvent](API_agent-runtime_FlowTraceNodeActionEvent.md) object
Required: No
** nodeDependencyTrace **
Contains information about an internal trace of a node.
Type: [FlowTraceDependencyEvent](API_agent-runtime_FlowTraceDependencyEvent.md) object
Required: No
** nodeInputTrace **
Contains information about the input into a node.
Type: [FlowTraceNodeInputEvent](API_agent-runtime_FlowTraceNodeInputEvent.md) object
Required: No
** nodeOutputTrace **
Contains information about the output from a node.
Type: [FlowTraceNodeOutputEvent](API_agent-runtime_FlowTraceNodeOutputEvent.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTrace)
# FlowTraceCondition
Contains information about a condition that was satisfied. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
** conditionName **
The name of the condition.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceCondition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceCondition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceCondition)
# FlowTraceConditionNodeResultEvent
Contains information about an output from a condition node. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
** nodeName **
The name of the condition node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** satisfiedConditions **
An array of objects containing information about the conditions that were satisfied.
Type: Array of [FlowTraceCondition](API_agent-runtime_FlowTraceCondition.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** timestamp **
The date and time that the trace was returned.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceConditionNodeResultEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceConditionNodeResultEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceConditionNodeResultEvent)
# FlowTraceDependencyEvent
Contains information about a dependency trace event in the flow.
## Contents
** nodeName **
The name of the node that generated the dependency trace.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The date and time that the dependency trace was generated.
Type: Timestamp
Required: Yes
** traceElements **
The trace elements containing detailed information about the dependency.
Type: [TraceElements](API_agent-runtime_TraceElements.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceDependencyEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceDependencyEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceDependencyEvent)
# FlowTraceEvent
Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
** trace **
The trace object containing information about an input or output for a node in the flow.
Type: [FlowTrace](API_agent-runtime_FlowTrace.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceEvent)
# FlowTraceNodeActionEvent
Contains information about an action (operation) called by a node in an Amazon Bedrock flow. The service generates action events for calls made by prompt nodes, agent nodes, and AWS Lambda nodes.
## Contents
** nodeName **
The name of the node that called the operation.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** operationName **
The name of the operation that the node called.
Type: String
Required: Yes
** requestId **
The ID of the request that the node made to the operation.
Type: String
Required: Yes
** serviceName **
The name of the service that the node called.
Type: String
Required: Yes
** timestamp **
The date and time that the operation was called.
Type: Timestamp
Required: Yes
** operationRequest **
The request payload sent to the downstream service.
Type: JSON value
Required: No
** operationResponse **
The response payload received from the downstream service.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeActionEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeActionEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeActionEvent)
# FlowTraceNodeInputContent
Contains the content of the node input. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** document **
The content of the node input.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputContent)
# FlowTraceNodeInputEvent
Contains information about the input into a node. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
** fields **
An array of objects containing information about each field in the input.
Type: Array of [FlowTraceNodeInputField](API_agent-runtime_FlowTraceNodeInputField.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** nodeName **
The name of the node that received the input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The date and time that the trace was returned.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputEvent)
# FlowTraceNodeInputExecutionChainItem
Represents an item in the execution chain for flow trace node input tracking.
## Contents
** nodeName **
The name of the node in the execution chain.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** type **
The type of execution chain item. Supported values are Iterator and Loop.
Type: String
Valid Values: `Iterator | Loop`
Required: Yes
** index **
The index position of this item in the execution chain.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputExecutionChainItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputExecutionChainItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputExecutionChainItem)
# FlowTraceNodeInputField
Contains information about a field in the input into a node. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
** content **
The content of the node input.
Type: [FlowTraceNodeInputContent](API_agent-runtime_FlowTraceNodeInputContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** nodeInputName **
The name of the node input.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** category **
The category of the input field.
Type: String
Valid Values: `LoopCondition | ReturnValueToLoopStart | ExitLoop`
Required: No
** executionChain **
The execution path through nested nodes like iterators and loops.
Type: Array of [FlowTraceNodeInputExecutionChainItem](API_agent-runtime_FlowTraceNodeInputExecutionChainItem.md) objects
Required: No
** source **
The source node that provides input data to this field.
Type: [FlowTraceNodeInputSource](API_agent-runtime_FlowTraceNodeInputSource.md) object
Required: No
** type **
The data type of the input field for compatibility validation.
Type: String
Valid Values: `String | Number | Boolean | Object | Array`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputField)
# FlowTraceNodeInputSource
Represents the source of input data for a flow trace node field.
## Contents
** expression **
The expression used to extract data from the source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
** nodeName **
The name of the source node that provides the input data.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** outputFieldName **
The name of the output field from the source node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeInputSource)
# FlowTraceNodeOutputContent
Contains the content of the node output. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** document **
The content of the node output.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputContent)
# FlowTraceNodeOutputEvent
Contains information about the output from a node. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
** fields **
An array of objects containing information about each field in the output.
Type: Array of [FlowTraceNodeOutputField](API_agent-runtime_FlowTraceNodeOutputField.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: Yes
** nodeName **
The name of the node that yielded the output.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The date and time that the trace was returned.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputEvent)
# FlowTraceNodeOutputField
Contains information about a field in the output from a node. For more information, see [Track each step in your prompt flow by viewing its trace in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html).
## Contents
** content **
The content of the node output.
Type: [FlowTraceNodeOutputContent](API_agent-runtime_FlowTraceNodeOutputContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** nodeOutputName **
The name of the node output.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** next **
The next node that receives output data from this field.
Type: Array of [FlowTraceNodeOutputNext](API_agent-runtime_FlowTraceNodeOutputNext.md) objects
Required: No
** type **
The data type of the output field for compatibility validation.
Type: String
Valid Values: `String | Number | Boolean | Object | Array`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputField)
# FlowTraceNodeOutputNext
Represents the next node that receives output data from a flow trace.
## Contents
** inputFieldName **
The name of the input field in the next node that receives the data.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** nodeName **
The name of the next node that receives the output data.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputNext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputNext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FlowTraceNodeOutputNext)
# FunctionDefinition
Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group.
## Contents
** name **
A name for the function.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: Yes
** description **
A description of the function and its purpose.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1200.
Required: No
** parameters **
The parameters that the agent elicits from the user to fulfill the function.
Type: String to [ParameterDetail](API_agent-runtime_ParameterDetail.md) object map
Key Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** requireConfirmation **
Contains information if user confirmation is required to invoke the function.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FunctionDefinition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FunctionDefinition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FunctionDefinition)
# FunctionInvocationInput
Contains information about the function that the agent predicts should be called.
This data type is used in the following API operations:
+ In the `returnControl` field of the [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax)
## Contents
** actionGroup **
The action group that the function belongs to.
Type: String
Required: Yes
** actionInvocationType **
Contains information about the function to invoke,
Type: String
Valid Values: `RESULT | USER_CONFIRMATION | USER_CONFIRMATION_AND_RESULT`
Required: No
** agentId **
The agent's ID.
Type: String
Required: No
** collaboratorName **
The collaborator's name.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** function **
The name of the function.
Type: String
Required: No
** parameters **
A list of parameters of the function.
Type: Array of [FunctionParameter](API_agent-runtime_FunctionParameter.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FunctionInvocationInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FunctionInvocationInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FunctionInvocationInput)
# FunctionParameter
Contains information about a parameter of the function.
This data type is used in the following API operations:
+ In the `returnControl` field of the [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax)
## Contents
** name **
The name of the parameter.
Type: String
Required: No
** type **
The data type of the parameter.
Type: String
Required: No
** value **
The value of the parameter.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FunctionParameter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FunctionParameter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FunctionParameter)
# FunctionResult
Contains information about the function that was called from the action group and the response that was returned.
This data type is used in the following API operations:
+ In the `returnControlInvocationResults` of the [InvokeAgent request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax)
## Contents
** actionGroup **
The action group that the function belongs to.
Type: String
Required: Yes
** agentId **
The agent's ID.
Type: String
Required: No
** confirmationState **
Contains the user confirmation information about the function that was called.
Type: String
Valid Values: `CONFIRM | DENY`
Required: No
** function **
The name of the function that was called.
Type: String
Required: No
** responseBody **
The response from the function call using the parameters. The response might be returned directly or from the Lambda function. Specify `TEXT` or `IMAGES`. The key of the object is the content type. You can only specify one type. If you specify `IMAGES`, you can specify only one image. You can specify images only when the function in the `returnControlInvocationResults` is a computer use action. For more information, see [Configure an Amazon Bedrock Agent to complete tasks with computer use tools](https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html).
Type: String to [ContentBody](API_agent-runtime_ContentBody.md) object map
Required: No
** responseState **
Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt
Type: String
Valid Values: `FAILURE | REPROMPT`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FunctionResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FunctionResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FunctionResult)
# FunctionSchema
Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** functions **
A list of functions that each define an action in the action group.
Type: Array of [FunctionDefinition](API_agent-runtime_FunctionDefinition.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/FunctionSchema)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/FunctionSchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/FunctionSchema)
# GeneratedQuery
Contains information about a query generated for a natural language query.
## Contents
** sql **
An SQL query that corresponds to the natural language query.
Type: String
Required: No
** type **
The type of transformed query.
Type: String
Valid Values: `REDSHIFT_SQL`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GeneratedQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GeneratedQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GeneratedQuery)
# GeneratedResponsePart
Contains metadata about a part of the generated response that is accompanied by a citation.
This data type is used in the following API operations:
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the `generatedResponsePart` field
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `generatedResponsePart` field
## Contents
** textResponsePart **
Contains metadata about a textual part of the generated response that is accompanied by a citation.
Type: [TextResponsePart](API_agent-runtime_TextResponsePart.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GeneratedResponsePart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GeneratedResponsePart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GeneratedResponsePart)
# GenerationConfiguration
Contains configurations for response generation based on the knowledge base query results.
This data type is used in the following API operations:
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax)
## Contents
** additionalModelRequestFields **
Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** guardrailConfiguration **
The configuration details for the guardrail.
Type: [GuardrailConfiguration](API_agent-runtime_GuardrailConfiguration.md) object
Required: No
** inferenceConfig **
Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
Type: [InferenceConfig](API_agent-runtime_InferenceConfig.md) object
Required: No
** performanceConfig **
The latency configuration for the model.
Type: [PerformanceConfiguration](API_agent-runtime_PerformanceConfiguration.md) object
Required: No
** promptTemplate **
Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the `$search_results$` variable. For more information, see [Use placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html) in the user guide.
Type: [PromptTemplate](API_agent-runtime_PromptTemplate.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GenerationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GenerationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GenerationConfiguration)
# GuardrailAssessment
Assessment details of the content analyzed by Guardrails.
## Contents
** contentPolicy **
Content policy details of the Guardrail.
Type: [GuardrailContentPolicyAssessment](API_agent-runtime_GuardrailContentPolicyAssessment.md) object
Required: No
** sensitiveInformationPolicy **
Sensitive Information policy details of Guardrail.
Type: [GuardrailSensitiveInformationPolicyAssessment](API_agent-runtime_GuardrailSensitiveInformationPolicyAssessment.md) object
Required: No
** topicPolicy **
Topic policy details of the Guardrail.
Type: [GuardrailTopicPolicyAssessment](API_agent-runtime_GuardrailTopicPolicyAssessment.md) object
Required: No
** wordPolicy **
Word policy details of the Guardrail.
Type: [GuardrailWordPolicyAssessment](API_agent-runtime_GuardrailWordPolicyAssessment.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailAssessment)
# GuardrailConfiguration
The configuration details for the guardrail.
## Contents
** guardrailId **
The unique identifier for the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern: `[a-z0-9]+`
Required: Yes
** guardrailVersion **
The version of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(([1-9][0-9]{0,7})|(DRAFT))`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailConfiguration)
# GuardrailConfigurationWithArn
The configuration details for the guardrail.
## Contents
** guardrailIdentifier **
The unique identifier for the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: Yes
** guardrailVersion **
The version of the guardrail.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern: `(([1-9][0-9]{0,7})|(DRAFT))`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailConfigurationWithArn)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailConfigurationWithArn)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailConfigurationWithArn)
# GuardrailContentFilter
Details of the content filter used in the Guardrail.
## Contents
** action **
The action placed on the content by the Guardrail filter.
Type: String
Valid Values: `BLOCKED`
Required: No
** confidence **
The confidence level regarding the content detected in the filter by the Guardrail.
Type: String
Valid Values: `NONE | LOW | MEDIUM | HIGH`
Required: No
** type **
The type of content detected in the filter by the Guardrail.
Type: String
Valid Values: `INSULTS | HATE | SEXUAL | VIOLENCE | MISCONDUCT | PROMPT_ATTACK`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailContentFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailContentFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailContentFilter)
# GuardrailContentPolicyAssessment
The details of the policy assessment in the Guardrails filter.
## Contents
** filters **
The filter details of the policy assessment used in the Guardrails filter.
Type: Array of [GuardrailContentFilter](API_agent-runtime_GuardrailContentFilter.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailContentPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailContentPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailContentPolicyAssessment)
# GuardrailCustomWord
The custom word details for the filter in the Guardrail.
## Contents
** action **
The action details for the custom word filter in the Guardrail.
Type: String
Valid Values: `BLOCKED`
Required: No
** match **
The match details for the custom word filter in the Guardrail.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailCustomWord)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailCustomWord)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailCustomWord)
# GuardrailEvent
A guardrail event.
## Contents
** action **
The guardrail action.
Type: String
Valid Values: `INTERVENED | NONE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailEvent)
# GuardrailManagedWord
The managed word details for the filter in the Guardrail.
## Contents
** action **
The action details for the managed word filter in the Guardrail.
Type: String
Valid Values: `BLOCKED`
Required: No
** match **
The match details for the managed word filter in the Guardrail.
Type: String
Required: No
** type **
The type details for the managed word filter in the Guardrail.
Type: String
Valid Values: `PROFANITY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailManagedWord)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailManagedWord)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailManagedWord)
# GuardrailPiiEntityFilter
The Guardrail filter to identify and remove personally identifiable information (PII).
## Contents
** action **
The action of the Guardrail filter to identify and remove PII.
Type: String
Valid Values: `BLOCKED | ANONYMIZED`
Required: No
** match **
The match to settings in the Guardrail filter to identify and remove PII.
Type: String
Required: No
** type **
The type of PII the Guardrail filter has identified and removed.
Type: String
Valid Values: `ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER | CREDIT_DEBIT_CARD_CVV | CREDIT_DEBIT_CARD_EXPIRY | CREDIT_DEBIT_CARD_NUMBER | DRIVER_ID | EMAIL | INTERNATIONAL_BANK_ACCOUNT_NUMBER | IP_ADDRESS | LICENSE_PLATE | MAC_ADDRESS | NAME | PASSWORD | PHONE | PIN | SWIFT_CODE | UK_NATIONAL_HEALTH_SERVICE_NUMBER | UK_NATIONAL_INSURANCE_NUMBER | UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER | URL | USERNAME | US_BANK_ACCOUNT_NUMBER | US_BANK_ROUTING_NUMBER | US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER | US_PASSPORT_NUMBER | US_SOCIAL_SECURITY_NUMBER | VEHICLE_IDENTIFICATION_NUMBER`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailPiiEntityFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailPiiEntityFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailPiiEntityFilter)
# GuardrailRegexFilter
The details for the regex filter used in the Guardrail.
## Contents
** action **
The action details for the regex filter used in the Guardrail.
Type: String
Valid Values: `BLOCKED | ANONYMIZED`
Required: No
** match **
The match details for the regex filter used in the Guardrail.
Type: String
Required: No
** name **
The name details for the regex filter used in the Guardrail.
Type: String
Required: No
** regex **
The regex details for the regex filter used in the Guardrail.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailRegexFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailRegexFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailRegexFilter)
# GuardrailSensitiveInformationPolicyAssessment
The details of the sensitive policy assessment used in the Guardrail.
## Contents
** piiEntities **
The details of the PII entities used in the sensitive policy assessment for the Guardrail.
Type: Array of [GuardrailPiiEntityFilter](API_agent-runtime_GuardrailPiiEntityFilter.md) objects
Required: No
** regexes **
The details of the regexes used in the sensitive policy assessment for the Guardrail.
Type: Array of [GuardrailRegexFilter](API_agent-runtime_GuardrailRegexFilter.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailSensitiveInformationPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailSensitiveInformationPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailSensitiveInformationPolicyAssessment)
# GuardrailTopic
The details for a specific topic defined in the Guardrail.
## Contents
** action **
The action details on a specific topic in the Guardrail.
Type: String
Valid Values: `BLOCKED`
Required: No
** name **
The name details on a specific topic in the Guardrail.
Type: String
Required: No
** type **
The type details on a specific topic in the Guardrail.
Type: String
Valid Values: `DENY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailTopic)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailTopic)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailTopic)
# GuardrailTopicPolicyAssessment
The details of the policy assessment used in the Guardrail.
## Contents
** topics **
The topic details of the policy assessment used in the Guardrail.
Type: Array of [GuardrailTopic](API_agent-runtime_GuardrailTopic.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailTopicPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailTopicPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailTopicPolicyAssessment)
# GuardrailTrace
The trace details used in the Guardrail.
## Contents
** action **
The trace action details used with the Guardrail.
Type: String
Valid Values: `INTERVENED | NONE`
Required: No
** inputAssessments **
The details of the input assessments used in the Guardrail Trace.
Type: Array of [GuardrailAssessment](API_agent-runtime_GuardrailAssessment.md) objects
Required: No
** metadata **
Contains information about the Guardrail output.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** outputAssessments **
The details of the output assessments used in the Guardrail Trace.
Type: Array of [GuardrailAssessment](API_agent-runtime_GuardrailAssessment.md) objects
Required: No
** traceId **
The details of the trace Id used in the Guardrail Trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailTrace)
# GuardrailWordPolicyAssessment
The assessment details for words defined in the Guardrail filter.
## Contents
** customWords **
The custom word details for words defined in the Guardrail filter.
Type: Array of [GuardrailCustomWord](API_agent-runtime_GuardrailCustomWord.md) objects
Required: No
** managedWordLists **
The managed word lists for words defined in the Guardrail filter.
Type: Array of [GuardrailManagedWord](API_agent-runtime_GuardrailManagedWord.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/GuardrailWordPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/GuardrailWordPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/GuardrailWordPolicyAssessment)
# ImageBlock
Image content for an invocation step.
## Contents
** format **
The format of the image.
Type: String
Valid Values: `png | jpeg | gif | webp`
Required: Yes
** source **
The source for the image.
Type: [ImageSource](API_agent-runtime_ImageSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ImageBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ImageBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ImageBlock)
# ImageInput
Details about an image in the result from a function in the action group invocation. You can specify images only when the function is a computer use action. For more information, see [Configure an Amazon Bedrock Agent to complete tasks with computer use tools](https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html).
## Contents
** format **
The type of image in the result.
Type: String
Valid Values: `png | jpeg | gif | webp`
Required: Yes
** source **
The source of the image in the result.
Type: [ImageInputSource](API_agent-runtime_ImageInputSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ImageInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ImageInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ImageInput)
# ImageInputSource
Details about the source of an input image in the result from a function in the action group invocation.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bytes **
The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ImageInputSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ImageInputSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ImageInputSource)
# ImageSource
The source for an image.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bytes **
The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1.
Required: No
** s3Location **
The path to the Amazon S3 bucket where the image is stored.
Type: [S3Location](API_agent-runtime_S3Location.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ImageSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ImageSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ImageSource)
# ImplicitFilterConfiguration
Settings for implicit filtering, where a model generates a metadata filter based on the prompt.
## Contents
** metadataAttributes **
Metadata that can be used in a filter.
Type: Array of [MetadataAttributeSchema](API_agent-runtime_MetadataAttributeSchema.md) objects
Array Members: Minimum number of 1 item. Maximum number of 25 items.
Required: Yes
** modelArn **
The model that generates the filter.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ImplicitFilterConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ImplicitFilterConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ImplicitFilterConfiguration)
# InferenceConfig
The configuration for inference settings when generating responses using RetrieveAndGenerate.
## Contents
** textInferenceConfig **
Configuration settings specific to text generation while generating responses using RetrieveAndGenerate.
Type: [TextInferenceConfig](API_agent-runtime_TextInferenceConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InferenceConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InferenceConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InferenceConfig)
# InferenceConfiguration
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
## Contents
** maximumLength **
The maximum number of tokens allowed in the generated response.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 8192.
Required: No
** stopSequences **
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 4 items.
Required: No
** temperature **
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** topK **
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for `topK` is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set `topK` to 50, the model selects the next token from among the top 50 most likely choices.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 500.
Required: No
** topP **
While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for `Top P` determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set `topP` to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InferenceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InferenceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InferenceConfiguration)
# InlineAgentFilePart
Contains intermediate response for code interpreter if any files have been generated.
## Contents
** files **
Files containing intermediate response for the user.
Type: Array of [OutputFile](API_agent-runtime_OutputFile.md) objects
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InlineAgentFilePart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InlineAgentFilePart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InlineAgentFilePart)
# InlineAgentPayloadPart
Contains a part of an agent response and citations for it.
## Contents
** attribution **
Contains citations for a part of an agent response.
Type: [Attribution](API_agent-runtime_Attribution.md) object
Required: No
** bytes **
A part of the agent response in bytes.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InlineAgentPayloadPart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InlineAgentPayloadPart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InlineAgentPayloadPart)
# InlineAgentResponseStream
The response from invoking the agent and associated citations and trace information.
## Contents
** accessDeniedException **
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403
Required: No
** badGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502
Required: No
** chunk **
Contains a part of an agent response and citations for it.
Type: [InlineAgentPayloadPart](API_agent-runtime_InlineAgentPayloadPart.md) object
Required: No
** conflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
Type: Exception
HTTP Status Code: 409
Required: No
** dependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424
Required: No
** files **
Contains intermediate response for code interpreter if any files have been generated.
Type: [InlineAgentFilePart](API_agent-runtime_InlineAgentFilePart.md) object
Required: No
** internalServerException **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
Required: No
** resourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
Type: Exception
HTTP Status Code: 404
Required: No
** returnControl **
Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
Type: [InlineAgentReturnControlPayload](API_agent-runtime_InlineAgentReturnControlPayload.md) object
Required: No
** serviceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
Type: Exception
HTTP Status Code: 400
Required: No
** throttlingException **
The number of requests exceeds the limit. Resubmit your request later.
Type: Exception
HTTP Status Code: 429
Required: No
** trace **
Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace events](https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html).
Type: [InlineAgentTracePart](API_agent-runtime_InlineAgentTracePart.md) object
Required: No
** validationException **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InlineAgentResponseStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InlineAgentResponseStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InlineAgentResponseStream)
# InlineAgentReturnControlPayload
Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) API operation.
## Contents
** invocationId **
The identifier of the action group invocation.
Type: String
Required: No
** invocationInputs **
A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
Type: Array of [InvocationInputMember](API_agent-runtime_InvocationInputMember.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InlineAgentReturnControlPayload)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InlineAgentReturnControlPayload)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InlineAgentReturnControlPayload)
# InlineAgentTracePart
Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace enablement](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
## Contents
** callerChain **
The caller chain for the trace part.
Type: Array of [Caller](API_agent-runtime_Caller.md) objects
Required: No
** collaboratorName **
The collaborator name for the trace part.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** eventTime **
The time that trace occurred.
Type: Timestamp
Required: No
** sessionId **
The unique identifier of the session with the agent.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** trace **
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace enablement](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
Type: [Trace](API_agent-runtime_Trace.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InlineAgentTracePart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InlineAgentTracePart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InlineAgentTracePart)
# InlineBedrockModelConfigurations
Settings for a model called with [InvokeInlineAgent](API_agent-runtime_InvokeInlineAgent.md).
## Contents
** performanceConfig **
The latency configuration for the model.
Type: [PerformanceConfiguration](API_agent-runtime_PerformanceConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InlineBedrockModelConfigurations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InlineBedrockModelConfigurations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InlineBedrockModelConfigurations)
# InlineSessionState
Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a [Lambda function](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html) for an action group or pass them when making an `InvokeInlineAgent` request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior. For more information, see [Control session context](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html)
## Contents
** conversationHistory **
Contains the conversation history that persist across sessions.
Type: [ConversationHistory](API_agent-runtime_ConversationHistory.md) object
Required: No
** files **
Contains information about the files used by code interpreter.
Type: Array of [InputFile](API_agent-runtime_InputFile.md) objects
Required: No
** invocationId **
The identifier of the invocation of an action. This value must match the `invocationId` returned in the `InvokeInlineAgent` response for the action whose results are provided in the `returnControlInvocationResults` field. For more information, see [Return control to the agent developer](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html).
Type: String
Required: No
** promptSessionAttributes **
Contains attributes that persist across a session and the values of those attributes.
Type: String to string map
Required: No
** returnControlInvocationResults **
Contains information about the results from the action group invocation. For more information, see [Return control to the agent developer](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html).
If you include this field in the `sessionState` field, the `inputText` field will be ignored.
Type: Array of [InvocationResultMember](API_agent-runtime_InvocationResultMember.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
** sessionAttributes **
Contains attributes that persist across a session and the values of those attributes.
Type: String to string map
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InlineSessionState)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InlineSessionState)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InlineSessionState)
# InputFile
Contains details of the source files.
## Contents
** name **
The name of the source file.
Type: String
Required: Yes
** source **
Specifies where the files are located.
Type: [FileSource](API_agent-runtime_FileSource.md) object
Required: Yes
** useCase **
Specifies how the source files will be used by the code interpreter.
Type: String
Valid Values: `CODE_INTERPRETER | CHAT`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InputFile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InputFile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InputFile)
# InputImage
Contains the image data for multimodal knowledge base queries, including format and content.
This data type is used in the following API operations:
+ [Retrieve request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the `image` field
## Contents
** format **
The format of the input image. Supported formats include png, gif, jpeg, and webp.
Type: String
Valid Values: `png | jpeg | gif | webp`
Required: Yes
** inlineContent **
The base64-encoded image data for inline image content. Maximum size is 5MB.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1. Maximum length of 5242880.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InputImage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InputImage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InputImage)
# InputPrompt
Contains information about the prompt to optimize.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** textPrompt **
Contains information about the text prompt to optimize.
Type: [TextPrompt](API_agent-runtime_TextPrompt.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InputPrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InputPrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InputPrompt)
# InvocationInput
Contains information pertaining to the action group or knowledge base that is being invoked.
## Contents
** actionGroupInvocationInput **
Contains information about the action group to be invoked.
Type: [ActionGroupInvocationInput](API_agent-runtime_ActionGroupInvocationInput.md) object
Required: No
** agentCollaboratorInvocationInput **
The collaborator's invocation input.
Type: [AgentCollaboratorInvocationInput](API_agent-runtime_AgentCollaboratorInvocationInput.md) object
Required: No
** codeInterpreterInvocationInput **
Contains information about the code interpreter to be invoked.
Type: [CodeInterpreterInvocationInput](API_agent-runtime_CodeInterpreterInvocationInput.md) object
Required: No
** invocationType **
Specifies whether the agent is invoking an action group or a knowledge base.
Type: String
Valid Values: `ACTION_GROUP | KNOWLEDGE_BASE | FINISH | ACTION_GROUP_CODE_INTERPRETER | AGENT_COLLABORATOR`
Required: No
** knowledgeBaseLookupInput **
Contains details about the knowledge base to look up and the query to be made.
Type: [KnowledgeBaseLookupInput](API_agent-runtime_KnowledgeBaseLookupInput.md) object
Required: No
** traceId **
The unique identifier of the trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvocationInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvocationInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvocationInput)
# InvocationInputMember
Contains details about the API operation or function that the agent predicts should be called.
This data type is used in the following API operations:
+ In the `returnControl` field of the [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax)
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** apiInvocationInput **
Contains information about the API operation that the agent predicts should be called.
Type: [ApiInvocationInput](API_agent-runtime_ApiInvocationInput.md) object
Required: No
** functionInvocationInput **
Contains information about the function that the agent predicts should be called.
Type: [FunctionInvocationInput](API_agent-runtime_FunctionInvocationInput.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvocationInputMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvocationInputMember)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvocationInputMember)
# InvocationResultMember
A result from the invocation of an action. For more information, see [Return control to the agent developer](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html) and [Control session context](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
This data type is used in the following API operations:
+ [InvokeAgent request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax)
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** apiResult **
The result from the API response from the action group invocation.
Type: [ApiResult](API_agent-runtime_ApiResult.md) object
Required: No
** functionResult **
The result from the function from the action group invocation.
Type: [FunctionResult](API_agent-runtime_FunctionResult.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvocationResultMember)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvocationResultMember)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvocationResultMember)
# InvocationStep
Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Contents
** invocationId **
The unique identifier (in UUID format) for the invocation that includes the invocation step.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** invocationStepId **
The unique identifier (in UUID format) for the invocation step.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** invocationStepTime **
The timestamp for when the invocation step was created.
Type: Timestamp
Required: Yes
** payload **
Payload content, such as text and images, for the invocation step.
Type: [InvocationStepPayload](API_agent-runtime_InvocationStepPayload.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** sessionId **
The unique identifier of the session containing the invocation step.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvocationStep)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvocationStep)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvocationStep)
# InvocationStepPayload
Payload content, such as text and images, for the invocation step.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** contentBlocks **
The content for the invocation step.
Type: Array of [BedrockSessionContentBlock](API_agent-runtime_BedrockSessionContentBlock.md) objects
Array Members: Minimum number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvocationStepPayload)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvocationStepPayload)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvocationStepPayload)
# InvocationStepSummary
Contains details about an invocation step within an invocation in a session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Contents
** invocationId **
A unique identifier for the invocation in UUID format.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** invocationStepId **
The unique identifier (in UUID format) for the invocation step.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** invocationStepTime **
The timestamp for when the invocation step was created.
Type: Timestamp
Required: Yes
** sessionId **
The unique identifier for the session associated with the invocation step.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvocationStepSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvocationStepSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvocationStepSummary)
# InvocationSummary
Contains details about an invocation in a session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Contents
** createdAt **
The timestamp for when the invocation was created.
Type: Timestamp
Required: Yes
** invocationId **
A unique identifier for the invocation in UUID format.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** sessionId **
The unique identifier for the session associated with the invocation.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/InvocationSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/InvocationSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/InvocationSummary)
# KnowledgeBase
Details of the knowledge base associated withe inline agent.
## Contents
** description **
The description of the knowledge base associated with the inline agent.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
** knowledgeBaseId **
The unique identifier for a knowledge base associated with the inline agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** retrievalConfiguration **
The configurations to apply to the knowledge base during query. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
Type: [KnowledgeBaseRetrievalConfiguration](API_agent-runtime_KnowledgeBaseRetrievalConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBase)
# KnowledgeBaseConfiguration
Configurations to apply to a knowledge base attached to the agent during query. For more information, see [Knowledge base retrieval configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html#session-state-kb).
## Contents
** knowledgeBaseId **
The unique identifier for a knowledge base attached to the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** retrievalConfiguration **
The configurations to apply to the knowledge base during query. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
Type: [KnowledgeBaseRetrievalConfiguration](API_agent-runtime_KnowledgeBaseRetrievalConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBaseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBaseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBaseConfiguration)
# KnowledgeBaseLookupInput
Contains details about the knowledge base to look up and the query to be made.
## Contents
** knowledgeBaseId **
The unique identifier of the knowledge base to look up.
Type: String
Required: No
** text **
The query made to the knowledge base.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBaseLookupInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBaseLookupInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBaseLookupInput)
# KnowledgeBaseLookupOutput
Contains details about the results from looking up the knowledge base.
## Contents
** metadata **
Contains information about the knowledge base output.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** retrievedReferences **
Contains metadata about the sources cited for the generated response.
Type: Array of [RetrievedReference](API_agent-runtime_RetrievedReference.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBaseLookupOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBaseLookupOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBaseLookupOutput)
# KnowledgeBaseQuery
Contains the query made to the knowledge base.
This data type is used in the following API operations:
+ [Retrieve request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the `retrievalQuery` field
## Contents
** image **
An image to include in the knowledge base query for multimodal retrieval.
Type: [InputImage](API_agent-runtime_InputImage.md) object
Required: No
** text **
The text of the query made to the knowledge base.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 20000.
Required: No
** type **
The type of query being performed.
Type: String
Valid Values: `TEXT | IMAGE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBaseQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBaseQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBaseQuery)
# KnowledgeBaseRetrievalConfiguration
Contains configurations for knowledge base query. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
This data type is used in the following API operations:
+ [Retrieve request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the `retrievalConfiguration` field
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the `retrievalConfiguration` field
## Contents
** vectorSearchConfiguration **
Contains details about how the results from the vector search should be returned. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
Type: [KnowledgeBaseVectorSearchConfiguration](API_agent-runtime_KnowledgeBaseVectorSearchConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrievalConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrievalConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrievalConfiguration)
# KnowledgeBaseRetrievalResult
Details about a result from querying the knowledge base.
This data type is used in the following API operations:
+ [Retrieve response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the `retrievalResults` field
## Contents
** content **
Contains information about the content of the chunk.
Type: [RetrievalResultContent](API_agent-runtime_RetrievalResultContent.md) object
Required: Yes
** location **
Contains information about the location of the data source.
Type: [RetrievalResultLocation](API_agent-runtime_RetrievalResultLocation.md) object
Required: No
** metadata **
Contains metadata attributes and their values for the file in the data source. For more information, see [Metadata and filtering](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata).
Type: String to JSON value map
Map Entries: Maximum number of items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** score **
The level of relevance of the result to the query.
Type: Double
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrievalResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrievalResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrievalResult)
# KnowledgeBaseRetrieveAndGenerateConfiguration
Contains details about the resource being queried.
This data type is used in the following API operations:
+ [Retrieve request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the `knowledgeBaseConfiguration` field
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the `knowledgeBaseConfiguration` field
## Contents
** knowledgeBaseId **
The unique identifier of the knowledge base that is queried.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: Yes
** modelArn **
The ARN of the foundation model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) used to generate a response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?`
Required: Yes
** generationConfiguration **
Contains configurations for response generation based on the knowledge base query results.
Type: [GenerationConfiguration](API_agent-runtime_GenerationConfiguration.md) object
Required: No
** orchestrationConfiguration **
Settings for how the model processes the prompt prior to retrieval and generation.
Type: [OrchestrationConfiguration](API_agent-runtime_OrchestrationConfiguration.md) object
Required: No
** retrievalConfiguration **
Contains configurations for how to retrieve and return the knowledge base query.
Type: [KnowledgeBaseRetrievalConfiguration](API_agent-runtime_KnowledgeBaseRetrievalConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrieveAndGenerateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrieveAndGenerateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrieveAndGenerateConfiguration)
# KnowledgeBaseVectorSearchConfiguration
Configurations for how to perform the search query and return results. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
This data type is used in the following API operations:
+ [Retrieve request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the `vectorSearchConfiguration` field
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the `vectorSearchConfiguration` field
## Contents
** filter **
Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html).
Type: [RetrievalFilter](API_agent-runtime_RetrievalFilter.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** implicitFilterConfiguration **
Settings for implicit filtering.
Type: [ImplicitFilterConfiguration](API_agent-runtime_ImplicitFilterConfiguration.md) object
Required: No
** numberOfResults **
The number of source chunks to retrieve.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
** overrideSearchType **
By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a `HYBRID` search using both vector embeddings and raw text, or `SEMANTIC` search using only vector embeddings. For other vector store configurations, only `SEMANTIC` search is available. For more information, see [Test a knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html).
Type: String
Valid Values: `HYBRID | SEMANTIC`
Required: No
** rerankingConfiguration **
Contains configurations for reranking the retrieved results. For more information, see [Improve the relevance of query responses with a reranker model](https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html).
Type: [VectorSearchRerankingConfiguration](API_agent-runtime_VectorSearchRerankingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/KnowledgeBaseVectorSearchConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/KnowledgeBaseVectorSearchConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/KnowledgeBaseVectorSearchConfiguration)
# Memory
Contains sessions summaries.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** sessionSummary **
Contains summary of a session.
Type: [MemorySessionSummary](API_agent-runtime_MemorySessionSummary.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Memory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Memory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Memory)
# MemorySessionSummary
Contains details of a session summary.
## Contents
** memoryId **
The unique identifier of the memory where the session summary is stored.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** sessionExpiryTime **
The time when the memory duration for the session is set to end.
Type: Timestamp
Required: No
** sessionId **
The identifier for this session.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** sessionStartTime **
The start time for this session.
Type: Timestamp
Required: No
** summaryText **
The summarized text for this session.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 25000000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/MemorySessionSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/MemorySessionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/MemorySessionSummary)
# Message
Details about a message.
## Contents
** content **
The message's content.
Type: Array of [ContentBlock](API_agent-runtime_ContentBlock.md) objects
Required: Yes
** role **
The message's role.
Type: String
Valid Values: `user | assistant`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Message)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Message)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Message)
# Metadata
Provides information about the execution process for different types of invocations, such as model invocation, knowledge base invocation, agent collaborator invocation, guardrail invocation, and code interpreter Invocation.
## Contents
** clientRequestId **
A unique identifier associated with the downstream invocation. This ID can be used for tracing, debugging, and identifying specific invocations in customer logs or systems.
Type: String
Required: No
** endTime **
In the final response, `endTime` is the end time of the agent invocation operation.
Type: Timestamp
Required: No
** operationTotalTimeMs **
The total time it took for the agent to complete execution. This field is only set for the final response.
Type: Long
Required: No
** startTime **
In the final response, `startTime` is the start time of the agent invocation operation.
Type: Timestamp
Required: No
** totalTimeMs **
The total execution time for the specific invocation being processed (model, knowledge base, guardrail, agent collaborator, or code interpreter). It represents how long the individual invocation took.
Type: Long
Required: No
** usage **
Specific to model invocation and contains details about the usage of a foundation model.
Type: [Usage](API_agent-runtime_Usage.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Metadata)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Metadata)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Metadata)
# MetadataAttributeSchema
Details about a metadata attribute.
## Contents
** description **
The attribute's description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `[\s\S]+`
Required: Yes
** key **
The attribute's key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[\s\S]+`
Required: Yes
** type **
The attribute's type.
Type: String
Valid Values: `STRING | NUMBER | BOOLEAN | STRING_LIST`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/MetadataAttributeSchema)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/MetadataAttributeSchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/MetadataAttributeSchema)
# MetadataConfigurationForReranking
Contains configurations for the metadata to use in reranking.
## Contents
** selectionMode **
Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify `SELECTIVE`, include the `selectiveModeConfiguration` field.
Type: String
Valid Values: `SELECTIVE | ALL`
Required: Yes
** selectiveModeConfiguration **
Contains configurations for the metadata fields to include or exclude when considering reranking.
Type: [RerankingMetadataSelectiveModeConfiguration](API_agent-runtime_RerankingMetadataSelectiveModeConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/MetadataConfigurationForReranking)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/MetadataConfigurationForReranking)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/MetadataConfigurationForReranking)
# ModelInvocationInput
The input for the pre-processing step.
+ The `type` matches the agent step.
+ The `text` contains the prompt.
+ The `inferenceConfiguration`, `parserMode`, and `overrideLambda` values are set in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated.
## Contents
** foundationModel **
The identifier of a foundation model.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `.*(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)`
Required: No
** inferenceConfiguration **
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: [InferenceConfiguration](API_agent-runtime_InferenceConfiguration.md) object
Required: No
** overrideLambda **
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
Type: String
Required: No
** parserMode **
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`.
Type: String
Valid Values: `DEFAULT | OVERRIDDEN`
Required: No
** promptCreationMode **
Specifies whether the default prompt template was `OVERRIDDEN`. If it was, the `basePromptTemplate` that was set in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object when the agent was created or updated is used instead.
Type: String
Valid Values: `DEFAULT | OVERRIDDEN`
Required: No
** text **
The text that prompted the agent at this step.
Type: String
Required: No
** traceId **
The unique identifier of the trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
** type **
The step in the agent sequence.
Type: String
Valid Values: `PRE_PROCESSING | ORCHESTRATION | KNOWLEDGE_BASE_RESPONSE_GENERATION | POST_PROCESSING | ROUTING_CLASSIFIER`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ModelInvocationInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ModelInvocationInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ModelInvocationInput)
# ModelPerformanceConfiguration
The performance configuration for a model called with [InvokeFlow](API_agent-runtime_InvokeFlow.md).
## Contents
** performanceConfig **
The latency configuration for the model.
Type: [PerformanceConfiguration](API_agent-runtime_PerformanceConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ModelPerformanceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ModelPerformanceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ModelPerformanceConfiguration)
# NodeActionEvent
Contains information about an action (operation) called by a node during execution.
## Contents
** nodeName **
The name of the node that called the operation.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** operationName **
The name of the operation that the node called.
Type: String
Required: Yes
** requestId **
The ID of the request that the node made to the operation.
Type: String
Required: Yes
** serviceName **
The name of the service that the node called.
Type: String
Required: Yes
** timestamp **
The date and time that the operation was called.
Type: Timestamp
Required: Yes
** operationRequest **
The request payload sent to the downstream service.
Type: JSON value
Required: No
** operationResponse **
The response payload received from the downstream service.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeActionEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeActionEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeActionEvent)
# NodeDependencyEvent
Contains information about an internal trace of a specific node during execution.
## Contents
** nodeName **
The name of the node that generated the dependency trace.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The date and time that the dependency trace was generated.
Type: Timestamp
Required: Yes
** traceElements **
The trace elements containing detailed information about the node execution.
Type: [NodeTraceElements](API_agent-runtime_NodeTraceElements.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeDependencyEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeDependencyEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeDependencyEvent)
# NodeExecutionContent
Contains the content of a flow node's input or output field for a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** document **
The document content of the field, which can contain text or structured data.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeExecutionContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeExecutionContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeExecutionContent)
# NodeFailureEvent
Contains information about a failure that occurred at a specific node during a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** errorCode **
The error code that identifies the type of failure that occurred at the node.
Type: String
Valid Values: `VALIDATION | DEPENDENCY_FAILED | BAD_GATEWAY | INTERNAL_SERVER`
Required: Yes
** errorMessage **
A descriptive message that provides details about the node failure.
Type: String
Required: Yes
** nodeName **
The name of the node where the failure occurred.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The timestamp when the node failure occurred.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeFailureEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeFailureEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeFailureEvent)
# NodeInputEvent
Contains information about the inputs provided to a specific node during a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** fields **
A list of input fields provided to the node.
Type: Array of [NodeInputField](API_agent-runtime_NodeInputField.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: Yes
** nodeName **
The name of the node that received the inputs.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The timestamp when the inputs were provided to the node.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeInputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeInputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeInputEvent)
# NodeInputExecutionChainItem
Represents an item in the execution chain for node input tracking.
## Contents
** nodeName **
The name of the node in the execution chain.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** type **
The type of execution chain item. Supported values are Iterator and Loop.
Type: String
Valid Values: `Iterator | Loop`
Required: Yes
** index **
The index position of this item in the execution chain.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeInputExecutionChainItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeInputExecutionChainItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeInputExecutionChainItem)
# NodeInputField
Represents an input field provided to a node during a flow execution.
## Contents
** content **
The content of the input field, which can contain text or structured data.
Type: [NodeExecutionContent](API_agent-runtime_NodeExecutionContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** name **
The name of the input field as defined in the node's input schema.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** category **
The category of the input field.
Type: String
Valid Values: `LoopCondition | ReturnValueToLoopStart | ExitLoop`
Required: No
** executionChain **
The execution path through nested nodes like iterators and loops.
Type: Array of [NodeInputExecutionChainItem](API_agent-runtime_NodeInputExecutionChainItem.md) objects
Required: No
** source **
The source node that provides input data to this field.
Type: [NodeInputSource](API_agent-runtime_NodeInputSource.md) object
Required: No
** type **
The data type of the input field for compatibility validation.
Type: String
Valid Values: `String | Number | Boolean | Object | Array`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeInputField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeInputField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeInputField)
# NodeInputSource
Represents the source of input data for a node field.
## Contents
** expression **
The expression used to extract data from the source.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
** nodeName **
The name of the source node that provides the input data.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** outputFieldName **
The name of the output field from the source node.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeInputSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeInputSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeInputSource)
# NodeOutputEvent
Contains information about the outputs produced by a specific node during a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** fields **
A list of output fields produced by the node.
Type: Array of [NodeOutputField](API_agent-runtime_NodeOutputField.md) objects
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Required: Yes
** nodeName **
The name of the node that produced the outputs.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** timestamp **
The timestamp when the outputs were produced by the node.
Type: Timestamp
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeOutputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeOutputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeOutputEvent)
# NodeOutputField
Represents an output field produced by a node during a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** content **
The content of the output field, which can contain text or structured data.
Type: [NodeExecutionContent](API_agent-runtime_NodeExecutionContent.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** name **
The name of the output field as defined in the node's output schema.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
** next **
The next node that receives output data from this field.
Type: Array of [NodeOutputNext](API_agent-runtime_NodeOutputNext.md) objects
Required: No
** type **
The data type of the output field for compatibility validation.
Type: String
Valid Values: `String | Number | Boolean | Object | Array`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeOutputField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeOutputField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeOutputField)
# NodeOutputNext
Represents the next node that receives output data.
## Contents
** inputFieldName **
The name of the input field in the next node that receives the data.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}`
Required: Yes
** nodeName **
The name of the next node that receives the output data.
Type: String
Pattern: `[a-zA-Z]([_]?[0-9a-zA-Z]){0,99}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeOutputNext)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeOutputNext)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeOutputNext)
# NodeTraceElements
Contains trace elements for node execution tracking.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** agentTraces **
Agent trace information for the node execution.
Type: Array of [TracePart](API_agent-runtime_TracePart.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/NodeTraceElements)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/NodeTraceElements)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/NodeTraceElements)
# Observation
Contains the result or output of an action group or knowledge base, or the response to the user.
## Contents
** actionGroupInvocationOutput **
Contains the JSON-formatted string returned by the API invoked by the action group.
Type: [ActionGroupInvocationOutput](API_agent-runtime_ActionGroupInvocationOutput.md) object
Required: No
** agentCollaboratorInvocationOutput **
A collaborator's invocation output.
Type: [AgentCollaboratorInvocationOutput](API_agent-runtime_AgentCollaboratorInvocationOutput.md) object
Required: No
** codeInterpreterInvocationOutput **
Contains the JSON-formatted string returned by the API invoked by the code interpreter.
Type: [CodeInterpreterInvocationOutput](API_agent-runtime_CodeInterpreterInvocationOutput.md) object
Required: No
** finalResponse **
Contains details about the response to the user.
Type: [FinalResponse](API_agent-runtime_FinalResponse.md) object
Required: No
** knowledgeBaseLookupOutput **
Contains details about the results from looking up the knowledge base.
Type: [KnowledgeBaseLookupOutput](API_agent-runtime_KnowledgeBaseLookupOutput.md) object
Required: No
** repromptResponse **
Contains details about the response to reprompt the input.
Type: [RepromptResponse](API_agent-runtime_RepromptResponse.md) object
Required: No
** traceId **
The unique identifier of the trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
** type **
Specifies what kind of information the agent returns in the observation. The following values are possible.
+ `ACTION_GROUP` – The agent returns the result of an action group.
+ `KNOWLEDGE_BASE` – The agent returns information from a knowledge base.
+ `FINISH` – The agent returns a final response to the user with no follow-up.
+ `ASK_USER` – The agent asks the user a question.
+ `REPROMPT` – The agent prompts the user again for the same information.
Type: String
Valid Values: `ACTION_GROUP | AGENT_COLLABORATOR | KNOWLEDGE_BASE | FINISH | ASK_USER | REPROMPT`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Observation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Observation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Observation)
# OptimizedPrompt
Contains information about the optimized prompt.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** textPrompt **
Contains information about the text in the prompt that was optimized.
Type: [TextPrompt](API_agent-runtime_TextPrompt.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OptimizedPrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OptimizedPrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OptimizedPrompt)
# OptimizedPromptEvent
An event in which the prompt was optimized.
## Contents
** optimizedPrompt **
Contains information about the optimized prompt.
Type: [OptimizedPrompt](API_agent-runtime_OptimizedPrompt.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OptimizedPromptEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OptimizedPromptEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OptimizedPromptEvent)
# OptimizedPromptStream
The stream containing events in the prompt optimization process.
## Contents
** accessDeniedException **
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403
Required: No
** analyzePromptEvent **
An event in which the prompt was analyzed in preparation for optimization.
Type: [AnalyzePromptEvent](API_agent-runtime_AnalyzePromptEvent.md) object
Required: No
** badGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502
Required: No
** dependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424
Required: No
** internalServerException **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
Required: No
** optimizedPromptEvent **
An event in which the prompt was optimized.
Type: [OptimizedPromptEvent](API_agent-runtime_OptimizedPromptEvent.md) object
Required: No
** throttlingException **
Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) to increase the rate or number of tokens you can process.
Type: Exception
HTTP Status Code: 429
Required: No
** validationException **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OptimizedPromptStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OptimizedPromptStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OptimizedPromptStream)
# OrchestrationConfiguration
Settings for how the model processes the prompt prior to retrieval and generation.
## Contents
** additionalModelRequestFields **
Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
** inferenceConfig **
Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
Type: [InferenceConfig](API_agent-runtime_InferenceConfig.md) object
Required: No
** performanceConfig **
The latency configuration for the model.
Type: [PerformanceConfiguration](API_agent-runtime_PerformanceConfiguration.md) object
Required: No
** promptTemplate **
Contains the template for the prompt that's sent to the model. Orchestration prompts must include the `$conversation_history$` and `$output_format_instructions$` variables. For more information, see [Use placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html) in the user guide.
Type: [PromptTemplate](API_agent-runtime_PromptTemplate.md) object
Required: No
** queryTransformationConfiguration **
To split up the prompt and retrieve multiple sources, set the transformation type to `QUERY_DECOMPOSITION`.
Type: [QueryTransformationConfiguration](API_agent-runtime_QueryTransformationConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OrchestrationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OrchestrationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OrchestrationConfiguration)
# OrchestrationExecutor
The structure of the executor invoking the actions in custom orchestration.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** lambda **
The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OrchestrationExecutor)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OrchestrationExecutor)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OrchestrationExecutor)
# OrchestrationModelInvocationOutput
The foundation model output from the orchestration step.
## Contents
** metadata **
Contains information about the foundation model output from the orchestration step.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** rawResponse **
Contains details of the raw response from the foundation model output.
Type: [RawResponse](API_agent-runtime_RawResponse.md) object
Required: No
** reasoningContent **
Contains content about the reasoning that the model made during the orchestration step.
Type: [ReasoningContentBlock](API_agent-runtime_ReasoningContentBlock.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** traceId **
The unique identifier of the trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OrchestrationModelInvocationOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OrchestrationModelInvocationOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OrchestrationModelInvocationOutput)
# OrchestrationTrace
Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** invocationInput **
Contains information pertaining to the action group or knowledge base that is being invoked.
Type: [InvocationInput](API_agent-runtime_InvocationInput.md) object
Required: No
** modelInvocationInput **
The input for the orchestration step.
+ The `type` is `ORCHESTRATION`.
+ The `text` contains the prompt.
+ The `inferenceConfiguration`, `parserMode`, and `overrideLambda` values are set in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated.
Type: [ModelInvocationInput](API_agent-runtime_ModelInvocationInput.md) object
Required: No
** modelInvocationOutput **
Contains information pertaining to the output from the foundation model that is being invoked.
Type: [OrchestrationModelInvocationOutput](API_agent-runtime_OrchestrationModelInvocationOutput.md) object
Required: No
** observation **
Details about the observation (the output of the action group Lambda or knowledge base) made by the agent.
Type: [Observation](API_agent-runtime_Observation.md) object
Required: No
** rationale **
Details about the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
Type: [Rationale](API_agent-runtime_Rationale.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OrchestrationTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OrchestrationTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OrchestrationTrace)
# OutputFile
Contains details of the response from code interpreter.
## Contents
** bytes **
The byte count of files that contains response from code interpreter.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Required: No
** name **
The name of the file containing response from code interpreter.
Type: String
Required: No
** type **
The type of file that contains response from the code interpreter.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/OutputFile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/OutputFile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/OutputFile)
# Parameter
A parameter for the API request or function.
## Contents
** name **
The name of the parameter.
Type: String
Required: No
** type **
The type of the parameter.
Type: String
Required: No
** value **
The value of the parameter.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Parameter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Parameter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Parameter)
# ParameterDetail
Contains details about a parameter in a function for an action group.
## Contents
** type **
The data type of the parameter.
Type: String
Valid Values: `string | number | integer | boolean | array`
Required: Yes
** description **
A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: No
** required **
Whether the parameter is required for the agent to complete the function for action group invocation.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ParameterDetail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ParameterDetail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ParameterDetail)
# PayloadPart
Contains a part of an agent response and citations for it.
## Contents
** attribution **
Contains citations for a part of an agent response.
Type: [Attribution](API_agent-runtime_Attribution.md) object
Required: No
** bytes **
A part of the agent response in bytes.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PayloadPart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PayloadPart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PayloadPart)
# PerformanceConfiguration
Performance settings for a model.
## Contents
** latency **
To use a latency-optimized version of the model, set to `optimized`.
Type: String
Valid Values: `standard | optimized`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PerformanceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PerformanceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PerformanceConfiguration)
# PostProcessingModelInvocationOutput
The foundation model output from the post-processing step.
## Contents
** metadata **
Contains information about the foundation model output from the post-processing step.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** parsedResponse **
Details about the response from the Lambda parsing of the output of the post-processing step.
Type: [PostProcessingParsedResponse](API_agent-runtime_PostProcessingParsedResponse.md) object
Required: No
** rawResponse **
Details of the raw response from the foundation model output.
Type: [RawResponse](API_agent-runtime_RawResponse.md) object
Required: No
** reasoningContent **
Contains content about the reasoning that the model made during the post-processing step.
Type: [ReasoningContentBlock](API_agent-runtime_ReasoningContentBlock.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** traceId **
The unique identifier of the trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PostProcessingModelInvocationOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PostProcessingModelInvocationOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PostProcessingModelInvocationOutput)
# PostProcessingParsedResponse
Details about the response from the Lambda parsing of the output from the post-processing step.
## Contents
** text **
The text returned by the parser.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PostProcessingParsedResponse)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PostProcessingParsedResponse)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PostProcessingParsedResponse)
# PostProcessingTrace
Details about the post-processing step, in which the agent shapes the response.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** modelInvocationInput **
The input for the post-processing step.
+ The `type` is `POST_PROCESSING`.
+ The `text` contains the prompt.
+ The `inferenceConfiguration`, `parserMode`, and `overrideLambda` values are set in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated.
Type: [ModelInvocationInput](API_agent-runtime_ModelInvocationInput.md) object
Required: No
** modelInvocationOutput **
The foundation model output from the post-processing step.
Type: [PostProcessingModelInvocationOutput](API_agent-runtime_PostProcessingModelInvocationOutput.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PostProcessingTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PostProcessingTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PostProcessingTrace)
# PreProcessingModelInvocationOutput
The foundation model output from the pre-processing step.
## Contents
** metadata **
Contains information about the foundation model output from the pre-processing step.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** parsedResponse **
Details about the response from the Lambda parsing of the output of the pre-processing step.
Type: [PreProcessingParsedResponse](API_agent-runtime_PreProcessingParsedResponse.md) object
Required: No
** rawResponse **
Details of the raw response from the foundation model output.
Type: [RawResponse](API_agent-runtime_RawResponse.md) object
Required: No
** reasoningContent **
Contains content about the reasoning that the model made during the pre-processing step.
Type: [ReasoningContentBlock](API_agent-runtime_ReasoningContentBlock.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** traceId **
The unique identifier of the trace.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PreProcessingModelInvocationOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PreProcessingModelInvocationOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PreProcessingModelInvocationOutput)
# PreProcessingParsedResponse
Details about the response from the Lambda parsing of the output from the pre-processing step.
## Contents
** isValid **
Whether the user input is valid or not. If `false`, the agent doesn't proceed to orchestration.
Type: Boolean
Required: No
** rationale **
The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PreProcessingParsedResponse)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PreProcessingParsedResponse)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PreProcessingParsedResponse)
# PreProcessingTrace
Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** modelInvocationInput **
The input for the pre-processing step.
+ The `type` is `PRE_PROCESSING`.
+ The `text` contains the prompt.
+ The `inferenceConfiguration`, `parserMode`, and `overrideLambda` values are set in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) object that was set when the agent was created or updated.
Type: [ModelInvocationInput](API_agent-runtime_ModelInvocationInput.md) object
Required: No
** modelInvocationOutput **
The foundation model output from the pre-processing step.
Type: [PreProcessingModelInvocationOutput](API_agent-runtime_PreProcessingModelInvocationOutput.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PreProcessingTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PreProcessingTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PreProcessingTrace)
# PromptConfiguration
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
## Contents
** additionalModelRequestFields **
If the Converse or ConverseStream operations support the model, `additionalModelRequestFields` contains additional inference parameters, beyond the base set of inference parameters in the `inferenceConfiguration` field.
For more information, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: JSON value
Required: No
** basePromptTemplate **
Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see [Prompt template placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html). For more information, see [Configure the prompt templates](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html).
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: No
** foundationModel **
The foundation model to use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `.*(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2})))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+))$|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)`
Required: No
** inferenceConfiguration **
Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType`. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: [InferenceConfiguration](API_agent-runtime_InferenceConfiguration.md) object
Required: No
** parserMode **
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`. If you set the field as `OVERRIDDEN`, the `overrideLambda` field in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) must be specified with the ARN of a Lambda function.
Type: String
Valid Values: `DEFAULT | OVERRIDDEN`
Required: No
** promptCreationMode **
Specifies whether to override the default prompt template for this `promptType`. Set this value to `OVERRIDDEN` to use the prompt that you provide in the `basePromptTemplate`. If you leave it as `DEFAULT`, the agent uses a default prompt template.
Type: String
Valid Values: `DEFAULT | OVERRIDDEN`
Required: No
** promptState **
Specifies whether to allow the inline agent to carry out the step specified in the `promptType`. If you set this value to `DISABLED`, the agent skips that step. The default state for each `promptType` is as follows.
+ `PRE_PROCESSING` – `ENABLED`
+ `ORCHESTRATION` – `ENABLED`
+ `KNOWLEDGE_BASE_RESPONSE_GENERATION` – `ENABLED`
+ `POST_PROCESSING` – `DISABLED`
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
** promptType **
The step in the agent sequence that this prompt configuration applies to.
Type: String
Valid Values: `PRE_PROCESSING | ORCHESTRATION | KNOWLEDGE_BASE_RESPONSE_GENERATION | POST_PROCESSING | ROUTING_CLASSIFIER`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PromptConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PromptConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PromptConfiguration)
# PromptCreationConfigurations
Specifies parameters that control how the service populates the agent prompt for an `InvokeAgent` or `InvokeInlineAgent` request. You can control which aspects of previous invocations in the same agent session the service uses to populate the agent prompt. This gives you more granular control over the contextual history that is used to process the current request.
## Contents
** excludePreviousThinkingSteps **
If `true`, the service removes any content between `` tags from previous conversations in an agent session. The service will only remove content from already processed turns. This helps you remove content which might not be useful for current and subsequent invocations. This can reduce the input token count and potentially save costs. The default value is `false`.
Type: Boolean
Required: No
** previousConversationTurnsToInclude **
The number of previous conversations from the ongoing agent session to include in the conversation history of the agent prompt, during the current invocation. This gives you more granular control over the context that the model is made aware of, and helps the model remove older context which is no longer useful during the ongoing agent session.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PromptCreationConfigurations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PromptCreationConfigurations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PromptCreationConfigurations)
# PromptOverrideConfiguration
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).
## Contents
** promptConfigurations **
Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html).
Type: Array of [PromptConfiguration](API_agent-runtime_PromptConfiguration.md) objects
Array Members: Minimum number of 0 items. Maximum number of 10 items.
Required: Yes
** overrideLambda **
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the `promptConfigurations` must contain a `parserMode` value that is set to `OVERRIDDEN`. For more information, see [Parser Lambda function in Amazon Bedrock Agents](https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html).
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PromptOverrideConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PromptOverrideConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PromptOverrideConfiguration)
# PromptTemplate
Contains the template for the prompt that's sent to the model for response generation. For more information, see [Knowledge base prompt templates](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt).
This data type is used in the following API operations:
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the `filter` field
## Contents
** textPromptTemplate **
The template for the prompt that's sent to the model for response generation. You can include prompt placeholders, which become replaced before the prompt is sent to the model to provide instructions and context to the model. In addition, you can include XML tags to delineate meaningful sections of the prompt template.
For more information, see the following resources:
+ [Knowledge base prompt templates](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt)
+ [Use XML tags with Anthropic Claude models](https://docs.claude.com/en/docs/build-with-claude/prompt-engineering/use-xml-tags)
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PromptTemplate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PromptTemplate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PromptTemplate)
# PropertyParameters
Contains the parameters in the request body.
## Contents
** properties **
A list of parameters in the request body.
Type: Array of [Parameter](API_agent-runtime_Parameter.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/PropertyParameters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/PropertyParameters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/PropertyParameters)
# QueryGenerationInput
Contains information about a natural language query to transform into SQL.
## Contents
** text **
The text of the query.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20000.
Required: Yes
** type **
The type of the query.
Type: String
Valid Values: `TEXT`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/QueryGenerationInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/QueryGenerationInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/QueryGenerationInput)
# QueryTransformationConfiguration
To split up the prompt and retrieve multiple sources, set the transformation type to `QUERY_DECOMPOSITION`.
## Contents
** type **
The type of transformation to apply to the prompt.
Type: String
Valid Values: `QUERY_DECOMPOSITION`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/QueryTransformationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/QueryTransformationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/QueryTransformationConfiguration)
# Rationale
Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.
## Contents
** text **
The reasoning or thought process of the agent, based on the input.
Type: String
Required: No
** traceId **
The unique identifier of the trace step.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Rationale)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Rationale)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Rationale)
# RawResponse
Contains the raw output from the foundation model.
## Contents
** content **
The foundation model's raw output content.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RawResponse)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RawResponse)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RawResponse)
# ReasoningContentBlock
Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** reasoningText **
Contains information about the reasoning that the model used to return the content in the content block.
Type: [ReasoningTextBlock](API_agent-runtime_ReasoningTextBlock.md) object
Required: No
** redactedContent **
The content in the reasoning that was encrypted by the model provider for trust and safety reasons.
Type: Base64-encoded binary data object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ReasoningContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ReasoningContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ReasoningContentBlock)
# ReasoningTextBlock
Contains information about the reasoning that the model used to return the content in the content block.
## Contents
** text **
Text describing the reasoning that the model used to return the content in the content block.
Type: String
Required: Yes
** signature **
A hash of all the messages in the conversation to ensure that the content in the reasoning text block isn't tampered with. You must submit the signature in subsequent `Converse` requests, in addition to the previous messages. If the previous messages are tampered with, the response throws an error.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ReasoningTextBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ReasoningTextBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ReasoningTextBlock)
# RepromptResponse
Contains details about the agent's response to reprompt the input.
## Contents
** source **
Specifies what output is prompting the agent to reprompt the input.
Type: String
Valid Values: `ACTION_GROUP | KNOWLEDGE_BASE | PARSER`
Required: No
** text **
The text reprompting the input.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RepromptResponse)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RepromptResponse)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RepromptResponse)
# RequestBody
The parameters in the API request body.
## Contents
** content **
The content in the request body.
Type: String to array of [Parameter](API_agent-runtime_Parameter.md) objects map
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RequestBody)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RequestBody)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RequestBody)
# RerankDocument
Contains information about a document to rerank. Choose the `type` to define and include the field that corresponds to the type.
## Contents
** type **
The type of document to rerank.
Type: String
Valid Values: `TEXT | JSON`
Required: Yes
** jsonDocument **
Contains a JSON document to rerank.
Type: JSON value
Required: No
** textDocument **
Contains information about a text document to rerank.
Type: [RerankTextDocument](API_agent-runtime_RerankTextDocument.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RerankDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RerankDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RerankDocument)
# RerankingConfiguration
Contains configurations for reranking.
## Contents
** bedrockRerankingConfiguration **
Contains configurations for an Amazon Bedrock reranker.
Type: [BedrockRerankingConfiguration](API_agent-runtime_BedrockRerankingConfiguration.md) object
Required: Yes
** type **
The type of reranker that the configurations apply to.
Type: String
Valid Values: `BEDROCK_RERANKING_MODEL`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RerankingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RerankingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RerankingConfiguration)
# RerankingMetadataSelectiveModeConfiguration
Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the `fieldsToExclude` field, the reranker ignores all the metadata fields that you specify. If you include the `fieldsToInclude` field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** fieldsToExclude **
An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
Type: Array of [FieldForReranking](API_agent-runtime_FieldForReranking.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
** fieldsToInclude **
An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
Type: Array of [FieldForReranking](API_agent-runtime_FieldForReranking.md) objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RerankingMetadataSelectiveModeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RerankingMetadataSelectiveModeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RerankingMetadataSelectiveModeConfiguration)
# RerankQuery
Contains information about a query to submit to the reranker model.
## Contents
** textQuery **
Contains information about a text query.
Type: [RerankTextDocument](API_agent-runtime_RerankTextDocument.md) object
Required: Yes
** type **
The type of the query.
Type: String
Valid Values: `TEXT`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RerankQuery)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RerankQuery)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RerankQuery)
# RerankResult
Contains information about a document that was reranked.
## Contents
** index **
The original index of the document from the input sources array.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: Yes
** relevanceScore **
The relevance score of the document.
Type: Float
Required: Yes
** document **
Contains information about the document.
Type: [RerankDocument](API_agent-runtime_RerankDocument.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RerankResult)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RerankResult)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RerankResult)
# RerankSource
Contains information about a source for reranking.
## Contents
** inlineDocumentSource **
Contains an inline definition of a source for reranking.
Type: [RerankDocument](API_agent-runtime_RerankDocument.md) object
Required: Yes
** type **
The type of the source.
Type: String
Valid Values: `INLINE`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RerankSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RerankSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RerankSource)
# RerankTextDocument
Contains information about a text document to rerank.
## Contents
** text **
The text of the document.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RerankTextDocument)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RerankTextDocument)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RerankTextDocument)
# ResponseStream
The response from invoking the agent and associated citations and trace information.
## Contents
** accessDeniedException **
The request is denied because of missing access permissions. Check your permissions and retry your request.
Type: Exception
HTTP Status Code: 403
Required: No
** badGatewayException **
There was an issue with a dependency due to a server issue. Retry your request.
Type: Exception
HTTP Status Code: 502
Required: No
** chunk **
Contains a part of an agent response and citations for it.
Type: [PayloadPart](API_agent-runtime_PayloadPart.md) object
Required: No
** conflictException **
There was a conflict performing an operation. Resolve the conflict and retry your request.
Type: Exception
HTTP Status Code: 409
Required: No
** dependencyFailedException **
There was an issue with a dependency. Check the resource configurations and retry the request.
Type: Exception
HTTP Status Code: 424
Required: No
** files **
Contains intermediate response for code interpreter if any files have been generated.
Type: [FilePart](API_agent-runtime_FilePart.md) object
Required: No
** internalServerException **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
Required: No
** modelNotReadyException **
The model specified in the request is not ready to serve Inference requests. The AWS SDK will automatically retry the operation up to 5 times. For information about configuring automatic retries, see [Retry behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide.
Type: Exception
HTTP Status Code: 424
Required: No
** resourceNotFoundException **
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
Type: Exception
HTTP Status Code: 404
Required: No
** returnControl **
Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.
Type: [ReturnControlPayload](API_agent-runtime_ReturnControlPayload.md) object
Required: No
** serviceQuotaExceededException **
The number of requests exceeds the service quota. Resubmit your request later.
Type: Exception
HTTP Status Code: 400
Required: No
** throttlingException **
The number of requests exceeds the limit. Resubmit your request later.
Type: Exception
HTTP Status Code: 429
Required: No
** trace **
Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace events](https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html).
Type: [TracePart](API_agent-runtime_TracePart.md) object
Required: No
** validationException **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ResponseStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ResponseStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ResponseStream)
# RetrievalFilter
Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see [Query configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html). See the examples below to see how to use these filters.
This data type is used in the following API operations:
+ [Retrieve request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax) – in the `filter` field
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the `filter` field
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** andAll **
Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.
Type: Array of [RetrievalFilter](#API_agent-runtime_RetrievalFilter) objects
Array Members: Minimum number of 2 items.
Required: No
** equals **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value matches the `value` in this object.
The following example would return data sources with an `animal` attribute whose value is `cat`:
`"equals": { "key": "animal", "value": "cat" }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** greaterThan **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value is greater than the `value` in this object.
The following example would return data sources with an `year` attribute whose value is greater than `1989`:
`"greaterThan": { "key": "year", "value": 1989 }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** greaterThanOrEquals **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value is greater than or equal to the `value` in this object.
The following example would return data sources with an `year` attribute whose value is greater than or equal to `1989`:
`"greaterThanOrEquals": { "key": "year", "value": 1989 }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** in **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value is in the list specified in the `value` in this object.
The following example would return data sources with an `animal` attribute that is either `cat` or `dog`:
`"in": { "key": "animal", "value": ["cat", "dog"] }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** lessThan **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value is less than the `value` in this object.
The following example would return data sources with an `year` attribute whose value is less than to `1989`.
`"lessThan": { "key": "year", "value": 1989 }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** lessThanOrEquals **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value is less than or equal to the `value` in this object.
The following example would return data sources with an `year` attribute whose value is less than or equal to `1989`.
`"lessThanOrEquals": { "key": "year", "value": 1989 }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** listContains **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value is a list that contains the `value` as one of its members.
The following example would return data sources with an `animals` attribute that is a list containing a `cat` member (for example `["dog", "cat"]`).
`"listContains": { "key": "animals", "value": "cat" }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** notEquals **
Knowledge base data sources are returned when:
+ It contains a metadata attribute whose name matches the `key` and whose value doesn't match the `value` in this object.
+ The key is not present in the document.
The following example would return data sources that don't contain an `animal` attribute whose value is `cat`.
`"notEquals": { "key": "animal", "value": "cat" }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** notIn **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value isn't in the list specified in the `value` in this object.
The following example would return data sources whose `animal` attribute is neither `cat` nor `dog`.
`"notIn": { "key": "animal", "value": ["cat", "dog"] }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** orAll **
Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.
Type: Array of [RetrievalFilter](#API_agent-runtime_RetrievalFilter) objects
Array Members: Minimum number of 2 items.
Required: No
** startsWith **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value starts with the `value` in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.
The following example would return data sources with an `animal` attribute starts with `ca` (for example, `cat` or `camel`).
`"startsWith": { "key": "animal", "value": "ca" }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
** stringContains **
Knowledge base data sources are returned if they contain a metadata attribute whose name matches the `key` and whose value is one of the following:
+ A string that contains the `value` as a substring. The following example would return data sources with an `animal` attribute that contains the substring `at` (for example `cat`).
`"stringContains": { "key": "animal", "value": "at" }`
+ A list with a member that contains the `value` as a substring. The following example would return data sources with an `animals` attribute that is a list containing a member that contains the substring `at` (for example `["dog", "cat"]`).
`"stringContains": { "key": "animals", "value": "at" }`
Type: [FilterAttribute](API_agent-runtime_FilterAttribute.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalFilter)
# RetrievalResultConfluenceLocation
The Confluence data source location.
## Contents
** url **
The Confluence host URL for the data source location.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultConfluenceLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultConfluenceLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultConfluenceLocation)
# RetrievalResultContent
Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.
This data type is used in the following API operations:
+ [Retrieve response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the `content` field
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `content` field
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the `content` field
## Contents
** audio **
Audio segment information when the retrieval result contains audio content.
Type: [AudioSegment](API_agent-runtime_AudioSegment.md) object
Required: No
** byteContent **
A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: `data:image/jpeg;base64,${base64-encoded string}`.
Type: String
Required: No
** row **
Specifies information about the rows with the cells to return in retrieval.
Type: Array of [RetrievalResultContentColumn](API_agent-runtime_RetrievalResultContentColumn.md) objects
Required: No
** text **
The cited text from the data source.
Type: String
Required: No
** type **
The type of content in the retrieval result.
Type: String
Valid Values: `TEXT | IMAGE | ROW | AUDIO | VIDEO`
Required: No
** video **
Video segment information when the retrieval result contains video content.
Type: [VideoSegment](API_agent-runtime_VideoSegment.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultContent)
# RetrievalResultContentColumn
Contains information about a column with a cell to return in retrieval.
## Contents
** columnName **
The name of the column.
Type: String
Required: No
** columnValue **
The value in the column.
Type: String
Required: No
** type **
The data type of the value.
Type: String
Valid Values: `BLOB | BOOLEAN | DOUBLE | NULL | LONG | STRING`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultContentColumn)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultContentColumn)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultContentColumn)
# RetrievalResultCustomDocumentLocation
Contains information about the location of a document in a custom data source.
## Contents
** id **
The ID of the document.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultCustomDocumentLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultCustomDocumentLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultCustomDocumentLocation)
# RetrievalResultKendraDocumentLocation
The location of a result in Amazon Kendra.
## Contents
** uri **
The document's uri.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultKendraDocumentLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultKendraDocumentLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultKendraDocumentLocation)
# RetrievalResultLocation
Contains information about the data source location.
This data type is used in the following API operations:
+ [Retrieve response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the `location` field
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `location` field
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the `location` field
## Contents
** type **
The type of data source location.
Type: String
Valid Values: `S3 | WEB | CONFLUENCE | SALESFORCE | SHAREPOINT | CUSTOM | KENDRA | SQL`
Required: Yes
** confluenceLocation **
The Confluence data source location.
Type: [RetrievalResultConfluenceLocation](API_agent-runtime_RetrievalResultConfluenceLocation.md) object
Required: No
** customDocumentLocation **
Specifies the location of a document in a custom data source.
Type: [RetrievalResultCustomDocumentLocation](API_agent-runtime_RetrievalResultCustomDocumentLocation.md) object
Required: No
** kendraDocumentLocation **
The location of a document in Amazon Kendra.
Type: [RetrievalResultKendraDocumentLocation](API_agent-runtime_RetrievalResultKendraDocumentLocation.md) object
Required: No
** s3Location **
The S3 data source location.
Type: [RetrievalResultS3Location](API_agent-runtime_RetrievalResultS3Location.md) object
Required: No
** salesforceLocation **
The Salesforce data source location.
Type: [RetrievalResultSalesforceLocation](API_agent-runtime_RetrievalResultSalesforceLocation.md) object
Required: No
** sharePointLocation **
The SharePoint data source location.
Type: [RetrievalResultSharePointLocation](API_agent-runtime_RetrievalResultSharePointLocation.md) object
Required: No
** sqlLocation **
Specifies information about the SQL query used to retrieve the result.
Type: [RetrievalResultSqlLocation](API_agent-runtime_RetrievalResultSqlLocation.md) object
Required: No
** webLocation **
The web URL/URLs data source location.
Type: [RetrievalResultWebLocation](API_agent-runtime_RetrievalResultWebLocation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultLocation)
# RetrievalResultS3Location
The S3 data source location.
This data type is used in the following API operations:
+ [Retrieve response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the `s3Location` field
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `s3Location` field
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the `s3Location` field
## Contents
** uri **
The S3 URI for the data source location.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultS3Location)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultS3Location)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultS3Location)
# RetrievalResultSalesforceLocation
The Salesforce data source location.
## Contents
** url **
The Salesforce host URL for the data source location.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultSalesforceLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultSalesforceLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultSalesforceLocation)
# RetrievalResultSharePointLocation
The SharePoint data source location.
## Contents
** url **
The SharePoint site URL for the data source location.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultSharePointLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultSharePointLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultSharePointLocation)
# RetrievalResultSqlLocation
Contains information about the SQL query used to retrieve the result.
## Contents
** query **
The SQL query used to retrieve the result.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultSqlLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultSqlLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultSqlLocation)
# RetrievalResultWebLocation
The web URL/URLs data source location.
## Contents
** url **
The web URL/URLs for the data source location.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievalResultWebLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievalResultWebLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievalResultWebLocation)
# RetrieveAndGenerateConfiguration
Contains details about the resource being queried.
This data type is used in the following API operations:
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the `retrieveAndGenerateConfiguration` field
## Contents
** type **
The type of resource that contains your data for retrieving information and generating responses.
If you choose to use `EXTERNAL_SOURCES`, then currently only Anthropic Claude 3 Sonnet models for knowledge bases are supported.
Type: String
Valid Values: `KNOWLEDGE_BASE | EXTERNAL_SOURCES`
Required: Yes
** externalSourcesConfiguration **
The configuration for the external source wrapper object in the `retrieveAndGenerate` function.
Type: [ExternalSourcesRetrieveAndGenerateConfiguration](API_agent-runtime_ExternalSourcesRetrieveAndGenerateConfiguration.md) object
Required: No
** knowledgeBaseConfiguration **
Contains details about the knowledge base for retrieving information and generating responses.
Type: [KnowledgeBaseRetrieveAndGenerateConfiguration](API_agent-runtime_KnowledgeBaseRetrieveAndGenerateConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateConfiguration)
# RetrieveAndGenerateInput
Contains the query made to the knowledge base.
This data type is used in the following API operations:
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the `input` field
## Contents
** text **
The query made to the knowledge base, in characters.
Type: String
Length Constraints: Maximum length of 20000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateInput)
# RetrieveAndGenerateOutput
Contains the response generated from querying the knowledge base.
This data type is used in the following API operations:
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `output` field
## Contents
** text **
The response generated from querying the knowledge base.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateOutput)
# RetrieveAndGenerateOutputEvent
A retrieve and generate output event.
## Contents
** text **
A text response.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateOutputEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateOutputEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateOutputEvent)
# RetrieveAndGenerateSessionConfiguration
Contains configuration about the session with the knowledge base.
This data type is used in the following API operations:
+ [RetrieveAndGenerate request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) – in the `sessionConfiguration` field
## Contents
** kmsKeyArn **
The ARN of the AWS KMS key encrypting the session.
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: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateSessionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateSessionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateSessionConfiguration)
# RetrieveAndGenerateStreamResponseOutput
A retrieve and generate stream response output.
## Contents
** accessDeniedException **
The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error, see [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 403
Required: No
** badGatewayException **
The request failed due to a bad gateway error.
Type: Exception
HTTP Status Code: 502
Required: No
** citation **
A citation event.
Type: [CitationEvent](API_agent-runtime_CitationEvent.md) object
Required: No
** conflictException **
Error occurred because of a conflict while performing an operation.
Type: Exception
HTTP Status Code: 409
Required: No
** dependencyFailedException **
The request failed due to a dependency error.
Type: Exception
HTTP Status Code: 424
Required: No
** guardrail **
A guardrail event.
Type: [GuardrailEvent](API_agent-runtime_GuardrailEvent.md) object
Required: No
** internalServerException **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
Required: No
** output **
An output event.
Type: [RetrieveAndGenerateOutputEvent](API_agent-runtime_RetrieveAndGenerateOutputEvent.md) object
Required: No
** resourceNotFoundException **
The specified resource ARN was not found. For troubleshooting this error, see [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 404
Required: No
** serviceQuotaExceededException **
Your request exceeds the service quota for your account. You can view your quotas at [Viewing service quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html). You can resubmit your request later.
Type: Exception
HTTP Status Code: 400
Required: No
** throttlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 429
Required: No
** validationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamResponseOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamResponseOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamResponseOutput)
# RetrievedReference
Contains metadata about a source cited for the generated response.
This data type is used in the following API operations:
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `retrievedReferences` field
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the `retrievedReferences` field
## Contents
** content **
Contains the cited text from the data source.
Type: [RetrievalResultContent](API_agent-runtime_RetrievalResultContent.md) object
Required: No
** location **
Contains information about the location of the data source.
Type: [RetrievalResultLocation](API_agent-runtime_RetrievalResultLocation.md) object
Required: No
** metadata **
Contains metadata attributes and their values for the file in the data source. For more information, see [Metadata and filtering](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata).
Type: String to JSON value map
Map Entries: Maximum number of items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RetrievedReference)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RetrievedReference)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RetrievedReference)
# ReturnControlPayload
Contains information to return from the action group that the agent has predicted to invoke.
This data type is used in the following API operations:
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax)
## Contents
** invocationId **
The identifier of the action group invocation.
Type: String
Required: No
** invocationInputs **
A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.
Type: Array of [InvocationInputMember](API_agent-runtime_InvocationInputMember.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ReturnControlPayload)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ReturnControlPayload)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ReturnControlPayload)
# ReturnControlResults
An action invocation result.
## Contents
** invocationId **
The action's invocation ID.
Type: String
Required: No
** returnControlInvocationResults **
The action invocation result.
Type: Array of [InvocationResultMember](API_agent-runtime_InvocationResultMember.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/ReturnControlResults)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/ReturnControlResults)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/ReturnControlResults)
# RoutingClassifierModelInvocationOutput
Invocation output from a routing classifier model.
## Contents
** metadata **
The invocation's metadata.
Type: [Metadata](API_agent-runtime_Metadata.md) object
Required: No
** rawResponse **
The invocation's raw response.
Type: [RawResponse](API_agent-runtime_RawResponse.md) object
Required: No
** traceId **
The invocation's trace ID.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 16.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RoutingClassifierModelInvocationOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RoutingClassifierModelInvocationOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RoutingClassifierModelInvocationOutput)
# RoutingClassifierTrace
A trace for a routing classifier.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** invocationInput **
The classifier's invocation input.
Type: [InvocationInput](API_agent-runtime_InvocationInput.md) object
Required: No
** modelInvocationInput **
The classifier's model invocation input.
Type: [ModelInvocationInput](API_agent-runtime_ModelInvocationInput.md) object
Required: No
** modelInvocationOutput **
The classifier's model invocation output.
Type: [RoutingClassifierModelInvocationOutput](API_agent-runtime_RoutingClassifierModelInvocationOutput.md) object
Required: No
** observation **
The classifier's observation.
Type: [Observation](API_agent-runtime_Observation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/RoutingClassifierTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/RoutingClassifierTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/RoutingClassifierTrace)
# S3Identifier
The identifier information for an Amazon S3 bucket.
## Contents
** s3BucketName **
The name of the S3 bucket.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 63.
Pattern: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`
Required: No
** s3ObjectKey **
The S3 object key for the S3 resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `[\.\-\!\*\_\'\(\)a-zA-Z0-9][\.\-\!\*\_\'\(\)\/a-zA-Z0-9]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/S3Identifier)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/S3Identifier)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/S3Identifier)
# S3Location
Information about the Amazon S3 bucket where the image is stored.
## Contents
** uri **
The path to the Amazon S3 bucket where the image is stored.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/S3Location)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/S3Location)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/S3Location)
# S3ObjectDoc
The unique wrapper object of the document from the S3 location.
## Contents
** uri **
The file location of the S3 wrapper object.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/S3ObjectDoc)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/S3ObjectDoc)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/S3ObjectDoc)
# S3ObjectFile
Contains details of the s3 object where the source file is located.
## Contents
** uri **
The uri of the s3 object.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.{1,1024}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/S3ObjectFile)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/S3ObjectFile)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/S3ObjectFile)
# SatisfiedCondition
Represents a condition that was satisfied during a condition node evaluation in a flow execution.
**Note**
Flow executions is in preview release for Amazon Bedrock and is subject to change.
## Contents
** conditionName **
The name of the condition that was satisfied.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/SatisfiedCondition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/SatisfiedCondition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/SatisfiedCondition)
# SessionState
Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a [Lambda function](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html) for an action group or pass them when making an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see [Control session context](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
## Contents
** conversationHistory **
The state's conversation history.
Type: [ConversationHistory](API_agent-runtime_ConversationHistory.md) object
Required: No
** files **
Contains information about the files used by code interpreter.
Type: Array of [InputFile](API_agent-runtime_InputFile.md) objects
Required: No
** invocationId **
The identifier of the invocation of an action. This value must match the `invocationId` returned in the `InvokeAgent` response for the action whose results are provided in the `returnControlInvocationResults` field. For more information, see [Return control to the agent developer](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html) and [Control session context](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
Type: String
Required: No
** knowledgeBaseConfigurations **
An array of configurations, each of which applies to a knowledge base attached to the agent.
Type: Array of [KnowledgeBaseConfiguration](API_agent-runtime_KnowledgeBaseConfiguration.md) objects
Array Members: Minimum number of 1 item.
Required: No
** promptSessionAttributes **
Contains attributes that persist across a prompt and the values of those attributes.
+ In orchestration prompt template, these attributes replace the \$1prompt\$1session\$1attributes\$1 placeholder variable. For more information, see [Prompt template placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html).
+ In [multi-agent collaboration](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-multi-agent-collaboration.html), the `promptSessionAttributes` will only be used by supervisor agent when \$1prompt\$1session\$1attributes\$1 is present in prompt template.
Type: String to string map
Required: No
** returnControlInvocationResults **
Contains information about the results from the action group invocation. For more information, see [Return control to the agent developer](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html) and [Control session context](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html).
If you include this field, the `inputText` field will be ignored.
Type: Array of [InvocationResultMember](API_agent-runtime_InvocationResultMember.md) objects
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Required: No
** sessionAttributes **
Contains attributes that persist across a session and the values of those attributes. If `sessionAttributes` are passed to a supervisor agent in [multi-agent collaboration](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-multi-agent-collaboration.html), it will be forwarded to all agent collaborators.
Type: String to string map
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/SessionState)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/SessionState)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/SessionState)
# SessionSummary
Contains details about a session. For more information about sessions, see [Store and retrieve conversation history and context with Amazon Bedrock sessions](https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html).
## Contents
** createdAt **
The timestamp for when the session was created.
Type: Timestamp
Required: Yes
** lastUpdatedAt **
The timestamp for when the session was last modified.
Type: Timestamp
Required: Yes
** sessionArn **
The Amazon Resource Name (ARN) of the session.
Type: String
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** sessionId **
The unique identifier for the session.
Type: String
Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}`
Required: Yes
** sessionStatus **
The current status of the session.
Type: String
Valid Values: `ACTIVE | EXPIRED | ENDED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/SessionSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/SessionSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/SessionSummary)
# Span
Contains information about where the text with a citation begins and ends in the generated output.
This data type is used in the following API operations:
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `span` field
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the `span` field
## Contents
** end **
Where the text with a citation ends in the generated output.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** start **
Where the text with a citation starts in the generated output.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Span)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Span)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Span)
# StreamingConfigurations
Configurations for streaming.
## Contents
** applyGuardrailInterval **
The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer `ApplyGuardrail` calls. The following examples show the response generated for *Hello, I am an agent* input string.
**Example response in chunks: Interval set to 3 characters**
`'Hel', 'lo, ','I am', ' an', ' Age', 'nt'`
Each chunk has at least 3 characters except for the last chunk
**Example response in chunks: Interval set to 20 or more characters**
`Hello, I am an Agent`
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** streamFinalResponse **
Specifies whether to enable streaming for the final response. This is set to `false` by default.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/StreamingConfigurations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/StreamingConfigurations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/StreamingConfigurations)
# TextInferenceConfig
Configuration settings for text generation using a language model via the RetrieveAndGenerate operation. Includes parameters like temperature, top-p, maximum token count, and stop sequences.
**Note**
The valid range of `maxTokens` depends on the accepted values for your chosen model's inference parameters. To see the inference parameters for your model, see [Inference parameters for foundation models.](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html)
## Contents
** maxTokens **
The maximum number of tokens to generate in the output text. Do not use the minimum of 0 or the maximum of 65536. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 65536.
Required: No
** stopSequences **
A list of sequences of characters that, if generated, will cause the model to stop generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The limit values described here are arbitary values, for actual values consult the limits defined by your specific model.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 4 items.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: No
** temperature **
Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** topP **
A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token.
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TextInferenceConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TextInferenceConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/TextInferenceConfig)
# TextPrompt
Contains information about the text prompt to optimize.
## Contents
** text **
The text in the text prompt to optimize.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TextPrompt)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TextPrompt)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/TextPrompt)
# TextResponsePart
Contains the part of the generated text that contains a citation, alongside where it begins and ends.
This data type is used in the following API operations:
+ [RetrieveAndGenerate response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) – in the `textResponsePart` field
+ [InvokeAgent response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax) – in the `textResponsePart` field
## Contents
** span **
Contains information about where the text with a citation begins and ends in the generated output.
Type: [Span](API_agent-runtime_Span.md) object
Required: No
** text **
The part of the generated text that contains a citation.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TextResponsePart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TextResponsePart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/TextResponsePart)
# TextToSqlConfiguration
Contains configurations for transforming text to SQL.
## Contents
** type **
The type of resource to use in transformation.
Type: String
Valid Values: `KNOWLEDGE_BASE`
Required: Yes
** knowledgeBaseConfiguration **
Specifies configurations for a knowledge base to use in transformation.
Type: [TextToSqlKnowledgeBaseConfiguration](API_agent-runtime_TextToSqlKnowledgeBaseConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TextToSqlConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TextToSqlConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/TextToSqlConfiguration)
# TextToSqlKnowledgeBaseConfiguration
Contains configurations for a knowledge base to use in transformation.
## Contents
** knowledgeBaseArn **
The ARN of the knowledge base
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:knowledge-base/[0-9a-zA-Z]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TextToSqlKnowledgeBaseConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TextToSqlKnowledgeBaseConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/TextToSqlKnowledgeBaseConfiguration)
# Trace
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace enablement](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** customOrchestrationTrace **
Details about the custom orchestration step in which the agent determines the order in which actions are executed.
Type: [CustomOrchestrationTrace](API_agent-runtime_CustomOrchestrationTrace.md) object
Required: No
** failureTrace **
Contains information about the failure of the interaction.
Type: [FailureTrace](API_agent-runtime_FailureTrace.md) object
Required: No
** guardrailTrace **
The trace details for a trace defined in the Guardrail filter.
Type: [GuardrailTrace](API_agent-runtime_GuardrailTrace.md) object
Required: No
** orchestrationTrace **
Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.
Type: [OrchestrationTrace](API_agent-runtime_OrchestrationTrace.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** postProcessingTrace **
Details about the post-processing step, in which the agent shapes the response..
Type: [PostProcessingTrace](API_agent-runtime_PostProcessingTrace.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** preProcessingTrace **
Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.
Type: [PreProcessingTrace](API_agent-runtime_PreProcessingTrace.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** routingClassifierTrace **
A routing classifier's trace.
Type: [RoutingClassifierTrace](API_agent-runtime_RoutingClassifierTrace.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Trace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Trace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Trace)
# TraceElements
Contains trace elements for flow execution tracking.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** agentTraces **
Agent trace information for the flow execution.
Type: Array of [TracePart](API_agent-runtime_TracePart.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TraceElements)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TraceElements)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/TraceElements)
# TracePart
Contains information about the agent and session, alongside the agent's reasoning process and results from calling API actions and querying knowledge bases and metadata about the trace. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace enablement](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
## Contents
** agentAliasId **
The unique identifier of the alias of the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: No
** agentId **
The unique identifier of the agent.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 10.
Pattern: `[0-9a-zA-Z]+`
Required: No
** agentVersion **
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})`
Required: No
** callerChain **
The part's caller chain.
Type: Array of [Caller](API_agent-runtime_Caller.md) objects
Required: No
** collaboratorName **
The part's collaborator name.
Type: String
Pattern: `([0-9a-zA-Z][_-]?){1,100}`
Required: No
** eventTime **
The time of the trace.
Type: Timestamp
Required: No
** sessionId **
The unique identifier of the session with the agent.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern: `[0-9a-zA-Z._:-]+`
Required: No
** trace **
Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see [Trace enablement](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement).
Type: [Trace](API_agent-runtime_Trace.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TracePart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TracePart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/TracePart)
# TransformationConfiguration
Contains configurations for transforming the natural language query into SQL.
## Contents
** mode **
The mode of the transformation.
Type: String
Valid Values: `TEXT_TO_SQL`
Required: Yes
** textToSqlConfiguration **
Specifies configurations for transforming text to SQL.
Type: [TextToSqlConfiguration](API_agent-runtime_TextToSqlConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/TransformationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/TransformationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/TransformationConfiguration)
# Usage
Contains information of the usage of the foundation model.
## Contents
** inputTokens **
Contains information about the input tokens from the foundation model usage.
Type: Integer
Required: No
** outputTokens **
Contains information about the output tokens from the foundation model usage.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/Usage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/Usage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/Usage)
# VectorSearchBedrockRerankingConfiguration
Contains configurations for reranking with an Amazon Bedrock reranker model.
## Contents
** modelConfiguration **
Contains configurations for the reranker model.
Type: [VectorSearchBedrockRerankingModelConfiguration](API_agent-runtime_VectorSearchBedrockRerankingModelConfiguration.md) object
Required: Yes
** metadataConfiguration **
Contains configurations for the metadata to use in reranking.
Type: [MetadataConfigurationForReranking](API_agent-runtime_MetadataConfigurationForReranking.md) object
Required: No
** numberOfRerankedResults **
The number of results to return after reranking.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/VectorSearchBedrockRerankingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/VectorSearchBedrockRerankingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/VectorSearchBedrockRerankingConfiguration)
# VectorSearchBedrockRerankingModelConfiguration
Contains configurations for an Amazon Bedrock reranker model.
## Contents
** modelArn **
The ARN of the reranker model to use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?`
Required: Yes
** additionalModelRequestFields **
A JSON object whose keys are request fields for the model and whose values are values for those fields.
Type: String to JSON value map
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/VectorSearchBedrockRerankingModelConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/VectorSearchBedrockRerankingModelConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/VectorSearchBedrockRerankingModelConfiguration)
# VectorSearchRerankingConfiguration
Contains configurations for reranking the retrieved results.
## Contents
** type **
The type of reranker model.
Type: String
Valid Values: `BEDROCK_RERANKING_MODEL`
Required: Yes
** bedrockRerankingConfiguration **
Contains configurations for an Amazon Bedrock reranker model.
Type: [VectorSearchBedrockRerankingConfiguration](API_agent-runtime_VectorSearchBedrockRerankingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/VectorSearchRerankingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/VectorSearchRerankingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/VectorSearchRerankingConfiguration)
# VideoSegment
Contains information about a video segment retrieved from a knowledge base, including its location and summary.
This data type is used in the following API operations:
+ [Retrieve response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax) – in the `video` field
## Contents
** s3Uri **
The S3 URI where this specific video segment is stored in the multimodal storage destination.
Type: String
Length Constraints: Minimum length of 1.
Required: Yes
** summary **
A text summary describing the content of the video segment.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-agent-runtime-2023-07-26/VideoSegment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-agent-runtime-2023-07-26/VideoSegment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-agent-runtime-2023-07-26/VideoSegment)
# Data Automation for Amazon Bedrock
The following data types are supported by Data Automation for Amazon Bedrock:
+ [AudioExtractionCategory](API_data-automation_AudioExtractionCategory.md)
+ [AudioExtractionCategoryTypeConfiguration](API_data-automation_AudioExtractionCategoryTypeConfiguration.md)
+ [AudioLanguageConfiguration](API_data-automation_AudioLanguageConfiguration.md)
+ [AudioOverrideConfiguration](API_data-automation_AudioOverrideConfiguration.md)
+ [AudioStandardExtraction](API_data-automation_AudioStandardExtraction.md)
+ [AudioStandardGenerativeField](API_data-automation_AudioStandardGenerativeField.md)
+ [AudioStandardOutputConfiguration](API_data-automation_AudioStandardOutputConfiguration.md)
+ [Blueprint](API_data-automation_Blueprint.md)
+ [BlueprintFilter](API_data-automation_BlueprintFilter.md)
+ [BlueprintItem](API_data-automation_BlueprintItem.md)
+ [BlueprintOptimizationObject](API_data-automation_BlueprintOptimizationObject.md)
+ [BlueprintOptimizationOutputConfiguration](API_data-automation_BlueprintOptimizationOutputConfiguration.md)
+ [BlueprintOptimizationSample](API_data-automation_BlueprintOptimizationSample.md)
+ [BlueprintSummary](API_data-automation_BlueprintSummary.md)
+ [ChannelLabelingConfiguration](API_data-automation_ChannelLabelingConfiguration.md)
+ [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md)
+ [DataAutomationLibrary](API_data-automation_DataAutomationLibrary.md)
+ [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md)
+ [DataAutomationLibraryEntitySummary](API_data-automation_DataAutomationLibraryEntitySummary.md)
+ [DataAutomationLibraryFilter](API_data-automation_DataAutomationLibraryFilter.md)
+ [DataAutomationLibraryIngestionJob](API_data-automation_DataAutomationLibraryIngestionJob.md)
+ [DataAutomationLibraryIngestionJobSummary](API_data-automation_DataAutomationLibraryIngestionJobSummary.md)
+ [DataAutomationLibraryItem](API_data-automation_DataAutomationLibraryItem.md)
+ [DataAutomationLibrarySummary](API_data-automation_DataAutomationLibrarySummary.md)
+ [DataAutomationProject](API_data-automation_DataAutomationProject.md)
+ [DataAutomationProjectFilter](API_data-automation_DataAutomationProjectFilter.md)
+ [DataAutomationProjectSummary](API_data-automation_DataAutomationProjectSummary.md)
+ [DeleteEntitiesInfo](API_data-automation_DeleteEntitiesInfo.md)
+ [DocumentBoundingBox](API_data-automation_DocumentBoundingBox.md)
+ [DocumentExtractionGranularity](API_data-automation_DocumentExtractionGranularity.md)
+ [DocumentOutputAdditionalFileFormat](API_data-automation_DocumentOutputAdditionalFileFormat.md)
+ [DocumentOutputFormat](API_data-automation_DocumentOutputFormat.md)
+ [DocumentOutputTextFormat](API_data-automation_DocumentOutputTextFormat.md)
+ [DocumentOverrideConfiguration](API_data-automation_DocumentOverrideConfiguration.md)
+ [DocumentStandardExtraction](API_data-automation_DocumentStandardExtraction.md)
+ [DocumentStandardGenerativeField](API_data-automation_DocumentStandardGenerativeField.md)
+ [DocumentStandardOutputConfiguration](API_data-automation_DocumentStandardOutputConfiguration.md)
+ [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md)
+ [EntityDetails](API_data-automation_EntityDetails.md)
+ [EntityTypeInfo](API_data-automation_EntityTypeInfo.md)
+ [EventBridgeConfiguration](API_data-automation_EventBridgeConfiguration.md)
+ [ImageBoundingBox](API_data-automation_ImageBoundingBox.md)
+ [ImageExtractionCategory](API_data-automation_ImageExtractionCategory.md)
+ [ImageOverrideConfiguration](API_data-automation_ImageOverrideConfiguration.md)
+ [ImageStandardExtraction](API_data-automation_ImageStandardExtraction.md)
+ [ImageStandardGenerativeField](API_data-automation_ImageStandardGenerativeField.md)
+ [ImageStandardOutputConfiguration](API_data-automation_ImageStandardOutputConfiguration.md)
+ [InlinePayload](API_data-automation_InlinePayload.md)
+ [InputConfiguration](API_data-automation_InputConfiguration.md)
+ [ModalityProcessingConfiguration](API_data-automation_ModalityProcessingConfiguration.md)
+ [ModalityRoutingConfiguration](API_data-automation_ModalityRoutingConfiguration.md)
+ [NotificationConfiguration](API_data-automation_NotificationConfiguration.md)
+ [OutputConfiguration](API_data-automation_OutputConfiguration.md)
+ [OverrideConfiguration](API_data-automation_OverrideConfiguration.md)
+ [Phrase](API_data-automation_Phrase.md)
+ [PIIEntitiesConfiguration](API_data-automation_PIIEntitiesConfiguration.md)
+ [S3Object](API_data-automation_S3Object.md)
+ [SensitiveDataConfiguration](API_data-automation_SensitiveDataConfiguration.md)
+ [SpeakerLabelingConfiguration](API_data-automation_SpeakerLabelingConfiguration.md)
+ [SplitterConfiguration](API_data-automation_SplitterConfiguration.md)
+ [StandardOutputConfiguration](API_data-automation_StandardOutputConfiguration.md)
+ [Tag](API_data-automation_Tag.md)
+ [TranscriptConfiguration](API_data-automation_TranscriptConfiguration.md)
+ [UpsertEntityInfo](API_data-automation_UpsertEntityInfo.md)
+ [ValidationExceptionField](API_data-automation_ValidationExceptionField.md)
+ [VideoBoundingBox](API_data-automation_VideoBoundingBox.md)
+ [VideoExtractionCategory](API_data-automation_VideoExtractionCategory.md)
+ [VideoOverrideConfiguration](API_data-automation_VideoOverrideConfiguration.md)
+ [VideoStandardExtraction](API_data-automation_VideoStandardExtraction.md)
+ [VideoStandardGenerativeField](API_data-automation_VideoStandardGenerativeField.md)
+ [VideoStandardOutputConfiguration](API_data-automation_VideoStandardOutputConfiguration.md)
+ [VocabularyEntity](API_data-automation_VocabularyEntity.md)
+ [VocabularyEntityInfo](API_data-automation_VocabularyEntityInfo.md)
+ [VocabularyEntitySummary](API_data-automation_VocabularyEntitySummary.md)
# AudioExtractionCategory
Settings for generating data from audio.
## Contents
** state **
Whether generating categorical data from audio is enabled.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
** typeConfiguration **
This element contains information about extractions from different types. Used to enable speaker and channel labeling for transcripts.
Type: [AudioExtractionCategoryTypeConfiguration](API_data-automation_AudioExtractionCategoryTypeConfiguration.md) object
Required: No
** types **
The types of data to generate.
Type: Array of strings
Valid Values: `AUDIO_CONTENT_MODERATION | TRANSCRIPT | TOPIC_CONTENT_MODERATION`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/AudioExtractionCategory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/AudioExtractionCategory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/AudioExtractionCategory)
# AudioExtractionCategoryTypeConfiguration
Allows configuration of extractions for different types of data, such as transcript and content moderation.
## Contents
** transcript **
This element allows you to configure different extractions for your transcript data, such as speaker and channel labeling.
Type: [TranscriptConfiguration](API_data-automation_TranscriptConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/AudioExtractionCategoryTypeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/AudioExtractionCategoryTypeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/AudioExtractionCategoryTypeConfiguration)
# AudioLanguageConfiguration
This allows you to set the input and output language of your audio. The input language can be set to any of the languages supported by Bedrock Data Automation. The output can either be set to english or whatever the dominant language is of the audio, determined by the language spoken for the most seconds.
## Contents
** generativeOutputLanguage **
The output language of your processing results. This can either be set to `EN` (English) or `DEFAULT` which will output the results in the dominant language of the audio. The dominant language is determined as the language in the audio, spoken the longest in the input audio.
Type: String
Valid Values: `DEFAULT | EN`
Required: No
** identifyMultipleLanguages **
The toggle determining if you want to detect multiple languages from your audio.
Type: Boolean
Required: No
** inputLanguages **
The input language of your audio. This can be set to any of the currently supported languages via the language codes.
Type: Array of strings
Valid Values: `EN | DE | ES | FR | IT | PT | JA | KO | CN | TW | HK`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/AudioLanguageConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/AudioLanguageConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/AudioLanguageConfiguration)
# AudioOverrideConfiguration
Sets whether your project will process audio or not.
## Contents
** languageConfiguration **
The output and input language configuration for your audio.
Type: [AudioLanguageConfiguration](API_data-automation_AudioLanguageConfiguration.md) object
Required: No
** modalityProcessing **
Sets modality processing for audio files. All modalities are enabled by default.
Type: [ModalityProcessingConfiguration](API_data-automation_ModalityProcessingConfiguration.md) object
Required: No
** sensitiveDataConfiguration **
Configuration for sensitive data detection and redaction for audio files.
Type: [SensitiveDataConfiguration](API_data-automation_SensitiveDataConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/AudioOverrideConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/AudioOverrideConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/AudioOverrideConfiguration)
# AudioStandardExtraction
Settings for generating data from audio.
## Contents
** category **
Settings for generating categorical data.
Type: [AudioExtractionCategory](API_data-automation_AudioExtractionCategory.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/AudioStandardExtraction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/AudioStandardExtraction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/AudioStandardExtraction)
# AudioStandardGenerativeField
Settings for generating descriptions of audio.
## Contents
** state **
Whether generating descriptions is enabled for audio.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
** types **
The types of description to generate.
Type: Array of strings
Valid Values: `AUDIO_SUMMARY | TOPIC_SUMMARY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/AudioStandardGenerativeField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/AudioStandardGenerativeField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/AudioStandardGenerativeField)
# AudioStandardOutputConfiguration
Output settings for processing audio.
## Contents
** extraction **
Settings for populating data fields that describe the audio.
Type: [AudioStandardExtraction](API_data-automation_AudioStandardExtraction.md) object
Required: No
** generativeField **
Whether to generate descriptions of the data.
Type: [AudioStandardGenerativeField](API_data-automation_AudioStandardGenerativeField.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/AudioStandardOutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/AudioStandardOutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/AudioStandardOutputConfiguration)
# Blueprint
A data processing blueprint.
## Contents
** blueprintArn **
The blueprint's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
** blueprintName **
The blueprint's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: Yes
** creationTime **
When the blueprint was created.
Type: Timestamp
Required: Yes
** lastModifiedTime **
When the blueprint was last updated.
Type: Timestamp
Required: Yes
** schema **
The blueprint's schema.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100000.
Required: Yes
** type **
The blueprint's type.
Type: String
Valid Values: `DOCUMENT | IMAGE | AUDIO`
Required: Yes
** blueprintStage **
The blueprint's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** blueprintVersion **
The blueprint's version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[0-9]*`
Required: No
** kmsEncryptionContext **
The AWS KMS encryption context to use for encryption.
Type: String to string map
Map Entries: Maximum number of items.
Key Length Constraints: Minimum length of 1. Maximum length of 2000.
Key Pattern: `.*\S.*`
Value Length Constraints: Minimum length of 1. Maximum length of 2000.
Value Pattern: `.*\S.*`
Required: No
** kmsKeyId **
The AWS KMS key to use for encryption.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+`
Required: No
** optimizationSamples **
Sample data used to optimize this blueprint.
Type: Array of [BlueprintOptimizationSample](API_data-automation_BlueprintOptimizationSample.md) objects
Required: No
** optimizationTime **
When the blueprint was last optimized.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/Blueprint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/Blueprint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/Blueprint)
# BlueprintFilter
A blueprint filter.
## Contents
** blueprintArn **
Filter by blueprint ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
** blueprintStage **
Filter by blueprint stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** blueprintVersion **
Filter by blueprint version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[0-9]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/BlueprintFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/BlueprintFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/BlueprintFilter)
# BlueprintItem
An abbreviated summary of a blueprint.
## Contents
** blueprintArn **
The blueprint's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
** blueprintStage **
The blueprint's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** blueprintVersion **
The blueprint's version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[0-9]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/BlueprintItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/BlueprintItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/BlueprintItem)
# BlueprintOptimizationObject
A blueprint to be optimized.
## Contents
** blueprintArn **
The blueprint's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
** stage **
The blueprint's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/BlueprintOptimizationObject)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/BlueprintOptimizationObject)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/BlueprintOptimizationObject)
# BlueprintOptimizationOutputConfiguration
Configuration for where to store blueprint optimization results.
## Contents
** s3Object **
The S3 location where optimization results will be stored.
Type: [S3Object](API_data-automation_S3Object.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/BlueprintOptimizationOutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/BlueprintOptimizationOutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/BlueprintOptimizationOutputConfiguration)
# BlueprintOptimizationSample
A sample asset and its corresponding ground truth for blueprint optimization.
## Contents
** assetS3Object **
The S3 location of the sample asset.
Type: [S3Object](API_data-automation_S3Object.md) object
Required: Yes
** groundTruthS3Object **
The S3 location of the ground truth data for this asset.
Type: [S3Object](API_data-automation_S3Object.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/BlueprintOptimizationSample)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/BlueprintOptimizationSample)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/BlueprintOptimizationSample)
# BlueprintSummary
A summary of a blueprint.
## Contents
** blueprintArn **
The blueprint's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
** creationTime **
When the blueprint was created.
Type: Timestamp
Required: Yes
** blueprintName **
The blueprint's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: No
** blueprintStage **
The blueprint's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** blueprintVersion **
The blueprint's version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[0-9]*`
Required: No
** lastModifiedTime **
When the blueprint was last updated.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/BlueprintSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/BlueprintSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/BlueprintSummary)
# ChannelLabelingConfiguration
Enables or disables channel labeling. Channel labeling, when enabled will assign a number to each audio channel, and indicate which channel is being used in each portion of the transcript. This appears in the response as "ch\$10" for the first channel, and "ch\$11" for the second.
## Contents
** state **
State of channel labeling, either enabled or disabled.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ChannelLabelingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ChannelLabelingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ChannelLabelingConfiguration)
# CustomOutputConfiguration
Blueprints to apply to objects processed by the project.
## Contents
** blueprints **
A list of blueprints.
Type: Array of [BlueprintItem](API_data-automation_BlueprintItem.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/CustomOutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/CustomOutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/CustomOutputConfiguration)
# DataAutomationLibrary
A data automation library.
## Contents
** creationTime **
When the library was created.
Type: Timestamp
Required: Yes
** libraryArn **
The library's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
** libraryName **
The library's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: Yes
** status **
The library's status.
Type: String
Valid Values: `ACTIVE | DELETING`
Required: Yes
** entityTypes **
The entity types supported by the library.
Type: Array of [EntityTypeInfo](API_data-automation_EntityTypeInfo.md) objects
Required: No
** kmsEncryptionContext **
The AWS KMS encryption context to use for encryption.
Type: String to string map
Map Entries: Maximum number of items.
Key Length Constraints: Minimum length of 1. Maximum length of 2000.
Key Pattern: `.*\S.*`
Value Length Constraints: Minimum length of 1. Maximum length of 2000.
Value Pattern: `.*\S.*`
Required: No
** kmsKeyId **
The AWS KMS key to use for encryption.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+`
Required: No
** libraryDescription **
The library's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern: `[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationLibrary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationLibrary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationLibrary)
# DataAutomationLibraryConfiguration
Configuration for data automation libraries.
## Contents
** libraries **
The libraries to use.
Type: Array of [DataAutomationLibraryItem](API_data-automation_DataAutomationLibraryItem.md) objects
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationLibraryConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationLibraryConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationLibraryConfiguration)
# DataAutomationLibraryEntitySummary
A summary of a data automation library entity.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** vocabulary **
Vocabulary entity details.
Type: [VocabularyEntitySummary](API_data-automation_VocabularyEntitySummary.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationLibraryEntitySummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationLibraryEntitySummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationLibraryEntitySummary)
# DataAutomationLibraryFilter
A data automation library filter.
## Contents
** libraryArn **
Filter by library ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationLibraryFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationLibraryFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationLibraryFilter)
# DataAutomationLibraryIngestionJob
A data automation library ingestion job.
## Contents
** creationTime **
When the job was created.
Type: Timestamp
Required: Yes
** entityType **
The entity type.
Type: String
Valid Values: `VOCABULARY`
Required: Yes
** jobArn **
The job's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library-ingestion-job/[a-zA-Z0-9-]{12,36}`
Required: Yes
** jobStatus **
The job's status.
Type: String
Valid Values: `IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`
Required: Yes
** operationType **
The operation type.
Type: String
Valid Values: `UPSERT | DELETE`
Required: Yes
** outputConfiguration **
Output configuration for the job.
Type: [OutputConfiguration](API_data-automation_OutputConfiguration.md) object
Required: Yes
** completionTime **
When the job completed.
Type: Timestamp
Required: No
** errorMessage **
The error message if the job failed.
Type: String
Required: No
** errorType **
The error type if the job failed.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationLibraryIngestionJob)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationLibraryIngestionJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationLibraryIngestionJob)
# DataAutomationLibraryIngestionJobSummary
A summary of a data automation library ingestion job.
## Contents
** creationTime **
When the job was created.
Type: Timestamp
Required: Yes
** entityType **
The entity type.
Type: String
Valid Values: `VOCABULARY`
Required: Yes
** jobArn **
The job's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library-ingestion-job/[a-zA-Z0-9-]{12,36}`
Required: Yes
** jobStatus **
The job's status.
Type: String
Valid Values: `IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED`
Required: Yes
** operationType **
The operation type.
Type: String
Valid Values: `UPSERT | DELETE`
Required: Yes
** completionTime **
When the job completed.
Type: Timestamp
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationLibraryIngestionJobSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationLibraryIngestionJobSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationLibraryIngestionJobSummary)
# DataAutomationLibraryItem
A data automation library item.
## Contents
** libraryArn **
The library's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationLibraryItem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationLibraryItem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationLibraryItem)
# DataAutomationLibrarySummary
A summary of a data automation library.
## Contents
** creationTime **
When the library was created.
Type: Timestamp
Required: Yes
** libraryArn **
The library's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-iso|-iso-[a-z]|-us-gov):bedrock:[a-zA-Z0-9-]*:[0-9]{12}:data-automation-library/[a-zA-Z0-9-]{12,36}`
Required: Yes
** libraryName **
The library's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationLibrarySummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationLibrarySummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationLibrarySummary)
# DataAutomationProject
A data automation project.
## Contents
** creationTime **
When the project was created.
Type: Timestamp
Required: Yes
** lastModifiedTime **
When the project was last updated.
Type: Timestamp
Required: Yes
** projectArn **
The project's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
Required: Yes
** projectName **
The project's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: Yes
** status **
The project's status.
Type: String
Valid Values: `COMPLETED | IN_PROGRESS | FAILED`
Required: Yes
** customOutputConfiguration **
Blueprints that are enabled for the project.
Type: [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md) object
Required: No
** dataAutomationLibraryConfiguration **
Library configuration for the project.
Type: [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md) object
Required: No
** kmsEncryptionContext **
The AWS KMS encryption context to use for encryption.
Type: String to string map
Map Entries: Maximum number of items.
Key Length Constraints: Minimum length of 1. Maximum length of 2000.
Key Pattern: `.*\S.*`
Value Length Constraints: Minimum length of 1. Maximum length of 2000.
Value Pattern: `.*\S.*`
Required: No
** kmsKeyId **
The AWS KMS key to use for encryption.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+`
Required: No
** overrideConfiguration **
Additional settings for the project.
Type: [OverrideConfiguration](API_data-automation_OverrideConfiguration.md) object
Required: No
** projectDescription **
The project's description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Required: No
** projectStage **
The project's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** projectType **
The type of bedrock data automation API that is compatible with this project.
Type: String
Valid Values: `ASYNC | SYNC`
Required: No
** standardOutputConfiguration **
The project's standard output configuration.
Type: [StandardOutputConfiguration](API_data-automation_StandardOutputConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationProject)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationProject)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationProject)
# DataAutomationProjectFilter
A data automation project filter.
## Contents
** projectArn **
Filter by project ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
Required: Yes
** projectStage **
Filter by stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationProjectFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationProjectFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationProjectFilter)
# DataAutomationProjectSummary
A summary of a data automation project.
## Contents
** creationTime **
The project's creation time.
Type: Timestamp
Required: Yes
** projectArn **
The project's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-]{12,36}`
Required: Yes
** projectName **
The project's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: No
** projectStage **
The project's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** projectType **
The project's type.
Type: String
Valid Values: `ASYNC | SYNC`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DataAutomationProjectSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DataAutomationProjectSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DataAutomationProjectSummary)
# DeleteEntitiesInfo
Information about entities to delete.
## Contents
** entityIds **
The entity IDs to delete.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 1000 items.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DeleteEntitiesInfo)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DeleteEntitiesInfo)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DeleteEntitiesInfo)
# DocumentBoundingBox
Bounding box settings for documents.
## Contents
** state **
Whether bounding boxes are enabled for documents.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentBoundingBox)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentBoundingBox)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentBoundingBox)
# DocumentExtractionGranularity
Granularity settings for documents.
## Contents
** types **
The levels of detail to extract.
Type: Array of strings
Valid Values: `DOCUMENT | PAGE | ELEMENT | WORD | LINE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentExtractionGranularity)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentExtractionGranularity)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentExtractionGranularity)
# DocumentOutputAdditionalFileFormat
Output settings for additional file formats.
## Contents
** state **
Whether additional file formats are enabled for a project.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentOutputAdditionalFileFormat)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentOutputAdditionalFileFormat)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentOutputAdditionalFileFormat)
# DocumentOutputFormat
A document output format.
## Contents
** additionalFileFormat **
Output settings for additional file formats.
Type: [DocumentOutputAdditionalFileFormat](API_data-automation_DocumentOutputAdditionalFileFormat.md) object
Required: Yes
** textFormat **
The text format.
Type: [DocumentOutputTextFormat](API_data-automation_DocumentOutputTextFormat.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentOutputFormat)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentOutputFormat)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentOutputFormat)
# DocumentOutputTextFormat
An output text format.
## Contents
** types **
The types of output text to generate.
Type: Array of strings
Valid Values: `PLAIN_TEXT | MARKDOWN | HTML | CSV`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentOutputTextFormat)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentOutputTextFormat)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentOutputTextFormat)
# DocumentOverrideConfiguration
Additional settings for a project.
## Contents
** modalityProcessing **
Sets modality processing for document files. All modalities are enabled by default.
Type: [ModalityProcessingConfiguration](API_data-automation_ModalityProcessingConfiguration.md) object
Required: No
** sensitiveDataConfiguration **
Configuration for sensitive data detection and redaction for document files.
Type: [SensitiveDataConfiguration](API_data-automation_SensitiveDataConfiguration.md) object
Required: No
** splitter **
Whether document splitter is enabled for a project.
Type: [SplitterConfiguration](API_data-automation_SplitterConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentOverrideConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentOverrideConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentOverrideConfiguration)
# DocumentStandardExtraction
Settings for generating data from documents.
## Contents
** boundingBox **
Whether to generate bounding boxes.
Type: [DocumentBoundingBox](API_data-automation_DocumentBoundingBox.md) object
Required: Yes
** granularity **
Which granularities to generate data for.
Type: [DocumentExtractionGranularity](API_data-automation_DocumentExtractionGranularity.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentStandardExtraction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentStandardExtraction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentStandardExtraction)
# DocumentStandardGenerativeField
Settings for generating descriptions of documents.
## Contents
** state **
Whether generating descriptions is enabled for documents.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentStandardGenerativeField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentStandardGenerativeField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentStandardGenerativeField)
# DocumentStandardOutputConfiguration
Output settings for processing documents.
## Contents
** extraction **
Settings for populating data fields that describe the document.
Type: [DocumentStandardExtraction](API_data-automation_DocumentStandardExtraction.md) object
Required: No
** generativeField **
Whether to generate descriptions.
Type: [DocumentStandardGenerativeField](API_data-automation_DocumentStandardGenerativeField.md) object
Required: No
** outputFormat **
The output format to generate.
Type: [DocumentOutputFormat](API_data-automation_DocumentOutputFormat.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/DocumentStandardOutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/DocumentStandardOutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/DocumentStandardOutputConfiguration)
# EncryptionConfiguration
Encryption settings for a project.
## Contents
** kmsKeyId **
The AWS KMS key to use for encryption.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+`
Required: Yes
** kmsEncryptionContext **
The AWS KMS encryption context to use for encryption.
Type: String to string map
Map Entries: Maximum number of items.
Key Length Constraints: Minimum length of 1. Maximum length of 2000.
Key Pattern: `.*\S.*`
Value Length Constraints: Minimum length of 1. Maximum length of 2000.
Value Pattern: `.*\S.*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/EncryptionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/EncryptionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/EncryptionConfiguration)
# EntityDetails
Details about an entity.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** vocabulary **
Vocabulary entity details.
Type: [VocabularyEntity](API_data-automation_VocabularyEntity.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/EntityDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/EntityDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/EntityDetails)
# EntityTypeInfo
Information about an entity type.
## Contents
** entityType **
The entity type.
Type: String
Valid Values: `VOCABULARY`
Required: Yes
** entityMetadata **
Metadata about the entity type.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/EntityTypeInfo)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/EntityTypeInfo)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/EntityTypeInfo)
# EventBridgeConfiguration
EventBridge configuration for notifications.
## Contents
** eventBridgeEnabled **
Whether EventBridge notifications are enabled.
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/EventBridgeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/EventBridgeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/EventBridgeConfiguration)
# ImageBoundingBox
Bounding box settings for a project.
## Contents
** state **
Whether bounding boxes are enabled for images.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ImageBoundingBox)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ImageBoundingBox)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ImageBoundingBox)
# ImageExtractionCategory
Settings for generating categorical data from images.
## Contents
** state **
Whether generating categorical data from images is enabled.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
** types **
The types of data to generate.
Type: Array of strings
Valid Values: `CONTENT_MODERATION | TEXT_DETECTION | LOGOS`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ImageExtractionCategory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ImageExtractionCategory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ImageExtractionCategory)
# ImageOverrideConfiguration
Sets whether your project will process images or not.
## Contents
** modalityProcessing **
Sets modality processing for image files. All modalities are enabled by default.
Type: [ModalityProcessingConfiguration](API_data-automation_ModalityProcessingConfiguration.md) object
Required: No
** sensitiveDataConfiguration **
Configuration for sensitive data detection and redaction for image files.
Type: [SensitiveDataConfiguration](API_data-automation_SensitiveDataConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ImageOverrideConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ImageOverrideConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ImageOverrideConfiguration)
# ImageStandardExtraction
Settings for generating data from images.
## Contents
** boundingBox **
Settings for generating bounding boxes.
Type: [ImageBoundingBox](API_data-automation_ImageBoundingBox.md) object
Required: Yes
** category **
Settings for generating categorical data.
Type: [ImageExtractionCategory](API_data-automation_ImageExtractionCategory.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ImageStandardExtraction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ImageStandardExtraction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ImageStandardExtraction)
# ImageStandardGenerativeField
Settings for generating descriptions of images.
## Contents
** state **
Whether generating descriptions is enabled for images.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
** types **
The types of description to generate.
Type: Array of strings
Valid Values: `IMAGE_SUMMARY | IAB`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ImageStandardGenerativeField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ImageStandardGenerativeField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ImageStandardGenerativeField)
# ImageStandardOutputConfiguration
Output settings for processing images.
## Contents
** extraction **
Settings for populating data fields that describe the image.
Type: [ImageStandardExtraction](API_data-automation_ImageStandardExtraction.md) object
Required: No
** generativeField **
Whether to generate descriptions of the data.
Type: [ImageStandardGenerativeField](API_data-automation_ImageStandardGenerativeField.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ImageStandardOutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ImageStandardOutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ImageStandardOutputConfiguration)
# InlinePayload
Inline payload for ingestion jobs.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** deleteEntitiesInfo **
Information about entities to delete.
Type: [DeleteEntitiesInfo](API_data-automation_DeleteEntitiesInfo.md) object
Required: No
** upsertEntitiesInfo **
Information about entities to upsert.
Type: Array of [UpsertEntityInfo](API_data-automation_UpsertEntityInfo.md) objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/InlinePayload)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/InlinePayload)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/InlinePayload)
# InputConfiguration
Input configuration for ingestion jobs.
Only one member of this object can be specified or returned. If both inlinePayload and s3Object are specified, the request will fail with an exception.
## Contents
** inlinePayload **
Inline payload input.
Type: [InlinePayload](API_data-automation_InlinePayload.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** s3Object **
S3 object input.
Type: [S3Object](API_data-automation_S3Object.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/InputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/InputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/InputConfiguration)
# ModalityProcessingConfiguration
This element is used to determine if the modality it is associated with is enabled or disabled. All modalities are enabled by default.
## Contents
** state **
Stores the state of the modality for your project, set to either enabled or disabled
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ModalityProcessingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ModalityProcessingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ModalityProcessingConfiguration)
# ModalityRoutingConfiguration
This element allows you to set up where JPEG, PNG, MOV, and MP4 files get routed to for processing. JPEG routing applies to both "JPEG" and "JPG" file extensions.
## Contents
** jpeg **
Sets whether JPEG files are routed to document or image processing.
Type: String
Valid Values: `IMAGE | DOCUMENT | AUDIO | VIDEO`
Required: No
** mov **
Sets whether MOV files are routed to audio or video processing.
Type: String
Valid Values: `IMAGE | DOCUMENT | AUDIO | VIDEO`
Required: No
** mp4 **
Sets whether MP4 files are routed to audio or video processing.
Type: String
Valid Values: `IMAGE | DOCUMENT | AUDIO | VIDEO`
Required: No
** png **
Sets whether PNG files are routed to document or image processing.
Type: String
Valid Values: `IMAGE | DOCUMENT | AUDIO | VIDEO`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ModalityRoutingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ModalityRoutingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ModalityRoutingConfiguration)
# NotificationConfiguration
Notification configuration for ingestion jobs.
## Contents
** eventBridgeConfiguration **
EventBridge configuration.
Type: [EventBridgeConfiguration](API_data-automation_EventBridgeConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/NotificationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/NotificationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/NotificationConfiguration)
# OutputConfiguration
Output configuration for ingestion jobs.
## Contents
** s3Uri **
S3 URI for output.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/OutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/OutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/OutputConfiguration)
# OverrideConfiguration
Additional settings for a project.
## Contents
** audio **
This element declares whether your project will process audio files.
Type: [AudioOverrideConfiguration](API_data-automation_AudioOverrideConfiguration.md) object
Required: No
** document **
Settings for processing documents.
Type: [DocumentOverrideConfiguration](API_data-automation_DocumentOverrideConfiguration.md) object
Required: No
** image **
This element declares whether your project will process image files.
Type: [ImageOverrideConfiguration](API_data-automation_ImageOverrideConfiguration.md) object
Required: No
** modalityRouting **
Lets you set which modalities certain file types are processed as.
Type: [ModalityRoutingConfiguration](API_data-automation_ModalityRoutingConfiguration.md) object
Required: No
** video **
This element declares whether your project will process video files.
Type: [VideoOverrideConfiguration](API_data-automation_VideoOverrideConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/OverrideConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/OverrideConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/OverrideConfiguration)
# Phrase
A phrase in a vocabulary entity.
## Contents
** text **
The phrase text.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `.*.+.*`
Required: Yes
** displayAsText **
The display text for the phrase.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `.*.+.*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/Phrase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/Phrase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/Phrase)
# PIIEntitiesConfiguration
Configuration for detecting and redacting Personally Identifiable Information (PII) entities. Specify which PII entity types to detect and the redaction mask mode. If not provided, defaults to ALL entity types with ENTITY\$1TYPE redaction mask mode.
## Contents
** piiEntityTypes **
List of PII entity types to detect/redact in the output. Choose from specific entity types (such as ADDRESS, NAME, EMAIL, PHONE, US\$1SOCIAL\$1SECURITY\$1NUMBER) or specify ALL to detect all supported PII types. If not specified, defaults to ALL.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 32 items.
Valid Values: `ALL | ADDRESS | AGE | NAME | EMAIL | PHONE | USERNAME | PASSWORD | DRIVER_ID | LICENSE_PLATE | VEHICLE_IDENTIFICATION_NUMBER | CREDIT_DEBIT_CARD_CVV | CREDIT_DEBIT_CARD_EXPIRY | CREDIT_DEBIT_CARD_NUMBER | PIN | INTERNATIONAL_BANK_ACCOUNT_NUMBER | SWIFT_CODE | IP_ADDRESS | MAC_ADDRESS | URL | AWS_ACCESS_KEY | AWS_SECRET_KEY | US_BANK_ACCOUNT_NUMBER | US_BANK_ROUTING_NUMBER | US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER | US_PASSPORT_NUMBER | US_SOCIAL_SECURITY_NUMBER | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER | UK_NATIONAL_HEALTH_SERVICE_NUMBER | UK_NATIONAL_INSURANCE_NUMBER | UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER`
Required: No
** redactionMaskMode **
Defines how detected PII entities are masked in redacted output files. Set to PII to replace all detected entities with a generic [PII] marker regardless of entity type. Set to ENTITY\$1TYPE to replace each detected entity with its specific type marker (for example, [NAME], [EMAIL], [ADDRESS]). This setting only applies when detectionMode is set to DETECTION\$1AND\$1REDACTION. If not specified, defaults to ENTITY\$1TYPE.
Type: String
Valid Values: `PII | ENTITY_TYPE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/PIIEntitiesConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/PIIEntitiesConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/PIIEntitiesConfiguration)
# S3Object
An object stored in Amazon S3.
## Contents
** s3Uri **
The S3 URI of the object.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?`
Required: Yes
** version **
The version of the S3 object.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/S3Object)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/S3Object)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/S3Object)
# SensitiveDataConfiguration
Configuration for detecting and redacting sensitive data in content. Use this to control whether sensitive data is detected only or both detected and redacted, specify the scope of detection (standard output, custom output, or both), and configure specific PII entity types to detect along with how they should be masked when redacted.
## Contents
** detectionMode **
Specifies the mode for handling sensitive data detection. Set to DETECTION to only identify sensitive data without modifying content - this produces one output file per detection scope containing detection information with original unredacted content. Set to DETECTION\$1AND\$1REDACTION to both identify and mask sensitive data - this produces two output files per detection scope: one unredacted file with detection information and one redacted file with masking applied to sensitive content. For example, if detectionScope includes both STANDARD and CUSTOM with DETECTION\$1AND\$1REDACTION mode, four output files will be generated (two for standard output and two for custom output).
Type: String
Valid Values: `DETECTION | DETECTION_AND_REDACTION`
Required: Yes
** detectionScope **
Defines which BDA output types to apply sensitive data detection to. Specify STANDARD to detect sensitive data in standard output, CUSTOM to detect in custom output (blueprint-based extraction), or both to apply detection to both output types. If not specified, defaults to both STANDARD and CUSTOM. The number of output files generated depends on both the detection mode and the scopes selected - each scope specified will produce its own set of output files according to the detection mode configured.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 2 items.
Valid Values: `STANDARD | CUSTOM`
Required: No
** piiEntitiesConfiguration **
Configuration for detecting and redacting Personally Identifiable Information (PII) entities.
Type: [PIIEntitiesConfiguration](API_data-automation_PIIEntitiesConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/SensitiveDataConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/SensitiveDataConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/SensitiveDataConfiguration)
# SpeakerLabelingConfiguration
Enables or disables speaker labeling. Speaker labeling, when enabled will assign a number to each speaker, and indicate which speaker is talking in each portion of the transcript. This appears in the response as "spk\$10" for the first speaker, "spk\$11" for the second, and so on for up to 30 speakers.
## Contents
** state **
State of speaker labeling, either enabled or disabled.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/SpeakerLabelingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/SpeakerLabelingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/SpeakerLabelingConfiguration)
# SplitterConfiguration
Document splitter settings. If a document is too large to be processed in one pass, the document splitter splits it into smaller documents.
## Contents
** state **
Whether document splitter is enabled for a project.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/SplitterConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/SplitterConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/SplitterConfiguration)
# StandardOutputConfiguration
Output settings for processing data.
## Contents
** audio **
Settings for processing audio.
Type: [AudioStandardOutputConfiguration](API_data-automation_AudioStandardOutputConfiguration.md) object
Required: No
** document **
Settings for processing documents.
Type: [DocumentStandardOutputConfiguration](API_data-automation_DocumentStandardOutputConfiguration.md) object
Required: No
** image **
Settings for processing images.
Type: [ImageStandardOutputConfiguration](API_data-automation_ImageStandardOutputConfiguration.md) object
Required: No
** video **
Settings for processing video.
Type: [VideoStandardOutputConfiguration](API_data-automation_VideoStandardOutputConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/StandardOutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/StandardOutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/StandardOutputConfiguration)
# Tag
A tag associated with a resource. Made up of a Key and Value
## Contents
** key **
The tag's key
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
** value **
The tag's value
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/Tag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/Tag)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/Tag)
# TranscriptConfiguration
Configuration for transcript options. This option allows you to enable speaker labeling and channel labeling.
## Contents
** channelLabeling **
Enables channel labeling. Each audio channel will be labeled with a number, and the transcript will indicate which channel is being used.
Type: [ChannelLabelingConfiguration](API_data-automation_ChannelLabelingConfiguration.md) object
Required: No
** speakerLabeling **
Enables speaker labeling. Each speaker within a transcript will recieve a number, and the transcript will note which speaker is talking.
Type: [SpeakerLabelingConfiguration](API_data-automation_SpeakerLabelingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/TranscriptConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/TranscriptConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/TranscriptConfiguration)
# UpsertEntityInfo
Information about entities to upsert.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** vocabulary **
Vocabulary entity information.
Type: [VocabularyEntityInfo](API_data-automation_VocabularyEntityInfo.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/UpsertEntityInfo)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/UpsertEntityInfo)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/UpsertEntityInfo)
# ValidationExceptionField
Error information for a field that failed validation.
## Contents
** message **
The error message.
Type: String
Pattern: `[\s\S]+`
Required: Yes
** name **
The field's name.
Type: String
Pattern: `[\s\S]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/ValidationExceptionField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/ValidationExceptionField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/ValidationExceptionField)
# VideoBoundingBox
Bounding box settings for video.
## Contents
** state **
Whether bounding boxes are enabled for video.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VideoBoundingBox)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VideoBoundingBox)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VideoBoundingBox)
# VideoExtractionCategory
Settings for generating categorical data from video.
## Contents
** state **
Whether generating categorical data from video is enabled.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
** types **
The types of data to generate.
Type: Array of strings
Valid Values: `CONTENT_MODERATION | TEXT_DETECTION | TRANSCRIPT | LOGOS`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VideoExtractionCategory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VideoExtractionCategory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VideoExtractionCategory)
# VideoOverrideConfiguration
Sets whether your project will process videos or not.
## Contents
** modalityProcessing **
Sets modality processing for video files. All modalities are enabled by default.
Type: [ModalityProcessingConfiguration](API_data-automation_ModalityProcessingConfiguration.md) object
Required: No
** sensitiveDataConfiguration **
Configuration for sensitive data detection and redaction for video files.
Type: [SensitiveDataConfiguration](API_data-automation_SensitiveDataConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VideoOverrideConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VideoOverrideConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VideoOverrideConfiguration)
# VideoStandardExtraction
Settings for generating data from video.
## Contents
** boundingBox **
Settings for generating bounding boxes.
Type: [VideoBoundingBox](API_data-automation_VideoBoundingBox.md) object
Required: Yes
** category **
Settings for generating categorical data.
Type: [VideoExtractionCategory](API_data-automation_VideoExtractionCategory.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VideoStandardExtraction)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VideoStandardExtraction)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VideoStandardExtraction)
# VideoStandardGenerativeField
Settings for generating descriptions of video.
## Contents
** state **
Whether generating descriptions is enabled for video.
Type: String
Valid Values: `ENABLED | DISABLED`
Required: Yes
** types **
The types of description to generate.
Type: Array of strings
Valid Values: `VIDEO_SUMMARY | IAB | CHAPTER_SUMMARY`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VideoStandardGenerativeField)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VideoStandardGenerativeField)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VideoStandardGenerativeField)
# VideoStandardOutputConfiguration
Output settings for processing video.
## Contents
** extraction **
Settings for populating data fields that describe the video.
Type: [VideoStandardExtraction](API_data-automation_VideoStandardExtraction.md) object
Required: No
** generativeField **
Whether to generate descriptions of the video.
Type: [VideoStandardGenerativeField](API_data-automation_VideoStandardGenerativeField.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VideoStandardOutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VideoStandardOutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VideoStandardOutputConfiguration)
# VocabularyEntity
A vocabulary entity.
## Contents
** description **
The entity description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern: `[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*`
Required: No
** entityId **
The entity ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: No
** language **
The entity language.
Type: String
Valid Values: `EN | DE | ES | FR | IT | PT | JA | KO | CN | TW | HK`
Required: No
** lastModifiedTime **
When the entity was last modified.
Type: Timestamp
Required: No
** phrases **
The entity phrases.
Type: Array of [Phrase](API_data-automation_Phrase.md) objects
Array Members: Minimum number of 1 item.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VocabularyEntity)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VocabularyEntity)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VocabularyEntity)
# VocabularyEntityInfo
Information about a vocabulary entity.
## Contents
** language **
The entity language.
Type: String
Valid Values: `EN | DE | ES | FR | IT | PT | JA | KO | CN | TW | HK`
Required: Yes
** phrases **
The entity phrases.
Type: Array of [Phrase](API_data-automation_Phrase.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
** description **
The entity description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern: `[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*`
Required: No
** entityId **
The entity ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VocabularyEntityInfo)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VocabularyEntityInfo)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VocabularyEntityInfo)
# VocabularyEntitySummary
A summary of a vocabulary entity.
## Contents
** description **
The entity description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern: `[a-zA-Z0-9\s!"\#\$%'&\(\)\*\+\,\-\./:;=\?@\[\\\]\^_`\{\|\}~><À-ÖØ-Üßà-öø-üẞ¿¡Œ-œ°£¥₹€§©ª®™¹±-µ✓⑆-⑉฿₽₱₦₣₩₫₺]*`
Required: No
** entityId **
The entity ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9-_]+`
Required: No
** language **
The entity language.
Type: String
Valid Values: `EN | DE | ES | FR | IT | PT | JA | KO | CN | TW | HK`
Required: No
** lastModifiedTime **
When the entity was last modified.
Type: Timestamp
Required: No
** numOfPhrases **
The number of phrases in the entity.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-2023-07-26/VocabularyEntitySummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-2023-07-26/VocabularyEntitySummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-2023-07-26/VocabularyEntitySummary)
# Runtime for Amazon Bedrock Data Automation
The following data types are supported by Runtime for Amazon Bedrock Data Automation:
+ [AssetProcessingConfiguration](API_data-automation-runtime_AssetProcessingConfiguration.md)
+ [Blueprint](API_data-automation-runtime_Blueprint.md)
+ [DataAutomationConfiguration](API_data-automation-runtime_DataAutomationConfiguration.md)
+ [EncryptionConfiguration](API_data-automation-runtime_EncryptionConfiguration.md)
+ [EventBridgeConfiguration](API_data-automation-runtime_EventBridgeConfiguration.md)
+ [InputConfiguration](API_data-automation-runtime_InputConfiguration.md)
+ [NotificationConfiguration](API_data-automation-runtime_NotificationConfiguration.md)
+ [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md)
+ [OutputSegment](API_data-automation-runtime_OutputSegment.md)
+ [SyncInputConfiguration](API_data-automation-runtime_SyncInputConfiguration.md)
+ [Tag](API_data-automation-runtime_Tag.md)
+ [TimestampSegment](API_data-automation-runtime_TimestampSegment.md)
+ [VideoAssetProcessingConfiguration](API_data-automation-runtime_VideoAssetProcessingConfiguration.md)
+ [VideoSegmentConfiguration](API_data-automation-runtime_VideoSegmentConfiguration.md)
# AssetProcessingConfiguration
Allows you to configure your input asset to narrow where you're looking for content. Works with passing segements of a larger video.
## Contents
** video **
Configures what portion of a video you want to run analysis on.
Type: [VideoAssetProcessingConfiguration](API_data-automation-runtime_VideoAssetProcessingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/AssetProcessingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/AssetProcessingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/AssetProcessingConfiguration)
# Blueprint
Details about a data automation blueprint.
## Contents
** blueprintArn **
The blueprint's ARN.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-insights-public-[a-zA-Z0-9-_]{1,30}|bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})`
Required: Yes
** stage **
The blueprint's stage.
Type: String
Valid Values: `DEVELOPMENT | LIVE`
Required: No
** version **
The blueprint's version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[0-9]*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/Blueprint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/Blueprint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/Blueprint)
# DataAutomationConfiguration
Details about a data automation project.
## Contents
** dataAutomationProjectArn **
The ARN of the project you're using in your configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `arn:aws(|-cn|-us-gov):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):data-automation-project/[a-zA-Z0-9-_]+`
Required: Yes
** stage **
The project's stage.
Type: String
Valid Values: `LIVE | DEVELOPMENT`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/DataAutomationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/DataAutomationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/DataAutomationConfiguration)
# EncryptionConfiguration
Encryption settings for an invocation.
## Contents
** kmsKeyId **
A KMS key ID to use for encryption.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+`
Required: Yes
** kmsEncryptionContext **
Name-value pairs to include as an encryption context.
Type: String to string map
Map Entries: Maximum number of 10 items.
Key Length Constraints: Minimum length of 1. Maximum length of 2000.
Key Pattern: `.*\S.*`
Value Length Constraints: Minimum length of 1. Maximum length of 2000.
Value Pattern: `.*\S.*`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/EncryptionConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/EncryptionConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/EncryptionConfiguration)
# EventBridgeConfiguration
Event bus settings for an invocation.
## Contents
** eventBridgeEnabled **
Whether to send events to an event bus.
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/EventBridgeConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/EventBridgeConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/EventBridgeConfiguration)
# InputConfiguration
Input object settings for an invocation.
## Contents
** s3Uri **
The objects S3 URI.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/[^\x00-\x1F\x7F\{^}%`\]">\[~<#|]*)?`
Required: Yes
** assetProcessingConfiguration **
Lets you configure what portion of content you want to analyze. Works with passing segements of a larger video.
Type: [AssetProcessingConfiguration](API_data-automation-runtime_AssetProcessingConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/InputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/InputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/InputConfiguration)
# NotificationConfiguration
Notification settings for an invocation.
## Contents
** eventBridgeConfiguration **
Event bus settings.
Type: [EventBridgeConfiguration](API_data-automation-runtime_EventBridgeConfiguration.md) object
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/NotificationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/NotificationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/NotificationConfiguration)
# OutputConfiguration
Output settings for an invocation. The service adds a unique invocation ID to the path that you specify and stores output objects under that path.
## Contents
** s3Uri **
The S3 URI for invocation output.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/[^\x00-\x1F\x7F\{^}%`\]">\[~<#|]*)?`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/OutputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/OutputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/OutputConfiguration)
# OutputSegment
A segment of output from a data automation invocation.
## Contents
** customOutput **
The custom output content for this segment.
Type: String
Required: No
** customOutputStatus **
The status of the custom output for this segment.
Type: String
Valid Values: `MATCH | NO_MATCH`
Required: No
** standardOutput **
The standard output content for this segment.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/OutputSegment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/OutputSegment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/OutputSegment)
# SyncInputConfiguration
Input configuration for a synchronous data automation invocation.
## Contents
** bytes **
The raw bytes of the input asset.
Type: Base64-encoded binary data object
Required: No
** s3Uri **
The S3 URI of the input asset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/[^\x00-\x1F\x7F\{^}%`\]">\[~<#|]*)?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/SyncInputConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/SyncInputConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/SyncInputConfiguration)
# Tag
A tag associated with a resource. A tag consists of a key and value.
## Contents
** key **
The key associated with a tag.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*`
Required: Yes
** value **
The value associated with a tag.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: `([\p{L}\p{Z}\p{N}_.:/=+\-@]*)`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/Tag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/Tag)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/Tag)
# TimestampSegment
Contians the start and end timestamp of the segement of the larger video you want to detect. The minimum video segment length is 5 minutes.
## Contents
** endTimeMillis **
The end time of the segment you want to extract information from.
Type: Long
Valid Range: Minimum value of 300000.
Required: Yes
** startTimeMillis **
The start time of the segement you want to extract information from.
Type: Long
Valid Range: Minimum value of 0.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/TimestampSegment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/TimestampSegment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/TimestampSegment)
# VideoAssetProcessingConfiguration
Sets up elements of your video asset. Lets you set what segement of a larger video you want to detect information from.
## Contents
** segmentConfiguration **
Allows you to set up a portion of a video you want to detect information from. You can select a segment 5 minutes or longer, and your analysis will treat that as a full video.
Type: [VideoSegmentConfiguration](API_data-automation-runtime_VideoSegmentConfiguration.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/VideoAssetProcessingConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/VideoAssetProcessingConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/VideoAssetProcessingConfiguration)
# VideoSegmentConfiguration
Used to set your start and end timestamp for what portion of a video you'd like to detect. The minimum segement length is 5 minutes.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** timestampSegment **
Holds the timestamps for the beginning and end of your video segment.
Type: [TimestampSegment](API_data-automation-runtime_TimestampSegment.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-data-automation-runtime-2024-06-13/VideoSegmentConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-data-automation-runtime-2024-06-13/VideoSegmentConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-data-automation-runtime-2024-06-13/VideoSegmentConfiguration)
# Amazon Bedrock Runtime
The following data types are supported by Amazon Bedrock Runtime:
+ [AnyToolChoice](API_runtime_AnyToolChoice.md)
+ [AppliedGuardrailDetails](API_runtime_AppliedGuardrailDetails.md)
+ [AsyncInvokeOutputDataConfig](API_runtime_AsyncInvokeOutputDataConfig.md)
+ [AsyncInvokeS3OutputDataConfig](API_runtime_AsyncInvokeS3OutputDataConfig.md)
+ [AsyncInvokeSummary](API_runtime_AsyncInvokeSummary.md)
+ [AudioBlock](API_runtime_AudioBlock.md)
+ [AudioSource](API_runtime_AudioSource.md)
+ [AutoToolChoice](API_runtime_AutoToolChoice.md)
+ [BidirectionalInputPayloadPart](API_runtime_BidirectionalInputPayloadPart.md)
+ [BidirectionalOutputPayloadPart](API_runtime_BidirectionalOutputPayloadPart.md)
+ [CacheDetail](API_runtime_CacheDetail.md)
+ [CachePointBlock](API_runtime_CachePointBlock.md)
+ [Citation](API_runtime_Citation.md)
+ [CitationGeneratedContent](API_runtime_CitationGeneratedContent.md)
+ [CitationLocation](API_runtime_CitationLocation.md)
+ [CitationsConfig](API_runtime_CitationsConfig.md)
+ [CitationsContentBlock](API_runtime_CitationsContentBlock.md)
+ [CitationsDelta](API_runtime_CitationsDelta.md)
+ [CitationSourceContent](API_runtime_CitationSourceContent.md)
+ [CitationSourceContentDelta](API_runtime_CitationSourceContentDelta.md)
+ [ContentBlock](API_runtime_ContentBlock.md)
+ [ContentBlockDelta](API_runtime_ContentBlockDelta.md)
+ [ContentBlockDeltaEvent](API_runtime_ContentBlockDeltaEvent.md)
+ [ContentBlockStart](API_runtime_ContentBlockStart.md)
+ [ContentBlockStartEvent](API_runtime_ContentBlockStartEvent.md)
+ [ContentBlockStopEvent](API_runtime_ContentBlockStopEvent.md)
+ [ConverseMetrics](API_runtime_ConverseMetrics.md)
+ [ConverseOutput](API_runtime_ConverseOutput.md)
+ [ConverseStreamMetadataEvent](API_runtime_ConverseStreamMetadataEvent.md)
+ [ConverseStreamMetrics](API_runtime_ConverseStreamMetrics.md)
+ [ConverseStreamOutput](API_runtime_ConverseStreamOutput.md)
+ [ConverseStreamTrace](API_runtime_ConverseStreamTrace.md)
+ [ConverseTokensRequest](API_runtime_ConverseTokensRequest.md)
+ [ConverseTrace](API_runtime_ConverseTrace.md)
+ [CountTokensInput](API_runtime_CountTokensInput.md)
+ [DocumentBlock](API_runtime_DocumentBlock.md)
+ [DocumentCharLocation](API_runtime_DocumentCharLocation.md)
+ [DocumentChunkLocation](API_runtime_DocumentChunkLocation.md)
+ [DocumentContentBlock](API_runtime_DocumentContentBlock.md)
+ [DocumentPageLocation](API_runtime_DocumentPageLocation.md)
+ [DocumentSource](API_runtime_DocumentSource.md)
+ [ErrorBlock](API_runtime_ErrorBlock.md)
+ [GuardrailAssessment](API_runtime_GuardrailAssessment.md)
+ [GuardrailAutomatedReasoningFinding](API_runtime_GuardrailAutomatedReasoningFinding.md)
+ [GuardrailAutomatedReasoningImpossibleFinding](API_runtime_GuardrailAutomatedReasoningImpossibleFinding.md)
+ [GuardrailAutomatedReasoningInputTextReference](API_runtime_GuardrailAutomatedReasoningInputTextReference.md)
+ [GuardrailAutomatedReasoningInvalidFinding](API_runtime_GuardrailAutomatedReasoningInvalidFinding.md)
+ [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md)
+ [GuardrailAutomatedReasoningNoTranslationsFinding](API_runtime_GuardrailAutomatedReasoningNoTranslationsFinding.md)
+ [GuardrailAutomatedReasoningPolicyAssessment](API_runtime_GuardrailAutomatedReasoningPolicyAssessment.md)
+ [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md)
+ [GuardrailAutomatedReasoningSatisfiableFinding](API_runtime_GuardrailAutomatedReasoningSatisfiableFinding.md)
+ [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md)
+ [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md)
+ [GuardrailAutomatedReasoningTooComplexFinding](API_runtime_GuardrailAutomatedReasoningTooComplexFinding.md)
+ [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md)
+ [GuardrailAutomatedReasoningTranslationAmbiguousFinding](API_runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding.md)
+ [GuardrailAutomatedReasoningTranslationOption](API_runtime_GuardrailAutomatedReasoningTranslationOption.md)
+ [GuardrailAutomatedReasoningValidFinding](API_runtime_GuardrailAutomatedReasoningValidFinding.md)
+ [GuardrailConfiguration](API_runtime_GuardrailConfiguration.md)
+ [GuardrailContentBlock](API_runtime_GuardrailContentBlock.md)
+ [GuardrailContentFilter](API_runtime_GuardrailContentFilter.md)
+ [GuardrailContentPolicyAssessment](API_runtime_GuardrailContentPolicyAssessment.md)
+ [GuardrailContextualGroundingFilter](API_runtime_GuardrailContextualGroundingFilter.md)
+ [GuardrailContextualGroundingPolicyAssessment](API_runtime_GuardrailContextualGroundingPolicyAssessment.md)
+ [GuardrailConverseContentBlock](API_runtime_GuardrailConverseContentBlock.md)
+ [GuardrailConverseImageBlock](API_runtime_GuardrailConverseImageBlock.md)
+ [GuardrailConverseImageSource](API_runtime_GuardrailConverseImageSource.md)
+ [GuardrailConverseTextBlock](API_runtime_GuardrailConverseTextBlock.md)
+ [GuardrailCoverage](API_runtime_GuardrailCoverage.md)
+ [GuardrailCustomWord](API_runtime_GuardrailCustomWord.md)
+ [GuardrailImageBlock](API_runtime_GuardrailImageBlock.md)
+ [GuardrailImageCoverage](API_runtime_GuardrailImageCoverage.md)
+ [GuardrailImageSource](API_runtime_GuardrailImageSource.md)
+ [GuardrailInvocationMetrics](API_runtime_GuardrailInvocationMetrics.md)
+ [GuardrailManagedWord](API_runtime_GuardrailManagedWord.md)
+ [GuardrailOutputContent](API_runtime_GuardrailOutputContent.md)
+ [GuardrailPiiEntityFilter](API_runtime_GuardrailPiiEntityFilter.md)
+ [GuardrailRegexFilter](API_runtime_GuardrailRegexFilter.md)
+ [GuardrailSensitiveInformationPolicyAssessment](API_runtime_GuardrailSensitiveInformationPolicyAssessment.md)
+ [GuardrailStreamConfiguration](API_runtime_GuardrailStreamConfiguration.md)
+ [GuardrailTextBlock](API_runtime_GuardrailTextBlock.md)
+ [GuardrailTextCharactersCoverage](API_runtime_GuardrailTextCharactersCoverage.md)
+ [GuardrailTopic](API_runtime_GuardrailTopic.md)
+ [GuardrailTopicPolicyAssessment](API_runtime_GuardrailTopicPolicyAssessment.md)
+ [GuardrailTraceAssessment](API_runtime_GuardrailTraceAssessment.md)
+ [GuardrailUsage](API_runtime_GuardrailUsage.md)
+ [GuardrailWordPolicyAssessment](API_runtime_GuardrailWordPolicyAssessment.md)
+ [ImageBlock](API_runtime_ImageBlock.md)
+ [ImageBlockDelta](API_runtime_ImageBlockDelta.md)
+ [ImageBlockStart](API_runtime_ImageBlockStart.md)
+ [ImageSource](API_runtime_ImageSource.md)
+ [InferenceConfiguration](API_runtime_InferenceConfiguration.md)
+ [InvokeModelTokensRequest](API_runtime_InvokeModelTokensRequest.md)
+ [InvokeModelWithBidirectionalStreamInput](API_runtime_InvokeModelWithBidirectionalStreamInput.md)
+ [InvokeModelWithBidirectionalStreamOutput](API_runtime_InvokeModelWithBidirectionalStreamOutput.md)
+ [JsonSchemaDefinition](API_runtime_JsonSchemaDefinition.md)
+ [Message](API_runtime_Message.md)
+ [MessageStartEvent](API_runtime_MessageStartEvent.md)
+ [MessageStopEvent](API_runtime_MessageStopEvent.md)
+ [OutputConfig](API_runtime_OutputConfig.md)
+ [OutputFormat](API_runtime_OutputFormat.md)
+ [OutputFormatStructure](API_runtime_OutputFormatStructure.md)
+ [PayloadPart](API_runtime_PayloadPart.md)
+ [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md)
+ [PromptRouterTrace](API_runtime_PromptRouterTrace.md)
+ [PromptVariableValues](API_runtime_PromptVariableValues.md)
+ [ReasoningContentBlock](API_runtime_ReasoningContentBlock.md)
+ [ReasoningContentBlockDelta](API_runtime_ReasoningContentBlockDelta.md)
+ [ReasoningTextBlock](API_runtime_ReasoningTextBlock.md)
+ [ResponseStream](API_runtime_ResponseStream.md)
+ [S3Location](API_runtime_S3Location.md)
+ [SearchResultBlock](API_runtime_SearchResultBlock.md)
+ [SearchResultContentBlock](API_runtime_SearchResultContentBlock.md)
+ [SearchResultLocation](API_runtime_SearchResultLocation.md)
+ [ServiceTier](API_runtime_ServiceTier.md)
+ [SpecificToolChoice](API_runtime_SpecificToolChoice.md)
+ [SystemContentBlock](API_runtime_SystemContentBlock.md)
+ [SystemTool](API_runtime_SystemTool.md)
+ [Tag](API_runtime_Tag.md)
+ [TokenUsage](API_runtime_TokenUsage.md)
+ [Tool](API_runtime_Tool.md)
+ [ToolChoice](API_runtime_ToolChoice.md)
+ [ToolConfiguration](API_runtime_ToolConfiguration.md)
+ [ToolInputSchema](API_runtime_ToolInputSchema.md)
+ [ToolResultBlock](API_runtime_ToolResultBlock.md)
+ [ToolResultBlockDelta](API_runtime_ToolResultBlockDelta.md)
+ [ToolResultBlockStart](API_runtime_ToolResultBlockStart.md)
+ [ToolResultContentBlock](API_runtime_ToolResultContentBlock.md)
+ [ToolSpecification](API_runtime_ToolSpecification.md)
+ [ToolUseBlock](API_runtime_ToolUseBlock.md)
+ [ToolUseBlockDelta](API_runtime_ToolUseBlockDelta.md)
+ [ToolUseBlockStart](API_runtime_ToolUseBlockStart.md)
+ [VideoBlock](API_runtime_VideoBlock.md)
+ [VideoSource](API_runtime_VideoSource.md)
+ [WebLocation](API_runtime_WebLocation.md)
# AnyToolChoice
The model must request at least one tool (no text is generated). For example, `{"any" : {}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AnyToolChoice)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AnyToolChoice)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AnyToolChoice)
# AppliedGuardrailDetails
Details about the specific guardrail that was applied during this assessment, including its identifier, version, ARN, origin, and ownership information.
## Contents
** guardrailArn **
The ARN of the guardrail that was applied.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+)`
Required: No
** guardrailId **
The unique ID of the guardrail that was applied.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `([a-z0-9]+)`
Required: No
** guardrailOrigin **
The origin of how the guardrail was applied. This can be either requested at the API level or enforced at the account or organization level as a default guardrail.
Type: Array of strings
Valid Values: `REQUEST | ACCOUNT_ENFORCED | ORGANIZATION_ENFORCED`
Required: No
** guardrailOwnership **
The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account.
Type: String
Valid Values: `SELF | CROSS_ACCOUNT`
Required: No
** guardrailVersion **
The version of the guardrail that was applied.
Type: String
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AppliedGuardrailDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AppliedGuardrailDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AppliedGuardrailDetails)
# AsyncInvokeOutputDataConfig
Asynchronous invocation output data settings.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** s3OutputDataConfig **
A storage location for the output data in an S3 bucket
Type: [AsyncInvokeS3OutputDataConfig](API_runtime_AsyncInvokeS3OutputDataConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AsyncInvokeOutputDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AsyncInvokeOutputDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AsyncInvokeOutputDataConfig)
# AsyncInvokeS3OutputDataConfig
Asynchronous invocation output data settings.
## Contents
** s3Uri **
An object URI starting with `s3://`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?`
Required: Yes
** bucketOwner **
If the bucket belongs to another AWS account, specify that account's ID.
Type: String
Pattern: `[0-9]{12}`
Required: No
** kmsKeyId **
A KMS encryption key ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+))`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AsyncInvokeS3OutputDataConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AsyncInvokeS3OutputDataConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AsyncInvokeS3OutputDataConfig)
# AsyncInvokeSummary
A summary of an asynchronous invocation.
## Contents
** invocationArn **
The invocation's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:async-invoke/[a-z0-9]{12}`
Required: Yes
** modelArn **
The invoked model's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern: `arn:[a-z0-9\-]+:bedrock:[a-z0-9\-]*:[0-9]*:(provisioned-model|foundation-model)/.+`
Required: Yes
** outputDataConfig **
The invocation's output data settings.
Type: [AsyncInvokeOutputDataConfig](API_runtime_AsyncInvokeOutputDataConfig.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** submitTime **
When the invocation was submitted.
Type: Timestamp
Required: Yes
** clientRequestToken **
The invocation's idempotency token.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: `[!-~]*`
Required: No
** endTime **
When the invocation ended.
Type: Timestamp
Required: No
** failureMessage **
An error message.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
** lastModifiedTime **
When the invocation was last modified.
Type: Timestamp
Required: No
** status **
The invocation's status.
Type: String
Valid Values: `InProgress | Completed | Failed`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AsyncInvokeSummary)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AsyncInvokeSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AsyncInvokeSummary)
# AudioBlock
An audio content block that contains audio data in various supported formats.
## Contents
** format **
The format of the audio data, such as MP3, WAV, FLAC, or other supported audio formats.
Type: String
Valid Values: `mp3 | opus | wav | aac | flac | mp4 | ogg | mkv | mka | x-aac | m4a | mpeg | mpga | pcm | webm`
Required: Yes
** source **
The source of the audio data, which can be provided as raw bytes or an S3 location.
Type: [AudioSource](API_runtime_AudioSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** error **
Error information if the audio block could not be processed or contains invalid data.
Type: [ErrorBlock](API_runtime_ErrorBlock.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AudioBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AudioBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AudioBlock)
# AudioSource
The source of audio data, which can be provided either as raw bytes or a reference to an S3 location.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bytes **
Audio data encoded in base64.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1.
Required: No
** s3Location **
A reference to audio data stored in an Amazon S3 bucket. To see which models support S3 uploads, see [Supported models and features for Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).
Type: [S3Location](API_runtime_S3Location.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AudioSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AudioSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AudioSource)
# AutoToolChoice
The Model automatically decides if a tool should be called or whether to generate text instead. For example, `{"auto" : {}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/AutoToolChoice)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/AutoToolChoice)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/AutoToolChoice)
# BidirectionalInputPayloadPart
Payload content for the bidirectional input. The input is an audio stream.
## Contents
** bytes **
The audio content for the bidirectional input.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/BidirectionalInputPayloadPart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/BidirectionalInputPayloadPart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/BidirectionalInputPayloadPart)
# BidirectionalOutputPayloadPart
Output from the bidirectional stream. The output is speech and a text transcription.
## Contents
** bytes **
The speech output of the bidirectional stream.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/BidirectionalOutputPayloadPart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/BidirectionalOutputPayloadPart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/BidirectionalOutputPayloadPart)
# CacheDetail
Cache creation metrics for a specific TTL duration
## Contents
** inputTokens **
Number of tokens written to cache with this TTL (cache creation tokens)
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
** ttl **
TTL duration for these cached tokens
Type: String
Valid Values: `5m | 1h`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CacheDetail)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CacheDetail)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CacheDetail)
# CachePointBlock
Defines a section of content to be cached for reuse in subsequent API calls.
## Contents
** type **
Specifies the type of cache point within the CachePointBlock.
Type: String
Valid Values: `default`
Required: Yes
** ttl **
Optional TTL duration for cache entries. When specified, enables extended TTL caching with the specified duration. When omitted, uses `type` value for caching behavior.
Type: String
Valid Values: `5m | 1h`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CachePointBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CachePointBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CachePointBlock)
# Citation
Contains information about a citation that references a specific source document. Citations provide traceability between the model's generated response and the source documents that informed that response.
## Contents
** location **
The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.
Type: [CitationLocation](API_runtime_CitationLocation.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** source **
The source from the original search result that provided the cited content.
Type: String
Required: No
** sourceContent **
The specific content from the source document that was referenced or cited in the generated response.
Type: Array of [CitationSourceContent](API_runtime_CitationSourceContent.md) objects
Required: No
** title **
The title or identifier of the source document being cited.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Citation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Citation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Citation)
# CitationGeneratedContent
Contains the generated text content that corresponds to or is supported by a citation from a source document.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** text **
The text content that was generated by the model and is supported by the associated citation.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationGeneratedContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationGeneratedContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationGeneratedContent)
# CitationLocation
Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** documentChar **
The character-level location within the document where the cited content is found.
Type: [DocumentCharLocation](API_runtime_DocumentCharLocation.md) object
Required: No
** documentChunk **
The chunk-level location within the document where the cited content is found, typically used for documents that have been segmented into logical chunks.
Type: [DocumentChunkLocation](API_runtime_DocumentChunkLocation.md) object
Required: No
** documentPage **
The page-level location within the document where the cited content is found.
Type: [DocumentPageLocation](API_runtime_DocumentPageLocation.md) object
Required: No
** searchResultLocation **
The search result location where the cited content is found, including the search result index and block positions within the content array.
Type: [SearchResultLocation](API_runtime_SearchResultLocation.md) object
Required: No
** web **
The web URL that was cited for this reference.
Type: [WebLocation](API_runtime_WebLocation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationLocation)
# CitationsConfig
Configuration settings for enabling and controlling document citations in Converse API responses. When enabled, the model can include citation information that links generated content back to specific source documents.
## Contents
** enabled **
Specifies whether citations from the selected document should be used in the model's response. When set to true, the model can generate citations that reference the source documents used to inform the response.
Type: Boolean
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationsConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationsConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationsConfig)
# CitationsContentBlock
A content block that contains both generated text and associated citation information. This block type is returned when document citations are enabled, providing traceability between the generated content and the source documents that informed the response.
## Contents
** citations **
An array of citations that reference the source documents used to generate the associated content.
Type: Array of [Citation](API_runtime_Citation.md) objects
Required: No
** content **
The generated content that is supported by the associated citations.
Type: Array of [CitationGeneratedContent](API_runtime_CitationGeneratedContent.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationsContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationsContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationsContentBlock)
# CitationsDelta
Contains incremental updates to citation information during streaming responses. This allows clients to build up citation data progressively as the response is generated.
## Contents
** location **
Specifies the precise location within a source document where cited content can be found. This can include character-level positions, page numbers, or document chunks depending on the document type and indexing method.
Type: [CitationLocation](API_runtime_CitationLocation.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** source **
The source from the original search result that provided the cited content.
Type: String
Required: No
** sourceContent **
The specific content from the source document that was referenced or cited in the generated response.
Type: Array of [CitationSourceContentDelta](API_runtime_CitationSourceContentDelta.md) objects
Required: No
** title **
The title or identifier of the source document being cited.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationsDelta)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationsDelta)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationsDelta)
# CitationSourceContent
Contains the actual text content from a source document that is being cited or referenced in the model's response.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** text **
The text content from the source document that is being cited.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationSourceContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationSourceContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationSourceContent)
# CitationSourceContentDelta
Contains incremental updates to the source content text during streaming responses, allowing clients to build up the cited content progressively.
## Contents
** text **
An incremental update to the text content from the source document that is being cited.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CitationSourceContentDelta)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CitationSourceContentDelta)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CitationSourceContentDelta)
# ContentBlock
A block of content for a message that you pass to, or receive from, a model with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** audio **
An audio content block containing audio data in the conversation.
Type: [AudioBlock](API_runtime_AudioBlock.md) object
Required: No
** cachePoint **
CachePoint to include in the message.
Type: [CachePointBlock](API_runtime_CachePointBlock.md) object
Required: No
** citationsContent **
A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.
Type: [CitationsContentBlock](API_runtime_CitationsContentBlock.md) object
Required: No
** document **
A document to include in the message.
Type: [DocumentBlock](API_runtime_DocumentBlock.md) object
Required: No
** guardContent **
Contains the content to assess with the guardrail. If you don't specify `guardContent` in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.
For more information, see [Use a guardrail with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-use-converse-api.html).
Type: [GuardrailConverseContentBlock](API_runtime_GuardrailConverseContentBlock.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** image **
Image to include in the message.
This field is only supported by Anthropic Claude 3 models.
Type: [ImageBlock](API_runtime_ImageBlock.md) object
Required: No
** reasoningContent **
Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
Type: [ReasoningContentBlock](API_runtime_ReasoningContentBlock.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** searchResult **
Search result to include in the message.
Type: [SearchResultBlock](API_runtime_SearchResultBlock.md) object
Required: No
** text **
Text to include in the message.
Type: String
Required: No
** toolResult **
The result for a tool request that a model makes.
Type: [ToolResultBlock](API_runtime_ToolResultBlock.md) object
Required: No
** toolUse **
Information about a tool use request from a model.
Type: [ToolUseBlock](API_runtime_ToolUseBlock.md) object
Required: No
** video **
Video to include in the message.
Type: [VideoBlock](API_runtime_VideoBlock.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlock)
# ContentBlockDelta
A block of content in a streaming response.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** citation **
Incremental citation information that is streamed as part of the response generation process.
Type: [CitationsDelta](API_runtime_CitationsDelta.md) object
Required: No
** image **
A streaming delta event containing incremental image data.
Type: [ImageBlockDelta](API_runtime_ImageBlockDelta.md) object
Required: No
** reasoningContent **
Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
Type: [ReasoningContentBlockDelta](API_runtime_ReasoningContentBlockDelta.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** text **
The content text.
Type: String
Required: No
** toolResult **
An incremental update that contains the results from a tool call.
Type: Array of [ToolResultBlockDelta](API_runtime_ToolResultBlockDelta.md) objects
Required: No
** toolUse **
Information about a tool that the model is requesting to use.
Type: [ToolUseBlockDelta](API_runtime_ToolUseBlockDelta.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockDelta)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockDelta)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockDelta)
# ContentBlockDeltaEvent
The content block delta event.
## Contents
** contentBlockIndex **
The block index for a content block delta event.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
** delta **
The delta for a content block delta event.
Type: [ContentBlockDelta](API_runtime_ContentBlockDelta.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockDeltaEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockDeltaEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockDeltaEvent)
# ContentBlockStart
Content block start information.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** image **
The initial event indicating the start of a streaming image block.
Type: [ImageBlockStart](API_runtime_ImageBlockStart.md) object
Required: No
** toolResult **
The
Type: [ToolResultBlockStart](API_runtime_ToolResultBlockStart.md) object
Required: No
** toolUse **
Information about a tool that the model is requesting to use.
Type: [ToolUseBlockStart](API_runtime_ToolUseBlockStart.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockStart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockStart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockStart)
# ContentBlockStartEvent
Content block start event.
## Contents
** contentBlockIndex **
The index for a content block start event.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
** start **
Start information about a content block start event.
Type: [ContentBlockStart](API_runtime_ContentBlockStart.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockStartEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockStartEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockStartEvent)
# ContentBlockStopEvent
A content block stop event.
## Contents
** contentBlockIndex **
The index for a content block.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ContentBlockStopEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ContentBlockStopEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ContentBlockStopEvent)
# ConverseMetrics
Metrics for a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
## Contents
** latencyMs **
The latency of the call to `Converse`, in milliseconds.
Type: Long
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseMetrics)
# ConverseOutput
The output from a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** message **
The message that the model generates.
Type: [Message](API_runtime_Message.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseOutput)
# ConverseStreamMetadataEvent
A conversation stream metadata event.
## Contents
** metrics **
The metrics for the conversation stream metadata event.
Type: [ConverseStreamMetrics](API_runtime_ConverseStreamMetrics.md) object
Required: Yes
** usage **
Usage information for the conversation stream event.
Type: [TokenUsage](API_runtime_TokenUsage.md) object
Required: Yes
** performanceConfig **
Model performance configuration metadata for the conversation stream event.
Type: [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) object
Required: No
** serviceTier **
Specifies the processing tier configuration used for serving the request.
Type: [ServiceTier](API_runtime_ServiceTier.md) object
Required: No
** trace **
The trace object in the response from [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) that contains information about the guardrail behavior.
Type: [ConverseStreamTrace](API_runtime_ConverseStreamTrace.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStreamMetadataEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStreamMetadataEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStreamMetadataEvent)
# ConverseStreamMetrics
Metrics for the stream.
## Contents
** latencyMs **
The latency for the streaming request, in milliseconds.
Type: Long
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStreamMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStreamMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStreamMetrics)
# ConverseStreamOutput
The messages output stream
## Contents
** contentBlockDelta **
The messages output content block delta.
Type: [ContentBlockDeltaEvent](API_runtime_ContentBlockDeltaEvent.md) object
Required: No
** contentBlockStart **
Start information for a content block.
Type: [ContentBlockStartEvent](API_runtime_ContentBlockStartEvent.md) object
Required: No
** contentBlockStop **
Stop information for a content block.
Type: [ContentBlockStopEvent](API_runtime_ContentBlockStopEvent.md) object
Required: No
** internalServerException **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
Required: No
** messageStart **
Message start information.
Type: [MessageStartEvent](API_runtime_MessageStartEvent.md) object
Required: No
** messageStop **
Message stop information.
Type: [MessageStopEvent](API_runtime_MessageStopEvent.md) object
Required: No
** metadata **
Metadata for the converse output stream.
Type: [ConverseStreamMetadataEvent](API_runtime_ConverseStreamMetadataEvent.md) object
Required: No
** modelStreamErrorException **
A streaming error occurred. Retry your request.
Type: Exception
HTTP Status Code: 424
Required: No
** serviceUnavailableException **
The service isn't currently available. For troubleshooting this error, see [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide
Type: Exception
HTTP Status Code: 503
Required: No
** throttlingException **
Your request was denied due to exceeding the account quotas for *Amazon Bedrock*. For troubleshooting this error, see [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 429
Required: No
** validationException **
The input fails to satisfy the constraints specified by *Amazon Bedrock*. For troubleshooting this error, see [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStreamOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStreamOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStreamOutput)
# ConverseStreamTrace
The trace object in a response from [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
## Contents
** guardrail **
The guardrail trace object.
Type: [GuardrailTraceAssessment](API_runtime_GuardrailTraceAssessment.md) object
Required: No
** promptRouter **
The request's prompt router.
Type: [PromptRouterTrace](API_runtime_PromptRouterTrace.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseStreamTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseStreamTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseStreamTrace)
# ConverseTokensRequest
The inputs from a `Converse` API request for token counting.
This structure mirrors the input format for the `Converse` operation, allowing you to count tokens for conversation-based inference requests.
## Contents
** additionalModelRequestFields **
The additionalModelRequestFields of Converse input request to count tokens for. Use this field when you want to pass additional parameters that the model supports.
Type: JSON value
Required: No
** messages **
An array of messages to count tokens for.
Type: Array of [Message](API_runtime_Message.md) objects
Required: No
** system **
The system content blocks to count tokens for. System content provides instructions or context to the model about how it should behave or respond. The token count will include any system content provided.
Type: Array of [SystemContentBlock](API_runtime_SystemContentBlock.md) objects
Required: No
** toolConfig **
The toolConfig of Converse input request to count tokens for. Configuration information for the tools that the model can use when generating a response.
Type: [ToolConfiguration](API_runtime_ToolConfiguration.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseTokensRequest)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseTokensRequest)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseTokensRequest)
# ConverseTrace
The trace object in a response from [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html).
## Contents
** guardrail **
The guardrail trace object.
Type: [GuardrailTraceAssessment](API_runtime_GuardrailTraceAssessment.md) object
Required: No
** promptRouter **
The request's prompt router.
Type: [PromptRouterTrace](API_runtime_PromptRouterTrace.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ConverseTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ConverseTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ConverseTrace)
# CountTokensInput
The input value for token counting. The value should be either an `InvokeModel` or `Converse` request body.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** converse **
A `Converse` request for which to count tokens. Use this field when you want to count tokens for a conversation-based input that would be sent to the `Converse` operation.
Type: [ConverseTokensRequest](API_runtime_ConverseTokensRequest.md) object
Required: No
** invokeModel **
An `InvokeModel` request for which to count tokens. Use this field when you want to count tokens for a raw text input that would be sent to the `InvokeModel` operation.
Type: [InvokeModelTokensRequest](API_runtime_InvokeModelTokensRequest.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/CountTokensInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/CountTokensInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/CountTokensInput)
# DocumentBlock
A document to include in a message.
## Contents
** name **
A name for the document. The name can only contain the following characters:
+ Alphanumeric characters
+ Whitespace characters (no more than one in a row)
+ Hyphens
+ Parentheses
+ Square brackets
This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
** source **
Contains the content of the document.
Type: [DocumentSource](API_runtime_DocumentSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** citations **
Configuration settings that control how citations should be generated for this specific document.
Type: [CitationsConfig](API_runtime_CitationsConfig.md) object
Required: No
** context **
Contextual information about how the document should be processed or interpreted by the model when generating citations.
Type: String
Required: No
** format **
The format of a document, or its extension.
Type: String
Valid Values: `pdf | csv | doc | docx | xls | xlsx | html | txt | md`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentBlock)
# DocumentCharLocation
Specifies a character-level location within a document, providing precise positioning information for cited content using start and end character indices.
## Contents
** documentIndex **
The index of the document within the array of documents provided in the request.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** end **
The ending character position of the cited content within the document.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** start **
The starting character position of the cited content within the document.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentCharLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentCharLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentCharLocation)
# DocumentChunkLocation
Specifies a chunk-level location within a document, providing positioning information for cited content using logical document segments or chunks.
## Contents
** documentIndex **
The index of the document within the array of documents provided in the request.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** end **
The ending chunk identifier or index of the cited content within the document.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** start **
The starting chunk identifier or index of the cited content within the document.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentChunkLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentChunkLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentChunkLocation)
# DocumentContentBlock
Contains the actual content of a document that can be processed by the model and potentially cited in the response.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** text **
The text content of the document.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentContentBlock)
# DocumentPageLocation
Specifies a page-level location within a document, providing positioning information for cited content using page numbers.
## Contents
** documentIndex **
The index of the document within the array of documents provided in the request.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** end **
The ending page number of the cited content within the document.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** start **
The starting page number of the cited content within the document.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentPageLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentPageLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentPageLocation)
# DocumentSource
Contains the content of a document.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bytes **
The raw bytes for the document. If you use an AWS SDK, you don't need to encode the bytes in base64.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1.
Required: No
** content **
The structured content of the document source, which may include various content blocks such as text, images, or other document elements.
Type: Array of [DocumentContentBlock](API_runtime_DocumentContentBlock.md) objects
Required: No
** s3Location **
The location of a document object in an Amazon S3 bucket. To see which models support S3 uploads, see [Supported models and features for Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).
Type: [S3Location](API_runtime_S3Location.md) object
Required: No
** text **
The text content of the document source.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/DocumentSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/DocumentSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/DocumentSource)
# ErrorBlock
A block containing error information when content processing fails.
## Contents
** message **
A human-readable error message describing what went wrong during content processing.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ErrorBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ErrorBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ErrorBlock)
# GuardrailAssessment
A behavior assessment of the guardrail policies used in a call to the Converse API.
## Contents
** appliedGuardrailDetails **
Details about the specific guardrail that was applied during this assessment, including its identifier, version, ARN, origin, and ownership information.
Type: [AppliedGuardrailDetails](API_runtime_AppliedGuardrailDetails.md) object
Required: No
** automatedReasoningPolicy **
The automated reasoning policy assessment results, including logical validation findings for the input content.
Type: [GuardrailAutomatedReasoningPolicyAssessment](API_runtime_GuardrailAutomatedReasoningPolicyAssessment.md) object
Required: No
** contentPolicy **
The content policy.
Type: [GuardrailContentPolicyAssessment](API_runtime_GuardrailContentPolicyAssessment.md) object
Required: No
** contextualGroundingPolicy **
The contextual grounding policy used for the guardrail assessment.
Type: [GuardrailContextualGroundingPolicyAssessment](API_runtime_GuardrailContextualGroundingPolicyAssessment.md) object
Required: No
** invocationMetrics **
The invocation metrics for the guardrail assessment.
Type: [GuardrailInvocationMetrics](API_runtime_GuardrailInvocationMetrics.md) object
Required: No
** sensitiveInformationPolicy **
The sensitive information policy.
Type: [GuardrailSensitiveInformationPolicyAssessment](API_runtime_GuardrailSensitiveInformationPolicyAssessment.md) object
Required: No
** topicPolicy **
The topic policy.
Type: [GuardrailTopicPolicyAssessment](API_runtime_GuardrailTopicPolicyAssessment.md) object
Required: No
** wordPolicy **
The word policy.
Type: [GuardrailWordPolicyAssessment](API_runtime_GuardrailWordPolicyAssessment.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAssessment)
# GuardrailAutomatedReasoningFinding
Represents a logical validation result from automated reasoning policy evaluation. The finding indicates whether claims in the input are logically valid, invalid, satisfiable, impossible, or have other logical issues.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** impossible **
Contains the result when the automated reasoning evaluation determines that no valid logical conclusions can be drawn due to contradictions in the premises or policy rules themselves.
Type: [GuardrailAutomatedReasoningImpossibleFinding](API_runtime_GuardrailAutomatedReasoningImpossibleFinding.md) object
Required: No
** invalid **
Contains the result when the automated reasoning evaluation determines that the claims in the input are logically invalid and contradict the established premises or policy rules.
Type: [GuardrailAutomatedReasoningInvalidFinding](API_runtime_GuardrailAutomatedReasoningInvalidFinding.md) object
Required: No
** noTranslations **
Contains the result when the automated reasoning evaluation cannot extract any relevant logical information from the input that can be validated against the policy rules.
Type: [GuardrailAutomatedReasoningNoTranslationsFinding](API_runtime_GuardrailAutomatedReasoningNoTranslationsFinding.md) object
Required: No
** satisfiable **
Contains the result when the automated reasoning evaluation determines that the claims in the input could be either true or false depending on additional assumptions not provided in the input context.
Type: [GuardrailAutomatedReasoningSatisfiableFinding](API_runtime_GuardrailAutomatedReasoningSatisfiableFinding.md) object
Required: No
** tooComplex **
Contains the result when the automated reasoning evaluation cannot process the input due to its complexity or volume exceeding the system's processing capacity for logical analysis.
Type: [GuardrailAutomatedReasoningTooComplexFinding](API_runtime_GuardrailAutomatedReasoningTooComplexFinding.md) object
Required: No
** translationAmbiguous **
Contains the result when the automated reasoning evaluation detects that the input has multiple valid logical interpretations, requiring additional context or clarification to proceed with validation.
Type: [GuardrailAutomatedReasoningTranslationAmbiguousFinding](API_runtime_GuardrailAutomatedReasoningTranslationAmbiguousFinding.md) object
Required: No
** valid **
Contains the result when the automated reasoning evaluation determines that the claims in the input are logically valid and definitively true based on the provided premises and policy rules.
Type: [GuardrailAutomatedReasoningValidFinding](API_runtime_GuardrailAutomatedReasoningValidFinding.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningFinding)
# GuardrailAutomatedReasoningImpossibleFinding
Indicates that no valid claims can be made due to logical contradictions in the premises or rules.
## Contents
** contradictingRules **
The automated reasoning policy rules that contradict the claims and/or premises in the input.
Type: Array of [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md) objects
Required: No
** logicWarning **
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
Type: [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) object
Required: No
** translation **
The logical translation of the input that this finding evaluates.
Type: [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningImpossibleFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningImpossibleFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningImpossibleFinding)
# GuardrailAutomatedReasoningInputTextReference
References a portion of the original input text that corresponds to logical elements.
## Contents
** text **
The specific text from the original input that this reference points to.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInputTextReference)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInputTextReference)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInputTextReference)
# GuardrailAutomatedReasoningInvalidFinding
Indicates that the claims are logically false and contradictory to the established rules or premises.
## Contents
** contradictingRules **
The automated reasoning policy rules that contradict the claims in the input.
Type: Array of [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md) objects
Required: No
** logicWarning **
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
Type: [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) object
Required: No
** translation **
The logical translation of the input that this finding invalidates.
Type: [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInvalidFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInvalidFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningInvalidFinding)
# GuardrailAutomatedReasoningLogicWarning
Identifies logical issues in the translated statements that exist independent of any policy rules, such as statements that are always true or always false.
## Contents
** claims **
The logical statements that are validated while assuming the policy and premises.
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects
Required: No
** premises **
The logical statements that serve as premises under which the claims are validated.
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects
Required: No
** type **
The category of the detected logical issue, such as statements that are always true or always false.
Type: String
Valid Values: `ALWAYS_FALSE | ALWAYS_TRUE`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningLogicWarning)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningLogicWarning)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningLogicWarning)
# GuardrailAutomatedReasoningNoTranslationsFinding
Indicates that no relevant logical information could be extracted from the input for validation.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningNoTranslationsFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningNoTranslationsFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningNoTranslationsFinding)
# GuardrailAutomatedReasoningPolicyAssessment
Contains the results of automated reasoning policy evaluation, including logical findings about the validity of claims made in the input content.
## Contents
** findings **
List of logical validation results produced by evaluating the input content against automated reasoning policies.
Type: Array of [GuardrailAutomatedReasoningFinding](API_runtime_GuardrailAutomatedReasoningFinding.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningPolicyAssessment)
# GuardrailAutomatedReasoningRule
References a specific automated reasoning policy rule that was applied during evaluation.
## Contents
** identifier **
The unique identifier of the automated reasoning rule.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 12.
Pattern: `[a-z0-9]{12}`
Required: No
** policyVersionArn **
The ARN of the automated reasoning policy version that contains this rule.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy/[a-z0-9]{12}(:([1-9][0-9]{0,11}))?`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningRule)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningRule)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningRule)
# GuardrailAutomatedReasoningSatisfiableFinding
Indicates that the claims could be either true or false depending on additional assumptions not provided in the input.
## Contents
** claimsFalseScenario **
An example scenario demonstrating how the claims could be logically false.
Type: [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) object
Required: No
** claimsTrueScenario **
An example scenario demonstrating how the claims could be logically true.
Type: [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) object
Required: No
** logicWarning **
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
Type: [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) object
Required: No
** translation **
The logical translation of the input that this finding evaluates.
Type: [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningSatisfiableFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningSatisfiableFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningSatisfiableFinding)
# GuardrailAutomatedReasoningScenario
Represents a logical scenario where claims can be evaluated as true or false, containing specific logical assignments.
## Contents
** statements **
List of logical assignments and statements that define this scenario.
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningScenario)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningScenario)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningScenario)
# GuardrailAutomatedReasoningStatement
A logical statement that includes both formal logic representation and natural language explanation.
## Contents
** logic **
The formal logical representation of the statement.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No
** naturalLanguage **
The natural language explanation of the logical statement.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningStatement)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningStatement)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningStatement)
# GuardrailAutomatedReasoningTooComplexFinding
Indicates that the input exceeds the processing capacity due to the volume or complexity of the logical information.
## Contents
The members of this exception structure are context-dependent.
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTooComplexFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTooComplexFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTooComplexFinding)
# GuardrailAutomatedReasoningTranslation
Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.
## Contents
** claims **
The logical statements that are being validated against the premises and policy rules.
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects
Required: No
** confidence **
A confidence score between 0 and 1 indicating how certain the system is about the logical translation.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** premises **
The logical statements that serve as the foundation or assumptions for the claims.
Type: Array of [GuardrailAutomatedReasoningStatement](API_runtime_GuardrailAutomatedReasoningStatement.md) objects
Required: No
** untranslatedClaims **
References to portions of the original input text that correspond to the claims but could not be fully translated.
Type: Array of [GuardrailAutomatedReasoningInputTextReference](API_runtime_GuardrailAutomatedReasoningInputTextReference.md) objects
Required: No
** untranslatedPremises **
References to portions of the original input text that correspond to the premises but could not be fully translated.
Type: Array of [GuardrailAutomatedReasoningInputTextReference](API_runtime_GuardrailAutomatedReasoningInputTextReference.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslation)
# GuardrailAutomatedReasoningTranslationAmbiguousFinding
Indicates that the input has multiple valid logical interpretations, requiring additional context or clarification.
## Contents
** differenceScenarios **
Scenarios showing how the different translation options differ in meaning.
Type: Array of [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) objects
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Required: No
** options **
Different logical interpretations that were detected during translation of the input.
Type: Array of [GuardrailAutomatedReasoningTranslationOption](API_runtime_GuardrailAutomatedReasoningTranslationOption.md) objects
Array Members: Minimum number of 0 items. Maximum number of 2 items.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationAmbiguousFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationAmbiguousFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationAmbiguousFinding)
# GuardrailAutomatedReasoningTranslationOption
Represents one possible logical interpretation of ambiguous input content.
## Contents
** translations **
Example translations that provide this possible interpretation of the input.
Type: Array of [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationOption)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationOption)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningTranslationOption)
# GuardrailAutomatedReasoningValidFinding
Indicates that the claims are definitively true and logically implied by the premises, with no possible alternative interpretations.
## Contents
** claimsTrueScenario **
An example scenario demonstrating how the claims are logically true.
Type: [GuardrailAutomatedReasoningScenario](API_runtime_GuardrailAutomatedReasoningScenario.md) object
Required: No
** logicWarning **
Indication of a logic issue with the translation without needing to consider the automated reasoning policy rules.
Type: [GuardrailAutomatedReasoningLogicWarning](API_runtime_GuardrailAutomatedReasoningLogicWarning.md) object
Required: No
** supportingRules **
The automated reasoning policy rules that support why this result is considered valid.
Type: Array of [GuardrailAutomatedReasoningRule](API_runtime_GuardrailAutomatedReasoningRule.md) objects
Required: No
** translation **
The logical translation of the input that this finding validates.
Type: [GuardrailAutomatedReasoningTranslation](API_runtime_GuardrailAutomatedReasoningTranslation.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningValidFinding)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningValidFinding)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailAutomatedReasoningValidFinding)
# GuardrailConfiguration
Configuration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation.
## Contents
** guardrailIdentifier **
The identifier for the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(|([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: No
** guardrailVersion **
The version of the guardrail.
Type: String
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`
Required: No
** trace **
The trace behavior for the guardrail.
Type: String
Valid Values: `enabled | disabled | enabled_full`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConfiguration)
# GuardrailContentBlock
The content block to be evaluated by the guardrail.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** image **
Image within guardrail content block to be evaluated by the guardrail.
Type: [GuardrailImageBlock](API_runtime_GuardrailImageBlock.md) object
Required: No
** text **
Text within content block to be evaluated by the guardrail.
Type: [GuardrailTextBlock](API_runtime_GuardrailTextBlock.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContentBlock)
# GuardrailContentFilter
The content filter for a guardrail.
## Contents
** action **
The guardrail action.
Type: String
Valid Values: `BLOCKED | NONE`
Required: Yes
** confidence **
The guardrail confidence.
Type: String
Valid Values: `NONE | LOW | MEDIUM | HIGH`
Required: Yes
** type **
The guardrail type.
Type: String
Valid Values: `INSULTS | HATE | SEXUAL | VIOLENCE | MISCONDUCT | PROMPT_ATTACK`
Required: Yes
** detected **
Indicates whether content that breaches the guardrail configuration is detected.
Type: Boolean
Required: No
** filterStrength **
The filter strength setting for the guardrail content filter.
Type: String
Valid Values: `NONE | LOW | MEDIUM | HIGH`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContentFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContentFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContentFilter)
# GuardrailContentPolicyAssessment
An assessment of a content policy for a guardrail.
## Contents
** filters **
The content policy filters.
Type: Array of [GuardrailContentFilter](API_runtime_GuardrailContentFilter.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContentPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContentPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContentPolicyAssessment)
# GuardrailContextualGroundingFilter
The details for the guardrails contextual grounding filter.
## Contents
** action **
The action performed by the guardrails contextual grounding filter.
Type: String
Valid Values: `BLOCKED | NONE`
Required: Yes
** score **
The score generated by contextual grounding filter.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
** threshold **
The threshold used by contextual grounding filter to determine whether the content is grounded or not.
Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
Required: Yes
** type **
The contextual grounding filter type.
Type: String
Valid Values: `GROUNDING | RELEVANCE`
Required: Yes
** detected **
Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContextualGroundingFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContextualGroundingFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContextualGroundingFilter)
# GuardrailContextualGroundingPolicyAssessment
The policy assessment details for the guardrails contextual grounding filter.
## Contents
** filters **
The filter details for the guardrails contextual grounding filter.
Type: Array of [GuardrailContextualGroundingFilter](API_runtime_GuardrailContextualGroundingFilter.md) objects
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailContextualGroundingPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailContextualGroundingPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailContextualGroundingPolicyAssessment)
# GuardrailConverseContentBlock
A content block for selective guarding with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** image **
Image within converse content block to be evaluated by the guardrail.
Type: [GuardrailConverseImageBlock](API_runtime_GuardrailConverseImageBlock.md) object
Required: No
** text **
The text to guard.
Type: [GuardrailConverseTextBlock](API_runtime_GuardrailConverseTextBlock.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConverseContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConverseContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConverseContentBlock)
# GuardrailConverseImageBlock
An image block that contains images that you want to assess with a guardrail.
## Contents
** format **
The format details for the image type of the guardrail converse image block.
Type: String
Valid Values: `png | jpeg`
Required: Yes
** source **
The image source (image bytes) of the guardrail converse image block.
Type: [GuardrailConverseImageSource](API_runtime_GuardrailConverseImageSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConverseImageBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConverseImageBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConverseImageBlock)
# GuardrailConverseImageSource
The image source (image bytes) of the guardrail converse image source.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bytes **
The raw image bytes for the image.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConverseImageSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConverseImageSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConverseImageSource)
# GuardrailConverseTextBlock
A text block that contains text that you want to assess with a guardrail. For more information, see [GuardrailConverseContentBlock](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_GuardrailConverseContentBlock.html).
## Contents
** text **
The text that you want to guard.
Type: String
Required: Yes
** qualifiers **
The qualifier details for the guardrails contextual grounding filter.
Type: Array of strings
Valid Values: `grounding_source | query | guard_content`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailConverseTextBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailConverseTextBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailConverseTextBlock)
# GuardrailCoverage
The action of the guardrail coverage details.
## Contents
** images **
The guardrail coverage for images (the number of images that guardrails guarded).
Type: [GuardrailImageCoverage](API_runtime_GuardrailImageCoverage.md) object
Required: No
** textCharacters **
The text characters of the guardrail coverage details.
Type: [GuardrailTextCharactersCoverage](API_runtime_GuardrailTextCharactersCoverage.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailCoverage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailCoverage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailCoverage)
# GuardrailCustomWord
A custom word configured in a guardrail.
## Contents
** action **
The action for the custom word.
Type: String
Valid Values: `BLOCKED | NONE`
Required: Yes
** match **
The match for the custom word.
Type: String
Required: Yes
** detected **
Indicates whether custom word content that breaches the guardrail configuration is detected.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailCustomWord)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailCustomWord)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailCustomWord)
# GuardrailImageBlock
Contain an image which user wants guarded. This block is accepted by the guardrails independent API.
## Contents
** format **
The format details for the file type of the image blocked by the guardrail.
Type: String
Valid Values: `png | jpeg`
Required: Yes
** source **
The image source (image bytes) details of the image blocked by the guardrail.
Type: [GuardrailImageSource](API_runtime_GuardrailImageSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailImageBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailImageBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailImageBlock)
# GuardrailImageCoverage
The details of the guardrail image coverage.
## Contents
** guarded **
The count (integer) of images guardrails guarded.
Type: Integer
Required: No
** total **
Represents the total number of images (integer) that were in the request (guarded and unguarded).
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailImageCoverage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailImageCoverage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailImageCoverage)
# GuardrailImageSource
The image source (image bytes) of the guardrail image source. Object used in independent api.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bytes **
The bytes details of the guardrail image source. Object used in independent api.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailImageSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailImageSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailImageSource)
# GuardrailInvocationMetrics
The invocation metrics for the guardrail.
## Contents
** guardrailCoverage **
The coverage details for the guardrail invocation metrics.
Type: [GuardrailCoverage](API_runtime_GuardrailCoverage.md) object
Required: No
** guardrailProcessingLatency **
The processing latency details for the guardrail invocation metrics.
Type: Long
Required: No
** usage **
The usage details for the guardrail invocation metrics.
Type: [GuardrailUsage](API_runtime_GuardrailUsage.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailInvocationMetrics)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailInvocationMetrics)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailInvocationMetrics)
# GuardrailManagedWord
A managed word configured in a guardrail.
## Contents
** action **
The action for the managed word.
Type: String
Valid Values: `BLOCKED | NONE`
Required: Yes
** match **
The match for the managed word.
Type: String
Required: Yes
** type **
The type for the managed word.
Type: String
Valid Values: `PROFANITY`
Required: Yes
** detected **
Indicates whether managed word content that breaches the guardrail configuration is detected.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailManagedWord)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailManagedWord)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailManagedWord)
# GuardrailOutputContent
The output content produced by the guardrail.
## Contents
** text **
The specific text for the output content produced by the guardrail.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailOutputContent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailOutputContent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailOutputContent)
# GuardrailPiiEntityFilter
A Personally Identifiable Information (PII) entity configured in a guardrail.
## Contents
** action **
The PII entity filter action.
Type: String
Valid Values: `ANONYMIZED | BLOCKED | NONE`
Required: Yes
** match **
The PII entity filter match.
Type: String
Required: Yes
** type **
The PII entity filter type.
Type: String
Valid Values: `ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER | CREDIT_DEBIT_CARD_CVV | CREDIT_DEBIT_CARD_EXPIRY | CREDIT_DEBIT_CARD_NUMBER | DRIVER_ID | EMAIL | INTERNATIONAL_BANK_ACCOUNT_NUMBER | IP_ADDRESS | LICENSE_PLATE | MAC_ADDRESS | NAME | PASSWORD | PHONE | PIN | SWIFT_CODE | UK_NATIONAL_HEALTH_SERVICE_NUMBER | UK_NATIONAL_INSURANCE_NUMBER | UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER | URL | USERNAME | US_BANK_ACCOUNT_NUMBER | US_BANK_ROUTING_NUMBER | US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER | US_PASSPORT_NUMBER | US_SOCIAL_SECURITY_NUMBER | VEHICLE_IDENTIFICATION_NUMBER`
Required: Yes
** detected **
Indicates whether personally identifiable information (PII) that breaches the guardrail configuration is detected.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailPiiEntityFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailPiiEntityFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailPiiEntityFilter)
# GuardrailRegexFilter
A Regex filter configured in a guardrail.
## Contents
** action **
The region filter action.
Type: String
Valid Values: `ANONYMIZED | BLOCKED | NONE`
Required: Yes
** detected **
Indicates whether custom regex entities that breach the guardrail configuration are detected.
Type: Boolean
Required: No
** match **
The regesx filter match.
Type: String
Required: No
** name **
The regex filter name.
Type: String
Required: No
** regex **
The regex query.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailRegexFilter)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailRegexFilter)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailRegexFilter)
# GuardrailSensitiveInformationPolicyAssessment
The assessment for a Personally Identifiable Information (PII) policy.
## Contents
** piiEntities **
The PII entities in the assessment.
Type: Array of [GuardrailPiiEntityFilter](API_runtime_GuardrailPiiEntityFilter.md) objects
Required: Yes
** regexes **
The regex queries in the assessment.
Type: Array of [GuardrailRegexFilter](API_runtime_GuardrailRegexFilter.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailSensitiveInformationPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailSensitiveInformationPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailSensitiveInformationPolicyAssessment)
# GuardrailStreamConfiguration
Configuration information for a guardrail that you use with the [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) action.
## Contents
** guardrailIdentifier **
The identifier for the guardrail.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern: `(|([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))`
Required: No
** guardrailVersion **
The version of the guardrail.
Type: String
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`
Required: No
** streamProcessingMode **
The processing mode.
The processing mode. For more information, see [Configure streaming response behavior](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-streaming.html).
Type: String
Valid Values: `sync | async`
Required: No
** trace **
The trace behavior for the guardrail.
Type: String
Valid Values: `enabled | disabled | enabled_full`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailStreamConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailStreamConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailStreamConfiguration)
# GuardrailTextBlock
The text block to be evaluated by the guardrail.
## Contents
** text **
The input text details to be evaluated by the guardrail.
Type: String
Required: Yes
** qualifiers **
The qualifiers describing the text block.
Type: Array of strings
Valid Values: `grounding_source | query | guard_content`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTextBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTextBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTextBlock)
# GuardrailTextCharactersCoverage
The guardrail coverage for the text characters.
## Contents
** guarded **
The text characters that were guarded by the guardrail coverage.
Type: Integer
Required: No
** total **
The total text characters by the guardrail coverage.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTextCharactersCoverage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTextCharactersCoverage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTextCharactersCoverage)
# GuardrailTopic
Information about a topic guardrail.
## Contents
** action **
The action the guardrail should take when it intervenes on a topic.
Type: String
Valid Values: `BLOCKED | NONE`
Required: Yes
** name **
The name for the guardrail.
Type: String
Required: Yes
** type **
The type behavior that the guardrail should perform when the model detects the topic.
Type: String
Valid Values: `DENY`
Required: Yes
** detected **
Indicates whether topic content that breaches the guardrail configuration is detected.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTopic)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTopic)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTopic)
# GuardrailTopicPolicyAssessment
A behavior assessment of a topic policy.
## Contents
** topics **
The topics in the assessment.
Type: Array of [GuardrailTopic](API_runtime_GuardrailTopic.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTopicPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTopicPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTopicPolicyAssessment)
# GuardrailTraceAssessment
A Top level guardrail trace object. For more information, see [ConverseTrace](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseTrace.html).
## Contents
** actionReason **
Provides the reason for the action taken when harmful content is detected.
Type: String
Required: No
** inputAssessment **
The input assessment.
Type: String to [GuardrailAssessment](API_runtime_GuardrailAssessment.md) object map
Required: No
** modelOutput **
The output from the model.
Type: Array of strings
Required: No
** outputAssessments **
the output assessments.
Type: String to array of [GuardrailAssessment](API_runtime_GuardrailAssessment.md) objects map
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailTraceAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailTraceAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailTraceAssessment)
# GuardrailUsage
The details on the use of the guardrail.
## Contents
** contentPolicyUnits **
The content policy units processed by the guardrail.
Type: Integer
Required: Yes
** contextualGroundingPolicyUnits **
The contextual grounding policy units processed by the guardrail.
Type: Integer
Required: Yes
** sensitiveInformationPolicyFreeUnits **
The sensitive information policy free units processed by the guardrail.
Type: Integer
Required: Yes
** sensitiveInformationPolicyUnits **
The sensitive information policy units processed by the guardrail.
Type: Integer
Required: Yes
** topicPolicyUnits **
The topic policy units processed by the guardrail.
Type: Integer
Required: Yes
** wordPolicyUnits **
The word policy units processed by the guardrail.
Type: Integer
Required: Yes
** automatedReasoningPolicies **
The number of automated reasoning policies that were processed during the guardrail evaluation.
Type: Integer
Required: No
** automatedReasoningPolicyUnits **
The number of text units processed by the automated reasoning policy.
Type: Integer
Required: No
** contentPolicyImageUnits **
The content policy image units processed by the guardrail.
Type: Integer
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailUsage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailUsage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailUsage)
# GuardrailWordPolicyAssessment
The word policy assessment.
## Contents
** customWords **
Custom words in the assessment.
Type: Array of [GuardrailCustomWord](API_runtime_GuardrailCustomWord.md) objects
Required: Yes
** managedWordLists **
Managed word lists in the assessment.
Type: Array of [GuardrailManagedWord](API_runtime_GuardrailManagedWord.md) objects
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/GuardrailWordPolicyAssessment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/GuardrailWordPolicyAssessment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/GuardrailWordPolicyAssessment)
# ImageBlock
Image content for a message.
## Contents
** format **
The format of the image.
Type: String
Valid Values: `png | jpeg | gif | webp`
Required: Yes
** source **
The source for the image.
Type: [ImageSource](API_runtime_ImageSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** error **
Error information if the image block could not be processed or contains invalid data.
Type: [ErrorBlock](API_runtime_ErrorBlock.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ImageBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ImageBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ImageBlock)
# ImageBlockDelta
A streaming delta event that contains incremental image data during streaming responses.
## Contents
** error **
Error information if this image delta could not be processed.
Type: [ErrorBlock](API_runtime_ErrorBlock.md) object
Required: No
** source **
The incremental image source data for this delta event.
Type: [ImageSource](API_runtime_ImageSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ImageBlockDelta)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ImageBlockDelta)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ImageBlockDelta)
# ImageBlockStart
The initial event in a streaming image block that indicates the start of image content.
## Contents
** format **
The format of the image data that will be streamed in subsequent delta events.
Type: String
Valid Values: `png | jpeg | gif | webp`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ImageBlockStart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ImageBlockStart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ImageBlockStart)
# ImageSource
The source for an image.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bytes **
The raw image bytes for the image. If you use an AWS SDK, you don't need to encode the image bytes in base64.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1.
Required: No
** s3Location **
The location of an image object in an Amazon S3 bucket. To see which models support S3 uploads, see [Supported models and features for Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).
Type: [S3Location](API_runtime_S3Location.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ImageSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ImageSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ImageSource)
# InferenceConfiguration
Base inference parameters to pass to a model in a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html). For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
If you need to pass additional parameters that the model supports, use the `additionalModelRequestFields` request field in the call to `Converse` or `ConverseStream`. For more information, see [Model parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
## Contents
** maxTokens **
The maximum number of tokens to allow in the generated response. The default value is the maximum allowed value for the model that you are using. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: Integer
Valid Range: Minimum value of 1.
Required: No
** stopSequences **
A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 2500 items.
Length Constraints: Minimum length of 1.
Required: No
** temperature **
The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
The default value is the default value for the model that you are using. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
** topP **
The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for `topP`, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence.
The default value is the default value for the model that you are using. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: Float
Valid Range: Minimum value of 0. Maximum value of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InferenceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InferenceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InferenceConfiguration)
# InvokeModelTokensRequest
The body of an `InvokeModel` API request for token counting. This structure mirrors the input format for the `InvokeModel` operation, allowing you to count tokens for raw text inference requests.
## Contents
** body **
The request body to count tokens for, formatted according to the model's expected input format. To learn about the input format for different models, see [Model inference parameters and responses](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html).
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 25000000.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModelTokensRequest)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModelTokensRequest)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModelTokensRequest)
# InvokeModelWithBidirectionalStreamInput
Payload content, the speech chunk, for the bidirectional input of the invocation step.
## Contents
** chunk **
The audio chunk that is used as input for the invocation step.
Type: [BidirectionalInputPayloadPart](API_runtime_BidirectionalInputPayloadPart.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamInput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamInput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamInput)
# InvokeModelWithBidirectionalStreamOutput
Output from the bidirectional stream that was used for model invocation.
## Contents
** chunk **
The speech chunk that was provided as output from the invocation step.
Type: [BidirectionalOutputPayloadPart](API_runtime_BidirectionalOutputPayloadPart.md) object
Required: No
** internalServerException **
The request encountered an unknown internal error.
Type: Exception
HTTP Status Code: 500
Required: No
** modelStreamErrorException **
The request encountered an error with the model stream.
Type: Exception
HTTP Status Code: 424
Required: No
** modelTimeoutException **
The connection was closed because a request was not received within the timeout period.
Type: Exception
HTTP Status Code: 408
Required: No
** serviceUnavailableException **
The request has failed due to a temporary failure of the server.
Type: Exception
HTTP Status Code: 503
Required: No
** throttlingException **
The request was denied due to request throttling.
Type: Exception
HTTP Status Code: 429
Required: No
** validationException **
The input fails to satisfy the constraints specified by an AWS service.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamOutput)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamOutput)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/InvokeModelWithBidirectionalStreamOutput)
# JsonSchemaDefinition
JSON schema structured output format options.
## Contents
** schema **
The JSON schema to constrain the model's output. For more information, see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference).
Type: String
Required: Yes
** description **
A description of the JSON schema.
Type: String
Required: No
** name **
The name of the JSON schema.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/JsonSchemaDefinition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/JsonSchemaDefinition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/JsonSchemaDefinition)
# Message
A message input, or returned from, a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
## Contents
** content **
The message content. Note the following restrictions:
+ You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively.
+ You can include up to five documents. Each document's size must be no more than 4.5 MB.
+ If you include a `ContentBlock` with a `document` field in the array, you must also include a `ContentBlock` with a `text` field.
+ You can only include images and documents if the `role` is `user`.
Type: Array of [ContentBlock](API_runtime_ContentBlock.md) objects
Required: Yes
** role **
The role that the message plays in the message.
Type: String
Valid Values: `user | assistant`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Message)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Message)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Message)
# MessageStartEvent
The start of a message.
## Contents
** role **
The role for the message.
Type: String
Valid Values: `user | assistant`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/MessageStartEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/MessageStartEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/MessageStartEvent)
# MessageStopEvent
The stop event for a message.
## Contents
** stopReason **
The reason why the model stopped generating output.
Type: String
Valid Values: `end_turn | tool_use | max_tokens | stop_sequence | guardrail_intervened | content_filtered | malformed_model_output | malformed_tool_use | model_context_window_exceeded`
Required: Yes
** additionalModelResponseFields **
The additional model response fields.
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/MessageStopEvent)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/MessageStopEvent)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/MessageStopEvent)
# OutputConfig
Output configuration for a model response in a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html).
## Contents
** textFormat **
Structured output parameters to control the model's text response.
Type: [OutputFormat](API_runtime_OutputFormat.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/OutputConfig)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/OutputConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/OutputConfig)
# OutputFormat
Structured output parameters to control the model's response.
## Contents
** structure **
The structure that the model's output must adhere to.
Type: [OutputFormatStructure](API_runtime_OutputFormatStructure.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** type **
The type of structured output format.
Type: String
Valid Values: `json_schema`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/OutputFormat)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/OutputFormat)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/OutputFormat)
# OutputFormatStructure
The structure that the model's output must adhere to.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** jsonSchema **
A JSON schema structure that the model's output must adhere to.
Type: [JsonSchemaDefinition](API_runtime_JsonSchemaDefinition.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/OutputFormatStructure)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/OutputFormatStructure)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/OutputFormatStructure)
# PayloadPart
Payload content included in the response.
## Contents
** bytes **
Base64-encoded bytes of payload data.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 1000000.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/PayloadPart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/PayloadPart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/PayloadPart)
# PerformanceConfiguration
Performance settings for a model.
## Contents
** latency **
To use a latency-optimized version of the model, set to `optimized`.
Type: String
Valid Values: `standard | optimized`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/PerformanceConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/PerformanceConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/PerformanceConfiguration)
# PromptRouterTrace
A prompt router trace.
## Contents
** invokedModelId **
The ID of the invoked model.
Type: String
Pattern: `(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{1,20}):(|[0-9]{12}):inference-profile/[a-zA-Z0-9-:.]+)`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/PromptRouterTrace)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/PromptRouterTrace)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/PromptRouterTrace)
# PromptVariableValues
Contains a map of variables in a prompt from Prompt management to an object containing the values to fill in for them when running model invocation. For more information, see [How Prompt management works](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-how.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** text **
The text value that the variable maps to.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/PromptVariableValues)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/PromptVariableValues)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/PromptVariableValues)
# ReasoningContentBlock
Contains content regarding the reasoning that is carried out by the model with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** reasoningText **
The reasoning that the model used to return the output.
Type: [ReasoningTextBlock](API_runtime_ReasoningTextBlock.md) object
Required: No
** redactedContent **
The content in the reasoning that was encrypted by the model provider for safety reasons. The encryption doesn't affect the quality of responses.
Type: Base64-encoded binary data object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ReasoningContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ReasoningContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ReasoningContentBlock)
# ReasoningContentBlockDelta
Contains content regarding the reasoning that is carried out by the model with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** redactedContent **
The content in the reasoning that was encrypted by the model provider for safety reasons. The encryption doesn't affect the quality of responses.
Type: Base64-encoded binary data object
Required: No
** signature **
A token that verifies that the reasoning text was generated by the model. If you pass a reasoning block back to the API in a multi-turn conversation, include the text and its signature unmodified.
Type: String
Required: No
** text **
The reasoning that the model used to return the output.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ReasoningContentBlockDelta)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ReasoningContentBlockDelta)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ReasoningContentBlockDelta)
# ReasoningTextBlock
Contains the reasoning that the model used to return the output.
## Contents
** text **
The reasoning that the model used to return the output.
Type: String
Required: Yes
** signature **
A token that verifies that the reasoning text was generated by the model. If you pass a reasoning block back to the API in a multi-turn conversation, include the text and its signature unmodified.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ReasoningTextBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ReasoningTextBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ReasoningTextBlock)
# ResponseStream
Definition of content in the response stream.
## Contents
** chunk **
Content included in the response.
Type: [PayloadPart](API_runtime_PayloadPart.md) object
Required: No
** internalServerException **
An internal server error occurred. Retry your request.
Type: Exception
HTTP Status Code: 500
Required: No
** modelStreamErrorException **
An error occurred while streaming the response. Retry your request.
Type: Exception
HTTP Status Code: 424
Required: No
** modelTimeoutException **
The request took too long to process. Processing time exceeded the model timeout length.
Type: Exception
HTTP Status Code: 408
Required: No
** serviceUnavailableException **
The service isn't available. Try again later.
Type: Exception
HTTP Status Code: 503
Required: No
** throttlingException **
Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) to increase the rate or number of tokens you can process.
Type: Exception
HTTP Status Code: 429
Required: No
** validationException **
Input validation failed. Check your request parameters and retry the request.
Type: Exception
HTTP Status Code: 400
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ResponseStream)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ResponseStream)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ResponseStream)
# S3Location
A storage location in an Amazon S3 bucket.
## Contents
** uri **
An object URI starting with `s3://`.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?`
Required: Yes
** bucketOwner **
If the bucket belongs to another AWS account, specify that account's ID.
Type: String
Pattern: `[0-9]{12}`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/S3Location)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/S3Location)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/S3Location)
# SearchResultBlock
A search result block that enables natural citations with proper source attribution for retrieved content.
**Note**
This field is only supported by Anthropic Claude Opus 4.1, Opus 4, Sonnet 4.5, Sonnet 4, Sonnet 3.7, and 3.5 Haiku models.
## Contents
** content **
An array of search result content block.
Type: Array of [SearchResultContentBlock](API_runtime_SearchResultContentBlock.md) objects
Required: Yes
** source **
The source URL or identifier for the content.
Type: String
Required: Yes
** title **
A descriptive title for the search result.
Type: String
Required: Yes
** citations **
Configuration setting for citations
Type: [CitationsConfig](API_runtime_CitationsConfig.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SearchResultBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SearchResultBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SearchResultBlock)
# SearchResultContentBlock
A block within a search result that contains the content.
## Contents
** text **
The actual text content
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SearchResultContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SearchResultContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SearchResultContentBlock)
# SearchResultLocation
Specifies a search result location within the content array, providing positioning information for cited content using search result index and block positions.
## Contents
** end **
The ending position in the content array where the cited content ends.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** searchResultIndex **
The index of the search result content block where the cited content is found.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** start **
The starting position in the content array where the cited content begins.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SearchResultLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SearchResultLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SearchResultLocation)
# ServiceTier
Specifies the processing tier configuration used for serving the request.
## Contents
** type **
Specifies the processing tier type used for serving the request.
Type: String
Valid Values: `priority | default | flex | reserved`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ServiceTier)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ServiceTier)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ServiceTier)
# SpecificToolChoice
The model must request a specific tool. For example, `{"tool" : {"name" : "Your tool name"}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide
**Note**
This field is only supported by Anthropic Claude 3 models.
## Contents
** name **
The name of the tool that the model must request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SpecificToolChoice)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SpecificToolChoice)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SpecificToolChoice)
# SystemContentBlock
Contains configurations for instructions to provide the model for how to handle input. To learn more, see [Using the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html).
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** cachePoint **
CachePoint to include in the system prompt.
Type: [CachePointBlock](API_runtime_CachePointBlock.md) object
Required: No
** guardContent **
A content block to assess with the guardrail. Use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations.
For more information, see [Use a guardrail with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-use-converse-api.html).
Type: [GuardrailConverseContentBlock](API_runtime_GuardrailConverseContentBlock.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
** text **
A system prompt for the model.
Type: String
Length Constraints: Minimum length of 1.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SystemContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SystemContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SystemContentBlock)
# SystemTool
Specifies a system-defined tool for the model to use. *System-defined tools* are tools that are created and provided by the model provider.
## Contents
** name **
The name of the system-defined tool that you want to call.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/SystemTool)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/SystemTool)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/SystemTool)
# Tag
A tag.
## Contents
** key **
The tag's key.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: Yes
** value **
The tag's value.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern: `[a-zA-Z0-9\s._:/=+@-]*`
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Tag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Tag)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Tag)
# TokenUsage
The tokens used in a message API inference call.
## Contents
** inputTokens **
The number of tokens sent in the request to the model.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
** outputTokens **
The number of tokens that the model generated for the request.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
** totalTokens **
The total of input tokens and tokens generated by the model.
Type: Integer
Valid Range: Minimum value of 0.
Required: Yes
** cacheDetails **
Detailed breakdown of cache writes by TTL. Empty if no cache creation occurred. Sorted by TTL duration (1h before 5m).
Type: Array of [CacheDetail](API_runtime_CacheDetail.md) objects
Required: No
** cacheReadInputTokens **
The number of input tokens read from the cache for the request.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
** cacheWriteInputTokens **
The number of input tokens written to the cache for the request.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/TokenUsage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/TokenUsage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/TokenUsage)
# Tool
Information about a tool that you can use with the Converse API. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** cachePoint **
CachePoint to include in the tool configuration.
Type: [CachePointBlock](API_runtime_CachePointBlock.md) object
Required: No
** systemTool **
Specifies the system-defined tool that you want use.
Type: [SystemTool](API_runtime_SystemTool.md) object
Required: No
** toolSpec **
The specfication for the tool.
Type: [ToolSpecification](API_runtime_ToolSpecification.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/Tool)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/Tool)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/Tool)
# ToolChoice
Determines which tools the model should request in a call to `Converse` or `ConverseStream`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** any **
The model must request at least one tool (no text is generated).
Type: [AnyToolChoice](API_runtime_AnyToolChoice.md) object
Required: No
** auto **
(Default). The Model automatically decides if a tool should be called or whether to generate text instead.
Type: [AutoToolChoice](API_runtime_AutoToolChoice.md) object
Required: No
** tool **
The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.
Type: [SpecificToolChoice](API_runtime_SpecificToolChoice.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolChoice)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolChoice)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolChoice)
# ToolConfiguration
Configuration information for the tools that you pass to a model. For more information, see [Tool use (function calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
** tools **
An array of tools that you want to pass to a model.
Type: Array of [Tool](API_runtime_Tool.md) objects
Array Members: Minimum number of 1 item.
Required: Yes
** toolChoice **
If supported by model, forces the model to request a tool.
Type: [ToolChoice](API_runtime_ToolChoice.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolConfiguration)
# ToolInputSchema
The schema for the tool. The top level schema type must be `object`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** json **
The JSON schema for the tool. For more information, see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference).
Type: JSON value
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolInputSchema)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolInputSchema)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolInputSchema)
# ToolResultBlock
A tool result block that contains the results for a tool request that the model previously made. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
** content **
The content for tool result content block.
Type: Array of [ToolResultContentBlock](API_runtime_ToolResultContentBlock.md) objects
Required: Yes
** toolUseId **
The ID of the tool request that this is the result for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
** status **
The status for the tool result content block.
This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.
Type: String
Valid Values: `success | error`
Required: No
** type **
The type for the tool result content block.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolResultBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolResultBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolResultBlock)
# ToolResultBlockDelta
Contains incremental updates to tool results information during streaming responses. This allows clients to build up tool results data progressively as the response is generated.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** json **
The JSON schema for the tool result content block. see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference).
Type: JSON value
Required: No
** text **
The reasoning the model used to return the output.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolResultBlockDelta)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolResultBlockDelta)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolResultBlockDelta)
# ToolResultBlockStart
The start of a tool result block. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
** toolUseId **
The ID of the tool that was used to generate this tool result block.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
** status **
The status of the tool result block.
Type: String
Valid Values: `success | error`
Required: No
** type **
The type for the tool that was used to generate this tool result block.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolResultBlockStart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolResultBlockStart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolResultBlockStart)
# ToolResultContentBlock
The tool result content block. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** document **
A tool result that is a document.
Type: [DocumentBlock](API_runtime_DocumentBlock.md) object
Required: No
** image **
A tool result that is an image.
This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.
Type: [ImageBlock](API_runtime_ImageBlock.md) object
Required: No
** json **
A tool result that is JSON format data.
Type: JSON value
Required: No
** searchResult **
A tool result that is a search result.
Type: [SearchResultBlock](API_runtime_SearchResultBlock.md) object
Required: No
** text **
A tool result that is text.
Type: String
Required: No
** video **
A tool result that is video.
Type: [VideoBlock](API_runtime_VideoBlock.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolResultContentBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolResultContentBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolResultContentBlock)
# ToolSpecification
The specification for the tool. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
** inputSchema **
The input schema for the tool in JSON format.
Type: [ToolInputSchema](API_runtime_ToolInputSchema.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
** name **
The name for the tool.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
** description **
The description for the tool.
Type: String
Length Constraints: Minimum length of 1.
Required: No
** strict **
Flag to enable structured output enforcement on a tool usage response.
Type: Boolean
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolSpecification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolSpecification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolSpecification)
# ToolUseBlock
A tool use content block. Contains information about a tool that the model is requesting be run., The model uses the result from the tool to generate a response. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
** input **
The input to pass to the tool.
Type: JSON value
Required: Yes
** name **
The name of the tool that the model wants to use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
** toolUseId **
The ID for the tool request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
** type **
The type for the tool request.
Type: String
Valid Values: `server_tool_use`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolUseBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolUseBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolUseBlock)
# ToolUseBlockDelta
The delta for a tool use block.
## Contents
** input **
The input for a requested tool.
Type: String
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolUseBlockDelta)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolUseBlockDelta)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolUseBlockDelta)
# ToolUseBlockStart
The start of a tool use block. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.
## Contents
** name **
The name of the tool that the model is requesting to use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
** toolUseId **
The ID for the tool request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `[a-zA-Z0-9_-]+`
Required: Yes
** type **
The type for the tool request.
Type: String
Valid Values: `server_tool_use`
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/ToolUseBlockStart)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/ToolUseBlockStart)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/ToolUseBlockStart)
# VideoBlock
A video block.
## Contents
** format **
The block's format.
Type: String
Valid Values: `mkv | mov | mp4 | webm | flv | mpeg | mpg | wmv | three_gp`
Required: Yes
** source **
The block's source.
Type: [VideoSource](API_runtime_VideoSource.md) object
**Note: **This object is a Union. Only one member of this object can be specified or returned.
Required: Yes
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/VideoBlock)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/VideoBlock)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/VideoBlock)
# VideoSource
A video source. You can upload a smaller video as a base64-encoded string as long as the encoded file is less than 25MB. You can also transfer videos up to 1GB in size from an S3 bucket.
## Contents
**Important**
This data type is a UNION, so only one of the following members can be specified when used or returned.
** bytes **
Video content encoded in base64.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 1.
Required: No
** s3Location **
The location of a video object in an Amazon S3 bucket. To see which models support S3 uploads, see [Supported models and features for Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html).
Type: [S3Location](API_runtime_S3Location.md) object
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/VideoSource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/VideoSource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/VideoSource)
# WebLocation
Provides the URL and domain information for the website that was cited when performing a web search.
## Contents
** domain **
The domain that was cited when performing a web search.
Type: String
Required: No
** url **
The URL that was cited when performing a web search.
Type: String
Required: No
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/bedrock-runtime-2023-09-30/WebLocation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/bedrock-runtime-2023-09-30/WebLocation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/bedrock-runtime-2023-09-30/WebLocation)
# Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see [Signing AWS API requests](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) in the *IAM User Guide*.
**X-Amz-Algorithm**
The hash algorithm that you used to create the request signature.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Valid Values: `AWS4-HMAC-SHA256`
Required: Conditional
**X-Amz-Credential**
The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4\$1request"). The value is expressed in the following format: *access\$1key*/*YYYYMMDD*/*region*/*service*/aws4\$1request.
For more information, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-Date**
The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: `20120325T120000Z`.
Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see [Elements of an AWS API request signature](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) in the *IAM User Guide*.
Type: string
Required: Conditional
**X-Amz-Security-Token**
The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see [AWS services that work with IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) in the *IAM User Guide*.
Condition: If you're using temporary security credentials from AWS STS, you must include the security token.
Type: string
Required: Conditional
**X-Amz-Signature**
Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
**X-Amz-SignedHeaders**
Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see [Create a signed AWS API request](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) in the *IAM User Guide*.
Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.
Type: string
Required: Conditional
# Common Error Types
This section lists common error types that this AWS service may return. Not all services return all error types listed here. For errors specific to an API action for this service, see the topic for that API action.
**AccessDeniedException**
You don't have permission to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 403
**ExpiredTokenException**
The security token included in the request has expired. Request a new security token and try again.
HTTP Status Code: 403
**IncompleteSignature**
The request signature doesn't conform to AWS standards. Verify that you're using valid AWS credentials and that your request is properly formatted. If you're using an SDK, ensure it's up to date.
HTTP Status Code: 403
**InternalFailure**
The request can't be processed right now because of an internal server issue. Try again later. If the problem persists, contact AWS Support.
HTTP Status Code: 500
**MalformedHttpRequestException**
The request body can't be processed. This typically happens when the request body can't be decompressed using the specified content encoding algorithm. Verify that the content encoding header matches the compression format used.
HTTP Status Code: 400
**NotAuthorized**
You don't have permissions to perform this action. Verify that your IAM policy includes the required permissions.
HTTP Status Code: 401
**OptInRequired**
Your AWS account needs a subscription for this service. Verify that you've enabled the service in your account.
HTTP Status Code: 403
**RequestAbortedException**
The request was aborted before a response could be returned. This typically happens when the client closes the connection.
HTTP Status Code: 400
**RequestEntityTooLargeException**
The request entity is too large. Reduce the size of the request body and try again.
HTTP Status Code: 413
**RequestTimeoutException**
The request timed out. The server didn't receive the complete request within the expected time frame. Try again.
HTTP Status Code: 408
**ServiceUnavailable**
The service is temporarily unavailable. Try again later.
HTTP Status Code: 503
**ThrottlingException**
Your request rate is too high. The AWS SDKs automatically retry requests that receive this exception. Reduce the frequency of requests.
HTTP Status Code: 400
**UnknownOperationException**
The action or operation isn't recognized. Verify that the action name is spelled correctly and that it's supported by the API version you're using.
HTTP Status Code: 404
**UnrecognizedClientException**
The X.509 certificate or AWS access key ID you provided doesn't exist in our records. Verify that you're using valid credentials and that they haven't expired.
HTTP Status Code: 403
**ValidationError**
The input doesn't meet the required format or constraints. Check that all required parameters are included and that values are valid.
HTTP Status Code: 400