# Actions
<a name="API_Operations"></a>

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
<a name="API_Operations_Amazon_Bedrock"></a>

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
<a name="API_BatchDeleteEvaluationJob"></a>

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
<a name="API_BatchDeleteEvaluationJob_RequestSyntax"></a>

```
POST /evaluation-jobs/batch-delete HTTP/1.1
Content-type: application/json

{
   "jobIdentifiers": [ "string" ]
}
```

## URI Request Parameters
<a name="API_BatchDeleteEvaluationJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_BatchDeleteEvaluationJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [jobIdentifiers](#API_BatchDeleteEvaluationJob_RequestSyntax) **   <a name="bedrock-BatchDeleteEvaluationJob-request-jobIdentifiers"></a>
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
<a name="API_BatchDeleteEvaluationJob_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "errors": [ 
      { 
         "code": "string",
         "jobIdentifier": "string",
         "message": "string"
      }
   ],
   "evaluationJobs": [ 
      { 
         "jobIdentifier": "string",
         "jobStatus": "string"
      }
   ]
}
```

## Response Elements
<a name="API_BatchDeleteEvaluationJob_ResponseElements"></a>

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 name="bedrock-BatchDeleteEvaluationJob-response-errors"></a>
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) **   <a name="bedrock-BatchDeleteEvaluationJob-response-evaluationJobs"></a>
The list of evaluation jobs for deletion.  
Type: Array of [BatchDeleteEvaluationJobItem](API_BatchDeleteEvaluationJobItem.md) objects

## Errors
<a name="API_BatchDeleteEvaluationJob_Errors"></a>

For information about 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
<a name="API_BatchDeleteEvaluationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_CancelAutomatedReasoningPolicyBuildWorkflow"></a>

Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.

## Request Syntax
<a name="API_CancelAutomatedReasoningPolicyBuildWorkflow_RequestSyntax"></a>

```
POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/cancel HTTP/1.1
```

## URI Request Parameters
<a name="API_CancelAutomatedReasoningPolicyBuildWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_CancelAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **   <a name="bedrock-CancelAutomatedReasoningPolicyBuildWorkflow-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-CancelAutomatedReasoningPolicyBuildWorkflow-request-uri-policyArn"></a>
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
<a name="API_CancelAutomatedReasoningPolicyBuildWorkflow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_CancelAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_CancelAutomatedReasoningPolicyBuildWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_CancelAutomatedReasoningPolicyBuildWorkflow_Errors"></a>

For information about 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
<a name="API_CancelAutomatedReasoningPolicyBuildWorkflow_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateAutomatedReasoningPolicy"></a>

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
<a name="API_CreateAutomatedReasoningPolicy_RequestSyntax"></a>

```
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
<a name="API_CreateAutomatedReasoningPolicy_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateAutomatedReasoningPolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateAutomatedReasoningPolicy_RequestSyntax) **   <a name="bedrock-CreateAutomatedReasoningPolicy-request-clientRequestToken"></a>
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 name="bedrock-CreateAutomatedReasoningPolicy-request-description"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicy-request-kmsKeyId"></a>
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 name="bedrock-CreateAutomatedReasoningPolicy-request-name"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicy-request-policyDefinition"></a>
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 name="bedrock-CreateAutomatedReasoningPolicy-request-tags"></a>
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
<a name="API_CreateAutomatedReasoningPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "definitionHash": "string",
   "description": "string",
   "name": "string",
   "policyArn": "string",
   "updatedAt": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_CreateAutomatedReasoningPolicy_ResponseElements"></a>

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) **   <a name="bedrock-CreateAutomatedReasoningPolicy-response-createdAt"></a>
The timestamp when the policy was created.  
Type: Timestamp

 ** [definitionHash](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **   <a name="bedrock-CreateAutomatedReasoningPolicy-response-definitionHash"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicy-response-description"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicy-response-name"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicy-response-policyArn"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicy-response-updatedAt"></a>
The timestamp when the policy was last updated.  
Type: Timestamp

 ** [version](#API_CreateAutomatedReasoningPolicy_ResponseSyntax) **   <a name="bedrock-CreateAutomatedReasoningPolicy-response-version"></a>
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
<a name="API_CreateAutomatedReasoningPolicy_Errors"></a>

For information about 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
<a name="API_CreateAutomatedReasoningPolicy_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateAutomatedReasoningPolicyTestCase"></a>

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
<a name="API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax"></a>

```
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
<a name="API_CreateAutomatedReasoningPolicyTestCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [policyArn](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) **   <a name="bedrock-CreateAutomatedReasoningPolicyTestCase-request-uri-policyArn"></a>
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
<a name="API_CreateAutomatedReasoningPolicyTestCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateAutomatedReasoningPolicyTestCase_RequestSyntax) **   <a name="bedrock-CreateAutomatedReasoningPolicyTestCase-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyTestCase-request-confidenceThreshold"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyTestCase-request-expectedAggregatedFindingsResult"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyTestCase-request-guardContent"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyTestCase-request-queryContent"></a>
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
<a name="API_CreateAutomatedReasoningPolicyTestCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "policyArn": "string",
   "testCaseId": "string"
}
```

## Response Elements
<a name="API_CreateAutomatedReasoningPolicyTestCase_ResponseElements"></a>

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) **   <a name="bedrock-CreateAutomatedReasoningPolicyTestCase-response-policyArn"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyTestCase-response-testCaseId"></a>
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
<a name="API_CreateAutomatedReasoningPolicyTestCase_Errors"></a>

For information about 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
<a name="API_CreateAutomatedReasoningPolicyTestCase_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateAutomatedReasoningPolicyVersion"></a>

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
<a name="API_CreateAutomatedReasoningPolicyVersion_RequestSyntax"></a>

```
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
<a name="API_CreateAutomatedReasoningPolicyVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [policyArn](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-request-uri-policyArn"></a>
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
<a name="API_CreateAutomatedReasoningPolicyVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateAutomatedReasoningPolicyVersion_RequestSyntax) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-request-lastUpdatedDefinitionHash"></a>
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 name="bedrock-CreateAutomatedReasoningPolicyVersion-request-tags"></a>
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
<a name="API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "definitionHash": "string",
   "description": "string",
   "name": "string",
   "policyArn": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_CreateAutomatedReasoningPolicyVersion_ResponseElements"></a>

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) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-response-createdAt"></a>
The timestamp when the policy version was created.  
Type: Timestamp

 ** [definitionHash](#API_CreateAutomatedReasoningPolicyVersion_ResponseSyntax) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-response-definitionHash"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-response-description"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-response-name"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-response-policyArn"></a>
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) **   <a name="bedrock-CreateAutomatedReasoningPolicyVersion-response-version"></a>
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
<a name="API_CreateAutomatedReasoningPolicyVersion_Errors"></a>

For information about 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
<a name="API_CreateAutomatedReasoningPolicyVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateCustomModel"></a>

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
<a name="API_CreateCustomModel_RequestSyntax"></a>

```
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
<a name="API_CreateCustomModel_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateCustomModel_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateCustomModel_RequestSyntax) **   <a name="bedrock-CreateCustomModel-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateCustomModel-request-modelKmsKeyArn"></a>
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 name="bedrock-CreateCustomModel-request-modelName"></a>
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) **   <a name="bedrock-CreateCustomModel-request-modelSourceConfig"></a>
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 name="bedrock-CreateCustomModel-request-modelTags"></a>
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) **   <a name="bedrock-CreateCustomModel-request-roleArn"></a>
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
<a name="API_CreateCustomModel_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "modelArn": "string"
}
```

## Response Elements
<a name="API_CreateCustomModel_ResponseElements"></a>

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) **   <a name="bedrock-CreateCustomModel-response-modelArn"></a>
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
<a name="API_CreateCustomModel_Errors"></a>

For information about 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
<a name="API_CreateCustomModel_Examples"></a>

### Example request
<a name="API_CreateCustomModel_Example_1"></a>

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
<a name="API_CreateCustomModel_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateCustomModelDeployment"></a>

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
<a name="API_CreateCustomModelDeployment_RequestSyntax"></a>

```
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
<a name="API_CreateCustomModelDeployment_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateCustomModelDeployment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateCustomModelDeployment_RequestSyntax) **   <a name="bedrock-CreateCustomModelDeployment-request-clientRequestToken"></a>
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 name="bedrock-CreateCustomModelDeployment-request-description"></a>
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) **   <a name="bedrock-CreateCustomModelDeployment-request-modelArn"></a>
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) **   <a name="bedrock-CreateCustomModelDeployment-request-modelDeploymentName"></a>
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) **   <a name="bedrock-CreateCustomModelDeployment-request-tags"></a>
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
<a name="API_CreateCustomModelDeployment_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "customModelDeploymentArn": "string"
}
```

## Response Elements
<a name="API_CreateCustomModelDeployment_ResponseElements"></a>

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) **   <a name="bedrock-CreateCustomModelDeployment-response-customModelDeploymentArn"></a>
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
<a name="API_CreateCustomModelDeployment_Errors"></a>

For information about 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
<a name="API_CreateCustomModelDeployment_Examples"></a>

### Example request
<a name="API_CreateCustomModelDeployment_Example_1"></a>

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
<a name="API_CreateCustomModelDeployment_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateEvaluationJob"></a>

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
<a name="API_CreateEvaluationJob_RequestSyntax"></a>

```
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
<a name="API_CreateEvaluationJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateEvaluationJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [applicationType](#API_CreateEvaluationJob_RequestSyntax) **   <a name="bedrock-CreateEvaluationJob-request-applicationType"></a>
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 name="bedrock-CreateEvaluationJob-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateEvaluationJob-request-customerEncryptionKeyId"></a>
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) **   <a name="bedrock-CreateEvaluationJob-request-evaluationConfig"></a>
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) **   <a name="bedrock-CreateEvaluationJob-request-inferenceConfig"></a>
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 name="bedrock-CreateEvaluationJob-request-jobDescription"></a>
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="bedrock-CreateEvaluationJob-request-jobName"></a>
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) **   <a name="bedrock-CreateEvaluationJob-request-jobTags"></a>
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) **   <a name="bedrock-CreateEvaluationJob-request-outputDataConfig"></a>
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) **   <a name="bedrock-CreateEvaluationJob-request-roleArn"></a>
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
<a name="API_CreateEvaluationJob_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "jobArn": "string"
}
```

## Response Elements
<a name="API_CreateEvaluationJob_ResponseElements"></a>

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) **   <a name="bedrock-CreateEvaluationJob-response-jobArn"></a>
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
<a name="API_CreateEvaluationJob_Errors"></a>

For information about 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
<a name="API_CreateEvaluationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateFoundationModelAgreement"></a>

Request a model access agreement for the specified model.

## Request Syntax
<a name="API_CreateFoundationModelAgreement_RequestSyntax"></a>

```
POST /create-foundation-model-agreement HTTP/1.1
Content-type: application/json

{
   "modelId": "string",
   "offerToken": "string"
}
```

## URI Request Parameters
<a name="API_CreateFoundationModelAgreement_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateFoundationModelAgreement_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [modelId](#API_CreateFoundationModelAgreement_RequestSyntax) **   <a name="bedrock-CreateFoundationModelAgreement-request-modelId"></a>
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) **   <a name="bedrock-CreateFoundationModelAgreement-request-offerToken"></a>
An offer token encapsulates the information for an offer.  
Type: String  
Required: Yes

## Response Syntax
<a name="API_CreateFoundationModelAgreement_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "modelId": "string"
}
```

## Response Elements
<a name="API_CreateFoundationModelAgreement_ResponseElements"></a>

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) **   <a name="bedrock-CreateFoundationModelAgreement-response-modelId"></a>
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
<a name="API_CreateFoundationModelAgreement_Errors"></a>

For information about 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
<a name="API_CreateFoundationModelAgreement_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateGuardrail"></a>

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
<a name="API_CreateGuardrail_RequestSyntax"></a>

```
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
<a name="API_CreateGuardrail_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateGuardrail_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [automatedReasoningPolicyConfig](#API_CreateGuardrail_RequestSyntax) **   <a name="bedrock-CreateGuardrail-request-automatedReasoningPolicyConfig"></a>
Optional configuration for integrating Automated Reasoning policies with the new guardrail.  
Type: [GuardrailAutomatedReasoningPolicyConfig](API_GuardrailAutomatedReasoningPolicyConfig.md) object  
Required: No

 ** [blockedInputMessaging](#API_CreateGuardrail_RequestSyntax) **   <a name="bedrock-CreateGuardrail-request-blockedInputMessaging"></a>
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) **   <a name="bedrock-CreateGuardrail-request-blockedOutputsMessaging"></a>
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 name="bedrock-CreateGuardrail-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateGuardrail-request-contentPolicyConfig"></a>
The content filter policies to configure for the guardrail.  
Type: [GuardrailContentPolicyConfig](API_GuardrailContentPolicyConfig.md) object  
Required: No

 ** [contextualGroundingPolicyConfig](#API_CreateGuardrail_RequestSyntax) **   <a name="bedrock-CreateGuardrail-request-contextualGroundingPolicyConfig"></a>
The contextual grounding policy configuration used to create a guardrail.  
Type: [GuardrailContextualGroundingPolicyConfig](API_GuardrailContextualGroundingPolicyConfig.md) object  
Required: No

 ** [crossRegionConfig](#API_CreateGuardrail_RequestSyntax) **   <a name="bedrock-CreateGuardrail-request-crossRegionConfig"></a>
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 name="bedrock-CreateGuardrail-request-description"></a>
A description of the guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [kmsKeyId](#API_CreateGuardrail_RequestSyntax) **   <a name="bedrock-CreateGuardrail-request-kmsKeyId"></a>
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) **   <a name="bedrock-CreateGuardrail-request-name"></a>
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) **   <a name="bedrock-CreateGuardrail-request-sensitiveInformationPolicyConfig"></a>
The sensitive information policy to configure for the guardrail.  
Type: [GuardrailSensitiveInformationPolicyConfig](API_GuardrailSensitiveInformationPolicyConfig.md) object  
Required: No

 ** [tags](#API_CreateGuardrail_RequestSyntax) **   <a name="bedrock-CreateGuardrail-request-tags"></a>
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) **   <a name="bedrock-CreateGuardrail-request-topicPolicyConfig"></a>
The topic policies to configure for the guardrail.  
Type: [GuardrailTopicPolicyConfig](API_GuardrailTopicPolicyConfig.md) object  
Required: No

 ** [wordPolicyConfig](#API_CreateGuardrail_RequestSyntax) **   <a name="bedrock-CreateGuardrail-request-wordPolicyConfig"></a>
The word policy you configure for the guardrail.  
Type: [GuardrailWordPolicyConfig](API_GuardrailWordPolicyConfig.md) object  
Required: No

## Response Syntax
<a name="API_CreateGuardrail_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "createdAt": "string",
   "guardrailArn": "string",
   "guardrailId": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_CreateGuardrail_ResponseElements"></a>

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) **   <a name="bedrock-CreateGuardrail-response-createdAt"></a>
The time at which the guardrail was created.  
Type: Timestamp

 ** [guardrailArn](#API_CreateGuardrail_ResponseSyntax) **   <a name="bedrock-CreateGuardrail-response-guardrailArn"></a>
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) **   <a name="bedrock-CreateGuardrail-response-guardrailId"></a>
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) **   <a name="bedrock-CreateGuardrail-response-version"></a>
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
<a name="API_CreateGuardrail_Errors"></a>

For information about 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
<a name="API_CreateGuardrail_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateGuardrailVersion"></a>

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
<a name="API_CreateGuardrailVersion_RequestSyntax"></a>

```
POST /guardrails/guardrailIdentifier HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "description": "string"
}
```

## URI Request Parameters
<a name="API_CreateGuardrailVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [guardrailIdentifier](#API_CreateGuardrailVersion_RequestSyntax) **   <a name="bedrock-CreateGuardrailVersion-request-uri-guardrailIdentifier"></a>
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
<a name="API_CreateGuardrailVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateGuardrailVersion_RequestSyntax) **   <a name="bedrock-CreateGuardrailVersion-request-clientRequestToken"></a>
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 name="bedrock-CreateGuardrailVersion-request-description"></a>
A description of the guardrail version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

## Response Syntax
<a name="API_CreateGuardrailVersion_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "guardrailId": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_CreateGuardrailVersion_ResponseElements"></a>

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) **   <a name="bedrock-CreateGuardrailVersion-response-guardrailId"></a>
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) **   <a name="bedrock-CreateGuardrailVersion-response-version"></a>
The number of the version of the guardrail.  
Type: String  
Pattern: `[1-9][0-9]{0,7}` 

## Errors
<a name="API_CreateGuardrailVersion_Errors"></a>

For information about 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
<a name="API_CreateGuardrailVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateInferenceProfile"></a>

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
<a name="API_CreateInferenceProfile_RequestSyntax"></a>

```
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
<a name="API_CreateInferenceProfile_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateInferenceProfile_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateInferenceProfile_RequestSyntax) **   <a name="bedrock-CreateInferenceProfile-request-clientRequestToken"></a>
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 name="bedrock-CreateInferenceProfile-request-description"></a>
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="bedrock-CreateInferenceProfile-request-inferenceProfileName"></a>
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) **   <a name="bedrock-CreateInferenceProfile-request-modelSource"></a>
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) **   <a name="bedrock-CreateInferenceProfile-request-tags"></a>
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
<a name="API_CreateInferenceProfile_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "inferenceProfileArn": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_CreateInferenceProfile_ResponseElements"></a>

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) **   <a name="bedrock-CreateInferenceProfile-response-inferenceProfileArn"></a>
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) **   <a name="bedrock-CreateInferenceProfile-response-status"></a>
The status of the inference profile. `ACTIVE` means that the inference profile is ready to be used.  
Type: String  
Valid Values: `ACTIVE` 

## Errors
<a name="API_CreateInferenceProfile_Errors"></a>

For information about 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
<a name="API_CreateInferenceProfile_Examples"></a>

### Create an application inference profile from a foundation model
<a name="API_CreateInferenceProfile_Example_1"></a>

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
<a name="API_CreateInferenceProfile_Example_1_Request"></a>

```
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
<a name="API_CreateInferenceProfile_Example_2"></a>

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
<a name="API_CreateInferenceProfile_Example_2_Request"></a>

```
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
<a name="API_CreateInferenceProfile_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateMarketplaceModelEndpoint"></a>

Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.

## Request Syntax
<a name="API_CreateMarketplaceModelEndpoint_RequestSyntax"></a>

```
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
<a name="API_CreateMarketplaceModelEndpoint_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateMarketplaceModelEndpoint_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [acceptEula](#API_CreateMarketplaceModelEndpoint_RequestSyntax) **   <a name="bedrock-CreateMarketplaceModelEndpoint-request-acceptEula"></a>
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 name="bedrock-CreateMarketplaceModelEndpoint-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateMarketplaceModelEndpoint-request-endpointConfig"></a>
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) **   <a name="bedrock-CreateMarketplaceModelEndpoint-request-endpointName"></a>
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) **   <a name="bedrock-CreateMarketplaceModelEndpoint-request-modelSourceIdentifier"></a>
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) **   <a name="bedrock-CreateMarketplaceModelEndpoint-request-tags"></a>
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
<a name="API_CreateMarketplaceModelEndpoint_ResponseSyntax"></a>

```
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
<a name="API_CreateMarketplaceModelEndpoint_ResponseElements"></a>

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) **   <a name="bedrock-CreateMarketplaceModelEndpoint-response-marketplaceModelEndpoint"></a>
Details about the created endpoint.  
Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md) object

## Errors
<a name="API_CreateMarketplaceModelEndpoint_Errors"></a>

For information about 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
<a name="API_CreateMarketplaceModelEndpoint_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateModelCopyJob"></a>

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
<a name="API_CreateModelCopyJob_RequestSyntax"></a>

```
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
<a name="API_CreateModelCopyJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateModelCopyJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateModelCopyJob_RequestSyntax) **   <a name="bedrock-CreateModelCopyJob-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateModelCopyJob-request-modelKmsKeyId"></a>
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) **   <a name="bedrock-CreateModelCopyJob-request-sourceModelArn"></a>
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="bedrock-CreateModelCopyJob-request-targetModelName"></a>
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) **   <a name="bedrock-CreateModelCopyJob-request-targetModelTags"></a>
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
<a name="API_CreateModelCopyJob_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "jobArn": "string"
}
```

## Response Elements
<a name="API_CreateModelCopyJob_ResponseElements"></a>

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) **   <a name="bedrock-CreateModelCopyJob-response-jobArn"></a>
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
<a name="API_CreateModelCopyJob_Errors"></a>

For information about 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
<a name="API_CreateModelCopyJob_Examples"></a>

### Create a model copy job (CLI)
<a name="API_CreateModelCopyJob_Example_1"></a>

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
<a name="API_CreateModelCopyJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateModelCustomizationJob"></a>

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
<a name="API_CreateModelCustomizationJob_RequestSyntax"></a>

```
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
<a name="API_CreateModelCustomizationJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateModelCustomizationJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [baseModelIdentifier](#API_CreateModelCustomizationJob_RequestSyntax) **   <a name="bedrock-CreateModelCustomizationJob-request-baseModelIdentifier"></a>
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 name="bedrock-CreateModelCustomizationJob-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateModelCustomizationJob-request-customizationConfig"></a>
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) **   <a name="bedrock-CreateModelCustomizationJob-request-customizationType"></a>
The customization type.  
Type: String  
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION`   
Required: No

 ** [customModelKmsKeyId](#API_CreateModelCustomizationJob_RequestSyntax) **   <a name="bedrock-CreateModelCustomizationJob-request-customModelKmsKeyId"></a>
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="bedrock-CreateModelCustomizationJob-request-customModelName"></a>
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) **   <a name="bedrock-CreateModelCustomizationJob-request-customModelTags"></a>
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) **   <a name="bedrock-CreateModelCustomizationJob-request-hyperParameters"></a>
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="bedrock-CreateModelCustomizationJob-request-jobName"></a>
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) **   <a name="bedrock-CreateModelCustomizationJob-request-jobTags"></a>
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) **   <a name="bedrock-CreateModelCustomizationJob-request-outputDataConfig"></a>
S3 location for the output data.  
Type: [OutputDataConfig](API_OutputDataConfig.md) object  
Required: Yes

 ** [roleArn](#API_CreateModelCustomizationJob_RequestSyntax) **   <a name="bedrock-CreateModelCustomizationJob-request-roleArn"></a>
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) **   <a name="bedrock-CreateModelCustomizationJob-request-trainingDataConfig"></a>
Information about the training dataset.  
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object  
Required: Yes

 ** [validationDataConfig](#API_CreateModelCustomizationJob_RequestSyntax) **   <a name="bedrock-CreateModelCustomizationJob-request-validationDataConfig"></a>
Information about the validation dataset.   
Type: [ValidationDataConfig](API_ValidationDataConfig.md) object  
Required: No

 ** [vpcConfig](#API_CreateModelCustomizationJob_RequestSyntax) **   <a name="bedrock-CreateModelCustomizationJob-request-vpcConfig"></a>
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
<a name="API_CreateModelCustomizationJob_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "jobArn": "string"
}
```

## Response Elements
<a name="API_CreateModelCustomizationJob_ResponseElements"></a>

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) **   <a name="bedrock-CreateModelCustomizationJob-response-jobArn"></a>
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
<a name="API_CreateModelCustomizationJob_Errors"></a>

For information about 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
<a name="API_CreateModelCustomizationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateModelImportJob"></a>

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
<a name="API_CreateModelImportJob_RequestSyntax"></a>

```
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
<a name="API_CreateModelImportJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateModelImportJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateModelImportJob_RequestSyntax) **   <a name="bedrock-CreateModelImportJob-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateModelImportJob-request-importedModelKmsKeyId"></a>
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) **   <a name="bedrock-CreateModelImportJob-request-importedModelName"></a>
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) **   <a name="bedrock-CreateModelImportJob-request-importedModelTags"></a>
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) **   <a name="bedrock-CreateModelImportJob-request-jobName"></a>
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) **   <a name="bedrock-CreateModelImportJob-request-jobTags"></a>
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) **   <a name="bedrock-CreateModelImportJob-request-modelDataSource"></a>
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) **   <a name="bedrock-CreateModelImportJob-request-roleArn"></a>
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) **   <a name="bedrock-CreateModelImportJob-request-vpcConfig"></a>
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
<a name="API_CreateModelImportJob_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "jobArn": "string"
}
```

## Response Elements
<a name="API_CreateModelImportJob_ResponseElements"></a>

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) **   <a name="bedrock-CreateModelImportJob-response-jobArn"></a>
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
<a name="API_CreateModelImportJob_Errors"></a>

For information about 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
<a name="API_CreateModelImportJob_Examples"></a>

### Create a model import job
<a name="API_CreateModelImportJob_Example_1"></a>

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
<a name="API_CreateModelImportJob_Example_2"></a>

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
<a name="API_CreateModelImportJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateModelInvocationJob"></a>

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
<a name="API_CreateModelInvocationJob_RequestSyntax"></a>

```
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
<a name="API_CreateModelInvocationJob_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateModelInvocationJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateModelInvocationJob_RequestSyntax) **   <a name="bedrock-CreateModelInvocationJob-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateModelInvocationJob-request-inputDataConfig"></a>
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="bedrock-CreateModelInvocationJob-request-jobName"></a>
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) **   <a name="bedrock-CreateModelInvocationJob-request-modelId"></a>
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) **   <a name="bedrock-CreateModelInvocationJob-request-modelInvocationType"></a>
The invocation endpoint for ModelInvocationJob  
Type: String  
Valid Values: `InvokeModel | Converse`   
Required: No

 ** [outputDataConfig](#API_CreateModelInvocationJob_RequestSyntax) **   <a name="bedrock-CreateModelInvocationJob-request-outputDataConfig"></a>
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) **   <a name="bedrock-CreateModelInvocationJob-request-roleArn"></a>
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) **   <a name="bedrock-CreateModelInvocationJob-request-tags"></a>
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) **   <a name="bedrock-CreateModelInvocationJob-request-timeoutDurationInHours"></a>
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) **   <a name="bedrock-CreateModelInvocationJob-request-vpcConfig"></a>
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
<a name="API_CreateModelInvocationJob_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "jobArn": "string"
}
```

## Response Elements
<a name="API_CreateModelInvocationJob_ResponseElements"></a>

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) **   <a name="bedrock-CreateModelInvocationJob-response-jobArn"></a>
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
<a name="API_CreateModelInvocationJob_Errors"></a>

For information about 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
<a name="API_CreateModelInvocationJob_Examples"></a>

### Create a batch inference job
<a name="API_CreateModelInvocationJob_Example_1"></a>

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
<a name="API_CreateModelInvocationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreatePromptRouter"></a>

Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.

## Request Syntax
<a name="API_CreatePromptRouter_RequestSyntax"></a>

```
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
<a name="API_CreatePromptRouter_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreatePromptRouter_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreatePromptRouter_RequestSyntax) **   <a name="bedrock-CreatePromptRouter-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreatePromptRouter-request-description"></a>
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) **   <a name="bedrock-CreatePromptRouter-request-fallbackModel"></a>
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 name="bedrock-CreatePromptRouter-request-models"></a>
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) **   <a name="bedrock-CreatePromptRouter-request-promptRouterName"></a>
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) **   <a name="bedrock-CreatePromptRouter-request-routingCriteria"></a>
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) **   <a name="bedrock-CreatePromptRouter-request-tags"></a>
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
<a name="API_CreatePromptRouter_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "promptRouterArn": "string"
}
```

## Response Elements
<a name="API_CreatePromptRouter_ResponseElements"></a>

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) **   <a name="bedrock-CreatePromptRouter-response-promptRouterArn"></a>
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
<a name="API_CreatePromptRouter_Errors"></a>

For information about 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
<a name="API_CreatePromptRouter_SeeAlso"></a>

For more information about using this API 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
<a name="API_CreateProvisionedModelThroughput"></a>

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
<a name="API_CreateProvisionedModelThroughput_RequestSyntax"></a>

```
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
<a name="API_CreateProvisionedModelThroughput_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_CreateProvisionedModelThroughput_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_CreateProvisionedModelThroughput_RequestSyntax) **   <a name="bedrock-CreateProvisionedModelThroughput-request-clientRequestToken"></a>
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) **   <a name="bedrock-CreateProvisionedModelThroughput-request-commitmentDuration"></a>
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) **   <a name="bedrock-CreateProvisionedModelThroughput-request-modelId"></a>
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) **   <a name="bedrock-CreateProvisionedModelThroughput-request-modelUnits"></a>
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) **   <a name="bedrock-CreateProvisionedModelThroughput-request-provisionedModelName"></a>
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) **   <a name="bedrock-CreateProvisionedModelThroughput-request-tags"></a>
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
<a name="API_CreateProvisionedModelThroughput_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "provisionedModelArn": "string"
}
```

## Response Elements
<a name="API_CreateProvisionedModelThroughput_ResponseElements"></a>

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) **   <a name="bedrock-CreateProvisionedModelThroughput-response-provisionedModelArn"></a>
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
<a name="API_CreateProvisionedModelThroughput_Errors"></a>

For information about 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
<a name="API_CreateProvisionedModelThroughput_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteAutomatedReasoningPolicy"></a>

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
<a name="API_DeleteAutomatedReasoningPolicy_RequestSyntax"></a>

```
DELETE /automated-reasoning-policies/policyArn?force=force HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAutomatedReasoningPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [force](#API_DeleteAutomatedReasoningPolicy_RequestSyntax) **   <a name="bedrock-DeleteAutomatedReasoningPolicy-request-uri-force"></a>
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) **   <a name="bedrock-DeleteAutomatedReasoningPolicy-request-uri-policyArn"></a>
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
<a name="API_DeleteAutomatedReasoningPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAutomatedReasoningPolicy_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteAutomatedReasoningPolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteAutomatedReasoningPolicy_Errors"></a>

For information about 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
<a name="API_DeleteAutomatedReasoningPolicy_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteAutomatedReasoningPolicyBuildWorkflow"></a>

Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.

## Request Syntax
<a name="API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestSyntax"></a>

```
DELETE /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId?updatedAt=lastUpdatedAt HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **   <a name="bedrock-DeleteAutomatedReasoningPolicyBuildWorkflow-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-DeleteAutomatedReasoningPolicyBuildWorkflow-request-uri-lastUpdatedAt"></a>
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) **   <a name="bedrock-DeleteAutomatedReasoningPolicyBuildWorkflow-request-uri-policyArn"></a>
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
<a name="API_DeleteAutomatedReasoningPolicyBuildWorkflow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteAutomatedReasoningPolicyBuildWorkflow_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteAutomatedReasoningPolicyBuildWorkflow_Errors"></a>

For information about 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
<a name="API_DeleteAutomatedReasoningPolicyBuildWorkflow_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteAutomatedReasoningPolicyTestCase"></a>

Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.

## Request Syntax
<a name="API_DeleteAutomatedReasoningPolicyTestCase_RequestSyntax"></a>

```
DELETE /automated-reasoning-policies/policyArn/test-cases/testCaseId?updatedAt=lastUpdatedAt HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteAutomatedReasoningPolicyTestCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [lastUpdatedAt](#API_DeleteAutomatedReasoningPolicyTestCase_RequestSyntax) **   <a name="bedrock-DeleteAutomatedReasoningPolicyTestCase-request-uri-lastUpdatedAt"></a>
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) **   <a name="bedrock-DeleteAutomatedReasoningPolicyTestCase-request-uri-policyArn"></a>
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) **   <a name="bedrock-DeleteAutomatedReasoningPolicyTestCase-request-uri-testCaseId"></a>
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
<a name="API_DeleteAutomatedReasoningPolicyTestCase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteAutomatedReasoningPolicyTestCase_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteAutomatedReasoningPolicyTestCase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteAutomatedReasoningPolicyTestCase_Errors"></a>

For information about 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
<a name="API_DeleteAutomatedReasoningPolicyTestCase_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteCustomModel"></a>

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
<a name="API_DeleteCustomModel_RequestSyntax"></a>

```
DELETE /custom-models/modelIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteCustomModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelIdentifier](#API_DeleteCustomModel_RequestSyntax) **   <a name="bedrock-DeleteCustomModel-request-uri-modelIdentifier"></a>
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
<a name="API_DeleteCustomModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteCustomModel_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteCustomModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteCustomModel_Errors"></a>

For information about 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
<a name="API_DeleteCustomModel_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteCustomModelDeployment"></a>

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
<a name="API_DeleteCustomModelDeployment_RequestSyntax"></a>

```
DELETE /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteCustomModelDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [customModelDeploymentIdentifier](#API_DeleteCustomModelDeployment_RequestSyntax) **   <a name="bedrock-DeleteCustomModelDeployment-request-uri-customModelDeploymentIdentifier"></a>
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
<a name="API_DeleteCustomModelDeployment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteCustomModelDeployment_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteCustomModelDeployment_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteCustomModelDeployment_Errors"></a>

For information about 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
<a name="API_DeleteCustomModelDeployment_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteEnforcedGuardrailConfiguration"></a>

Deletes the account-level enforced guardrail configuration.

## Request Syntax
<a name="API_DeleteEnforcedGuardrailConfiguration_RequestSyntax"></a>

```
DELETE /enforcedGuardrailsConfiguration/configId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteEnforcedGuardrailConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [configId](#API_DeleteEnforcedGuardrailConfiguration_RequestSyntax) **   <a name="bedrock-DeleteEnforcedGuardrailConfiguration-request-uri-configId"></a>
Unique ID for the account enforced configuration.  
Pattern: `[a-z0-9]+`   
Required: Yes

## Request Body
<a name="API_DeleteEnforcedGuardrailConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteEnforcedGuardrailConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteEnforcedGuardrailConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteEnforcedGuardrailConfiguration_Errors"></a>

For information about 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
<a name="API_DeleteEnforcedGuardrailConfiguration_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteFoundationModelAgreement"></a>

Delete the model access agreement for the specified model.

## Request Syntax
<a name="API_DeleteFoundationModelAgreement_RequestSyntax"></a>

```
POST /delete-foundation-model-agreement HTTP/1.1
Content-type: application/json

{
   "modelId": "string"
}
```

## URI Request Parameters
<a name="API_DeleteFoundationModelAgreement_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteFoundationModelAgreement_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [modelId](#API_DeleteFoundationModelAgreement_RequestSyntax) **   <a name="bedrock-DeleteFoundationModelAgreement-request-modelId"></a>
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
<a name="API_DeleteFoundationModelAgreement_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteFoundationModelAgreement_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteFoundationModelAgreement_Errors"></a>

For information about 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
<a name="API_DeleteFoundationModelAgreement_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteGuardrail"></a>

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
<a name="API_DeleteGuardrail_RequestSyntax"></a>

```
DELETE /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteGuardrail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [guardrailIdentifier](#API_DeleteGuardrail_RequestSyntax) **   <a name="bedrock-DeleteGuardrail-request-uri-guardrailIdentifier"></a>
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) **   <a name="bedrock-DeleteGuardrail-request-uri-guardrailVersion"></a>
The version of the guardrail.  
Pattern: `[1-9][0-9]{0,7}` 

## Request Body
<a name="API_DeleteGuardrail_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteGuardrail_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_DeleteGuardrail_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_DeleteGuardrail_Errors"></a>

For information about 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
<a name="API_DeleteGuardrail_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteImportedModel"></a>

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
<a name="API_DeleteImportedModel_RequestSyntax"></a>

```
DELETE /imported-models/modelIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteImportedModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelIdentifier](#API_DeleteImportedModel_RequestSyntax) **   <a name="bedrock-DeleteImportedModel-request-uri-modelIdentifier"></a>
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
<a name="API_DeleteImportedModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteImportedModel_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteImportedModel_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteImportedModel_Errors"></a>

For information about 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
<a name="API_DeleteImportedModel_Examples"></a>

### Delete an imported model
<a name="API_DeleteImportedModel_Example_1"></a>

Deletes a model that you have previously imported.

```
DELETE /imported-models/{modelIdentifier} HTTP/1.1
Content-type: application/json
```

### Example response
<a name="API_DeleteImportedModel_Example_2"></a>

Response for the above request.

```
HTTP/1.1 200
```

## See Also
<a name="API_DeleteImportedModel_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteInferenceProfile"></a>

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
<a name="API_DeleteInferenceProfile_RequestSyntax"></a>

```
DELETE /inference-profiles/inferenceProfileIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteInferenceProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [inferenceProfileIdentifier](#API_DeleteInferenceProfile_RequestSyntax) **   <a name="bedrock-DeleteInferenceProfile-request-uri-inferenceProfileIdentifier"></a>
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
<a name="API_DeleteInferenceProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteInferenceProfile_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteInferenceProfile_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteInferenceProfile_Errors"></a>

For information about 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
<a name="API_DeleteInferenceProfile_Examples"></a>

### Delete an application inference profile
<a name="API_DeleteInferenceProfile_Example_1"></a>

Assuming you've created an application inference profile called `USClaudeSonnetApplicationIP`, run the following example to delete it:

#### Sample Request
<a name="API_DeleteInferenceProfile_Example_1_Request"></a>

```
DELETE /inference-profiles/USClaudeSonnetApplicationIP HTTP/1.1
```

## See Also
<a name="API_DeleteInferenceProfile_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteMarketplaceModelEndpoint"></a>

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

## Request Syntax
<a name="API_DeleteMarketplaceModelEndpoint_RequestSyntax"></a>

```
DELETE /marketplace-model/endpoints/endpointArn HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteMarketplaceModelEndpoint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [endpointArn](#API_DeleteMarketplaceModelEndpoint_RequestSyntax) **   <a name="bedrock-DeleteMarketplaceModelEndpoint-request-uri-endpointArn"></a>
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
<a name="API_DeleteMarketplaceModelEndpoint_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteMarketplaceModelEndpoint_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteMarketplaceModelEndpoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteMarketplaceModelEndpoint_Errors"></a>

For information about 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
<a name="API_DeleteMarketplaceModelEndpoint_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteModelInvocationLoggingConfiguration"></a>

Delete the invocation logging. 

## Request Syntax
<a name="API_DeleteModelInvocationLoggingConfiguration_RequestSyntax"></a>

```
DELETE /logging/modelinvocations HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteModelInvocationLoggingConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_DeleteModelInvocationLoggingConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteModelInvocationLoggingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteModelInvocationLoggingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteModelInvocationLoggingConfiguration_Errors"></a>

For information about 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
<a name="API_DeleteModelInvocationLoggingConfiguration_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeletePromptRouter"></a>

Deletes a specified prompt router. This action cannot be undone.

## Request Syntax
<a name="API_DeletePromptRouter_RequestSyntax"></a>

```
DELETE /prompt-routers/promptRouterArn HTTP/1.1
```

## URI Request Parameters
<a name="API_DeletePromptRouter_RequestParameters"></a>

The request uses the following URI parameters.

 ** [promptRouterArn](#API_DeletePromptRouter_RequestSyntax) **   <a name="bedrock-DeletePromptRouter-request-uri-promptRouterArn"></a>
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
<a name="API_DeletePromptRouter_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeletePromptRouter_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeletePromptRouter_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePromptRouter_Errors"></a>

For information about 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
<a name="API_DeletePromptRouter_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteProvisionedModelThroughput"></a>

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
<a name="API_DeleteProvisionedModelThroughput_RequestSyntax"></a>

```
DELETE /provisioned-model-throughput/provisionedModelId HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteProvisionedModelThroughput_RequestParameters"></a>

The request uses the following URI parameters.

 ** [provisionedModelId](#API_DeleteProvisionedModelThroughput_RequestSyntax) **   <a name="bedrock-DeleteProvisionedModelThroughput-request-uri-provisionedModelId"></a>
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
<a name="API_DeleteProvisionedModelThroughput_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteProvisionedModelThroughput_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteProvisionedModelThroughput_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteProvisionedModelThroughput_Errors"></a>

For information about 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
<a name="API_DeleteProvisionedModelThroughput_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeleteResourcePolicy"></a>

Deletes a previously created Bedrock resource policy.

## Request Syntax
<a name="API_DeleteResourcePolicy_RequestSyntax"></a>

```
DELETE /resource-policy/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_DeleteResourcePolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_DeleteResourcePolicy_RequestSyntax) **   <a name="bedrock-DeleteResourcePolicy-request-uri-resourceArn"></a>
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
<a name="API_DeleteResourcePolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeleteResourcePolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeleteResourcePolicy_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteResourcePolicy_Errors"></a>

For information about 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
<a name="API_DeleteResourcePolicy_SeeAlso"></a>

For more information about using this API 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
<a name="API_DeregisterMarketplaceModelEndpoint"></a>

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
<a name="API_DeregisterMarketplaceModelEndpoint_RequestSyntax"></a>

```
DELETE /marketplace-model/endpoints/endpointArn/registration HTTP/1.1
```

## URI Request Parameters
<a name="API_DeregisterMarketplaceModelEndpoint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [endpointArn](#API_DeregisterMarketplaceModelEndpoint_RequestSyntax) **   <a name="bedrock-DeregisterMarketplaceModelEndpoint-request-uri-endpointArn"></a>
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
<a name="API_DeregisterMarketplaceModelEndpoint_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_DeregisterMarketplaceModelEndpoint_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_DeregisterMarketplaceModelEndpoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeregisterMarketplaceModelEndpoint_Errors"></a>

For information about 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
<a name="API_DeregisterMarketplaceModelEndpoint_SeeAlso"></a>

For more information about using this API 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
<a name="API_ExportAutomatedReasoningPolicyVersion"></a>

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
<a name="API_ExportAutomatedReasoningPolicyVersion_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/export HTTP/1.1
```

## URI Request Parameters
<a name="API_ExportAutomatedReasoningPolicyVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [policyArn](#API_ExportAutomatedReasoningPolicyVersion_RequestSyntax) **   <a name="bedrock-ExportAutomatedReasoningPolicyVersion-request-uri-policyArn"></a>
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
<a name="API_ExportAutomatedReasoningPolicyVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ExportAutomatedReasoningPolicyVersion_ResponseSyntax"></a>

```
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
<a name="API_ExportAutomatedReasoningPolicyVersion_ResponseElements"></a>

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) **   <a name="bedrock-ExportAutomatedReasoningPolicyVersion-response-rules"></a>
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) **   <a name="bedrock-ExportAutomatedReasoningPolicyVersion-response-types"></a>
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) **   <a name="bedrock-ExportAutomatedReasoningPolicyVersion-response-variables"></a>
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) **   <a name="bedrock-ExportAutomatedReasoningPolicyVersion-response-version"></a>
The version of the policy definition format.  
Type: String

## Errors
<a name="API_ExportAutomatedReasoningPolicyVersion_Errors"></a>

For information about 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
<a name="API_ExportAutomatedReasoningPolicyVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetAutomatedReasoningPolicy"></a>

Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.

## Request Syntax
<a name="API_GetAutomatedReasoningPolicy_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAutomatedReasoningPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [policyArn](#API_GetAutomatedReasoningPolicy_RequestSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicy-request-uri-policyArn"></a>
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
<a name="API_GetAutomatedReasoningPolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAutomatedReasoningPolicy_ResponseSyntax"></a>

```
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
<a name="API_GetAutomatedReasoningPolicy_ResponseElements"></a>

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) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-createdAt"></a>
The timestamp when the policy was created.  
Type: Timestamp

 ** [definitionHash](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-definitionHash"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-description"></a>
The description of the policy.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 1024.  
Pattern: `[\s\S]+` 

 ** [kmsKeyArn](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-kmsKeyArn"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-name"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-policyArn"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-policyId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-updatedAt"></a>
The timestamp when the policy was last updated.  
Type: Timestamp

 ** [version](#API_GetAutomatedReasoningPolicy_ResponseSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicy-response-version"></a>
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
<a name="API_GetAutomatedReasoningPolicy_Errors"></a>

For information about 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
<a name="API_GetAutomatedReasoningPolicy_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetAutomatedReasoningPolicyAnnotations"></a>

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
<a name="API_GetAutomatedReasoningPolicyAnnotations_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/annotations HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAutomatedReasoningPolicyAnnotations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyAnnotations_RequestSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicyAnnotations-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyAnnotations-request-uri-policyArn"></a>
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
<a name="API_GetAutomatedReasoningPolicyAnnotations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAutomatedReasoningPolicyAnnotations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "annotations": [ 
      { ... }
   ],
   "annotationSetHash": "string",
   "buildWorkflowId": "string",
   "name": "string",
   "policyArn": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_GetAutomatedReasoningPolicyAnnotations_ResponseElements"></a>

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) **   <a name="bedrock-GetAutomatedReasoningPolicyAnnotations-response-annotations"></a>
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 name="bedrock-GetAutomatedReasoningPolicyAnnotations-response-annotationSetHash"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyAnnotations-response-buildWorkflowId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyAnnotations-response-name"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyAnnotations-response-policyArn"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyAnnotations-response-updatedAt"></a>
The timestamp when the annotations were last updated.  
Type: Timestamp

## Errors
<a name="API_GetAutomatedReasoningPolicyAnnotations_Errors"></a>

For information about 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
<a name="API_GetAutomatedReasoningPolicyAnnotations_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetAutomatedReasoningPolicyBuildWorkflow"></a>

Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.

## Request Syntax
<a name="API_GetAutomatedReasoningPolicyBuildWorkflow_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAutomatedReasoningPolicyBuildWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-request-uri-policyArn"></a>
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
<a name="API_GetAutomatedReasoningPolicyBuildWorkflow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax"></a>

```
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
<a name="API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseElements"></a>

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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-buildWorkflowId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-buildWorkflowType"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-createdAt"></a>
The timestamp when the build workflow was created.  
Type: Timestamp

 ** [documentContentType](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-documentContentType"></a>
The content type of the source document (e.g., text/plain, application/pdf).  
Type: String  
Valid Values: `pdf | txt` 

 ** [documentDescription](#API_GetAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-documentDescription"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-documentName"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-policyArn"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-status"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflow-response-updatedAt"></a>
The timestamp when the build workflow was last updated.  
Type: Timestamp

## Errors
<a name="API_GetAutomatedReasoningPolicyBuildWorkflow_Errors"></a>

For information about 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
<a name="API_GetAutomatedReasoningPolicyBuildWorkflow_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets"></a>

Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.

## Request Syntax
<a name="API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/result-assets?assetId=assetId&assetType=assetType HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestParameters"></a>

The request uses the following URI parameters.

 ** [assetId](#API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflowResultAssets-request-uri-assetId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflowResultAssets-request-uri-assetType"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflowResultAssets-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflowResultAssets-request-uri-policyArn"></a>
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
<a name="API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "buildWorkflowAssets": { ... },
   "buildWorkflowId": "string",
   "policyArn": "string"
}
```

## Response Elements
<a name="API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_ResponseElements"></a>

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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflowResultAssets-response-buildWorkflowAssets"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflowResultAssets-response-buildWorkflowId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyBuildWorkflowResultAssets-response-policyArn"></a>
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
<a name="API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_Errors"></a>

For information about 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
<a name="API_GetAutomatedReasoningPolicyBuildWorkflowResultAssets_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetAutomatedReasoningPolicyNextScenario"></a>

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
<a name="API_GetAutomatedReasoningPolicyNextScenario_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/scenarios HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAutomatedReasoningPolicyNextScenario_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyNextScenario_RequestSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicyNextScenario-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyNextScenario-request-uri-policyArn"></a>
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
<a name="API_GetAutomatedReasoningPolicyNextScenario_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAutomatedReasoningPolicyNextScenario_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "policyArn": "string",
   "scenario": { 
      "alternateExpression": "string",
      "expectedResult": "string",
      "expression": "string",
      "ruleIds": [ "string" ]
   }
}
```

## Response Elements
<a name="API_GetAutomatedReasoningPolicyNextScenario_ResponseElements"></a>

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) **   <a name="bedrock-GetAutomatedReasoningPolicyNextScenario-response-policyArn"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyNextScenario-response-scenario"></a>
The next test scenario to validate, including the test expression and expected results.  
Type: [AutomatedReasoningPolicyScenario](API_AutomatedReasoningPolicyScenario.md) object

## Errors
<a name="API_GetAutomatedReasoningPolicyNextScenario_Errors"></a>

For information about 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
<a name="API_GetAutomatedReasoningPolicyNextScenario_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetAutomatedReasoningPolicyTestCase"></a>

Retrieves details about a specific Automated Reasoning policy test.

## Request Syntax
<a name="API_GetAutomatedReasoningPolicyTestCase_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/test-cases/testCaseId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAutomatedReasoningPolicyTestCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [policyArn](#API_GetAutomatedReasoningPolicyTestCase_RequestSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicyTestCase-request-uri-policyArn"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyTestCase-request-uri-testCaseId"></a>
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
<a name="API_GetAutomatedReasoningPolicyTestCase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAutomatedReasoningPolicyTestCase_ResponseSyntax"></a>

```
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
<a name="API_GetAutomatedReasoningPolicyTestCase_ResponseElements"></a>

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) **   <a name="bedrock-GetAutomatedReasoningPolicyTestCase-response-policyArn"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyTestCase-response-testCase"></a>
The test details including the content, query, expected result, and metadata.  
Type: [AutomatedReasoningPolicyTestCase](API_AutomatedReasoningPolicyTestCase.md) object

## Errors
<a name="API_GetAutomatedReasoningPolicyTestCase_Errors"></a>

For information about 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
<a name="API_GetAutomatedReasoningPolicyTestCase_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetAutomatedReasoningPolicyTestResult"></a>

Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.

## Request Syntax
<a name="API_GetAutomatedReasoningPolicyTestResult_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-cases/testCaseId/test-results HTTP/1.1
```

## URI Request Parameters
<a name="API_GetAutomatedReasoningPolicyTestResult_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_GetAutomatedReasoningPolicyTestResult_RequestSyntax) **   <a name="bedrock-GetAutomatedReasoningPolicyTestResult-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyTestResult-request-uri-policyArn"></a>
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) **   <a name="bedrock-GetAutomatedReasoningPolicyTestResult-request-uri-testCaseId"></a>
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
<a name="API_GetAutomatedReasoningPolicyTestResult_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetAutomatedReasoningPolicyTestResult_ResponseSyntax"></a>

```
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
<a name="API_GetAutomatedReasoningPolicyTestResult_ResponseElements"></a>

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) **   <a name="bedrock-GetAutomatedReasoningPolicyTestResult-response-testResult"></a>
The test result containing validation findings, execution status, and detailed analysis.  
Type: [AutomatedReasoningPolicyTestResult](API_AutomatedReasoningPolicyTestResult.md) object

## Errors
<a name="API_GetAutomatedReasoningPolicyTestResult_Errors"></a>

For information about 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
<a name="API_GetAutomatedReasoningPolicyTestResult_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetCustomModel"></a>

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
<a name="API_GetCustomModel_RequestSyntax"></a>

```
GET /custom-models/modelIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetCustomModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelIdentifier](#API_GetCustomModel_RequestSyntax) **   <a name="bedrock-GetCustomModel-request-uri-modelIdentifier"></a>
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
<a name="API_GetCustomModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetCustomModel_ResponseSyntax"></a>

```
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
<a name="API_GetCustomModel_ResponseElements"></a>

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) **   <a name="bedrock-GetCustomModel-response-baseModelArn"></a>
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) **   <a name="bedrock-GetCustomModel-response-creationTime"></a>
Creation time of the model.  
Type: Timestamp

 ** [customizationConfig](#API_GetCustomModel_ResponseSyntax) **   <a name="bedrock-GetCustomModel-response-customizationConfig"></a>
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) **   <a name="bedrock-GetCustomModel-response-customizationType"></a>
The type of model customization.  
Type: String  
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION | REINFORCEMENT_FINE_TUNING | IMPORTED` 

 ** [failureMessage](#API_GetCustomModel_ResponseSyntax) **   <a name="bedrock-GetCustomModel-response-failureMessage"></a>
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) **   <a name="bedrock-GetCustomModel-response-hyperParameters"></a>
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) **   <a name="bedrock-GetCustomModel-response-jobArn"></a>
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) **   <a name="bedrock-GetCustomModel-response-jobName"></a>
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) **   <a name="bedrock-GetCustomModel-response-modelArn"></a>
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) **   <a name="bedrock-GetCustomModel-response-modelKmsKeyArn"></a>
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) **   <a name="bedrock-GetCustomModel-response-modelName"></a>
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) **   <a name="bedrock-GetCustomModel-response-modelStatus"></a>
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) **   <a name="bedrock-GetCustomModel-response-outputDataConfig"></a>
Output data configuration associated with this custom model.  
Type: [OutputDataConfig](API_OutputDataConfig.md) object

 ** [trainingDataConfig](#API_GetCustomModel_ResponseSyntax) **   <a name="bedrock-GetCustomModel-response-trainingDataConfig"></a>
Contains information about the training dataset.  
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object

 ** [trainingMetrics](#API_GetCustomModel_ResponseSyntax) **   <a name="bedrock-GetCustomModel-response-trainingMetrics"></a>
Contains training metrics from the job creation.  
Type: [TrainingMetrics](API_TrainingMetrics.md) object

 ** [validationDataConfig](#API_GetCustomModel_ResponseSyntax) **   <a name="bedrock-GetCustomModel-response-validationDataConfig"></a>
Contains information about the validation dataset.  
Type: [ValidationDataConfig](API_ValidationDataConfig.md) object

 ** [validationMetrics](#API_GetCustomModel_ResponseSyntax) **   <a name="bedrock-GetCustomModel-response-validationMetrics"></a>
The validation metrics from the job creation.  
Type: Array of [ValidatorMetric](API_ValidatorMetric.md) objects

## Errors
<a name="API_GetCustomModel_Errors"></a>

For information about 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
<a name="API_GetCustomModel_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetCustomModelDeployment"></a>

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
<a name="API_GetCustomModelDeployment_RequestSyntax"></a>

```
GET /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetCustomModelDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [customModelDeploymentIdentifier](#API_GetCustomModelDeployment_RequestSyntax) **   <a name="bedrock-GetCustomModelDeployment-request-uri-customModelDeploymentIdentifier"></a>
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
<a name="API_GetCustomModelDeployment_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetCustomModelDeployment_ResponseSyntax"></a>

```
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
<a name="API_GetCustomModelDeployment_ResponseElements"></a>

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) **   <a name="bedrock-GetCustomModelDeployment-response-createdAt"></a>
The date and time when the custom model deployment was created.  
Type: Timestamp

 ** [customModelDeploymentArn](#API_GetCustomModelDeployment_ResponseSyntax) **   <a name="bedrock-GetCustomModelDeployment-response-customModelDeploymentArn"></a>
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) **   <a name="bedrock-GetCustomModelDeployment-response-description"></a>
The description of the custom model deployment.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*` 

 ** [failureMessage](#API_GetCustomModelDeployment_ResponseSyntax) **   <a name="bedrock-GetCustomModelDeployment-response-failureMessage"></a>
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) **   <a name="bedrock-GetCustomModelDeployment-response-lastUpdatedAt"></a>
The date and time when the custom model deployment was last updated.  
Type: Timestamp

 ** [modelArn](#API_GetCustomModelDeployment_ResponseSyntax) **   <a name="bedrock-GetCustomModelDeployment-response-modelArn"></a>
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) **   <a name="bedrock-GetCustomModelDeployment-response-modelDeploymentName"></a>
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) **   <a name="bedrock-GetCustomModelDeployment-response-status"></a>
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) **   <a name="bedrock-GetCustomModelDeployment-response-updateDetails"></a>
 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
<a name="API_GetCustomModelDeployment_Errors"></a>

For information about 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
<a name="API_GetCustomModelDeployment_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetEvaluationJob"></a>

Gets information about an evaluation job, such as the status of the job.

## Request Syntax
<a name="API_GetEvaluationJob_RequestSyntax"></a>

```
GET /evaluation-jobs/jobIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetEvaluationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobIdentifier](#API_GetEvaluationJob_RequestSyntax) **   <a name="bedrock-GetEvaluationJob-request-uri-jobIdentifier"></a>
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
<a name="API_GetEvaluationJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetEvaluationJob_ResponseSyntax"></a>

```
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
<a name="API_GetEvaluationJob_ResponseElements"></a>

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) **   <a name="bedrock-GetEvaluationJob-response-applicationType"></a>
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) **   <a name="bedrock-GetEvaluationJob-response-creationTime"></a>
The time the evaluation job was created.  
Type: Timestamp

 ** [customerEncryptionKeyId](#API_GetEvaluationJob_ResponseSyntax) **   <a name="bedrock-GetEvaluationJob-response-customerEncryptionKeyId"></a>
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) **   <a name="bedrock-GetEvaluationJob-response-evaluationConfig"></a>
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 name="bedrock-GetEvaluationJob-response-failureMessages"></a>
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) **   <a name="bedrock-GetEvaluationJob-response-inferenceConfig"></a>
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) **   <a name="bedrock-GetEvaluationJob-response-jobArn"></a>
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) **   <a name="bedrock-GetEvaluationJob-response-jobDescription"></a>
The description of the evaluation job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `.+` 

 ** [jobName](#API_GetEvaluationJob_ResponseSyntax) **   <a name="bedrock-GetEvaluationJob-response-jobName"></a>
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) **   <a name="bedrock-GetEvaluationJob-response-jobType"></a>
Specifies whether the evaluation job is automated or human-based.  
Type: String  
Valid Values: `Human | Automated` 

 ** [lastModifiedTime](#API_GetEvaluationJob_ResponseSyntax) **   <a name="bedrock-GetEvaluationJob-response-lastModifiedTime"></a>
The time the evaluation job was last modified.  
Type: Timestamp

 ** [outputDataConfig](#API_GetEvaluationJob_ResponseSyntax) **   <a name="bedrock-GetEvaluationJob-response-outputDataConfig"></a>
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) **   <a name="bedrock-GetEvaluationJob-response-roleArn"></a>
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) **   <a name="bedrock-GetEvaluationJob-response-status"></a>
The current status of the evaluation job.  
Type: String  
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting` 

## Errors
<a name="API_GetEvaluationJob_Errors"></a>

For information about 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
<a name="API_GetEvaluationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetFoundationModel"></a>

Get details about a Amazon Bedrock foundation model.

## Request Syntax
<a name="API_GetFoundationModel_RequestSyntax"></a>

```
GET /foundation-models/modelIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetFoundationModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelIdentifier](#API_GetFoundationModel_RequestSyntax) **   <a name="bedrock-GetFoundationModel-request-uri-modelIdentifier"></a>
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
<a name="API_GetFoundationModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetFoundationModel_ResponseSyntax"></a>

```
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
<a name="API_GetFoundationModel_ResponseElements"></a>

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) **   <a name="bedrock-GetFoundationModel-response-modelDetails"></a>
Information about the foundation model.  
Type: [FoundationModelDetails](API_FoundationModelDetails.md) object

## Errors
<a name="API_GetFoundationModel_Errors"></a>

For information about 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
<a name="API_GetFoundationModel_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetFoundationModelAvailability"></a>

Get information about the Foundation model availability.

## Request Syntax
<a name="API_GetFoundationModelAvailability_RequestSyntax"></a>

```
GET /foundation-model-availability/modelId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetFoundationModelAvailability_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelId](#API_GetFoundationModelAvailability_RequestSyntax) **   <a name="bedrock-GetFoundationModelAvailability-request-uri-modelId"></a>
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
<a name="API_GetFoundationModelAvailability_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetFoundationModelAvailability_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "agreementAvailability": { 
      "errorMessage": "string",
      "status": "string"
   },
   "authorizationStatus": "string",
   "entitlementAvailability": "string",
   "modelId": "string",
   "regionAvailability": "string"
}
```

## Response Elements
<a name="API_GetFoundationModelAvailability_ResponseElements"></a>

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) **   <a name="bedrock-GetFoundationModelAvailability-response-agreementAvailability"></a>
Agreement availability.   
Type: [AgreementAvailability](API_AgreementAvailability.md) object

 ** [authorizationStatus](#API_GetFoundationModelAvailability_ResponseSyntax) **   <a name="bedrock-GetFoundationModelAvailability-response-authorizationStatus"></a>
Authorization status.  
Type: String  
Valid Values: `AUTHORIZED | NOT_AUTHORIZED` 

 ** [entitlementAvailability](#API_GetFoundationModelAvailability_ResponseSyntax) **   <a name="bedrock-GetFoundationModelAvailability-response-entitlementAvailability"></a>
Entitlement availability.   
Type: String  
Valid Values: `AVAILABLE | NOT_AVAILABLE` 

 ** [modelId](#API_GetFoundationModelAvailability_ResponseSyntax) **   <a name="bedrock-GetFoundationModelAvailability-response-modelId"></a>
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) **   <a name="bedrock-GetFoundationModelAvailability-response-regionAvailability"></a>
Region availability.   
Type: String  
Valid Values: `AVAILABLE | NOT_AVAILABLE` 

## Errors
<a name="API_GetFoundationModelAvailability_Errors"></a>

For information about 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
<a name="API_GetFoundationModelAvailability_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetGuardrail"></a>

Gets details about a guardrail. If you don't specify a version, the response returns details for the `DRAFT` version.

## Request Syntax
<a name="API_GetGuardrail_RequestSyntax"></a>

```
GET /guardrails/guardrailIdentifier?guardrailVersion=guardrailVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_GetGuardrail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [guardrailIdentifier](#API_GetGuardrail_RequestSyntax) **   <a name="bedrock-GetGuardrail-request-uri-guardrailIdentifier"></a>
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) **   <a name="bedrock-GetGuardrail-request-uri-guardrailVersion"></a>
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
<a name="API_GetGuardrail_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetGuardrail_ResponseSyntax"></a>

```
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
<a name="API_GetGuardrail_ResponseElements"></a>

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) **   <a name="bedrock-GetGuardrail-response-automatedReasoningPolicy"></a>
The current Automated Reasoning policy configuration for the guardrail, if any is configured.  
Type: [GuardrailAutomatedReasoningPolicy](API_GuardrailAutomatedReasoningPolicy.md) object

 ** [blockedInputMessaging](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-blockedInputMessaging"></a>
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) **   <a name="bedrock-GetGuardrail-response-blockedOutputsMessaging"></a>
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) **   <a name="bedrock-GetGuardrail-response-contentPolicy"></a>
The content policy that was configured for the guardrail.  
Type: [GuardrailContentPolicy](API_GuardrailContentPolicy.md) object

 ** [contextualGroundingPolicy](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-contextualGroundingPolicy"></a>
The contextual grounding policy used in the guardrail.  
Type: [GuardrailContextualGroundingPolicy](API_GuardrailContextualGroundingPolicy.md) object

 ** [createdAt](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-createdAt"></a>
The date and time at which the guardrail was created.  
Type: Timestamp

 ** [crossRegionDetails](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-crossRegionDetails"></a>
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) **   <a name="bedrock-GetGuardrail-response-description"></a>
The description of the guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [failureRecommendations](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-failureRecommendations"></a>
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) **   <a name="bedrock-GetGuardrail-response-guardrailArn"></a>
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) **   <a name="bedrock-GetGuardrail-response-guardrailId"></a>
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) **   <a name="bedrock-GetGuardrail-response-kmsKeyArn"></a>
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) **   <a name="bedrock-GetGuardrail-response-name"></a>
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) **   <a name="bedrock-GetGuardrail-response-sensitiveInformationPolicy"></a>
The sensitive information policy that was configured for the guardrail.  
Type: [GuardrailSensitiveInformationPolicy](API_GuardrailSensitiveInformationPolicy.md) object

 ** [status](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-status"></a>
The status of the guardrail.  
Type: String  
Valid Values: `CREATING | UPDATING | VERSIONING | READY | FAILED | DELETING` 

 ** [statusReasons](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-statusReasons"></a>
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) **   <a name="bedrock-GetGuardrail-response-topicPolicy"></a>
The topic policy that was configured for the guardrail.  
Type: [GuardrailTopicPolicy](API_GuardrailTopicPolicy.md) object

 ** [updatedAt](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-updatedAt"></a>
The date and time at which the guardrail was updated.  
Type: Timestamp

 ** [version](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-version"></a>
The version of the guardrail.  
Type: String  
Pattern: `(([1-9][0-9]{0,7})|(DRAFT))` 

 ** [wordPolicy](#API_GetGuardrail_ResponseSyntax) **   <a name="bedrock-GetGuardrail-response-wordPolicy"></a>
The word policy that was configured for the guardrail.  
Type: [GuardrailWordPolicy](API_GuardrailWordPolicy.md) object

## Errors
<a name="API_GetGuardrail_Errors"></a>

For information about 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
<a name="API_GetGuardrail_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetImportedModel"></a>

Gets properties associated with a customized model you imported. 

## Request Syntax
<a name="API_GetImportedModel_RequestSyntax"></a>

```
GET /imported-models/modelIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetImportedModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelIdentifier](#API_GetImportedModel_RequestSyntax) **   <a name="bedrock-GetImportedModel-request-uri-modelIdentifier"></a>
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
<a name="API_GetImportedModel_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetImportedModel_ResponseSyntax"></a>

```
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
<a name="API_GetImportedModel_ResponseElements"></a>

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) **   <a name="bedrock-GetImportedModel-response-creationTime"></a>
Creation time of the imported model.  
Type: Timestamp

 ** [customModelUnits](#API_GetImportedModel_ResponseSyntax) **   <a name="bedrock-GetImportedModel-response-customModelUnits"></a>
Information about the hardware utilization for a single copy of the model.  
Type: [CustomModelUnits](API_CustomModelUnits.md) object

 ** [instructSupported](#API_GetImportedModel_ResponseSyntax) **   <a name="bedrock-GetImportedModel-response-instructSupported"></a>
Specifies if the imported model supports converse.  
Type: Boolean

 ** [jobArn](#API_GetImportedModel_ResponseSyntax) **   <a name="bedrock-GetImportedModel-response-jobArn"></a>
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) **   <a name="bedrock-GetImportedModel-response-jobName"></a>
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) **   <a name="bedrock-GetImportedModel-response-modelArchitecture"></a>
The architecture of the imported model.  
Type: String

 ** [modelArn](#API_GetImportedModel_ResponseSyntax) **   <a name="bedrock-GetImportedModel-response-modelArn"></a>
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) **   <a name="bedrock-GetImportedModel-response-modelDataSource"></a>
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) **   <a name="bedrock-GetImportedModel-response-modelKmsKeyArn"></a>
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) **   <a name="bedrock-GetImportedModel-response-modelName"></a>
The name of the imported model.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 63.  
Pattern: `([0-9a-zA-Z][_-]?)+` 

## Errors
<a name="API_GetImportedModel_Errors"></a>

For information about 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
<a name="API_GetImportedModel_Examples"></a>

### Get model properties
<a name="API_GetImportedModel_Example_1"></a>

Get the properties associated with a customized model that you imported.

```
GET /imported-models/{modelIdentifier} HTTP/1.1
Content-type: application/json
```

### Example response
<a name="API_GetImportedModel_Example_2"></a>

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
<a name="API_GetImportedModel_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetInferenceProfile"></a>

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
<a name="API_GetInferenceProfile_RequestSyntax"></a>

```
GET /inference-profiles/inferenceProfileIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetInferenceProfile_RequestParameters"></a>

The request uses the following URI parameters.

 ** [inferenceProfileIdentifier](#API_GetInferenceProfile_RequestSyntax) **   <a name="bedrock-GetInferenceProfile-request-uri-inferenceProfileIdentifier"></a>
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
<a name="API_GetInferenceProfile_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetInferenceProfile_ResponseSyntax"></a>

```
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
<a name="API_GetInferenceProfile_ResponseElements"></a>

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) **   <a name="bedrock-GetInferenceProfile-response-createdAt"></a>
The time at which the inference profile was created.  
Type: Timestamp

 ** [description](#API_GetInferenceProfile_ResponseSyntax) **   <a name="bedrock-GetInferenceProfile-response-description"></a>
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) **   <a name="bedrock-GetInferenceProfile-response-inferenceProfileArn"></a>
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) **   <a name="bedrock-GetInferenceProfile-response-inferenceProfileId"></a>
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) **   <a name="bedrock-GetInferenceProfile-response-inferenceProfileName"></a>
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 name="bedrock-GetInferenceProfile-response-models"></a>
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) **   <a name="bedrock-GetInferenceProfile-response-status"></a>
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) **   <a name="bedrock-GetInferenceProfile-response-type"></a>
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) **   <a name="bedrock-GetInferenceProfile-response-updatedAt"></a>
The time at which the inference profile was last updated.  
Type: Timestamp

## Errors
<a name="API_GetInferenceProfile_Errors"></a>

For information about 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
<a name="API_GetInferenceProfile_Examples"></a>

### Get information about an inference profile
<a name="API_GetInferenceProfile_Example_1"></a>

Run the following example to get information about the US Anthropic Claude 3 Sonnet inference profile:

#### Sample Request
<a name="API_GetInferenceProfile_Example_1_Request"></a>

```
GET /inference-profiles/us.anthropic.claude-3-sonnet-20240229-v1:0 HTTP/1.1
```

## See Also
<a name="API_GetInferenceProfile_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetMarketplaceModelEndpoint"></a>

Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.

## Request Syntax
<a name="API_GetMarketplaceModelEndpoint_RequestSyntax"></a>

```
GET /marketplace-model/endpoints/endpointArn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetMarketplaceModelEndpoint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [endpointArn](#API_GetMarketplaceModelEndpoint_RequestSyntax) **   <a name="bedrock-GetMarketplaceModelEndpoint-request-uri-endpointArn"></a>
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
<a name="API_GetMarketplaceModelEndpoint_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetMarketplaceModelEndpoint_ResponseSyntax"></a>

```
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
<a name="API_GetMarketplaceModelEndpoint_ResponseElements"></a>

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) **   <a name="bedrock-GetMarketplaceModelEndpoint-response-marketplaceModelEndpoint"></a>
Details about the requested endpoint.  
Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md) object

## Errors
<a name="API_GetMarketplaceModelEndpoint_Errors"></a>

For information about 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
<a name="API_GetMarketplaceModelEndpoint_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetModelCopyJob"></a>

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
<a name="API_GetModelCopyJob_RequestSyntax"></a>

```
GET /model-copy-jobs/jobArn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetModelCopyJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobArn](#API_GetModelCopyJob_RequestSyntax) **   <a name="bedrock-GetModelCopyJob-request-uri-jobArn"></a>
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
<a name="API_GetModelCopyJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetModelCopyJob_ResponseSyntax"></a>

```
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
<a name="API_GetModelCopyJob_ResponseElements"></a>

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) **   <a name="bedrock-GetModelCopyJob-response-creationTime"></a>
The time at which the model copy job was created.  
Type: Timestamp

 ** [failureMessage](#API_GetModelCopyJob_ResponseSyntax) **   <a name="bedrock-GetModelCopyJob-response-failureMessage"></a>
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) **   <a name="bedrock-GetModelCopyJob-response-jobArn"></a>
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) **   <a name="bedrock-GetModelCopyJob-response-sourceAccountId"></a>
The unique identifier of the account that the model being copied originated from.  
Type: String  
Pattern: `[0-9]{12}` 

 ** [sourceModelArn](#API_GetModelCopyJob_ResponseSyntax) **   <a name="bedrock-GetModelCopyJob-response-sourceModelArn"></a>
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) **   <a name="bedrock-GetModelCopyJob-response-sourceModelName"></a>
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) **   <a name="bedrock-GetModelCopyJob-response-status"></a>
The status of the model copy job.  
Type: String  
Valid Values: `InProgress | Completed | Failed` 

 ** [targetModelArn](#API_GetModelCopyJob_ResponseSyntax) **   <a name="bedrock-GetModelCopyJob-response-targetModelArn"></a>
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) **   <a name="bedrock-GetModelCopyJob-response-targetModelKmsKeyArn"></a>
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) **   <a name="bedrock-GetModelCopyJob-response-targetModelName"></a>
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) **   <a name="bedrock-GetModelCopyJob-response-targetModelTags"></a>
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
<a name="API_GetModelCopyJob_Errors"></a>

For information about 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
<a name="API_GetModelCopyJob_Examples"></a>

### Get a model copy job (CLI)
<a name="API_GetModelCopyJob_Example_1"></a>

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
<a name="API_GetModelCopyJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetModelCustomizationJob"></a>

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
<a name="API_GetModelCustomizationJob_RequestSyntax"></a>

```
GET /model-customization-jobs/jobIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetModelCustomizationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobIdentifier](#API_GetModelCustomizationJob_RequestSyntax) **   <a name="bedrock-GetModelCustomizationJob-request-uri-jobIdentifier"></a>
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
<a name="API_GetModelCustomizationJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetModelCustomizationJob_ResponseSyntax"></a>

```
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
<a name="API_GetModelCustomizationJob_ResponseElements"></a>

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) **   <a name="bedrock-GetModelCustomizationJob-response-baseModelArn"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-clientRequestToken"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-creationTime"></a>
Time that the resource was created.  
Type: Timestamp

 ** [customizationConfig](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-customizationConfig"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-customizationType"></a>
The type of model customization.  
Type: String  
Valid Values: `FINE_TUNING | CONTINUED_PRE_TRAINING | DISTILLATION | REINFORCEMENT_FINE_TUNING | IMPORTED` 

 ** [endTime](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-endTime"></a>
Time that the resource transitioned to terminal state.  
Type: Timestamp

 ** [failureMessage](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-failureMessage"></a>
Information about why the job failed.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [hyperParameters](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-hyperParameters"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-jobArn"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-jobName"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-lastModifiedTime"></a>
Time that the resource was last modified.  
Type: Timestamp

 ** [outputDataConfig](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-outputDataConfig"></a>
Output data configuration   
Type: [OutputDataConfig](API_OutputDataConfig.md) object

 ** [outputModelArn](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-outputModelArn"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-outputModelKmsKeyArn"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-outputModelName"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-roleArn"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-status"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-statusDetails"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-trainingDataConfig"></a>
Contains information about the training dataset.  
Type: [TrainingDataConfig](API_TrainingDataConfig.md) object

 ** [trainingMetrics](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-trainingMetrics"></a>
Contains training metrics from the job creation.  
Type: [TrainingMetrics](API_TrainingMetrics.md) object

 ** [validationDataConfig](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-validationDataConfig"></a>
Contains information about the validation dataset.  
Type: [ValidationDataConfig](API_ValidationDataConfig.md) object

 ** [validationMetrics](#API_GetModelCustomizationJob_ResponseSyntax) **   <a name="bedrock-GetModelCustomizationJob-response-validationMetrics"></a>
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) **   <a name="bedrock-GetModelCustomizationJob-response-vpcConfig"></a>
VPC configuration for the custom model job.  
Type: [VpcConfig](API_VpcConfig.md) object

## Errors
<a name="API_GetModelCustomizationJob_Errors"></a>

For information about 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
<a name="API_GetModelCustomizationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetModelImportJob"></a>

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
<a name="API_GetModelImportJob_RequestSyntax"></a>

```
GET /model-import-jobs/jobIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetModelImportJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobIdentifier](#API_GetModelImportJob_RequestSyntax) **   <a name="bedrock-GetModelImportJob-request-uri-jobIdentifier"></a>
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
<a name="API_GetModelImportJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetModelImportJob_ResponseSyntax"></a>

```
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
<a name="API_GetModelImportJob_ResponseElements"></a>

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) **   <a name="bedrock-GetModelImportJob-response-creationTime"></a>
The time the resource was created.  
Type: Timestamp

 ** [endTime](#API_GetModelImportJob_ResponseSyntax) **   <a name="bedrock-GetModelImportJob-response-endTime"></a>
Time that the resource transitioned to terminal state.  
Type: Timestamp

 ** [failureMessage](#API_GetModelImportJob_ResponseSyntax) **   <a name="bedrock-GetModelImportJob-response-failureMessage"></a>
Information about why the import job failed.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [importedModelArn](#API_GetModelImportJob_ResponseSyntax) **   <a name="bedrock-GetModelImportJob-response-importedModelArn"></a>
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) **   <a name="bedrock-GetModelImportJob-response-importedModelKmsKeyArn"></a>
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) **   <a name="bedrock-GetModelImportJob-response-importedModelName"></a>
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) **   <a name="bedrock-GetModelImportJob-response-jobArn"></a>
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) **   <a name="bedrock-GetModelImportJob-response-jobName"></a>
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) **   <a name="bedrock-GetModelImportJob-response-lastModifiedTime"></a>
Time the resource was last modified.  
Type: Timestamp

 ** [modelDataSource](#API_GetModelImportJob_ResponseSyntax) **   <a name="bedrock-GetModelImportJob-response-modelDataSource"></a>
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) **   <a name="bedrock-GetModelImportJob-response-roleArn"></a>
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) **   <a name="bedrock-GetModelImportJob-response-status"></a>
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) **   <a name="bedrock-GetModelImportJob-response-vpcConfig"></a>
The Virtual Private Cloud (VPC) configuration of the import model job.  
Type: [VpcConfig](API_VpcConfig.md) object

## Errors
<a name="API_GetModelImportJob_Errors"></a>

For information about 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
<a name="API_GetModelImportJob_Examples"></a>

### Get model import job
<a name="API_GetModelImportJob_Example_1"></a>

Gets the properties of a model import job.

```
GET /model-import-jobs/{jobIdentifier} HTTP/1.1
Content-type: application/json
```

### Example response
<a name="API_GetModelImportJob_Example_2"></a>

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
<a name="API_GetModelImportJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetModelInvocationJob"></a>

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
<a name="API_GetModelInvocationJob_RequestSyntax"></a>

```
GET /model-invocation-job/jobIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_GetModelInvocationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobIdentifier](#API_GetModelInvocationJob_RequestSyntax) **   <a name="bedrock-GetModelInvocationJob-request-uri-jobIdentifier"></a>
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
<a name="API_GetModelInvocationJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetModelInvocationJob_ResponseSyntax"></a>

```
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
<a name="API_GetModelInvocationJob_ResponseElements"></a>

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 name="bedrock-GetModelInvocationJob-response-clientRequestToken"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-endTime"></a>
The time at which the batch inference job ended.  
Type: Timestamp

 ** [errorRecordCount](#API_GetModelInvocationJob_ResponseSyntax) **   <a name="bedrock-GetModelInvocationJob-response-errorRecordCount"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-inputDataConfig"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-jobArn"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-jobExpirationTime"></a>
The time at which the batch inference job times or timed out.  
Type: Timestamp

 ** [jobName](#API_GetModelInvocationJob_ResponseSyntax) **   <a name="bedrock-GetModelInvocationJob-response-jobName"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-lastModifiedTime"></a>
The time at which the batch inference job was last modified.  
Type: Timestamp

 ** [message](#API_GetModelInvocationJob_ResponseSyntax) **   <a name="bedrock-GetModelInvocationJob-response-message"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-modelId"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-modelInvocationType"></a>
The invocation endpoint for ModelInvocationJob  
Type: String  
Valid Values: `InvokeModel | Converse` 

 ** [outputDataConfig](#API_GetModelInvocationJob_ResponseSyntax) **   <a name="bedrock-GetModelInvocationJob-response-outputDataConfig"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-processedRecordCount"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-roleArn"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-status"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-submitTime"></a>
The time at which the batch inference job was submitted.  
Type: Timestamp

 ** [successRecordCount](#API_GetModelInvocationJob_ResponseSyntax) **   <a name="bedrock-GetModelInvocationJob-response-successRecordCount"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-timeoutDurationInHours"></a>
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) **   <a name="bedrock-GetModelInvocationJob-response-totalRecordCount"></a>
The total number of records in the batch inference job.  
Type: Long  
Valid Range: Minimum value of 0.

 ** [vpcConfig](#API_GetModelInvocationJob_ResponseSyntax) **   <a name="bedrock-GetModelInvocationJob-response-vpcConfig"></a>
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
<a name="API_GetModelInvocationJob_Errors"></a>

For information about 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
<a name="API_GetModelInvocationJob_Examples"></a>

### Get a batch inference job
<a name="API_GetModelInvocationJob_Example_1"></a>

This example illustrates one usage of GetModelInvocationJob.

```
GET /model-invocation-job/BATCHJOB1234 HTTP/1.1
```

## See Also
<a name="API_GetModelInvocationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetModelInvocationLoggingConfiguration"></a>

Get the current configuration values for model invocation logging.

## Request Syntax
<a name="API_GetModelInvocationLoggingConfiguration_RequestSyntax"></a>

```
GET /logging/modelinvocations HTTP/1.1
```

## URI Request Parameters
<a name="API_GetModelInvocationLoggingConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetModelInvocationLoggingConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetModelInvocationLoggingConfiguration_ResponseSyntax"></a>

```
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
<a name="API_GetModelInvocationLoggingConfiguration_ResponseElements"></a>

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) **   <a name="bedrock-GetModelInvocationLoggingConfiguration-response-loggingConfig"></a>
The current configuration values.  
Type: [LoggingConfig](API_LoggingConfig.md) object

## Errors
<a name="API_GetModelInvocationLoggingConfiguration_Errors"></a>

For information about 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
<a name="API_GetModelInvocationLoggingConfiguration_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetPromptRouter"></a>

Retrieves details about a prompt router.

## Request Syntax
<a name="API_GetPromptRouter_RequestSyntax"></a>

```
GET /prompt-routers/promptRouterArn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetPromptRouter_RequestParameters"></a>

The request uses the following URI parameters.

 ** [promptRouterArn](#API_GetPromptRouter_RequestSyntax) **   <a name="bedrock-GetPromptRouter-request-uri-promptRouterArn"></a>
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
<a name="API_GetPromptRouter_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetPromptRouter_ResponseSyntax"></a>

```
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
<a name="API_GetPromptRouter_ResponseElements"></a>

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) **   <a name="bedrock-GetPromptRouter-response-createdAt"></a>
When the router was created.  
Type: Timestamp

 ** [description](#API_GetPromptRouter_ResponseSyntax) **   <a name="bedrock-GetPromptRouter-response-description"></a>
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) **   <a name="bedrock-GetPromptRouter-response-fallbackModel"></a>
The router's fallback model.  
Type: [PromptRouterTargetModel](API_PromptRouterTargetModel.md) object

 ** [models](#API_GetPromptRouter_ResponseSyntax) **   <a name="bedrock-GetPromptRouter-response-models"></a>
The router's models.  
Type: Array of [PromptRouterTargetModel](API_PromptRouterTargetModel.md) objects

 ** [promptRouterArn](#API_GetPromptRouter_ResponseSyntax) **   <a name="bedrock-GetPromptRouter-response-promptRouterArn"></a>
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) **   <a name="bedrock-GetPromptRouter-response-promptRouterName"></a>
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) **   <a name="bedrock-GetPromptRouter-response-routingCriteria"></a>
The router's routing criteria.  
Type: [RoutingCriteria](API_RoutingCriteria.md) object

 ** [status](#API_GetPromptRouter_ResponseSyntax) **   <a name="bedrock-GetPromptRouter-response-status"></a>
The router's status.  
Type: String  
Valid Values: `AVAILABLE` 

 ** [type](#API_GetPromptRouter_ResponseSyntax) **   <a name="bedrock-GetPromptRouter-response-type"></a>
The router's type.  
Type: String  
Valid Values: `custom | default` 

 ** [updatedAt](#API_GetPromptRouter_ResponseSyntax) **   <a name="bedrock-GetPromptRouter-response-updatedAt"></a>
When the router was updated.  
Type: Timestamp

## Errors
<a name="API_GetPromptRouter_Errors"></a>

For information about 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
<a name="API_GetPromptRouter_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetProvisionedModelThroughput"></a>

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
<a name="API_GetProvisionedModelThroughput_RequestSyntax"></a>

```
GET /provisioned-model-throughput/provisionedModelId HTTP/1.1
```

## URI Request Parameters
<a name="API_GetProvisionedModelThroughput_RequestParameters"></a>

The request uses the following URI parameters.

 ** [provisionedModelId](#API_GetProvisionedModelThroughput_RequestSyntax) **   <a name="bedrock-GetProvisionedModelThroughput-request-uri-provisionedModelId"></a>
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
<a name="API_GetProvisionedModelThroughput_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetProvisionedModelThroughput_ResponseSyntax"></a>

```
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
<a name="API_GetProvisionedModelThroughput_ResponseElements"></a>

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) **   <a name="bedrock-GetProvisionedModelThroughput-response-commitmentDuration"></a>
Commitment duration of the Provisioned Throughput.  
Type: String  
Valid Values: `OneMonth | SixMonths` 

 ** [commitmentExpirationTime](#API_GetProvisionedModelThroughput_ResponseSyntax) **   <a name="bedrock-GetProvisionedModelThroughput-response-commitmentExpirationTime"></a>
The timestamp for when the commitment term for the Provisioned Throughput expires.  
Type: Timestamp

 ** [creationTime](#API_GetProvisionedModelThroughput_ResponseSyntax) **   <a name="bedrock-GetProvisionedModelThroughput-response-creationTime"></a>
The timestamp of the creation time for this Provisioned Throughput.   
Type: Timestamp

 ** [desiredModelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) **   <a name="bedrock-GetProvisionedModelThroughput-response-desiredModelArn"></a>
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) **   <a name="bedrock-GetProvisionedModelThroughput-response-desiredModelUnits"></a>
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 name="bedrock-GetProvisionedModelThroughput-response-failureMessage"></a>
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) **   <a name="bedrock-GetProvisionedModelThroughput-response-foundationModelArn"></a>
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) **   <a name="bedrock-GetProvisionedModelThroughput-response-lastModifiedTime"></a>
The timestamp of the last time that this Provisioned Throughput was modified.   
Type: Timestamp

 ** [modelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) **   <a name="bedrock-GetProvisionedModelThroughput-response-modelArn"></a>
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) **   <a name="bedrock-GetProvisionedModelThroughput-response-modelUnits"></a>
The number of model units allocated to this Provisioned Throughput.  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [provisionedModelArn](#API_GetProvisionedModelThroughput_ResponseSyntax) **   <a name="bedrock-GetProvisionedModelThroughput-response-provisionedModelArn"></a>
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) **   <a name="bedrock-GetProvisionedModelThroughput-response-provisionedModelName"></a>
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) **   <a name="bedrock-GetProvisionedModelThroughput-response-status"></a>
The status of the Provisioned Throughput.   
Type: String  
Valid Values: `Creating | InService | Updating | Failed` 

## Errors
<a name="API_GetProvisionedModelThroughput_Errors"></a>

For information about 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
<a name="API_GetProvisionedModelThroughput_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetResourcePolicy"></a>

Gets the resource policy document for a Bedrock resource

## Request Syntax
<a name="API_GetResourcePolicy_RequestSyntax"></a>

```
GET /resource-policy/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_GetResourcePolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_GetResourcePolicy_RequestSyntax) **   <a name="bedrock-GetResourcePolicy-request-uri-resourceArn"></a>
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
<a name="API_GetResourcePolicy_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetResourcePolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "resourcePolicy": "string"
}
```

## Response Elements
<a name="API_GetResourcePolicy_ResponseElements"></a>

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) **   <a name="bedrock-GetResourcePolicy-response-resourcePolicy"></a>
The JSON string representing the Bedrock resource policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 20480.  
Pattern: `[ -ÿ]+` 

## Errors
<a name="API_GetResourcePolicy_Errors"></a>

For information about 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
<a name="API_GetResourcePolicy_SeeAlso"></a>

For more information about using this API 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
<a name="API_GetUseCaseForModelAccess"></a>

 Returns the use case for requesting access to Anthropic models. 

## Request Syntax
<a name="API_GetUseCaseForModelAccess_RequestSyntax"></a>

```
GET /use-case-for-model-access HTTP/1.1
```

## URI Request Parameters
<a name="API_GetUseCaseForModelAccess_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetUseCaseForModelAccess_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_GetUseCaseForModelAccess_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "formData": blob
}
```

## Response Elements
<a name="API_GetUseCaseForModelAccess_ResponseElements"></a>

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) **   <a name="bedrock-GetUseCaseForModelAccess-response-formData"></a>
 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
<a name="API_GetUseCaseForModelAccess_Errors"></a>

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
<a name="API_GetUseCaseForModelAccess_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListAutomatedReasoningPolicies"></a>

Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.

## Request Syntax
<a name="API_ListAutomatedReasoningPolicies_RequestSyntax"></a>

```
GET /automated-reasoning-policies?maxResults=maxResults&nextToken=nextToken&policyArn=policyArn HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAutomatedReasoningPolicies_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListAutomatedReasoningPolicies_RequestSyntax) **   <a name="bedrock-ListAutomatedReasoningPolicies-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListAutomatedReasoningPolicies-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListAutomatedReasoningPolicies-request-uri-policyArn"></a>
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
<a name="API_ListAutomatedReasoningPolicies_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAutomatedReasoningPolicies_ResponseSyntax"></a>

```
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
<a name="API_ListAutomatedReasoningPolicies_ResponseElements"></a>

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 name="bedrock-ListAutomatedReasoningPolicies-response-automatedReasoningPolicySummaries"></a>
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) **   <a name="bedrock-ListAutomatedReasoningPolicies-response-nextToken"></a>
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
<a name="API_ListAutomatedReasoningPolicies_Errors"></a>

For information about 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
<a name="API_ListAutomatedReasoningPolicies_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListAutomatedReasoningPolicyBuildWorkflows"></a>

Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.

## Request Syntax
<a name="API_ListAutomatedReasoningPolicyBuildWorkflows_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/build-workflows?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAutomatedReasoningPolicyBuildWorkflows_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListAutomatedReasoningPolicyBuildWorkflows_RequestSyntax) **   <a name="bedrock-ListAutomatedReasoningPolicyBuildWorkflows-request-uri-maxResults"></a>
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 name="bedrock-ListAutomatedReasoningPolicyBuildWorkflows-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListAutomatedReasoningPolicyBuildWorkflows-request-uri-policyArn"></a>
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
<a name="API_ListAutomatedReasoningPolicyBuildWorkflows_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAutomatedReasoningPolicyBuildWorkflows_ResponseSyntax"></a>

```
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
<a name="API_ListAutomatedReasoningPolicyBuildWorkflows_ResponseElements"></a>

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 name="bedrock-ListAutomatedReasoningPolicyBuildWorkflows-response-automatedReasoningPolicyBuildWorkflowSummaries"></a>
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 name="bedrock-ListAutomatedReasoningPolicyBuildWorkflows-response-nextToken"></a>
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
<a name="API_ListAutomatedReasoningPolicyBuildWorkflows_Errors"></a>

For information about 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
<a name="API_ListAutomatedReasoningPolicyBuildWorkflows_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListAutomatedReasoningPolicyTestCases"></a>

Lists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully.

## Request Syntax
<a name="API_ListAutomatedReasoningPolicyTestCases_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/test-cases?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAutomatedReasoningPolicyTestCases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListAutomatedReasoningPolicyTestCases_RequestSyntax) **   <a name="bedrock-ListAutomatedReasoningPolicyTestCases-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListAutomatedReasoningPolicyTestCases-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListAutomatedReasoningPolicyTestCases-request-uri-policyArn"></a>
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
<a name="API_ListAutomatedReasoningPolicyTestCases_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAutomatedReasoningPolicyTestCases_ResponseSyntax"></a>

```
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
<a name="API_ListAutomatedReasoningPolicyTestCases_ResponseElements"></a>

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) **   <a name="bedrock-ListAutomatedReasoningPolicyTestCases-response-nextToken"></a>
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 name="bedrock-ListAutomatedReasoningPolicyTestCases-response-testCases"></a>
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
<a name="API_ListAutomatedReasoningPolicyTestCases_Errors"></a>

For information about 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
<a name="API_ListAutomatedReasoningPolicyTestCases_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListAutomatedReasoningPolicyTestResults"></a>

Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.

## Request Syntax
<a name="API_ListAutomatedReasoningPolicyTestResults_RequestSyntax"></a>

```
GET /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-results?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListAutomatedReasoningPolicyTestResults_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_ListAutomatedReasoningPolicyTestResults_RequestSyntax) **   <a name="bedrock-ListAutomatedReasoningPolicyTestResults-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-ListAutomatedReasoningPolicyTestResults-request-uri-maxResults"></a>
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 name="bedrock-ListAutomatedReasoningPolicyTestResults-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListAutomatedReasoningPolicyTestResults-request-uri-policyArn"></a>
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
<a name="API_ListAutomatedReasoningPolicyTestResults_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListAutomatedReasoningPolicyTestResults_ResponseSyntax"></a>

```
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
<a name="API_ListAutomatedReasoningPolicyTestResults_ResponseElements"></a>

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 name="bedrock-ListAutomatedReasoningPolicyTestResults-response-nextToken"></a>
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 name="bedrock-ListAutomatedReasoningPolicyTestResults-response-testResults"></a>
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
<a name="API_ListAutomatedReasoningPolicyTestResults_Errors"></a>

For information about 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
<a name="API_ListAutomatedReasoningPolicyTestResults_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListCustomModelDeployments"></a>

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
<a name="API_ListCustomModelDeployments_RequestSyntax"></a>

```
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
<a name="API_ListCustomModelDeployments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [createdAfter](#API_ListCustomModelDeployments_RequestSyntax) **   <a name="bedrock-ListCustomModelDeployments-request-uri-createdAfter"></a>
Filters deployments created after the specified date and time.

 ** [createdBefore](#API_ListCustomModelDeployments_RequestSyntax) **   <a name="bedrock-ListCustomModelDeployments-request-uri-createdBefore"></a>
Filters deployments created before the specified date and time.

 ** [maxResults](#API_ListCustomModelDeployments_RequestSyntax) **   <a name="bedrock-ListCustomModelDeployments-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListCustomModelDeployments-request-uri-modelArnEquals"></a>
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) **   <a name="bedrock-ListCustomModelDeployments-request-uri-nameContains"></a>
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) **   <a name="bedrock-ListCustomModelDeployments-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListCustomModelDeployments-request-uri-sortBy"></a>
The field to sort the results by. The only supported value is `CreationTime`.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListCustomModelDeployments_RequestSyntax) **   <a name="bedrock-ListCustomModelDeployments-request-uri-sortOrder"></a>
The sort order for the results. Valid values are `Ascending` and `Descending`. Default is `Descending`.  
Valid Values: `Ascending | Descending` 

 ** [statusEquals](#API_ListCustomModelDeployments_RequestSyntax) **   <a name="bedrock-ListCustomModelDeployments-request-uri-statusEquals"></a>
Filters deployments by status. Valid values are `CREATING`, `ACTIVE`, and `FAILED`.  
Valid Values: `Creating | Active | Failed` 

## Request Body
<a name="API_ListCustomModelDeployments_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListCustomModelDeployments_ResponseSyntax"></a>

```
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
<a name="API_ListCustomModelDeployments_ResponseElements"></a>

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 name="bedrock-ListCustomModelDeployments-response-modelDeploymentSummaries"></a>
A list of custom model deployment summaries.  
Type: Array of [CustomModelDeploymentSummary](API_CustomModelDeploymentSummary.md) objects

 ** [nextToken](#API_ListCustomModelDeployments_ResponseSyntax) **   <a name="bedrock-ListCustomModelDeployments-response-nextToken"></a>
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
<a name="API_ListCustomModelDeployments_Errors"></a>

For information about 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
<a name="API_ListCustomModelDeployments_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListCustomModels"></a>

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
<a name="API_ListCustomModels_RequestSyntax"></a>

```
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
<a name="API_ListCustomModels_RequestParameters"></a>

The request uses the following URI parameters.

 ** [baseModelArnEquals](#API_ListCustomModels_RequestSyntax) **   <a name="bedrock-ListCustomModels-request-uri-baseModelArnEquals"></a>
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) **   <a name="bedrock-ListCustomModels-request-uri-creationTimeAfter"></a>
Return custom models created after the specified time. 

 ** [creationTimeBefore](#API_ListCustomModels_RequestSyntax) **   <a name="bedrock-ListCustomModels-request-uri-creationTimeBefore"></a>
Return custom models created before the specified time. 

 ** [foundationModelArnEquals](#API_ListCustomModels_RequestSyntax) **   <a name="bedrock-ListCustomModels-request-uri-foundationModelArnEquals"></a>
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) **   <a name="bedrock-ListCustomModels-request-uri-isOwned"></a>
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) **   <a name="bedrock-ListCustomModels-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListCustomModels-request-uri-modelStatus"></a>
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) **   <a name="bedrock-ListCustomModels-request-uri-nameContains"></a>
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) **   <a name="bedrock-ListCustomModels-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListCustomModels-request-uri-sortBy"></a>
The field to sort by in the returned list of models.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListCustomModels_RequestSyntax) **   <a name="bedrock-ListCustomModels-request-uri-sortOrder"></a>
The sort order of the results.  
Valid Values: `Ascending | Descending` 

## Request Body
<a name="API_ListCustomModels_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListCustomModels_ResponseSyntax"></a>

```
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
<a name="API_ListCustomModels_ResponseElements"></a>

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) **   <a name="bedrock-ListCustomModels-response-modelSummaries"></a>
Model summaries.  
Type: Array of [CustomModelSummary](API_CustomModelSummary.md) objects

 ** [nextToken](#API_ListCustomModels_ResponseSyntax) **   <a name="bedrock-ListCustomModels-response-nextToken"></a>
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
<a name="API_ListCustomModels_Errors"></a>

For information about 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
<a name="API_ListCustomModels_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListEnforcedGuardrailsConfiguration"></a>

Lists the account-level enforced guardrail configurations.

## Request Syntax
<a name="API_ListEnforcedGuardrailsConfiguration_RequestSyntax"></a>

```
GET /enforcedGuardrailsConfiguration?nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListEnforcedGuardrailsConfiguration_RequestParameters"></a>

The request uses the following URI parameters.

 ** [nextToken](#API_ListEnforcedGuardrailsConfiguration_RequestSyntax) **   <a name="bedrock-ListEnforcedGuardrailsConfiguration-request-uri-nextToken"></a>
Opaque continuation token of previous paginated response.  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `\S*` 

## Request Body
<a name="API_ListEnforcedGuardrailsConfiguration_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEnforcedGuardrailsConfiguration_ResponseSyntax"></a>

```
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
<a name="API_ListEnforcedGuardrailsConfiguration_ResponseElements"></a>

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) **   <a name="bedrock-ListEnforcedGuardrailsConfiguration-response-guardrailsConfig"></a>
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) **   <a name="bedrock-ListEnforcedGuardrailsConfiguration-response-nextToken"></a>
Opaque continuation token of previous paginated response.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `\S*` 

## Errors
<a name="API_ListEnforcedGuardrailsConfiguration_Errors"></a>

For information about 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
<a name="API_ListEnforcedGuardrailsConfiguration_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListEvaluationJobs"></a>

Lists all existing evaluation jobs.

## Request Syntax
<a name="API_ListEvaluationJobs_RequestSyntax"></a>

```
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
<a name="API_ListEvaluationJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [applicationTypeEquals](#API_ListEvaluationJobs_RequestSyntax) **   <a name="bedrock-ListEvaluationJobs-request-uri-applicationTypeEquals"></a>
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 name="bedrock-ListEvaluationJobs-request-uri-creationTimeAfter"></a>
A filter to only list evaluation jobs created after a specified time.

 ** [creationTimeBefore](#API_ListEvaluationJobs_RequestSyntax) **   <a name="bedrock-ListEvaluationJobs-request-uri-creationTimeBefore"></a>
A filter to only list evaluation jobs created before a specified time.

 ** [maxResults](#API_ListEvaluationJobs_RequestSyntax) **   <a name="bedrock-ListEvaluationJobs-request-uri-maxResults"></a>
The maximum number of results to return.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [nameContains](#API_ListEvaluationJobs_RequestSyntax) **   <a name="bedrock-ListEvaluationJobs-request-uri-nameContains"></a>
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) **   <a name="bedrock-ListEvaluationJobs-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListEvaluationJobs-request-uri-sortBy"></a>
Specifies a creation time to sort the list of evaluation jobs by when they were created.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListEvaluationJobs_RequestSyntax) **   <a name="bedrock-ListEvaluationJobs-request-uri-sortOrder"></a>
Specifies whether to sort the list of evaluation jobs by either ascending or descending order.  
Valid Values: `Ascending | Descending` 

 ** [statusEquals](#API_ListEvaluationJobs_RequestSyntax) **   <a name="bedrock-ListEvaluationJobs-request-uri-statusEquals"></a>
A filter to only list evaluation jobs that are of a certain status.  
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting` 

## Request Body
<a name="API_ListEvaluationJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListEvaluationJobs_ResponseSyntax"></a>

```
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
<a name="API_ListEvaluationJobs_ResponseElements"></a>

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 name="bedrock-ListEvaluationJobs-response-jobSummaries"></a>
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) **   <a name="bedrock-ListEvaluationJobs-response-nextToken"></a>
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
<a name="API_ListEvaluationJobs_Errors"></a>

For information about 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
<a name="API_ListEvaluationJobs_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListFoundationModelAgreementOffers"></a>

Get the offers associated with the specified model.

## Request Syntax
<a name="API_ListFoundationModelAgreementOffers_RequestSyntax"></a>

```
GET /list-foundation-model-agreement-offers/modelId?offerType=offerType HTTP/1.1
```

## URI Request Parameters
<a name="API_ListFoundationModelAgreementOffers_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelId](#API_ListFoundationModelAgreementOffers_RequestSyntax) **   <a name="bedrock-ListFoundationModelAgreementOffers-request-uri-modelId"></a>
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) **   <a name="bedrock-ListFoundationModelAgreementOffers-request-uri-offerType"></a>
 Type of offer associated with the model.   
Valid Values: `ALL | PUBLIC` 

## Request Body
<a name="API_ListFoundationModelAgreementOffers_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListFoundationModelAgreementOffers_ResponseSyntax"></a>

```
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
<a name="API_ListFoundationModelAgreementOffers_ResponseElements"></a>

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) **   <a name="bedrock-ListFoundationModelAgreementOffers-response-modelId"></a>
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) **   <a name="bedrock-ListFoundationModelAgreementOffers-response-offers"></a>
List of the offers associated with the specified model.  
Type: Array of [Offer](API_Offer.md) objects

## Errors
<a name="API_ListFoundationModelAgreementOffers_Errors"></a>

For information about 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
<a name="API_ListFoundationModelAgreementOffers_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListFoundationModels"></a>

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
<a name="API_ListFoundationModels_RequestSyntax"></a>

```
GET /foundation-models?byCustomizationType=byCustomizationType&byInferenceType=byInferenceType&byOutputModality=byOutputModality&byProvider=byProvider HTTP/1.1
```

## URI Request Parameters
<a name="API_ListFoundationModels_RequestParameters"></a>

The request uses the following URI parameters.

 ** [byCustomizationType](#API_ListFoundationModels_RequestSyntax) **   <a name="bedrock-ListFoundationModels-request-uri-byCustomizationType"></a>
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) **   <a name="bedrock-ListFoundationModels-request-uri-byInferenceType"></a>
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) **   <a name="bedrock-ListFoundationModels-request-uri-byOutputModality"></a>
Return models that support the output modality that you specify.  
Valid Values: `TEXT | IMAGE | EMBEDDING` 

 ** [byProvider](#API_ListFoundationModels_RequestSyntax) **   <a name="bedrock-ListFoundationModels-request-uri-byProvider"></a>
Return models belonging to the model provider that you specify.  
Pattern: `[A-Za-z0-9- ]{1,63}` 

## Request Body
<a name="API_ListFoundationModels_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListFoundationModels_ResponseSyntax"></a>

```
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
<a name="API_ListFoundationModels_ResponseElements"></a>

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 name="bedrock-ListFoundationModels-response-modelSummaries"></a>
A list of Amazon Bedrock foundation models.  
Type: Array of [FoundationModelSummary](API_FoundationModelSummary.md) objects

## Errors
<a name="API_ListFoundationModels_Errors"></a>

For information about 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
<a name="API_ListFoundationModels_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListGuardrails"></a>

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
<a name="API_ListGuardrails_RequestSyntax"></a>

```
GET /guardrails?guardrailIdentifier=guardrailIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListGuardrails_RequestParameters"></a>

The request uses the following URI parameters.

 ** [guardrailIdentifier](#API_ListGuardrails_RequestSyntax) **   <a name="bedrock-ListGuardrails-request-uri-guardrailIdentifier"></a>
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) **   <a name="bedrock-ListGuardrails-request-uri-maxResults"></a>
The maximum number of results to return in the response.  
Valid Range: Minimum value of 1. Maximum value of 1000.

 ** [nextToken](#API_ListGuardrails_RequestSyntax) **   <a name="bedrock-ListGuardrails-request-uri-nextToken"></a>
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
<a name="API_ListGuardrails_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListGuardrails_ResponseSyntax"></a>

```
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
<a name="API_ListGuardrails_ResponseElements"></a>

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 name="bedrock-ListGuardrails-response-guardrails"></a>
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) **   <a name="bedrock-ListGuardrails-response-nextToken"></a>
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
<a name="API_ListGuardrails_Errors"></a>

For information about 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
<a name="API_ListGuardrails_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListImportedModels"></a>

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
<a name="API_ListImportedModels_RequestSyntax"></a>

```
GET /imported-models?creationTimeAfter=creationTimeAfter&creationTimeBefore=creationTimeBefore&maxResults=maxResults&nameContains=nameContains&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder HTTP/1.1
```

## URI Request Parameters
<a name="API_ListImportedModels_RequestParameters"></a>

The request uses the following URI parameters.

 ** [creationTimeAfter](#API_ListImportedModels_RequestSyntax) **   <a name="bedrock-ListImportedModels-request-uri-creationTimeAfter"></a>
Return imported models that were created after the specified time.

 ** [creationTimeBefore](#API_ListImportedModels_RequestSyntax) **   <a name="bedrock-ListImportedModels-request-uri-creationTimeBefore"></a>
Return imported models that created before the specified time.

 ** [maxResults](#API_ListImportedModels_RequestSyntax) **   <a name="bedrock-ListImportedModels-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListImportedModels-request-uri-nameContains"></a>
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) **   <a name="bedrock-ListImportedModels-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListImportedModels-request-uri-sortBy"></a>
The field to sort by in the returned list of imported models.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListImportedModels_RequestSyntax) **   <a name="bedrock-ListImportedModels-request-uri-sortOrder"></a>
Specifies whetehr to sort the results in ascending or descending order.  
Valid Values: `Ascending | Descending` 

## Request Body
<a name="API_ListImportedModels_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListImportedModels_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "modelSummaries": [ 
      { 
         "creationTime": "string",
         "instructSupported": boolean,
         "modelArchitecture": "string",
         "modelArn": "string",
         "modelName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_ListImportedModels_ResponseElements"></a>

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) **   <a name="bedrock-ListImportedModels-response-modelSummaries"></a>
Model summaries.  
Type: Array of [ImportedModelSummary](API_ImportedModelSummary.md) objects

 ** [nextToken](#API_ListImportedModels_ResponseSyntax) **   <a name="bedrock-ListImportedModels-response-nextToken"></a>
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
<a name="API_ListImportedModels_Errors"></a>

For information about 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
<a name="API_ListImportedModels_Examples"></a>

### List the imported models
<a name="API_ListImportedModels_Example_1"></a>

Lists the models that you have imported. 

```
GET /imported-models/ HTTP/1.1
Content-type: application/json
```

### Example response
<a name="API_ListImportedModels_Example_2"></a>

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
<a name="API_ListImportedModels_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListInferenceProfiles"></a>

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
<a name="API_ListInferenceProfiles_RequestSyntax"></a>

```
GET /inference-profiles?maxResults=maxResults&nextToken=nextToken&type=typeEquals HTTP/1.1
```

## URI Request Parameters
<a name="API_ListInferenceProfiles_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListInferenceProfiles_RequestSyntax) **   <a name="bedrock-ListInferenceProfiles-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListInferenceProfiles-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListInferenceProfiles-request-uri-typeEquals"></a>
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
<a name="API_ListInferenceProfiles_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListInferenceProfiles_ResponseSyntax"></a>

```
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
<a name="API_ListInferenceProfiles_ResponseElements"></a>

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 name="bedrock-ListInferenceProfiles-response-inferenceProfileSummaries"></a>
A list of information about each inference profile that you can use.  
Type: Array of [InferenceProfileSummary](API_InferenceProfileSummary.md) objects

 ** [nextToken](#API_ListInferenceProfiles_ResponseSyntax) **   <a name="bedrock-ListInferenceProfiles-response-nextToken"></a>
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
<a name="API_ListInferenceProfiles_Errors"></a>

For information about 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
<a name="API_ListInferenceProfiles_Examples"></a>

### List information about inference profiles in your Region
<a name="API_ListInferenceProfiles_Example_1"></a>

Run the following example to list information for up to 5 inference profiles in your region:

#### Sample Request
<a name="API_ListInferenceProfiles_Example_1_Request"></a>

```
GET /inference-profiles?maxResults=5 HTTP/1.1
```

## See Also
<a name="API_ListInferenceProfiles_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListMarketplaceModelEndpoints"></a>

Lists the endpoints for models from Amazon Bedrock Marketplace in your AWS account.

## Request Syntax
<a name="API_ListMarketplaceModelEndpoints_RequestSyntax"></a>

```
GET /marketplace-model/endpoints?maxResults=maxResults&modelSourceIdentifier=modelSourceEquals&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_ListMarketplaceModelEndpoints_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListMarketplaceModelEndpoints_RequestSyntax) **   <a name="bedrock-ListMarketplaceModelEndpoints-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListMarketplaceModelEndpoints-request-uri-modelSourceEquals"></a>
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) **   <a name="bedrock-ListMarketplaceModelEndpoints-request-uri-nextToken"></a>
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
<a name="API_ListMarketplaceModelEndpoints_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListMarketplaceModelEndpoints_ResponseSyntax"></a>

```
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
<a name="API_ListMarketplaceModelEndpoints_ResponseElements"></a>

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) **   <a name="bedrock-ListMarketplaceModelEndpoints-response-marketplaceModelEndpoints"></a>
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) **   <a name="bedrock-ListMarketplaceModelEndpoints-response-nextToken"></a>
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
<a name="API_ListMarketplaceModelEndpoints_Errors"></a>

For information about 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
<a name="API_ListMarketplaceModelEndpoints_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListModelCopyJobs"></a>

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
<a name="API_ListModelCopyJobs_RequestSyntax"></a>

```
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
<a name="API_ListModelCopyJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [creationTimeAfter](#API_ListModelCopyJobs_RequestSyntax) **   <a name="bedrock-ListModelCopyJobs-request-uri-creationTimeAfter"></a>
Filters for model copy jobs created after the specified time.

 ** [creationTimeBefore](#API_ListModelCopyJobs_RequestSyntax) **   <a name="bedrock-ListModelCopyJobs-request-uri-creationTimeBefore"></a>
Filters for model copy jobs created before the specified time. 

 ** [maxResults](#API_ListModelCopyJobs_RequestSyntax) **   <a name="bedrock-ListModelCopyJobs-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListModelCopyJobs-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListModelCopyJobs-request-uri-sortBy"></a>
The field to sort by in the returned list of model copy jobs.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListModelCopyJobs_RequestSyntax) **   <a name="bedrock-ListModelCopyJobs-request-uri-sortOrder"></a>
Specifies whether to sort the results in ascending or descending order.  
Valid Values: `Ascending | Descending` 

 ** [sourceAccountEquals](#API_ListModelCopyJobs_RequestSyntax) **   <a name="bedrock-ListModelCopyJobs-request-uri-sourceAccountEquals"></a>
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) **   <a name="bedrock-ListModelCopyJobs-request-uri-sourceModelArnEquals"></a>
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) **   <a name="bedrock-ListModelCopyJobs-request-uri-statusEquals"></a>
Filters for model copy jobs whose status matches the value that you specify.  
Valid Values: `InProgress | Completed | Failed` 

 ** [targetModelNameContains](#API_ListModelCopyJobs_RequestSyntax) **   <a name="bedrock-ListModelCopyJobs-request-uri-targetModelNameContains"></a>
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
<a name="API_ListModelCopyJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListModelCopyJobs_ResponseSyntax"></a>

```
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
<a name="API_ListModelCopyJobs_ResponseElements"></a>

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 name="bedrock-ListModelCopyJobs-response-modelCopyJobSummaries"></a>
A list of information about each model copy job.  
Type: Array of [ModelCopyJobSummary](API_ModelCopyJobSummary.md) objects

 ** [nextToken](#API_ListModelCopyJobs_ResponseSyntax) **   <a name="bedrock-ListModelCopyJobs-response-nextToken"></a>
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
<a name="API_ListModelCopyJobs_Errors"></a>

For information about 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
<a name="API_ListModelCopyJobs_Examples"></a>

### List model copy jobs (CLI)
<a name="API_ListModelCopyJobs_Example_1"></a>

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
<a name="API_ListModelCopyJobs_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListModelCustomizationJobs"></a>

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
<a name="API_ListModelCustomizationJobs_RequestSyntax"></a>

```
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
<a name="API_ListModelCustomizationJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [creationTimeAfter](#API_ListModelCustomizationJobs_RequestSyntax) **   <a name="bedrock-ListModelCustomizationJobs-request-uri-creationTimeAfter"></a>
Return customization jobs created after the specified time. 

 ** [creationTimeBefore](#API_ListModelCustomizationJobs_RequestSyntax) **   <a name="bedrock-ListModelCustomizationJobs-request-uri-creationTimeBefore"></a>
Return customization jobs created before the specified time. 

 ** [maxResults](#API_ListModelCustomizationJobs_RequestSyntax) **   <a name="bedrock-ListModelCustomizationJobs-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListModelCustomizationJobs-request-uri-nameContains"></a>
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) **   <a name="bedrock-ListModelCustomizationJobs-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListModelCustomizationJobs-request-uri-sortBy"></a>
The field to sort by in the returned list of jobs.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListModelCustomizationJobs_RequestSyntax) **   <a name="bedrock-ListModelCustomizationJobs-request-uri-sortOrder"></a>
The sort order of the results.  
Valid Values: `Ascending | Descending` 

 ** [statusEquals](#API_ListModelCustomizationJobs_RequestSyntax) **   <a name="bedrock-ListModelCustomizationJobs-request-uri-statusEquals"></a>
Return customization jobs with the specified status.   
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped` 

## Request Body
<a name="API_ListModelCustomizationJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListModelCustomizationJobs_ResponseSyntax"></a>

```
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
<a name="API_ListModelCustomizationJobs_ResponseElements"></a>

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) **   <a name="bedrock-ListModelCustomizationJobs-response-modelCustomizationJobSummaries"></a>
Job summaries.  
Type: Array of [ModelCustomizationJobSummary](API_ModelCustomizationJobSummary.md) objects

 ** [nextToken](#API_ListModelCustomizationJobs_ResponseSyntax) **   <a name="bedrock-ListModelCustomizationJobs-response-nextToken"></a>
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
<a name="API_ListModelCustomizationJobs_Errors"></a>

For information about 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
<a name="API_ListModelCustomizationJobs_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListModelImportJobs"></a>

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
<a name="API_ListModelImportJobs_RequestSyntax"></a>

```
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
<a name="API_ListModelImportJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [creationTimeAfter](#API_ListModelImportJobs_RequestSyntax) **   <a name="bedrock-ListModelImportJobs-request-uri-creationTimeAfter"></a>
Return import jobs that were created after the specified time.

 ** [creationTimeBefore](#API_ListModelImportJobs_RequestSyntax) **   <a name="bedrock-ListModelImportJobs-request-uri-creationTimeBefore"></a>
Return import jobs that were created before the specified time.

 ** [maxResults](#API_ListModelImportJobs_RequestSyntax) **   <a name="bedrock-ListModelImportJobs-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListModelImportJobs-request-uri-nameContains"></a>
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) **   <a name="bedrock-ListModelImportJobs-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListModelImportJobs-request-uri-sortBy"></a>
The field to sort by in the returned list of imported jobs.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListModelImportJobs_RequestSyntax) **   <a name="bedrock-ListModelImportJobs-request-uri-sortOrder"></a>
Specifies whether to sort the results in ascending or descending order.  
Valid Values: `Ascending | Descending` 

 ** [statusEquals](#API_ListModelImportJobs_RequestSyntax) **   <a name="bedrock-ListModelImportJobs-request-uri-statusEquals"></a>
Return imported jobs with the specified status.  
Valid Values: `InProgress | Completed | Failed` 

## Request Body
<a name="API_ListModelImportJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListModelImportJobs_ResponseSyntax"></a>

```
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
<a name="API_ListModelImportJobs_ResponseElements"></a>

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) **   <a name="bedrock-ListModelImportJobs-response-modelImportJobSummaries"></a>
Import job summaries.  
Type: Array of [ModelImportJobSummary](API_ModelImportJobSummary.md) objects

 ** [nextToken](#API_ListModelImportJobs_ResponseSyntax) **   <a name="bedrock-ListModelImportJobs-response-nextToken"></a>
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
<a name="API_ListModelImportJobs_Errors"></a>

For information about 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
<a name="API_ListModelImportJobs_Examples"></a>

### List model import jobs
<a name="API_ListModelImportJobs_Example_1"></a>

Gets a list of the import jobs that you have submitted.

```
GET /model-import-jobs/ HTTP/1.1
Content-type: application/json
```

### Example response
<a name="API_ListModelImportJobs_Example_2"></a>

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
<a name="API_ListModelImportJobs_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListModelInvocationJobs"></a>

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
<a name="API_ListModelInvocationJobs_RequestSyntax"></a>

```
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
<a name="API_ListModelInvocationJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListModelInvocationJobs_RequestSyntax) **   <a name="bedrock-ListModelInvocationJobs-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListModelInvocationJobs-request-uri-nameContains"></a>
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) **   <a name="bedrock-ListModelInvocationJobs-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListModelInvocationJobs-request-uri-sortBy"></a>
An attribute by which to sort the results.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListModelInvocationJobs_RequestSyntax) **   <a name="bedrock-ListModelInvocationJobs-request-uri-sortOrder"></a>
Specifies whether to sort the results by ascending or descending order.  
Valid Values: `Ascending | Descending` 

 ** [statusEquals](#API_ListModelInvocationJobs_RequestSyntax) **   <a name="bedrock-ListModelInvocationJobs-request-uri-statusEquals"></a>
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) **   <a name="bedrock-ListModelInvocationJobs-request-uri-submitTimeAfter"></a>
Specify a time to filter for batch inference jobs that were submitted after the time you specify.

 ** [submitTimeBefore](#API_ListModelInvocationJobs_RequestSyntax) **   <a name="bedrock-ListModelInvocationJobs-request-uri-submitTimeBefore"></a>
Specify a time to filter for batch inference jobs that were submitted before the time you specify.

## Request Body
<a name="API_ListModelInvocationJobs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListModelInvocationJobs_ResponseSyntax"></a>

```
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
<a name="API_ListModelInvocationJobs_ResponseElements"></a>

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 name="bedrock-ListModelInvocationJobs-response-invocationJobSummaries"></a>
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) **   <a name="bedrock-ListModelInvocationJobs-response-nextToken"></a>
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
<a name="API_ListModelInvocationJobs_Errors"></a>

For information about 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
<a name="API_ListModelInvocationJobs_Examples"></a>

### List up to ten model invocation jobs
<a name="API_ListModelInvocationJobs_Example_1"></a>

This example illustrates one usage of ListModelInvocationJobs.

```
GET /model-invocation-jobs?maxResults=10&sortBy=CreationTime&sortOrder=Descending HTTP/1.1
```

## See Also
<a name="API_ListModelInvocationJobs_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListPromptRouters"></a>

Retrieves a list of prompt routers.

## Request Syntax
<a name="API_ListPromptRouters_RequestSyntax"></a>

```
GET /prompt-routers?maxResults=maxResults&nextToken=nextToken&type=type HTTP/1.1
```

## URI Request Parameters
<a name="API_ListPromptRouters_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_ListPromptRouters_RequestSyntax) **   <a name="bedrock-ListPromptRouters-request-uri-maxResults"></a>
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) **   <a name="bedrock-ListPromptRouters-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListPromptRouters-request-uri-type"></a>
The type of the prompt routers, such as whether it's default or custom.  
Valid Values: `custom | default` 

## Request Body
<a name="API_ListPromptRouters_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListPromptRouters_ResponseSyntax"></a>

```
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
<a name="API_ListPromptRouters_ResponseElements"></a>

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) **   <a name="bedrock-ListPromptRouters-response-nextToken"></a>
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 name="bedrock-ListPromptRouters-response-promptRouterSummaries"></a>
A list of prompt router summaries.  
Type: Array of [PromptRouterSummary](API_PromptRouterSummary.md) objects

## Errors
<a name="API_ListPromptRouters_Errors"></a>

For information about 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
<a name="API_ListPromptRouters_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListProvisionedModelThroughputs"></a>

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
<a name="API_ListProvisionedModelThroughputs_RequestSyntax"></a>

```
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
<a name="API_ListProvisionedModelThroughputs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [creationTimeAfter](#API_ListProvisionedModelThroughputs_RequestSyntax) **   <a name="bedrock-ListProvisionedModelThroughputs-request-uri-creationTimeAfter"></a>
A filter that returns Provisioned Throughputs created after the specified time. 

 ** [creationTimeBefore](#API_ListProvisionedModelThroughputs_RequestSyntax) **   <a name="bedrock-ListProvisionedModelThroughputs-request-uri-creationTimeBefore"></a>
A filter that returns Provisioned Throughputs created before the specified time. 

 ** [maxResults](#API_ListProvisionedModelThroughputs_RequestSyntax) **   <a name="bedrock-ListProvisionedModelThroughputs-request-uri-maxResults"></a>
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 name="bedrock-ListProvisionedModelThroughputs-request-uri-modelArnEquals"></a>
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 name="bedrock-ListProvisionedModelThroughputs-request-uri-nameContains"></a>
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) **   <a name="bedrock-ListProvisionedModelThroughputs-request-uri-nextToken"></a>
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) **   <a name="bedrock-ListProvisionedModelThroughputs-request-uri-sortBy"></a>
The field by which to sort the returned list of Provisioned Throughputs.  
Valid Values: `CreationTime` 

 ** [sortOrder](#API_ListProvisionedModelThroughputs_RequestSyntax) **   <a name="bedrock-ListProvisionedModelThroughputs-request-uri-sortOrder"></a>
The sort order of the results.  
Valid Values: `Ascending | Descending` 

 ** [statusEquals](#API_ListProvisionedModelThroughputs_RequestSyntax) **   <a name="bedrock-ListProvisionedModelThroughputs-request-uri-statusEquals"></a>
A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.  
Valid Values: `Creating | InService | Updating | Failed` 

## Request Body
<a name="API_ListProvisionedModelThroughputs_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_ListProvisionedModelThroughputs_ResponseSyntax"></a>

```
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
<a name="API_ListProvisionedModelThroughputs_ResponseElements"></a>

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) **   <a name="bedrock-ListProvisionedModelThroughputs-response-nextToken"></a>
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 name="bedrock-ListProvisionedModelThroughputs-response-provisionedModelSummaries"></a>
A list of summaries, one for each Provisioned Throughput in the response.  
Type: Array of [ProvisionedModelSummary](API_ProvisionedModelSummary.md) objects

## Errors
<a name="API_ListProvisionedModelThroughputs_Errors"></a>

For information about 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
<a name="API_ListProvisionedModelThroughputs_SeeAlso"></a>

For more information about using this API 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
<a name="API_ListTagsForResource"></a>

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
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
POST /listTagsForResource HTTP/1.1
Content-type: application/json

{
   "resourceARN": "string"
}
```

## URI Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_ListTagsForResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="bedrock-ListTagsForResource-request-resourceARN"></a>
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
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

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) **   <a name="bedrock-ListTagsForResource-response-tags"></a>
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
<a name="API_ListTagsForResource_Errors"></a>

For information about 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
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_PutEnforcedGuardrailConfiguration"></a>

Sets the account-level enforced guardrail configuration.

## Request Syntax
<a name="API_PutEnforcedGuardrailConfiguration_RequestSyntax"></a>

```
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
<a name="API_PutEnforcedGuardrailConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutEnforcedGuardrailConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [configId](#API_PutEnforcedGuardrailConfiguration_RequestSyntax) **   <a name="bedrock-PutEnforcedGuardrailConfiguration-request-configId"></a>
Unique ID for the account enforced configuration.  
Type: String  
Pattern: `[a-z0-9]+`   
Required: No

 ** [guardrailInferenceConfig](#API_PutEnforcedGuardrailConfiguration_RequestSyntax) **   <a name="bedrock-PutEnforcedGuardrailConfiguration-request-guardrailInferenceConfig"></a>
Account-level enforced guardrail input configuration.  
Type: [AccountEnforcedGuardrailInferenceInputConfiguration](API_AccountEnforcedGuardrailInferenceInputConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_PutEnforcedGuardrailConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "configId": "string",
   "updatedAt": "string",
   "updatedBy": "string"
}
```

## Response Elements
<a name="API_PutEnforcedGuardrailConfiguration_ResponseElements"></a>

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) **   <a name="bedrock-PutEnforcedGuardrailConfiguration-response-configId"></a>
Unique ID for the account enforced configuration.  
Type: String  
Pattern: `[a-z0-9]+` 

 ** [updatedAt](#API_PutEnforcedGuardrailConfiguration_ResponseSyntax) **   <a name="bedrock-PutEnforcedGuardrailConfiguration-response-updatedAt"></a>
Timestamp.  
Type: Timestamp

 ** [updatedBy](#API_PutEnforcedGuardrailConfiguration_ResponseSyntax) **   <a name="bedrock-PutEnforcedGuardrailConfiguration-response-updatedBy"></a>
The ARN of the role used to update the configuration.  
Type: String

## Errors
<a name="API_PutEnforcedGuardrailConfiguration_Errors"></a>

For information about 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
<a name="API_PutEnforcedGuardrailConfiguration_SeeAlso"></a>

For more information about using this API 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
<a name="API_PutModelInvocationLoggingConfiguration"></a>

Set the configuration values for model invocation logging.

## Request Syntax
<a name="API_PutModelInvocationLoggingConfiguration_RequestSyntax"></a>

```
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
<a name="API_PutModelInvocationLoggingConfiguration_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutModelInvocationLoggingConfiguration_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [loggingConfig](#API_PutModelInvocationLoggingConfiguration_RequestSyntax) **   <a name="bedrock-PutModelInvocationLoggingConfiguration-request-loggingConfig"></a>
The logging configuration values to set.  
Type: [LoggingConfig](API_LoggingConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_PutModelInvocationLoggingConfiguration_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_PutModelInvocationLoggingConfiguration_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutModelInvocationLoggingConfiguration_Errors"></a>

For information about 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
<a name="API_PutModelInvocationLoggingConfiguration_SeeAlso"></a>

For more information about using this API 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
<a name="API_PutResourcePolicy"></a>

Adds a resource policy for a Bedrock resource.

## Request Syntax
<a name="API_PutResourcePolicy_RequestSyntax"></a>

```
POST /resource-policy HTTP/1.1
Content-type: application/json

{
   "resourceArn": "string",
   "resourcePolicy": "string"
}
```

## URI Request Parameters
<a name="API_PutResourcePolicy_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutResourcePolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resourceArn](#API_PutResourcePolicy_RequestSyntax) **   <a name="bedrock-PutResourcePolicy-request-resourceArn"></a>
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) **   <a name="bedrock-PutResourcePolicy-request-resourcePolicy"></a>
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
<a name="API_PutResourcePolicy_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "resourceArn": "string"
}
```

## Response Elements
<a name="API_PutResourcePolicy_ResponseElements"></a>

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) **   <a name="bedrock-PutResourcePolicy-response-resourceArn"></a>
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
<a name="API_PutResourcePolicy_Errors"></a>

For information about 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
<a name="API_PutResourcePolicy_SeeAlso"></a>

For more information about using this API 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
<a name="API_PutUseCaseForModelAccess"></a>

 Returns the use case for model access. The example shown below under *Examples* shows the form data json configuration.

## Request Syntax
<a name="API_PutUseCaseForModelAccess_RequestSyntax"></a>

```
POST /use-case-for-model-access HTTP/1.1
Content-type: application/json

{
   "formData": blob
}
```

## URI Request Parameters
<a name="API_PutUseCaseForModelAccess_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_PutUseCaseForModelAccess_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [formData](#API_PutUseCaseForModelAccess_RequestSyntax) **   <a name="bedrock-PutUseCaseForModelAccess-request-formData"></a>
 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
<a name="API_PutUseCaseForModelAccess_ResponseSyntax"></a>

```
HTTP/1.1 201
```

## Response Elements
<a name="API_PutUseCaseForModelAccess_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 201 response with an empty HTTP body.

## Errors
<a name="API_PutUseCaseForModelAccess_Errors"></a>

For information about 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
<a name="API_PutUseCaseForModelAccess_Examples"></a>

### Example
<a name="API_PutUseCaseForModelAccess_Example_1"></a>

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
<a name="API_PutUseCaseForModelAccess_SeeAlso"></a>

For more information about using this API 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
<a name="API_RegisterMarketplaceModelEndpoint"></a>

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

## Request Syntax
<a name="API_RegisterMarketplaceModelEndpoint_RequestSyntax"></a>

```
POST /marketplace-model/endpoints/endpointIdentifier/registration HTTP/1.1
Content-type: application/json

{
   "modelSourceIdentifier": "string"
}
```

## URI Request Parameters
<a name="API_RegisterMarketplaceModelEndpoint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [endpointIdentifier](#API_RegisterMarketplaceModelEndpoint_RequestSyntax) **   <a name="bedrock-RegisterMarketplaceModelEndpoint-request-uri-endpointIdentifier"></a>
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
<a name="API_RegisterMarketplaceModelEndpoint_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [modelSourceIdentifier](#API_RegisterMarketplaceModelEndpoint_RequestSyntax) **   <a name="bedrock-RegisterMarketplaceModelEndpoint-request-modelSourceIdentifier"></a>
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
<a name="API_RegisterMarketplaceModelEndpoint_ResponseSyntax"></a>

```
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
<a name="API_RegisterMarketplaceModelEndpoint_ResponseElements"></a>

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) **   <a name="bedrock-RegisterMarketplaceModelEndpoint-response-marketplaceModelEndpoint"></a>
Details about the registered endpoint.  
Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md) object

## Errors
<a name="API_RegisterMarketplaceModelEndpoint_Errors"></a>

For information about 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
<a name="API_RegisterMarketplaceModelEndpoint_SeeAlso"></a>

For more information about using this API 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
<a name="API_StartAutomatedReasoningPolicyBuildWorkflow"></a>

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
<a name="API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax"></a>

```
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
<a name="API_StartAutomatedReasoningPolicyBuildWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowType](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **   <a name="bedrock-StartAutomatedReasoningPolicyBuildWorkflow-request-uri-buildWorkflowType"></a>
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 name="bedrock-StartAutomatedReasoningPolicyBuildWorkflow-request-clientRequestToken"></a>
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) **   <a name="bedrock-StartAutomatedReasoningPolicyBuildWorkflow-request-uri-policyArn"></a>
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
<a name="API_StartAutomatedReasoningPolicyBuildWorkflow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [policyDefinition](#API_StartAutomatedReasoningPolicyBuildWorkflow_RequestSyntax) **   <a name="bedrock-StartAutomatedReasoningPolicyBuildWorkflow-request-policyDefinition"></a>
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) **   <a name="bedrock-StartAutomatedReasoningPolicyBuildWorkflow-request-workflowContent"></a>
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
<a name="API_StartAutomatedReasoningPolicyBuildWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "buildWorkflowId": "string",
   "policyArn": "string"
}
```

## Response Elements
<a name="API_StartAutomatedReasoningPolicyBuildWorkflow_ResponseElements"></a>

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) **   <a name="bedrock-StartAutomatedReasoningPolicyBuildWorkflow-response-buildWorkflowId"></a>
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) **   <a name="bedrock-StartAutomatedReasoningPolicyBuildWorkflow-response-policyArn"></a>
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
<a name="API_StartAutomatedReasoningPolicyBuildWorkflow_Errors"></a>

For information about 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
<a name="API_StartAutomatedReasoningPolicyBuildWorkflow_SeeAlso"></a>

For more information about using this API 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
<a name="API_StartAutomatedReasoningPolicyTestWorkflow"></a>

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
<a name="API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax"></a>

```
POST /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/test-workflows HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "testCaseIds": [ "string" ]
}
```

## URI Request Parameters
<a name="API_StartAutomatedReasoningPolicyTestWorkflow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) **   <a name="bedrock-StartAutomatedReasoningPolicyTestWorkflow-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-StartAutomatedReasoningPolicyTestWorkflow-request-uri-policyArn"></a>
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
<a name="API_StartAutomatedReasoningPolicyTestWorkflow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_StartAutomatedReasoningPolicyTestWorkflow_RequestSyntax) **   <a name="bedrock-StartAutomatedReasoningPolicyTestWorkflow-request-clientRequestToken"></a>
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) **   <a name="bedrock-StartAutomatedReasoningPolicyTestWorkflow-request-testCaseIds"></a>
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
<a name="API_StartAutomatedReasoningPolicyTestWorkflow_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "policyArn": "string"
}
```

## Response Elements
<a name="API_StartAutomatedReasoningPolicyTestWorkflow_ResponseElements"></a>

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) **   <a name="bedrock-StartAutomatedReasoningPolicyTestWorkflow-response-policyArn"></a>
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
<a name="API_StartAutomatedReasoningPolicyTestWorkflow_Errors"></a>

For information about 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
<a name="API_StartAutomatedReasoningPolicyTestWorkflow_SeeAlso"></a>

For more information about using this API 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
<a name="API_StopEvaluationJob"></a>

Stops an evaluation job that is current being created or running.

## Request Syntax
<a name="API_StopEvaluationJob_RequestSyntax"></a>

```
POST /evaluation-job/jobIdentifier/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_StopEvaluationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobIdentifier](#API_StopEvaluationJob_RequestSyntax) **   <a name="bedrock-StopEvaluationJob-request-uri-jobIdentifier"></a>
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
<a name="API_StopEvaluationJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StopEvaluationJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopEvaluationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopEvaluationJob_Errors"></a>

For information about 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
<a name="API_StopEvaluationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_StopModelCustomizationJob"></a>

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
<a name="API_StopModelCustomizationJob_RequestSyntax"></a>

```
POST /model-customization-jobs/jobIdentifier/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_StopModelCustomizationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobIdentifier](#API_StopModelCustomizationJob_RequestSyntax) **   <a name="bedrock-StopModelCustomizationJob-request-uri-jobIdentifier"></a>
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
<a name="API_StopModelCustomizationJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StopModelCustomizationJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopModelCustomizationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopModelCustomizationJob_Errors"></a>

For information about 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
<a name="API_StopModelCustomizationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_StopModelInvocationJob"></a>

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
<a name="API_StopModelInvocationJob_RequestSyntax"></a>

```
POST /model-invocation-job/jobIdentifier/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_StopModelInvocationJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobIdentifier](#API_StopModelInvocationJob_RequestSyntax) **   <a name="bedrock-StopModelInvocationJob-request-uri-jobIdentifier"></a>
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
<a name="API_StopModelInvocationJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_StopModelInvocationJob_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_StopModelInvocationJob_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_StopModelInvocationJob_Errors"></a>

For information about 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
<a name="API_StopModelInvocationJob_Examples"></a>

### Stop a model invocation job
<a name="API_StopModelInvocationJob_Example_1"></a>

This example illustrates one usage of StopModelInvocationJob.

```
POST /model-invocation-job/BATCHJOB1234/stop HTTP/1.1
```

## See Also
<a name="API_StopModelInvocationJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_TagResource"></a>

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
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tagResource HTTP/1.1
Content-type: application/json

{
   "resourceARN": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_TagResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resourceARN](#API_TagResource_RequestSyntax) **   <a name="bedrock-TagResource-request-resourceARN"></a>
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) **   <a name="bedrock-TagResource-request-tags"></a>
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
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about 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
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_UntagResource"></a>

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
<a name="API_UntagResource_RequestSyntax"></a>

```
POST /untagResource HTTP/1.1
Content-type: application/json

{
   "resourceARN": "string",
   "tagKeys": [ "string" ]
}
```

## URI Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_UntagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resourceARN](#API_UntagResource_RequestSyntax) **   <a name="bedrock-UntagResource-request-resourceARN"></a>
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) **   <a name="bedrock-UntagResource-request-tagKeys"></a>
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
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about 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
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_UpdateAutomatedReasoningPolicy"></a>

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
<a name="API_UpdateAutomatedReasoningPolicy_RequestSyntax"></a>

```
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
<a name="API_UpdateAutomatedReasoningPolicy_RequestParameters"></a>

The request uses the following URI parameters.

 ** [policyArn](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) **   <a name="bedrock-UpdateAutomatedReasoningPolicy-request-uri-policyArn"></a>
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
<a name="API_UpdateAutomatedReasoningPolicy_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_UpdateAutomatedReasoningPolicy_RequestSyntax) **   <a name="bedrock-UpdateAutomatedReasoningPolicy-request-description"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicy-request-name"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicy-request-policyDefinition"></a>
The updated policy definition containing the formal logic rules, variables, and types.  
Type: [AutomatedReasoningPolicyDefinition](API_AutomatedReasoningPolicyDefinition.md) object  
Required: Yes

## Response Syntax
<a name="API_UpdateAutomatedReasoningPolicy_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "definitionHash": "string",
   "name": "string",
   "policyArn": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_UpdateAutomatedReasoningPolicy_ResponseElements"></a>

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) **   <a name="bedrock-UpdateAutomatedReasoningPolicy-response-definitionHash"></a>
The hash of the updated policy definition.  
Type: String  
Length Constraints: Fixed length of 128.  
Pattern: `[0-9a-z]{128}` 

 ** [name](#API_UpdateAutomatedReasoningPolicy_ResponseSyntax) **   <a name="bedrock-UpdateAutomatedReasoningPolicy-response-name"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicy-response-policyArn"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicy-response-updatedAt"></a>
The timestamp when the policy was last updated.  
Type: Timestamp

## Errors
<a name="API_UpdateAutomatedReasoningPolicy_Errors"></a>

For information about 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
<a name="API_UpdateAutomatedReasoningPolicy_SeeAlso"></a>

For more information about using this API 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
<a name="API_UpdateAutomatedReasoningPolicyAnnotations"></a>

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
<a name="API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax"></a>

```
PATCH /automated-reasoning-policies/policyArn/build-workflows/buildWorkflowId/annotations HTTP/1.1
Content-type: application/json

{
   "annotations": [ 
      { ... }
   ],
   "lastUpdatedAnnotationSetHash": "string"
}
```

## URI Request Parameters
<a name="API_UpdateAutomatedReasoningPolicyAnnotations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [buildWorkflowId](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) **   <a name="bedrock-UpdateAutomatedReasoningPolicyAnnotations-request-uri-buildWorkflowId"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyAnnotations-request-uri-policyArn"></a>
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
<a name="API_UpdateAutomatedReasoningPolicyAnnotations_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [annotations](#API_UpdateAutomatedReasoningPolicyAnnotations_RequestSyntax) **   <a name="bedrock-UpdateAutomatedReasoningPolicyAnnotations-request-annotations"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyAnnotations-request-lastUpdatedAnnotationSetHash"></a>
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
<a name="API_UpdateAutomatedReasoningPolicyAnnotations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "annotationSetHash": "string",
   "buildWorkflowId": "string",
   "policyArn": "string",
   "updatedAt": "string"
}
```

## Response Elements
<a name="API_UpdateAutomatedReasoningPolicyAnnotations_ResponseElements"></a>

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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyAnnotations-response-annotationSetHash"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyAnnotations-response-buildWorkflowId"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyAnnotations-response-policyArn"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyAnnotations-response-updatedAt"></a>
The timestamp when the annotations were updated.  
Type: Timestamp

## Errors
<a name="API_UpdateAutomatedReasoningPolicyAnnotations_Errors"></a>

For information about 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
<a name="API_UpdateAutomatedReasoningPolicyAnnotations_SeeAlso"></a>

For more information about using this API 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
<a name="API_UpdateAutomatedReasoningPolicyTestCase"></a>

Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.

## Request Syntax
<a name="API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax"></a>

```
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
<a name="API_UpdateAutomatedReasoningPolicyTestCase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [policyArn](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-request-uri-policyArn"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-request-uri-testCaseId"></a>
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
<a name="API_UpdateAutomatedReasoningPolicyTestCase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_UpdateAutomatedReasoningPolicyTestCase_RequestSyntax) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-request-clientRequestToken"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-request-confidenceThreshold"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-request-expectedAggregatedFindingsResult"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-request-guardContent"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-request-lastUpdatedAt"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-request-queryContent"></a>
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
<a name="API_UpdateAutomatedReasoningPolicyTestCase_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "policyArn": "string",
   "testCaseId": "string"
}
```

## Response Elements
<a name="API_UpdateAutomatedReasoningPolicyTestCase_ResponseElements"></a>

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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-response-policyArn"></a>
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) **   <a name="bedrock-UpdateAutomatedReasoningPolicyTestCase-response-testCaseId"></a>
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
<a name="API_UpdateAutomatedReasoningPolicyTestCase_Errors"></a>

For information about 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
<a name="API_UpdateAutomatedReasoningPolicyTestCase_SeeAlso"></a>

For more information about using this API 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
<a name="API_UpdateCustomModelDeployment"></a>

 Updates a custom model deployment with a new custom model. This allows you to deploy updated models without creating new deployment endpoints. 

## Request Syntax
<a name="API_UpdateCustomModelDeployment_RequestSyntax"></a>

```
PATCH /model-customization/custom-model-deployments/customModelDeploymentIdentifier HTTP/1.1
Content-type: application/json

{
   "modelArn": "string"
}
```

## URI Request Parameters
<a name="API_UpdateCustomModelDeployment_RequestParameters"></a>

The request uses the following URI parameters.

 ** [customModelDeploymentIdentifier](#API_UpdateCustomModelDeployment_RequestSyntax) **   <a name="bedrock-UpdateCustomModelDeployment-request-uri-customModelDeploymentIdentifier"></a>
 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
<a name="API_UpdateCustomModelDeployment_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [modelArn](#API_UpdateCustomModelDeployment_RequestSyntax) **   <a name="bedrock-UpdateCustomModelDeployment-request-modelArn"></a>
 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
<a name="API_UpdateCustomModelDeployment_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "customModelDeploymentArn": "string"
}
```

## Response Elements
<a name="API_UpdateCustomModelDeployment_ResponseElements"></a>

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) **   <a name="bedrock-UpdateCustomModelDeployment-response-customModelDeploymentArn"></a>
 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
<a name="API_UpdateCustomModelDeployment_Errors"></a>

For information about 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
<a name="API_UpdateCustomModelDeployment_SeeAlso"></a>

For more information about using this API 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
<a name="API_UpdateGuardrail"></a>

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
<a name="API_UpdateGuardrail_RequestSyntax"></a>

```
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
<a name="API_UpdateGuardrail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [guardrailIdentifier](#API_UpdateGuardrail_RequestSyntax) **   <a name="bedrock-UpdateGuardrail-request-uri-guardrailIdentifier"></a>
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
<a name="API_UpdateGuardrail_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [automatedReasoningPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **   <a name="bedrock-UpdateGuardrail-request-automatedReasoningPolicyConfig"></a>
Updated configuration for Automated Reasoning policies associated with the guardrail.  
Type: [GuardrailAutomatedReasoningPolicyConfig](API_GuardrailAutomatedReasoningPolicyConfig.md) object  
Required: No

 ** [blockedInputMessaging](#API_UpdateGuardrail_RequestSyntax) **   <a name="bedrock-UpdateGuardrail-request-blockedInputMessaging"></a>
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) **   <a name="bedrock-UpdateGuardrail-request-blockedOutputsMessaging"></a>
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) **   <a name="bedrock-UpdateGuardrail-request-contentPolicyConfig"></a>
The content policy to configure for the guardrail.  
Type: [GuardrailContentPolicyConfig](API_GuardrailContentPolicyConfig.md) object  
Required: No

 ** [contextualGroundingPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **   <a name="bedrock-UpdateGuardrail-request-contextualGroundingPolicyConfig"></a>
The contextual grounding policy configuration used to update a guardrail.  
Type: [GuardrailContextualGroundingPolicyConfig](API_GuardrailContextualGroundingPolicyConfig.md) object  
Required: No

 ** [crossRegionConfig](#API_UpdateGuardrail_RequestSyntax) **   <a name="bedrock-UpdateGuardrail-request-crossRegionConfig"></a>
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 name="bedrock-UpdateGuardrail-request-description"></a>
A description of the guardrail.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [kmsKeyId](#API_UpdateGuardrail_RequestSyntax) **   <a name="bedrock-UpdateGuardrail-request-kmsKeyId"></a>
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="bedrock-UpdateGuardrail-request-name"></a>
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) **   <a name="bedrock-UpdateGuardrail-request-sensitiveInformationPolicyConfig"></a>
The sensitive information policy to configure for the guardrail.  
Type: [GuardrailSensitiveInformationPolicyConfig](API_GuardrailSensitiveInformationPolicyConfig.md) object  
Required: No

 ** [topicPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **   <a name="bedrock-UpdateGuardrail-request-topicPolicyConfig"></a>
The topic policy to configure for the guardrail.  
Type: [GuardrailTopicPolicyConfig](API_GuardrailTopicPolicyConfig.md) object  
Required: No

 ** [wordPolicyConfig](#API_UpdateGuardrail_RequestSyntax) **   <a name="bedrock-UpdateGuardrail-request-wordPolicyConfig"></a>
The word policy to configure for the guardrail.  
Type: [GuardrailWordPolicyConfig](API_GuardrailWordPolicyConfig.md) object  
Required: No

## Response Syntax
<a name="API_UpdateGuardrail_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "guardrailArn": "string",
   "guardrailId": "string",
   "updatedAt": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_UpdateGuardrail_ResponseElements"></a>

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) **   <a name="bedrock-UpdateGuardrail-response-guardrailArn"></a>
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) **   <a name="bedrock-UpdateGuardrail-response-guardrailId"></a>
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) **   <a name="bedrock-UpdateGuardrail-response-updatedAt"></a>
The date and time at which the guardrail was updated.  
Type: Timestamp

 ** [version](#API_UpdateGuardrail_ResponseSyntax) **   <a name="bedrock-UpdateGuardrail-response-version"></a>
The version of the guardrail.  
Type: String  
Length Constraints: Fixed length of 5.  
Pattern: `DRAFT` 

## Errors
<a name="API_UpdateGuardrail_Errors"></a>

For information about 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
<a name="API_UpdateGuardrail_SeeAlso"></a>

For more information about using this API 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
<a name="API_UpdateMarketplaceModelEndpoint"></a>

Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.

## Request Syntax
<a name="API_UpdateMarketplaceModelEndpoint_RequestSyntax"></a>

```
PATCH /marketplace-model/endpoints/endpointArn HTTP/1.1
Content-type: application/json

{
   "clientRequestToken": "string",
   "endpointConfig": { ... }
}
```

## URI Request Parameters
<a name="API_UpdateMarketplaceModelEndpoint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [endpointArn](#API_UpdateMarketplaceModelEndpoint_RequestSyntax) **   <a name="bedrock-UpdateMarketplaceModelEndpoint-request-uri-endpointArn"></a>
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
<a name="API_UpdateMarketplaceModelEndpoint_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_UpdateMarketplaceModelEndpoint_RequestSyntax) **   <a name="bedrock-UpdateMarketplaceModelEndpoint-request-clientRequestToken"></a>
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) **   <a name="bedrock-UpdateMarketplaceModelEndpoint-request-endpointConfig"></a>
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
<a name="API_UpdateMarketplaceModelEndpoint_ResponseSyntax"></a>

```
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
<a name="API_UpdateMarketplaceModelEndpoint_ResponseElements"></a>

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) **   <a name="bedrock-UpdateMarketplaceModelEndpoint-response-marketplaceModelEndpoint"></a>
Details about the updated endpoint.  
Type: [MarketplaceModelEndpoint](API_MarketplaceModelEndpoint.md) object

## Errors
<a name="API_UpdateMarketplaceModelEndpoint_Errors"></a>

For information about 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
<a name="API_UpdateMarketplaceModelEndpoint_SeeAlso"></a>

For more information about using this API 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
<a name="API_UpdateProvisionedModelThroughput"></a>

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
<a name="API_UpdateProvisionedModelThroughput_RequestSyntax"></a>

```
PATCH /provisioned-model-throughput/provisionedModelId HTTP/1.1
Content-type: application/json

{
   "desiredModelId": "string",
   "desiredProvisionedModelName": "string"
}
```

## URI Request Parameters
<a name="API_UpdateProvisionedModelThroughput_RequestParameters"></a>

The request uses the following URI parameters.

 ** [provisionedModelId](#API_UpdateProvisionedModelThroughput_RequestSyntax) **   <a name="bedrock-UpdateProvisionedModelThroughput-request-uri-provisionedModelId"></a>
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
<a name="API_UpdateProvisionedModelThroughput_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [desiredModelId](#API_UpdateProvisionedModelThroughput_RequestSyntax) **   <a name="bedrock-UpdateProvisionedModelThroughput-request-desiredModelId"></a>
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) **   <a name="bedrock-UpdateProvisionedModelThroughput-request-desiredProvisionedModelName"></a>
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
<a name="API_UpdateProvisionedModelThroughput_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_UpdateProvisionedModelThroughput_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UpdateProvisionedModelThroughput_Errors"></a>

For information about 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
<a name="API_UpdateProvisionedModelThroughput_SeeAlso"></a>

For more information about using this API 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
<a name="API_Operations_Agents_for_Amazon_Bedrock"></a>

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
<a name="API_agent_AssociateAgentCollaborator"></a>

Makes an agent a collaborator for another agent.

## Request Syntax
<a name="API_agent_AssociateAgentCollaborator_RequestSyntax"></a>

```
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
<a name="API_agent_AssociateAgentCollaborator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_AssociateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_AssociateAgentCollaborator-request-uri-agentId"></a>
The agent's ID.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentVersion](#API_agent_AssociateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_AssociateAgentCollaborator-request-uri-agentVersion"></a>
An agent version.  
Length Constraints: Fixed length of 5.  
Pattern: `DRAFT`   
Required: Yes

## Request Body
<a name="API_agent_AssociateAgentCollaborator_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [agentDescriptor](#API_agent_AssociateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_AssociateAgentCollaborator-request-agentDescriptor"></a>
The alias of the collaborator agent.  
Type: [AgentDescriptor](API_agent_AgentDescriptor.md) object  
Required: Yes

 ** [clientToken](#API_agent_AssociateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_AssociateAgentCollaborator-request-clientToken"></a>
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) **   <a name="bedrock-agent_AssociateAgentCollaborator-request-collaborationInstruction"></a>
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="bedrock-agent_AssociateAgentCollaborator-request-collaboratorName"></a>
A name for the collaborator.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [relayConversationHistory](#API_agent_AssociateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_AssociateAgentCollaborator-request-relayConversationHistory"></a>
A relay conversation history for the collaborator.  
Type: String  
Valid Values: `TO_COLLABORATOR | DISABLED`   
Required: No

## Response Syntax
<a name="API_agent_AssociateAgentCollaborator_ResponseSyntax"></a>

```
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
<a name="API_agent_AssociateAgentCollaborator_ResponseElements"></a>

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) **   <a name="bedrock-agent_AssociateAgentCollaborator-response-agentCollaborator"></a>
Details about the collaborator.  
Type: [AgentCollaborator](API_agent_AgentCollaborator.md) object

## Errors
<a name="API_agent_AssociateAgentCollaborator_Errors"></a>

For information about 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
<a name="API_agent_AssociateAgentCollaborator_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_AssociateAgentKnowledgeBase"></a>

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
<a name="API_agent_AssociateAgentKnowledgeBase_RequestSyntax"></a>

```
PUT /agents/agentId/agentversions/agentVersion/knowledgebases/ HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "knowledgeBaseId": "string",
   "knowledgeBaseState": "string"
}
```

## URI Request Parameters
<a name="API_agent_AssociateAgentKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_AssociateAgentKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_AssociateAgentKnowledgeBase-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_AssociateAgentKnowledgeBase-request-uri-agentVersion"></a>
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
<a name="API_agent_AssociateAgentKnowledgeBase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_agent_AssociateAgentKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_AssociateAgentKnowledgeBase-request-description"></a>
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) **   <a name="bedrock-agent_AssociateAgentKnowledgeBase-request-knowledgeBaseId"></a>
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) **   <a name="bedrock-agent_AssociateAgentKnowledgeBase-request-knowledgeBaseState"></a>
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
<a name="API_agent_AssociateAgentKnowledgeBase_ResponseSyntax"></a>

```
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
<a name="API_agent_AssociateAgentKnowledgeBase_ResponseElements"></a>

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) **   <a name="bedrock-agent_AssociateAgentKnowledgeBase-response-agentKnowledgeBase"></a>
Contains details about the knowledge base that has been associated with the agent.  
Type: [AgentKnowledgeBase](API_agent_AgentKnowledgeBase.md) object

## Errors
<a name="API_agent_AssociateAgentKnowledgeBase_Errors"></a>

For information about 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
<a name="API_agent_AssociateAgentKnowledgeBase_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreateAgent"></a>

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
<a name="API_agent_CreateAgent_RequestSyntax"></a>

```
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
<a name="API_agent_CreateAgent_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent_CreateAgent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [agentCollaboration](#API_agent_CreateAgent_RequestSyntax) **   <a name="bedrock-agent_CreateAgent-request-agentCollaboration"></a>
The agent's collaboration role.  
Type: String  
Valid Values: `SUPERVISOR | SUPERVISOR_ROUTER | DISABLED`   
Required: No

 ** [agentName](#API_agent_CreateAgent_RequestSyntax) **   <a name="bedrock-agent_CreateAgent-request-agentName"></a>
A name for the agent that you create.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [agentResourceRoleArn](#API_agent_CreateAgent_RequestSyntax) **   <a name="bedrock-agent_CreateAgent-request-agentResourceRoleArn"></a>
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 name="bedrock-agent_CreateAgent-request-clientToken"></a>
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) **   <a name="bedrock-agent_CreateAgent-request-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_CreateAgent-request-customOrchestration"></a>
 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 name="bedrock-agent_CreateAgent-request-description"></a>
A description of the agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [foundationModel](#API_agent_CreateAgent_RequestSyntax) **   <a name="bedrock-agent_CreateAgent-request-foundationModel"></a>
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) **   <a name="bedrock-agent_CreateAgent-request-guardrailConfiguration"></a>
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) **   <a name="bedrock-agent_CreateAgent-request-idleSessionTTLInSeconds"></a>
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) **   <a name="bedrock-agent_CreateAgent-request-instruction"></a>
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) **   <a name="bedrock-agent_CreateAgent-request-memoryConfiguration"></a>
 Contains the details of the memory configured for the agent.  
Type: [MemoryConfiguration](API_agent_MemoryConfiguration.md) object  
Required: No

 ** [orchestrationType](#API_agent_CreateAgent_RequestSyntax) **   <a name="bedrock-agent_CreateAgent-request-orchestrationType"></a>
 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) **   <a name="bedrock-agent_CreateAgent-request-promptOverrideConfiguration"></a>
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) **   <a name="bedrock-agent_CreateAgent-request-tags"></a>
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
<a name="API_agent_CreateAgent_ResponseSyntax"></a>

```
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
<a name="API_agent_CreateAgent_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreateAgent-response-agent"></a>
Contains details about the agent created.  
Type: [Agent](API_agent_Agent.md) object

## Errors
<a name="API_agent_CreateAgent_Errors"></a>

For information about 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
<a name="API_agent_CreateAgent_Examples"></a>

### Example request
<a name="API_agent_CreateAgent_Example_1"></a>

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
<a name="API_agent_CreateAgent_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreateAgentActionGroup"></a>

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
<a name="API_agent_CreateAgentActionGroup_RequestSyntax"></a>

```
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
<a name="API_agent_CreateAgentActionGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_CreateAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_CreateAgentActionGroup-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_CreateAgentActionGroup-request-uri-agentVersion"></a>
The version of the agent for which to create the action group.  
Length Constraints: Fixed length of 5.  
Pattern: `DRAFT`   
Required: Yes

## Request Body
<a name="API_agent_CreateAgentActionGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actionGroupExecutor](#API_agent_CreateAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_CreateAgentActionGroup-request-actionGroupExecutor"></a>
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) **   <a name="bedrock-agent_CreateAgentActionGroup-request-actionGroupName"></a>
The name to give the action group.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [actionGroupState](#API_agent_CreateAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_CreateAgentActionGroup-request-actionGroupState"></a>
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) **   <a name="bedrock-agent_CreateAgentActionGroup-request-apiSchema"></a>
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 name="bedrock-agent_CreateAgentActionGroup-request-clientToken"></a>
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 name="bedrock-agent_CreateAgentActionGroup-request-description"></a>
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) **   <a name="bedrock-agent_CreateAgentActionGroup-request-functionSchema"></a>
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) **   <a name="bedrock-agent_CreateAgentActionGroup-request-parentActionGroupSignature"></a>
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) **   <a name="bedrock-agent_CreateAgentActionGroup-request-parentActionGroupSignatureParams"></a>
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
<a name="API_agent_CreateAgentActionGroup_ResponseSyntax"></a>

```
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
<a name="API_agent_CreateAgentActionGroup_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreateAgentActionGroup-response-agentActionGroup"></a>
Contains details about the action group that was created.  
Type: [AgentActionGroup](API_agent_AgentActionGroup.md) object

## Errors
<a name="API_agent_CreateAgentActionGroup_Errors"></a>

For information about 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
<a name="API_agent_CreateAgentActionGroup_Examples"></a>

### Create an action group using an OpenAPI schema and a Lambda function
<a name="API_agent_CreateAgentActionGroup_Example_1"></a>

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
<a name="API_agent_CreateAgentActionGroup_Example_2"></a>

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
<a name="API_agent_CreateAgentActionGroup_Example_3"></a>

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
<a name="API_agent_CreateAgentActionGroup_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreateAgentAlias"></a>

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

## Request Syntax
<a name="API_agent_CreateAgentAlias_RequestSyntax"></a>

```
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
<a name="API_agent_CreateAgentAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_CreateAgentAlias_RequestSyntax) **   <a name="bedrock-agent_CreateAgentAlias-request-uri-agentId"></a>
The unique identifier of the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_CreateAgentAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [agentAliasName](#API_agent_CreateAgentAlias_RequestSyntax) **   <a name="bedrock-agent_CreateAgentAlias-request-agentAliasName"></a>
The name of the alias.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [clientToken](#API_agent_CreateAgentAlias_RequestSyntax) **   <a name="bedrock-agent_CreateAgentAlias-request-clientToken"></a>
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 name="bedrock-agent_CreateAgentAlias-request-description"></a>
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) **   <a name="bedrock-agent_CreateAgentAlias-request-routingConfiguration"></a>
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) **   <a name="bedrock-agent_CreateAgentAlias-request-tags"></a>
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
<a name="API_agent_CreateAgentAlias_ResponseSyntax"></a>

```
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
<a name="API_agent_CreateAgentAlias_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreateAgentAlias-response-agentAlias"></a>
Contains details about the alias that was created.  
Type: [AgentAlias](API_agent_AgentAlias.md) object

## Errors
<a name="API_agent_CreateAgentAlias_Errors"></a>

For information about 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
<a name="API_agent_CreateAgentAlias_Examples"></a>

### Example request
<a name="API_agent_CreateAgentAlias_Example_1"></a>

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
<a name="API_agent_CreateAgentAlias_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreateDataSource"></a>

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
<a name="API_agent_CreateDataSource_RequestSyntax"></a>

```
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
<a name="API_agent_CreateDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_agent_CreateDataSource_RequestSyntax) **   <a name="bedrock-agent_CreateDataSource-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base to which to add the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_CreateDataSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_CreateDataSource_RequestSyntax) **   <a name="bedrock-agent_CreateDataSource-request-clientToken"></a>
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) **   <a name="bedrock-agent_CreateDataSource-request-dataDeletionPolicy"></a>
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) **   <a name="bedrock-agent_CreateDataSource-request-dataSourceConfiguration"></a>
The connection configuration for the data source.  
Type: [DataSourceConfiguration](API_agent_DataSourceConfiguration.md) object  
Required: Yes

 ** [description](#API_agent_CreateDataSource_RequestSyntax) **   <a name="bedrock-agent_CreateDataSource-request-description"></a>
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) **   <a name="bedrock-agent_CreateDataSource-request-name"></a>
The name of the data source.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [serverSideEncryptionConfiguration](#API_agent_CreateDataSource_RequestSyntax) **   <a name="bedrock-agent_CreateDataSource-request-serverSideEncryptionConfiguration"></a>
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) **   <a name="bedrock-agent_CreateDataSource-request-vectorIngestionConfiguration"></a>
Contains details about how to ingest the documents in the data source.  
Type: [VectorIngestionConfiguration](API_agent_VectorIngestionConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_agent_CreateDataSource_ResponseSyntax"></a>

```
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
<a name="API_agent_CreateDataSource_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreateDataSource-response-dataSource"></a>
Contains details about the data source.  
Type: [DataSource](API_agent_DataSource.md) object

## Errors
<a name="API_agent_CreateDataSource_Errors"></a>

For information about 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
<a name="API_agent_CreateDataSource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreateFlow"></a>

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
<a name="API_agent_CreateFlow_RequestSyntax"></a>

```
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
<a name="API_agent_CreateFlow_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent_CreateFlow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_CreateFlow_RequestSyntax) **   <a name="bedrock-agent_CreateFlow-request-clientToken"></a>
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) **   <a name="bedrock-agent_CreateFlow-request-customerEncryptionKeyArn"></a>
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 name="bedrock-agent_CreateFlow-request-definition"></a>
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 name="bedrock-agent_CreateFlow-request-description"></a>
A description for the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [executionRoleArn](#API_agent_CreateFlow_RequestSyntax) **   <a name="bedrock-agent_CreateFlow-request-executionRoleArn"></a>
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="bedrock-agent_CreateFlow-request-name"></a>
A name for the flow.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [tags](#API_agent_CreateFlow_RequestSyntax) **   <a name="bedrock-agent_CreateFlow-request-tags"></a>
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
<a name="API_agent_CreateFlow_ResponseSyntax"></a>

```
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
<a name="API_agent_CreateFlow_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreateFlow-response-arn"></a>
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) **   <a name="bedrock-agent_CreateFlow-response-createdAt"></a>
The time at which the flow was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_CreateFlow_ResponseSyntax) **   <a name="bedrock-agent_CreateFlow-response-customerEncryptionKeyArn"></a>
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 name="bedrock-agent_CreateFlow-response-definition"></a>
A definition of the nodes and connections between nodes in the flow.  
Type: [FlowDefinition](API_agent_FlowDefinition.md) object

 ** [description](#API_agent_CreateFlow_ResponseSyntax) **   <a name="bedrock-agent_CreateFlow-response-description"></a>
The description of the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [executionRoleArn](#API_agent_CreateFlow_ResponseSyntax) **   <a name="bedrock-agent_CreateFlow-response-executionRoleArn"></a>
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) **   <a name="bedrock-agent_CreateFlow-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_CreateFlow_ResponseSyntax) **   <a name="bedrock-agent_CreateFlow-response-name"></a>
The name of the flow.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [status](#API_agent_CreateFlow_ResponseSyntax) **   <a name="bedrock-agent_CreateFlow-response-status"></a>
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) **   <a name="bedrock-agent_CreateFlow-response-updatedAt"></a>
The time at which the flow was last updated.  
Type: Timestamp

 ** [version](#API_agent_CreateFlow_ResponseSyntax) **   <a name="bedrock-agent_CreateFlow-response-version"></a>
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
<a name="API_agent_CreateFlow_Errors"></a>

For information about 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
<a name="API_agent_CreateFlow_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreateFlowAlias"></a>

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
<a name="API_agent_CreateFlowAlias_RequestSyntax"></a>

```
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
<a name="API_agent_CreateFlowAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_CreateFlowAlias_RequestSyntax) **   <a name="bedrock-agent_CreateFlowAlias-request-uri-flowIdentifier"></a>
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
<a name="API_agent_CreateFlowAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_CreateFlowAlias_RequestSyntax) **   <a name="bedrock-agent_CreateFlowAlias-request-clientToken"></a>
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) **   <a name="bedrock-agent_CreateFlowAlias-request-concurrencyConfiguration"></a>
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 name="bedrock-agent_CreateFlowAlias-request-description"></a>
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="bedrock-agent_CreateFlowAlias-request-name"></a>
A name for the alias.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [routingConfiguration](#API_agent_CreateFlowAlias_RequestSyntax) **   <a name="bedrock-agent_CreateFlowAlias-request-routingConfiguration"></a>
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) **   <a name="bedrock-agent_CreateFlowAlias-request-tags"></a>
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
<a name="API_agent_CreateFlowAlias_ResponseSyntax"></a>

```
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
<a name="API_agent_CreateFlowAlias_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreateFlowAlias-response-arn"></a>
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) **   <a name="bedrock-agent_CreateFlowAlias-response-concurrencyConfiguration"></a>
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) **   <a name="bedrock-agent_CreateFlowAlias-response-createdAt"></a>
The time at which the alias was created.  
Type: Timestamp

 ** [description](#API_agent_CreateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowAlias-response-description"></a>
The description of the alias.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [flowId](#API_agent_CreateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowAlias-response-flowId"></a>
The unique identifier of the flow that the alias belongs to.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [id](#API_agent_CreateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowAlias-response-id"></a>
The unique identifier of the alias.  
Type: String  
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})` 

 ** [name](#API_agent_CreateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowAlias-response-name"></a>
The name of the alias.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [routingConfiguration](#API_agent_CreateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowAlias-response-routingConfiguration"></a>
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) **   <a name="bedrock-agent_CreateFlowAlias-response-updatedAt"></a>
The time at which the alias of the flow was last updated.  
Type: Timestamp

## Errors
<a name="API_agent_CreateFlowAlias_Errors"></a>

For information about 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
<a name="API_agent_CreateFlowAlias_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreateFlowVersion"></a>

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
<a name="API_agent_CreateFlowVersion_RequestSyntax"></a>

```
POST /flows/flowIdentifier/versions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string"
}
```

## URI Request Parameters
<a name="API_agent_CreateFlowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_CreateFlowVersion_RequestSyntax) **   <a name="bedrock-agent_CreateFlowVersion-request-uri-flowIdentifier"></a>
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
<a name="API_agent_CreateFlowVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_CreateFlowVersion_RequestSyntax) **   <a name="bedrock-agent_CreateFlowVersion-request-clientToken"></a>
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 name="bedrock-agent_CreateFlowVersion-request-description"></a>
A description of the version of the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

## Response Syntax
<a name="API_agent_CreateFlowVersion_ResponseSyntax"></a>

```
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
<a name="API_agent_CreateFlowVersion_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreateFlowVersion-response-arn"></a>
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) **   <a name="bedrock-agent_CreateFlowVersion-response-createdAt"></a>
The time at which the flow was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_CreateFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowVersion-response-customerEncryptionKeyArn"></a>
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 name="bedrock-agent_CreateFlowVersion-response-definition"></a>
A definition of the nodes and connections in the flow.  
Type: [FlowDefinition](API_agent_FlowDefinition.md) object

 ** [description](#API_agent_CreateFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowVersion-response-description"></a>
The description of the version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [executionRoleArn](#API_agent_CreateFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowVersion-response-executionRoleArn"></a>
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) **   <a name="bedrock-agent_CreateFlowVersion-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_CreateFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowVersion-response-name"></a>
The name of the version.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [status](#API_agent_CreateFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowVersion-response-status"></a>
The status of the flow.  
Type: String  
Valid Values: `Failed | Prepared | Preparing | NotPrepared` 

 ** [version](#API_agent_CreateFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_CreateFlowVersion-response-version"></a>
The version of the flow that was created. Versions are numbered incrementally, starting from 1.  
Type: String  
Pattern: `[0-9]{1,5}` 

## Errors
<a name="API_agent_CreateFlowVersion_Errors"></a>

For information about 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
<a name="API_agent_CreateFlowVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreateKnowledgeBase"></a>

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
<a name="API_agent_CreateKnowledgeBase_RequestSyntax"></a>

```
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
<a name="API_agent_CreateKnowledgeBase_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent_CreateKnowledgeBase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_CreateKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_CreateKnowledgeBase-request-clientToken"></a>
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 name="bedrock-agent_CreateKnowledgeBase-request-description"></a>
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) **   <a name="bedrock-agent_CreateKnowledgeBase-request-knowledgeBaseConfiguration"></a>
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="bedrock-agent_CreateKnowledgeBase-request-name"></a>
A name for the knowledge base.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [roleArn](#API_agent_CreateKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_CreateKnowledgeBase-request-roleArn"></a>
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) **   <a name="bedrock-agent_CreateKnowledgeBase-request-storageConfiguration"></a>
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) **   <a name="bedrock-agent_CreateKnowledgeBase-request-tags"></a>
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
<a name="API_agent_CreateKnowledgeBase_ResponseSyntax"></a>

```
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
<a name="API_agent_CreateKnowledgeBase_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreateKnowledgeBase-response-knowledgeBase"></a>
Contains details about the knowledge base.  
Type: [KnowledgeBase](API_agent_KnowledgeBase.md) object

## Errors
<a name="API_agent_CreateKnowledgeBase_Errors"></a>

For information about 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
<a name="API_agent_CreateKnowledgeBase_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreatePrompt"></a>

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
<a name="API_agent_CreatePrompt_RequestSyntax"></a>

```
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
<a name="API_agent_CreatePrompt_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent_CreatePrompt_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_CreatePrompt_RequestSyntax) **   <a name="bedrock-agent_CreatePrompt-request-clientToken"></a>
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) **   <a name="bedrock-agent_CreatePrompt-request-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_CreatePrompt-request-defaultVariant"></a>
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 name="bedrock-agent_CreatePrompt-request-description"></a>
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="bedrock-agent_CreatePrompt-request-name"></a>
A name for the prompt.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [tags](#API_agent_CreatePrompt_RequestSyntax) **   <a name="bedrock-agent_CreatePrompt-request-tags"></a>
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 name="bedrock-agent_CreatePrompt-request-variants"></a>
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
<a name="API_agent_CreatePrompt_ResponseSyntax"></a>

```
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
<a name="API_agent_CreatePrompt_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreatePrompt-response-arn"></a>
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) **   <a name="bedrock-agent_CreatePrompt-response-createdAt"></a>
The time at which the prompt was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_CreatePrompt_ResponseSyntax) **   <a name="bedrock-agent_CreatePrompt-response-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_CreatePrompt-response-defaultVariant"></a>
The name of the default variant for your prompt.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [description](#API_agent_CreatePrompt_ResponseSyntax) **   <a name="bedrock-agent_CreatePrompt-response-description"></a>
The description of the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [id](#API_agent_CreatePrompt_ResponseSyntax) **   <a name="bedrock-agent_CreatePrompt-response-id"></a>
The unique identifier of the prompt.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_CreatePrompt_ResponseSyntax) **   <a name="bedrock-agent_CreatePrompt-response-name"></a>
The name of the prompt.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [updatedAt](#API_agent_CreatePrompt_ResponseSyntax) **   <a name="bedrock-agent_CreatePrompt-response-updatedAt"></a>
The time at which the prompt was last updated.  
Type: Timestamp

 ** [variants](#API_agent_CreatePrompt_ResponseSyntax) **   <a name="bedrock-agent_CreatePrompt-response-variants"></a>
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) **   <a name="bedrock-agent_CreatePrompt-response-version"></a>
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
<a name="API_agent_CreatePrompt_Errors"></a>

For information about 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
<a name="API_agent_CreatePrompt_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_CreatePromptVersion"></a>

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
<a name="API_agent_CreatePromptVersion_RequestSyntax"></a>

```
POST /prompts/promptIdentifier/versions HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_agent_CreatePromptVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [promptIdentifier](#API_agent_CreatePromptVersion_RequestSyntax) **   <a name="bedrock-agent_CreatePromptVersion-request-uri-promptIdentifier"></a>
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
<a name="API_agent_CreatePromptVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_CreatePromptVersion_RequestSyntax) **   <a name="bedrock-agent_CreatePromptVersion-request-clientToken"></a>
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 name="bedrock-agent_CreatePromptVersion-request-description"></a>
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) **   <a name="bedrock-agent_CreatePromptVersion-request-tags"></a>
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
<a name="API_agent_CreatePromptVersion_ResponseSyntax"></a>

```
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
<a name="API_agent_CreatePromptVersion_ResponseElements"></a>

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) **   <a name="bedrock-agent_CreatePromptVersion-response-arn"></a>
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) **   <a name="bedrock-agent_CreatePromptVersion-response-createdAt"></a>
The time at which the prompt was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_CreatePromptVersion_ResponseSyntax) **   <a name="bedrock-agent_CreatePromptVersion-response-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_CreatePromptVersion-response-defaultVariant"></a>
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 name="bedrock-agent_CreatePromptVersion-response-description"></a>
A description for the version.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [id](#API_agent_CreatePromptVersion_ResponseSyntax) **   <a name="bedrock-agent_CreatePromptVersion-response-id"></a>
The unique identifier of the prompt.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_CreatePromptVersion_ResponseSyntax) **   <a name="bedrock-agent_CreatePromptVersion-response-name"></a>
The name of the prompt.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [updatedAt](#API_agent_CreatePromptVersion_ResponseSyntax) **   <a name="bedrock-agent_CreatePromptVersion-response-updatedAt"></a>
The time at which the prompt was last updated.  
Type: Timestamp

 ** [variants](#API_agent_CreatePromptVersion_ResponseSyntax) **   <a name="bedrock-agent_CreatePromptVersion-response-variants"></a>
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) **   <a name="bedrock-agent_CreatePromptVersion-response-version"></a>
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
<a name="API_agent_CreatePromptVersion_Errors"></a>

For information about 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
<a name="API_agent_CreatePromptVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteAgent"></a>

Deletes an agent.

## Request Syntax
<a name="API_agent_DeleteAgent_RequestSyntax"></a>

```
DELETE /agents/agentId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_DeleteAgent_RequestSyntax) **   <a name="bedrock-agent_DeleteAgent-request-uri-agentId"></a>
The unique identifier of the agent to delete.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [skipResourceInUseCheck](#API_agent_DeleteAgent_RequestSyntax) **   <a name="bedrock-agent_DeleteAgent-request-uri-skipResourceInUseCheck"></a>
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
<a name="API_agent_DeleteAgent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteAgent_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "agentId": "string",
   "agentStatus": "string"
}
```

## Response Elements
<a name="API_agent_DeleteAgent_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeleteAgent-response-agentId"></a>
The unique identifier of the agent that was deleted.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [agentStatus](#API_agent_DeleteAgent_ResponseSyntax) **   <a name="bedrock-agent_DeleteAgent-response-agentStatus"></a>
The status of the agent.  
Type: String  
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING` 

## Errors
<a name="API_agent_DeleteAgent_Errors"></a>

For information about 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
<a name="API_agent_DeleteAgent_Examples"></a>

### Example request
<a name="API_agent_DeleteAgent_Example_1"></a>

This example illustrates one usage of DeleteAgent.

```
DELETE /agents/ABCDEFGHIJ/ HTTP/1.1
```

## See Also
<a name="API_agent_DeleteAgent_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteAgentActionGroup"></a>

Deletes an action group in an agent.

## Request Syntax
<a name="API_agent_DeleteAgentActionGroup_RequestSyntax"></a>

```
DELETE /agents/agentId/agentversions/agentVersion/actiongroups/actionGroupId/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteAgentActionGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [actionGroupId](#API_agent_DeleteAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_DeleteAgentActionGroup-request-uri-actionGroupId"></a>
The unique identifier of the action group to delete.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentId](#API_agent_DeleteAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_DeleteAgentActionGroup-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_DeleteAgentActionGroup-request-uri-agentVersion"></a>
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) **   <a name="bedrock-agent_DeleteAgentActionGroup-request-uri-skipResourceInUseCheck"></a>
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
<a name="API_agent_DeleteAgentActionGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteAgentActionGroup_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_agent_DeleteAgentActionGroup_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_agent_DeleteAgentActionGroup_Errors"></a>

For information about 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
<a name="API_agent_DeleteAgentActionGroup_Examples"></a>

### Example request
<a name="API_agent_DeleteAgentActionGroup_Example_1"></a>

This example illustrates one usage of DeleteAgentActionGroup.

```
DELETE /agents/ABCDEFGHIJ/agentversions/1/actiongroups/ABCDEFGHIJ/ HTTP/1.1
```

## See Also
<a name="API_agent_DeleteAgentActionGroup_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteAgentAlias"></a>

Deletes an alias of an agent.

## Request Syntax
<a name="API_agent_DeleteAgentAlias_RequestSyntax"></a>

```
DELETE /agents/agentId/agentaliases/agentAliasId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteAgentAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentAliasId](#API_agent_DeleteAgentAlias_RequestSyntax) **   <a name="bedrock-agent_DeleteAgentAlias-request-uri-agentAliasId"></a>
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) **   <a name="bedrock-agent_DeleteAgentAlias-request-uri-agentId"></a>
The unique identifier of the agent that the alias belongs to.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_DeleteAgentAlias_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteAgentAlias_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "agentAliasId": "string",
   "agentAliasStatus": "string",
   "agentId": "string"
}
```

## Response Elements
<a name="API_agent_DeleteAgentAlias_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeleteAgentAlias-response-agentAliasId"></a>
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) **   <a name="bedrock-agent_DeleteAgentAlias-response-agentAliasStatus"></a>
The status of the alias.  
Type: String  
Valid Values: `CREATING | PREPARED | FAILED | UPDATING | DELETING | DISSOCIATED` 

 ** [agentId](#API_agent_DeleteAgentAlias_ResponseSyntax) **   <a name="bedrock-agent_DeleteAgentAlias-response-agentId"></a>
The unique identifier of the agent that the alias belongs to.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

## Errors
<a name="API_agent_DeleteAgentAlias_Errors"></a>

For information about 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
<a name="API_agent_DeleteAgentAlias_Examples"></a>

### Example request
<a name="API_agent_DeleteAgentAlias_Example_1"></a>

This example illustrates one usage of DeleteAgentAlias.

```
DELETE /agents/ABCDEFGHIJ/agentaliases/ABCDEFGHIJ/ HTTP/1.1
```

## See Also
<a name="API_agent_DeleteAgentAlias_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteAgentVersion"></a>

Deletes a version of an agent.

## Request Syntax
<a name="API_agent_DeleteAgentVersion_RequestSyntax"></a>

```
DELETE /agents/agentId/agentversions/agentVersion/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteAgentVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_DeleteAgentVersion_RequestSyntax) **   <a name="bedrock-agent_DeleteAgentVersion-request-uri-agentId"></a>
The unique identifier of the agent that the version belongs to.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentVersion](#API_agent_DeleteAgentVersion_RequestSyntax) **   <a name="bedrock-agent_DeleteAgentVersion-request-uri-agentVersion"></a>
The version of the agent to delete.  
Pattern: `[0-9]{1,5}`   
Required: Yes

 ** [skipResourceInUseCheck](#API_agent_DeleteAgentVersion_RequestSyntax) **   <a name="bedrock-agent_DeleteAgentVersion-request-uri-skipResourceInUseCheck"></a>
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
<a name="API_agent_DeleteAgentVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteAgentVersion_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "agentId": "string",
   "agentStatus": "string",
   "agentVersion": "string"
}
```

## Response Elements
<a name="API_agent_DeleteAgentVersion_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeleteAgentVersion-response-agentId"></a>
The unique identifier of the agent that the version belongs to.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [agentStatus](#API_agent_DeleteAgentVersion_ResponseSyntax) **   <a name="bedrock-agent_DeleteAgentVersion-response-agentStatus"></a>
The status of the agent version.  
Type: String  
Valid Values: `CREATING | PREPARING | PREPARED | NOT_PREPARED | DELETING | FAILED | VERSIONING | UPDATING` 

 ** [agentVersion](#API_agent_DeleteAgentVersion_ResponseSyntax) **   <a name="bedrock-agent_DeleteAgentVersion-response-agentVersion"></a>
The version that was deleted.  
Type: String  
Pattern: `[0-9]{1,5}` 

## Errors
<a name="API_agent_DeleteAgentVersion_Errors"></a>

For information about 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
<a name="API_agent_DeleteAgentVersion_Examples"></a>

### Example request
<a name="API_agent_DeleteAgentVersion_Example_1"></a>

This example illustrates one usage of DeleteAgentVersion.

```
DELETE /agents/ABCDEFGHIJ/agentversions/1/?skipResourceInUseCheck=true HTTP/1.1
```

## See Also
<a name="API_agent_DeleteAgentVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteDataSource"></a>

Deletes a data source from a knowledge base.

## Request Syntax
<a name="API_agent_DeleteDataSource_RequestSyntax"></a>

```
DELETE /knowledgebases/knowledgeBaseId/datasources/dataSourceId HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_DeleteDataSource_RequestSyntax) **   <a name="bedrock-agent_DeleteDataSource-request-uri-dataSourceId"></a>
The unique identifier of the data source to delete.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [knowledgeBaseId](#API_agent_DeleteDataSource_RequestSyntax) **   <a name="bedrock-agent_DeleteDataSource-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base from which to delete the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_DeleteDataSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteDataSource_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "dataSourceId": "string",
   "knowledgeBaseId": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_agent_DeleteDataSource_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeleteDataSource-response-dataSourceId"></a>
The unique identifier of the data source that was deleted.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [knowledgeBaseId](#API_agent_DeleteDataSource_ResponseSyntax) **   <a name="bedrock-agent_DeleteDataSource-response-knowledgeBaseId"></a>
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) **   <a name="bedrock-agent_DeleteDataSource-response-status"></a>
The status of the data source.  
Type: String  
Valid Values: `AVAILABLE | DELETING | DELETE_UNSUCCESSFUL` 

## Errors
<a name="API_agent_DeleteDataSource_Errors"></a>

For information about 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
<a name="API_agent_DeleteDataSource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteFlow"></a>

Deletes a flow.

## Request Syntax
<a name="API_agent_DeleteFlow_RequestSyntax"></a>

```
DELETE /flows/flowIdentifier/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_DeleteFlow_RequestSyntax) **   <a name="bedrock-agent_DeleteFlow-request-uri-flowIdentifier"></a>
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) **   <a name="bedrock-agent_DeleteFlow-request-uri-skipResourceInUseCheck"></a>
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
<a name="API_agent_DeleteFlow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteFlow_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string"
}
```

## Response Elements
<a name="API_agent_DeleteFlow_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeleteFlow-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

## Errors
<a name="API_agent_DeleteFlow_Errors"></a>

For information about 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
<a name="API_agent_DeleteFlow_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteFlowAlias"></a>

Deletes an alias of a flow.

## Request Syntax
<a name="API_agent_DeleteFlowAlias_RequestSyntax"></a>

```
DELETE /flows/flowIdentifier/aliases/aliasIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteFlowAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aliasIdentifier](#API_agent_DeleteFlowAlias_RequestSyntax) **   <a name="bedrock-agent_DeleteFlowAlias-request-uri-aliasIdentifier"></a>
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) **   <a name="bedrock-agent_DeleteFlowAlias-request-uri-flowIdentifier"></a>
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
<a name="API_agent_DeleteFlowAlias_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteFlowAlias_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "flowId": "string",
   "id": "string"
}
```

## Response Elements
<a name="API_agent_DeleteFlowAlias_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeleteFlowAlias-response-flowId"></a>
The unique identifier of the flow that the alias belongs to.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [id](#API_agent_DeleteFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_DeleteFlowAlias-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})` 

## Errors
<a name="API_agent_DeleteFlowAlias_Errors"></a>

For information about 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
<a name="API_agent_DeleteFlowAlias_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteFlowVersion"></a>

Deletes a version of a flow.

## Request Syntax
<a name="API_agent_DeleteFlowVersion_RequestSyntax"></a>

```
DELETE /flows/flowIdentifier/versions/flowVersion/?skipResourceInUseCheck=skipResourceInUseCheck HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteFlowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_DeleteFlowVersion_RequestSyntax) **   <a name="bedrock-agent_DeleteFlowVersion-request-uri-flowIdentifier"></a>
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) **   <a name="bedrock-agent_DeleteFlowVersion-request-uri-flowVersion"></a>
The version of the flow that you want to delete.  
Pattern: `[0-9]{1,5}`   
Required: Yes

 ** [skipResourceInUseCheck](#API_agent_DeleteFlowVersion_RequestSyntax) **   <a name="bedrock-agent_DeleteFlowVersion-request-uri-skipResourceInUseCheck"></a>
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
<a name="API_agent_DeleteFlowVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteFlowVersion_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_agent_DeleteFlowVersion_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeleteFlowVersion-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [version](#API_agent_DeleteFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_DeleteFlowVersion-response-version"></a>
The version of the flow being deleted.  
Type: String  
Pattern: `[0-9]{1,5}` 

## Errors
<a name="API_agent_DeleteFlowVersion_Errors"></a>

For information about 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
<a name="API_agent_DeleteFlowVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteKnowledgeBase"></a>

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
<a name="API_agent_DeleteKnowledgeBase_RequestSyntax"></a>

```
DELETE /knowledgebases/knowledgeBaseId HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeleteKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_agent_DeleteKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_DeleteKnowledgeBase-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base to delete.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_DeleteKnowledgeBase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeleteKnowledgeBase_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "knowledgeBaseId": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_agent_DeleteKnowledgeBase_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeleteKnowledgeBase-response-knowledgeBaseId"></a>
The unique identifier of the knowledge base that was deleted.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [status](#API_agent_DeleteKnowledgeBase_ResponseSyntax) **   <a name="bedrock-agent_DeleteKnowledgeBase-response-status"></a>
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
<a name="API_agent_DeleteKnowledgeBase_Errors"></a>

For information about 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
<a name="API_agent_DeleteKnowledgeBase_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeleteKnowledgeBaseDocuments"></a>

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
<a name="API_agent_DeleteKnowledgeBaseDocuments_RequestSyntax"></a>

```
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
<a name="API_agent_DeleteKnowledgeBaseDocuments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_DeleteKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_DeleteKnowledgeBaseDocuments-request-uri-dataSourceId"></a>
The unique identifier of the data source that contains the documents.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [knowledgeBaseId](#API_agent_DeleteKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_DeleteKnowledgeBaseDocuments-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base that is connected to the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_DeleteKnowledgeBaseDocuments_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_DeleteKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_DeleteKnowledgeBaseDocuments-request-clientToken"></a>
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 name="bedrock-agent_DeleteKnowledgeBaseDocuments-request-documentIdentifiers"></a>
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
<a name="API_agent_DeleteKnowledgeBaseDocuments_ResponseSyntax"></a>

```
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
<a name="API_agent_DeleteKnowledgeBaseDocuments_ResponseElements"></a>

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 name="bedrock-agent_DeleteKnowledgeBaseDocuments-response-documentDetails"></a>
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
<a name="API_agent_DeleteKnowledgeBaseDocuments_Errors"></a>

For information about 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
<a name="API_agent_DeleteKnowledgeBaseDocuments_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DeletePrompt"></a>

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
<a name="API_agent_DeletePrompt_RequestSyntax"></a>

```
DELETE /prompts/promptIdentifier/?promptVersion=promptVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DeletePrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [promptIdentifier](#API_agent_DeletePrompt_RequestSyntax) **   <a name="bedrock-agent_DeletePrompt-request-uri-promptIdentifier"></a>
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) **   <a name="bedrock-agent_DeletePrompt-request-uri-promptVersion"></a>
The version of the prompt to delete. To delete the prompt, omit this field.  
Pattern: `[0-9]{1,5}` 

## Request Body
<a name="API_agent_DeletePrompt_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DeletePrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "id": "string",
   "version": "string"
}
```

## Response Elements
<a name="API_agent_DeletePrompt_ResponseElements"></a>

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) **   <a name="bedrock-agent_DeletePrompt-response-id"></a>
The unique identifier of the prompt that was deleted.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [version](#API_agent_DeletePrompt_ResponseSyntax) **   <a name="bedrock-agent_DeletePrompt-response-version"></a>
The version of the prompt that was deleted.  
Type: String  
Pattern: `[0-9]{1,5}` 

## Errors
<a name="API_agent_DeletePrompt_Errors"></a>

For information about 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
<a name="API_agent_DeletePrompt_Examples"></a>

### Delete a prompt
<a name="API_agent_DeletePrompt_Example_1"></a>

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
<a name="API_agent_DeletePrompt_Example_2"></a>

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
<a name="API_agent_DeletePrompt_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DisassociateAgentCollaborator"></a>

Disassociates an agent collaborator.

## Request Syntax
<a name="API_agent_DisassociateAgentCollaborator_RequestSyntax"></a>

```
DELETE /agents/agentId/agentversions/agentVersion/agentcollaborators/collaboratorId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DisassociateAgentCollaborator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_DisassociateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_DisassociateAgentCollaborator-request-uri-agentId"></a>
An agent ID.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentVersion](#API_agent_DisassociateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_DisassociateAgentCollaborator-request-uri-agentVersion"></a>
The agent's version.  
Length Constraints: Fixed length of 5.  
Pattern: `DRAFT`   
Required: Yes

 ** [collaboratorId](#API_agent_DisassociateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_DisassociateAgentCollaborator-request-uri-collaboratorId"></a>
The collaborator's ID.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_DisassociateAgentCollaborator_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DisassociateAgentCollaborator_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_agent_DisassociateAgentCollaborator_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_agent_DisassociateAgentCollaborator_Errors"></a>

For information about 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
<a name="API_agent_DisassociateAgentCollaborator_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_DisassociateAgentKnowledgeBase"></a>

Disassociates a knowledge base from an agent.

## Request Syntax
<a name="API_agent_DisassociateAgentKnowledgeBase_RequestSyntax"></a>

```
DELETE /agents/agentId/agentversions/agentVersion/knowledgebases/knowledgeBaseId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_DisassociateAgentKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_DisassociateAgentKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_DisassociateAgentKnowledgeBase-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_DisassociateAgentKnowledgeBase-request-uri-agentVersion"></a>
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) **   <a name="bedrock-agent_DisassociateAgentKnowledgeBase-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base to disassociate.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_DisassociateAgentKnowledgeBase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_DisassociateAgentKnowledgeBase_ResponseSyntax"></a>

```
HTTP/1.1 204
```

## Response Elements
<a name="API_agent_DisassociateAgentKnowledgeBase_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

## Errors
<a name="API_agent_DisassociateAgentKnowledgeBase_Errors"></a>

For information about 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
<a name="API_agent_DisassociateAgentKnowledgeBase_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetAgent"></a>

Gets information about an agent.

## Request Syntax
<a name="API_agent_GetAgent_RequestSyntax"></a>

```
GET /agents/agentId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_GetAgent_RequestSyntax) **   <a name="bedrock-agent_GetAgent-request-uri-agentId"></a>
The unique identifier of the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_GetAgent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetAgent_ResponseSyntax"></a>

```
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
<a name="API_agent_GetAgent_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetAgent-response-agent"></a>
Contains details about the agent.  
Type: [Agent](API_agent_Agent.md) object

## Errors
<a name="API_agent_GetAgent_Errors"></a>

For information about 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
<a name="API_agent_GetAgent_Examples"></a>

### Example request
<a name="API_agent_GetAgent_Example_1"></a>

This example illustrates one usage of GetAgent.

```
GET /agents/ABCDEFGHIJ/ HTTP/1.1
```

## See Also
<a name="API_agent_GetAgent_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetAgentActionGroup"></a>

Gets information about an action group for an agent.

## Request Syntax
<a name="API_agent_GetAgentActionGroup_RequestSyntax"></a>

```
GET /agents/agentId/agentversions/agentVersion/actiongroups/actionGroupId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetAgentActionGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [actionGroupId](#API_agent_GetAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_GetAgentActionGroup-request-uri-actionGroupId"></a>
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) **   <a name="bedrock-agent_GetAgentActionGroup-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_GetAgentActionGroup-request-uri-agentVersion"></a>
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
<a name="API_agent_GetAgentActionGroup_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetAgentActionGroup_ResponseSyntax"></a>

```
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
<a name="API_agent_GetAgentActionGroup_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetAgentActionGroup-response-agentActionGroup"></a>
Contains details about the action group.  
Type: [AgentActionGroup](API_agent_AgentActionGroup.md) object

## Errors
<a name="API_agent_GetAgentActionGroup_Errors"></a>

For information about 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
<a name="API_agent_GetAgentActionGroup_Examples"></a>

### Example request
<a name="API_agent_GetAgentActionGroup_Example_1"></a>

This example illustrates one usage of GetAgentActionGroup.

```
GET /agents/AGENT12345/agentversions/1/actiongroups/ACTION1234/ HTTP/1.1
```

## See Also
<a name="API_agent_GetAgentActionGroup_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetAgentAlias"></a>

Gets information about an alias of an agent.

## Request Syntax
<a name="API_agent_GetAgentAlias_RequestSyntax"></a>

```
GET /agents/agentId/agentaliases/agentAliasId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetAgentAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentAliasId](#API_agent_GetAgentAlias_RequestSyntax) **   <a name="bedrock-agent_GetAgentAlias-request-uri-agentAliasId"></a>
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) **   <a name="bedrock-agent_GetAgentAlias-request-uri-agentId"></a>
The unique identifier of the agent to which the alias to get information belongs.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_GetAgentAlias_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetAgentAlias_ResponseSyntax"></a>

```
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
<a name="API_agent_GetAgentAlias_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetAgentAlias-response-agentAlias"></a>
Contains information about the alias.  
Type: [AgentAlias](API_agent_AgentAlias.md) object

## Errors
<a name="API_agent_GetAgentAlias_Errors"></a>

For information about 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
<a name="API_agent_GetAgentAlias_Examples"></a>

### Example request
<a name="API_agent_GetAgentAlias_Example_1"></a>

This example illustrates one usage of GetAgentAlias.

```
GET /agents/ABCDEFGHIJ/agentaliases/ABCDEFGHIJ/ HTTP/1.1
```

## See Also
<a name="API_agent_GetAgentAlias_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetAgentCollaborator"></a>

Retrieves information about an agent's collaborator.

## Request Syntax
<a name="API_agent_GetAgentCollaborator_RequestSyntax"></a>

```
GET /agents/agentId/agentversions/agentVersion/agentcollaborators/collaboratorId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetAgentCollaborator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_GetAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_GetAgentCollaborator-request-uri-agentId"></a>
The agent's ID.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentVersion](#API_agent_GetAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_GetAgentCollaborator-request-uri-agentVersion"></a>
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) **   <a name="bedrock-agent_GetAgentCollaborator-request-uri-collaboratorId"></a>
The collaborator's ID.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_GetAgentCollaborator_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetAgentCollaborator_ResponseSyntax"></a>

```
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
<a name="API_agent_GetAgentCollaborator_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetAgentCollaborator-response-agentCollaborator"></a>
Details about the collaborator.  
Type: [AgentCollaborator](API_agent_AgentCollaborator.md) object

## Errors
<a name="API_agent_GetAgentCollaborator_Errors"></a>

For information about 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
<a name="API_agent_GetAgentCollaborator_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetAgentKnowledgeBase"></a>

Gets information about a knowledge base associated with an agent.

## Request Syntax
<a name="API_agent_GetAgentKnowledgeBase_RequestSyntax"></a>

```
GET /agents/agentId/agentversions/agentVersion/knowledgebases/knowledgeBaseId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetAgentKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_GetAgentKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_GetAgentKnowledgeBase-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_GetAgentKnowledgeBase-request-uri-agentVersion"></a>
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) **   <a name="bedrock-agent_GetAgentKnowledgeBase-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base associated with the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_GetAgentKnowledgeBase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetAgentKnowledgeBase_ResponseSyntax"></a>

```
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
<a name="API_agent_GetAgentKnowledgeBase_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetAgentKnowledgeBase-response-agentKnowledgeBase"></a>
Contains details about a knowledge base attached to an agent.  
Type: [AgentKnowledgeBase](API_agent_AgentKnowledgeBase.md) object

## Errors
<a name="API_agent_GetAgentKnowledgeBase_Errors"></a>

For information about 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
<a name="API_agent_GetAgentKnowledgeBase_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetAgentVersion"></a>

Gets details about a version of an agent.

## Request Syntax
<a name="API_agent_GetAgentVersion_RequestSyntax"></a>

```
GET /agents/agentId/agentversions/agentVersion/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetAgentVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_GetAgentVersion_RequestSyntax) **   <a name="bedrock-agent_GetAgentVersion-request-uri-agentId"></a>
The unique identifier of the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentVersion](#API_agent_GetAgentVersion_RequestSyntax) **   <a name="bedrock-agent_GetAgentVersion-request-uri-agentVersion"></a>
The version of the agent.  
Pattern: `[0-9]{1,5}`   
Required: Yes

## Request Body
<a name="API_agent_GetAgentVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetAgentVersion_ResponseSyntax"></a>

```
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
<a name="API_agent_GetAgentVersion_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetAgentVersion-response-agentVersion"></a>
Contains details about the version of the agent.  
Type: [AgentVersion](API_agent_AgentVersion.md) object

## Errors
<a name="API_agent_GetAgentVersion_Errors"></a>

For information about 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
<a name="API_agent_GetAgentVersion_Examples"></a>

### Example request
<a name="API_agent_GetAgentVersion_Example_1"></a>

This example illustrates one usage of GetAgentVersion.

```
GET /agents/agentId/agentversions/agentVersion/ HTTP/1.1
```

## See Also
<a name="API_agent_GetAgentVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetDataSource"></a>

Gets information about a data source.

## Request Syntax
<a name="API_agent_GetDataSource_RequestSyntax"></a>

```
GET /knowledgebases/knowledgeBaseId/datasources/dataSourceId HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_GetDataSource_RequestSyntax) **   <a name="bedrock-agent_GetDataSource-request-uri-dataSourceId"></a>
The unique identifier of the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [knowledgeBaseId](#API_agent_GetDataSource_RequestSyntax) **   <a name="bedrock-agent_GetDataSource-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base for the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_GetDataSource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetDataSource_ResponseSyntax"></a>

```
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
<a name="API_agent_GetDataSource_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetDataSource-response-dataSource"></a>
Contains details about the data source.  
Type: [DataSource](API_agent_DataSource.md) object

## Errors
<a name="API_agent_GetDataSource_Errors"></a>

For information about 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
<a name="API_agent_GetDataSource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetFlow"></a>

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
<a name="API_agent_GetFlow_RequestSyntax"></a>

```
GET /flows/flowIdentifier/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_GetFlow_RequestSyntax) **   <a name="bedrock-agent_GetFlow-request-uri-flowIdentifier"></a>
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
<a name="API_agent_GetFlow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetFlow_ResponseSyntax"></a>

```
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
<a name="API_agent_GetFlow_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetFlow-response-arn"></a>
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) **   <a name="bedrock-agent_GetFlow-response-createdAt"></a>
The time at which the flow was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_GetFlow_ResponseSyntax) **   <a name="bedrock-agent_GetFlow-response-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_GetFlow-response-definition"></a>
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) **   <a name="bedrock-agent_GetFlow-response-description"></a>
The description of the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [executionRoleArn](#API_agent_GetFlow_ResponseSyntax) **   <a name="bedrock-agent_GetFlow-response-executionRoleArn"></a>
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) **   <a name="bedrock-agent_GetFlow-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_GetFlow_ResponseSyntax) **   <a name="bedrock-agent_GetFlow-response-name"></a>
The name of the flow.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [status](#API_agent_GetFlow_ResponseSyntax) **   <a name="bedrock-agent_GetFlow-response-status"></a>
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) **   <a name="bedrock-agent_GetFlow-response-updatedAt"></a>
The time at which the flow was last updated.  
Type: Timestamp

 ** [validations](#API_agent_GetFlow_ResponseSyntax) **   <a name="bedrock-agent_GetFlow-response-validations"></a>
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) **   <a name="bedrock-agent_GetFlow-response-version"></a>
The version of the flow for which information was retrieved.  
Type: String  
Length Constraints: Fixed length of 5.  
Pattern: `DRAFT` 

## Errors
<a name="API_agent_GetFlow_Errors"></a>

For information about 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
<a name="API_agent_GetFlow_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetFlowAlias"></a>

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
<a name="API_agent_GetFlowAlias_RequestSyntax"></a>

```
GET /flows/flowIdentifier/aliases/aliasIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetFlowAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aliasIdentifier](#API_agent_GetFlowAlias_RequestSyntax) **   <a name="bedrock-agent_GetFlowAlias-request-uri-aliasIdentifier"></a>
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) **   <a name="bedrock-agent_GetFlowAlias-request-uri-flowIdentifier"></a>
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
<a name="API_agent_GetFlowAlias_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetFlowAlias_ResponseSyntax"></a>

```
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
<a name="API_agent_GetFlowAlias_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetFlowAlias-response-arn"></a>
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) **   <a name="bedrock-agent_GetFlowAlias-response-concurrencyConfiguration"></a>
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) **   <a name="bedrock-agent_GetFlowAlias-response-createdAt"></a>
The time at which the flow was created.  
Type: Timestamp

 ** [description](#API_agent_GetFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_GetFlowAlias-response-description"></a>
The description of the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [flowId](#API_agent_GetFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_GetFlowAlias-response-flowId"></a>
The unique identifier of the flow that the alias belongs to.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [id](#API_agent_GetFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_GetFlowAlias-response-id"></a>
The unique identifier of the alias of the flow.  
Type: String  
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})` 

 ** [name](#API_agent_GetFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_GetFlowAlias-response-name"></a>
The name of the alias.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [routingConfiguration](#API_agent_GetFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_GetFlowAlias-response-routingConfiguration"></a>
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) **   <a name="bedrock-agent_GetFlowAlias-response-updatedAt"></a>
The time at which the alias was last updated.  
Type: Timestamp

## Errors
<a name="API_agent_GetFlowAlias_Errors"></a>

For information about 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
<a name="API_agent_GetFlowAlias_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetFlowVersion"></a>

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
<a name="API_agent_GetFlowVersion_RequestSyntax"></a>

```
GET /flows/flowIdentifier/versions/flowVersion/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetFlowVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_GetFlowVersion_RequestSyntax) **   <a name="bedrock-agent_GetFlowVersion-request-uri-flowIdentifier"></a>
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) **   <a name="bedrock-agent_GetFlowVersion-request-uri-flowVersion"></a>
The version of the flow for which to get information.  
Pattern: `[0-9]{1,5}`   
Required: Yes

## Request Body
<a name="API_agent_GetFlowVersion_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetFlowVersion_ResponseSyntax"></a>

```
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
<a name="API_agent_GetFlowVersion_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetFlowVersion-response-arn"></a>
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) **   <a name="bedrock-agent_GetFlowVersion-response-createdAt"></a>
The time at which the flow was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_GetFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_GetFlowVersion-response-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_GetFlowVersion-response-definition"></a>
The definition of the nodes and connections between nodes in the flow.  
Type: [FlowDefinition](API_agent_FlowDefinition.md) object

 ** [description](#API_agent_GetFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_GetFlowVersion-response-description"></a>
The description of the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [executionRoleArn](#API_agent_GetFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_GetFlowVersion-response-executionRoleArn"></a>
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) **   <a name="bedrock-agent_GetFlowVersion-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_GetFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_GetFlowVersion-response-name"></a>
The name of the version.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [status](#API_agent_GetFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_GetFlowVersion-response-status"></a>
The status of the flow.  
Type: String  
Valid Values: `Failed | Prepared | Preparing | NotPrepared` 

 ** [version](#API_agent_GetFlowVersion_ResponseSyntax) **   <a name="bedrock-agent_GetFlowVersion-response-version"></a>
The version of the flow for which information was retrieved.  
Type: String  
Pattern: `[0-9]{1,5}` 

## Errors
<a name="API_agent_GetFlowVersion_Errors"></a>

For information about 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
<a name="API_agent_GetFlowVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetIngestionJob"></a>

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
<a name="API_agent_GetIngestionJob_RequestSyntax"></a>

```
GET /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ingestionJobId HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetIngestionJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_GetIngestionJob_RequestSyntax) **   <a name="bedrock-agent_GetIngestionJob-request-uri-dataSourceId"></a>
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) **   <a name="bedrock-agent_GetIngestionJob-request-uri-ingestionJobId"></a>
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) **   <a name="bedrock-agent_GetIngestionJob-request-uri-knowledgeBaseId"></a>
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
<a name="API_agent_GetIngestionJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetIngestionJob_ResponseSyntax"></a>

```
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
<a name="API_agent_GetIngestionJob_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetIngestionJob-response-ingestionJob"></a>
Contains details about the data ingestion job.  
Type: [IngestionJob](API_agent_IngestionJob.md) object

## Errors
<a name="API_agent_GetIngestionJob_Errors"></a>

For information about 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
<a name="API_agent_GetIngestionJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetKnowledgeBase"></a>

Gets information about a knowledge base.

## Request Syntax
<a name="API_agent_GetKnowledgeBase_RequestSyntax"></a>

```
GET /knowledgebases/knowledgeBaseId HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_agent_GetKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_GetKnowledgeBase-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base you want to get information on.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_GetKnowledgeBase_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetKnowledgeBase_ResponseSyntax"></a>

```
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
<a name="API_agent_GetKnowledgeBase_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetKnowledgeBase-response-knowledgeBase"></a>
Contains details about the knowledge base.  
Type: [KnowledgeBase](API_agent_KnowledgeBase.md) object

## Errors
<a name="API_agent_GetKnowledgeBase_Errors"></a>

For information about 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
<a name="API_agent_GetKnowledgeBase_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetKnowledgeBaseDocuments"></a>

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
<a name="API_agent_GetKnowledgeBaseDocuments_RequestSyntax"></a>

```
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
<a name="API_agent_GetKnowledgeBaseDocuments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_GetKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_GetKnowledgeBaseDocuments-request-uri-dataSourceId"></a>
The unique identifier of the data source that contains the documents.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [knowledgeBaseId](#API_agent_GetKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_GetKnowledgeBaseDocuments-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base that is connected to the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_GetKnowledgeBaseDocuments_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [documentIdentifiers](#API_agent_GetKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_GetKnowledgeBaseDocuments-request-documentIdentifiers"></a>
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
<a name="API_agent_GetKnowledgeBaseDocuments_ResponseSyntax"></a>

```
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
<a name="API_agent_GetKnowledgeBaseDocuments_ResponseElements"></a>

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 name="bedrock-agent_GetKnowledgeBaseDocuments-response-documentDetails"></a>
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
<a name="API_agent_GetKnowledgeBaseDocuments_Errors"></a>

For information about 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
<a name="API_agent_GetKnowledgeBaseDocuments_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_GetPrompt"></a>

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
<a name="API_agent_GetPrompt_RequestSyntax"></a>

```
GET /prompts/promptIdentifier/?promptVersion=promptVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_GetPrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [promptIdentifier](#API_agent_GetPrompt_RequestSyntax) **   <a name="bedrock-agent_GetPrompt-request-uri-promptIdentifier"></a>
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) **   <a name="bedrock-agent_GetPrompt-request-uri-promptVersion"></a>
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
<a name="API_agent_GetPrompt_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_GetPrompt_ResponseSyntax"></a>

```
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
<a name="API_agent_GetPrompt_ResponseElements"></a>

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) **   <a name="bedrock-agent_GetPrompt-response-arn"></a>
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) **   <a name="bedrock-agent_GetPrompt-response-createdAt"></a>
The time at which the prompt was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_GetPrompt_ResponseSyntax) **   <a name="bedrock-agent_GetPrompt-response-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_GetPrompt-response-defaultVariant"></a>
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) **   <a name="bedrock-agent_GetPrompt-response-description"></a>
The descriptino of the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [id](#API_agent_GetPrompt_ResponseSyntax) **   <a name="bedrock-agent_GetPrompt-response-id"></a>
The unique identifier of the prompt.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_GetPrompt_ResponseSyntax) **   <a name="bedrock-agent_GetPrompt-response-name"></a>
The name of the prompt.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [updatedAt](#API_agent_GetPrompt_ResponseSyntax) **   <a name="bedrock-agent_GetPrompt-response-updatedAt"></a>
The time at which the prompt was last updated.  
Type: Timestamp

 ** [variants](#API_agent_GetPrompt_ResponseSyntax) **   <a name="bedrock-agent_GetPrompt-response-variants"></a>
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) **   <a name="bedrock-agent_GetPrompt-response-version"></a>
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
<a name="API_agent_GetPrompt_Errors"></a>

For information about 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
<a name="API_agent_GetPrompt_Examples"></a>

### Get information about the working draft of a prompt
<a name="API_agent_GetPrompt_Example_1"></a>

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
<a name="API_agent_GetPrompt_Example_2"></a>

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
<a name="API_agent_GetPrompt_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_IngestKnowledgeBaseDocuments"></a>

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
<a name="API_agent_IngestKnowledgeBaseDocuments_RequestSyntax"></a>

```
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
<a name="API_agent_IngestKnowledgeBaseDocuments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_IngestKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_IngestKnowledgeBaseDocuments-request-uri-dataSourceId"></a>
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) **   <a name="bedrock-agent_IngestKnowledgeBaseDocuments-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base to ingest the documents into.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_IngestKnowledgeBaseDocuments_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_IngestKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_IngestKnowledgeBaseDocuments-request-clientToken"></a>
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 name="bedrock-agent_IngestKnowledgeBaseDocuments-request-documents"></a>
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
<a name="API_agent_IngestKnowledgeBaseDocuments_ResponseSyntax"></a>

```
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
<a name="API_agent_IngestKnowledgeBaseDocuments_ResponseElements"></a>

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 name="bedrock-agent_IngestKnowledgeBaseDocuments-response-documentDetails"></a>
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
<a name="API_agent_IngestKnowledgeBaseDocuments_Errors"></a>

For information about 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
<a name="API_agent_IngestKnowledgeBaseDocuments_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListAgentActionGroups"></a>

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

## Request Syntax
<a name="API_agent_ListAgentActionGroups_RequestSyntax"></a>

```
POST /agents/agentId/agentversions/agentVersion/actiongroups/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListAgentActionGroups_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_ListAgentActionGroups_RequestSyntax) **   <a name="bedrock-agent_ListAgentActionGroups-request-uri-agentId"></a>
The unique identifier of the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentVersion](#API_agent_ListAgentActionGroups_RequestSyntax) **   <a name="bedrock-agent_ListAgentActionGroups-request-uri-agentVersion"></a>
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
<a name="API_agent_ListAgentActionGroups_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListAgentActionGroups_RequestSyntax) **   <a name="bedrock-agent_ListAgentActionGroups-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListAgentActionGroups-request-nextToken"></a>
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
<a name="API_agent_ListAgentActionGroups_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "actionGroupSummaries": [ 
      { 
         "actionGroupId": "string",
         "actionGroupName": "string",
         "actionGroupState": "string",
         "description": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_agent_ListAgentActionGroups_ResponseElements"></a>

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 name="bedrock-agent_ListAgentActionGroups-response-actionGroupSummaries"></a>
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) **   <a name="bedrock-agent_ListAgentActionGroups-response-nextToken"></a>
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
<a name="API_agent_ListAgentActionGroups_Errors"></a>

For information about 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
<a name="API_agent_ListAgentActionGroups_Examples"></a>

### Example request
<a name="API_agent_ListAgentActionGroups_Example_1"></a>

This example illustrates one usage of ListAgentActionGroups.

```
POST /agents/AGENT12345/agentversions/1/actiongroups/ HTTP/1.1
Content-type: application/json

{
   "maxResults": 10
}
```

## See Also
<a name="API_agent_ListAgentActionGroups_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListAgentAliases"></a>

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

## Request Syntax
<a name="API_agent_ListAgentAliases_RequestSyntax"></a>

```
POST /agents/agentId/agentaliases/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListAgentAliases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_ListAgentAliases_RequestSyntax) **   <a name="bedrock-agent_ListAgentAliases-request-uri-agentId"></a>
The unique identifier of the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_ListAgentAliases_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListAgentAliases_RequestSyntax) **   <a name="bedrock-agent_ListAgentAliases-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListAgentAliases-request-nextToken"></a>
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
<a name="API_agent_ListAgentAliases_ResponseSyntax"></a>

```
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
<a name="API_agent_ListAgentAliases_ResponseElements"></a>

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 name="bedrock-agent_ListAgentAliases-response-agentAliasSummaries"></a>
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) **   <a name="bedrock-agent_ListAgentAliases-response-nextToken"></a>
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
<a name="API_agent_ListAgentAliases_Errors"></a>

For information about 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
<a name="API_agent_ListAgentAliases_Examples"></a>

### Example request
<a name="API_agent_ListAgentAliases_Example_1"></a>

This example illustrates one usage of ListAgentAliases.

```
POST /agents/ABCDEFGHIJ/agentaliases/ HTTP/1.1
Content-type: application/json

{
   "maxResults": 10
}
```

## See Also
<a name="API_agent_ListAgentAliases_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListAgentCollaborators"></a>

Retrieve a list of an agent's collaborators.

## Request Syntax
<a name="API_agent_ListAgentCollaborators_RequestSyntax"></a>

```
POST /agents/agentId/agentversions/agentVersion/agentcollaborators/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListAgentCollaborators_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_ListAgentCollaborators_RequestSyntax) **   <a name="bedrock-agent_ListAgentCollaborators-request-uri-agentId"></a>
The agent's ID.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentVersion](#API_agent_ListAgentCollaborators_RequestSyntax) **   <a name="bedrock-agent_ListAgentCollaborators-request-uri-agentVersion"></a>
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
<a name="API_agent_ListAgentCollaborators_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListAgentCollaborators_RequestSyntax) **   <a name="bedrock-agent_ListAgentCollaborators-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListAgentCollaborators-request-nextToken"></a>
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
<a name="API_agent_ListAgentCollaborators_ResponseSyntax"></a>

```
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
<a name="API_agent_ListAgentCollaborators_ResponseElements"></a>

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 name="bedrock-agent_ListAgentCollaborators-response-agentCollaboratorSummaries"></a>
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) **   <a name="bedrock-agent_ListAgentCollaborators-response-nextToken"></a>
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
<a name="API_agent_ListAgentCollaborators_Errors"></a>

For information about 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
<a name="API_agent_ListAgentCollaborators_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListAgentKnowledgeBases"></a>

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

## Request Syntax
<a name="API_agent_ListAgentKnowledgeBases_RequestSyntax"></a>

```
POST /agents/agentId/agentversions/agentVersion/knowledgebases/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListAgentKnowledgeBases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_ListAgentKnowledgeBases_RequestSyntax) **   <a name="bedrock-agent_ListAgentKnowledgeBases-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_ListAgentKnowledgeBases-request-uri-agentVersion"></a>
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
<a name="API_agent_ListAgentKnowledgeBases_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListAgentKnowledgeBases_RequestSyntax) **   <a name="bedrock-agent_ListAgentKnowledgeBases-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListAgentKnowledgeBases-request-nextToken"></a>
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
<a name="API_agent_ListAgentKnowledgeBases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "agentKnowledgeBaseSummaries": [ 
      { 
         "description": "string",
         "knowledgeBaseId": "string",
         "knowledgeBaseState": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_agent_ListAgentKnowledgeBases_ResponseElements"></a>

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 name="bedrock-agent_ListAgentKnowledgeBases-response-agentKnowledgeBaseSummaries"></a>
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) **   <a name="bedrock-agent_ListAgentKnowledgeBases-response-nextToken"></a>
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
<a name="API_agent_ListAgentKnowledgeBases_Errors"></a>

For information about 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
<a name="API_agent_ListAgentKnowledgeBases_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListAgents"></a>

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

## Request Syntax
<a name="API_agent_ListAgents_RequestSyntax"></a>

```
POST /agents/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListAgents_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent_ListAgents_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListAgents_RequestSyntax) **   <a name="bedrock-agent_ListAgents-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListAgents-request-nextToken"></a>
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
<a name="API_agent_ListAgents_ResponseSyntax"></a>

```
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
<a name="API_agent_ListAgents_ResponseElements"></a>

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 name="bedrock-agent_ListAgents-response-agentSummaries"></a>
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) **   <a name="bedrock-agent_ListAgents-response-nextToken"></a>
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
<a name="API_agent_ListAgents_Errors"></a>

For information about 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
<a name="API_agent_ListAgents_Examples"></a>

### Example request
<a name="API_agent_ListAgents_Example_1"></a>

This example illustrates one usage of ListAgents.

```
POST /agents/ HTTP/1.1
Content-type: application/json

{
   "maxResults": 10
}
```

## See Also
<a name="API_agent_ListAgents_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListAgentVersions"></a>

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

## Request Syntax
<a name="API_agent_ListAgentVersions_RequestSyntax"></a>

```
POST /agents/agentId/agentversions/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListAgentVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_ListAgentVersions_RequestSyntax) **   <a name="bedrock-agent_ListAgentVersions-request-uri-agentId"></a>
The unique identifier of the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_ListAgentVersions_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListAgentVersions_RequestSyntax) **   <a name="bedrock-agent_ListAgentVersions-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListAgentVersions-request-nextToken"></a>
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
<a name="API_agent_ListAgentVersions_ResponseSyntax"></a>

```
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
<a name="API_agent_ListAgentVersions_ResponseElements"></a>

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 name="bedrock-agent_ListAgentVersions-response-agentVersionSummaries"></a>
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) **   <a name="bedrock-agent_ListAgentVersions-response-nextToken"></a>
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
<a name="API_agent_ListAgentVersions_Errors"></a>

For information about 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
<a name="API_agent_ListAgentVersions_Examples"></a>

### Example request
<a name="API_agent_ListAgentVersions_Example_1"></a>

This example illustrates one usage of ListAgentVersions.

```
POST /agents/agentId/agentversions/ HTTP/1.1
Content-type: application/json
        
{
   "maxResults": 10
}
```

## See Also
<a name="API_agent_ListAgentVersions_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListDataSources"></a>

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

## Request Syntax
<a name="API_agent_ListDataSources_RequestSyntax"></a>

```
POST /knowledgebases/knowledgeBaseId/datasources/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListDataSources_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_agent_ListDataSources_RequestSyntax) **   <a name="bedrock-agent_ListDataSources-request-uri-knowledgeBaseId"></a>
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
<a name="API_agent_ListDataSources_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListDataSources_RequestSyntax) **   <a name="bedrock-agent_ListDataSources-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListDataSources-request-nextToken"></a>
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
<a name="API_agent_ListDataSources_ResponseSyntax"></a>

```
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
<a name="API_agent_ListDataSources_ResponseElements"></a>

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 name="bedrock-agent_ListDataSources-response-dataSourceSummaries"></a>
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) **   <a name="bedrock-agent_ListDataSources-response-nextToken"></a>
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
<a name="API_agent_ListDataSources_Errors"></a>

For information about 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
<a name="API_agent_ListDataSources_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListFlowAliases"></a>

Returns a list of aliases for a flow.

## Request Syntax
<a name="API_agent_ListFlowAliases_RequestSyntax"></a>

```
GET /flows/flowIdentifier/aliases?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_ListFlowAliases_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_ListFlowAliases_RequestSyntax) **   <a name="bedrock-agent_ListFlowAliases-request-uri-flowIdentifier"></a>
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) **   <a name="bedrock-agent_ListFlowAliases-request-uri-maxResults"></a>
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) **   <a name="bedrock-agent_ListFlowAliases-request-uri-nextToken"></a>
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
<a name="API_agent_ListFlowAliases_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_ListFlowAliases_ResponseSyntax"></a>

```
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
<a name="API_agent_ListFlowAliases_ResponseElements"></a>

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 name="bedrock-agent_ListFlowAliases-response-flowAliasSummaries"></a>
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) **   <a name="bedrock-agent_ListFlowAliases-response-nextToken"></a>
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
<a name="API_agent_ListFlowAliases_Errors"></a>

For information about 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
<a name="API_agent_ListFlowAliases_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListFlows"></a>

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
<a name="API_agent_ListFlows_RequestSyntax"></a>

```
GET /flows/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_ListFlows_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_agent_ListFlows_RequestSyntax) **   <a name="bedrock-agent_ListFlows-request-uri-maxResults"></a>
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) **   <a name="bedrock-agent_ListFlows-request-uri-nextToken"></a>
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
<a name="API_agent_ListFlows_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_ListFlows_ResponseSyntax"></a>

```
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
<a name="API_agent_ListFlows_ResponseElements"></a>

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 name="bedrock-agent_ListFlows-response-flowSummaries"></a>
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) **   <a name="bedrock-agent_ListFlows-response-nextToken"></a>
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
<a name="API_agent_ListFlows_Errors"></a>

For information about 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
<a name="API_agent_ListFlows_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListFlowVersions"></a>

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
<a name="API_agent_ListFlowVersions_RequestSyntax"></a>

```
GET /flows/flowIdentifier/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_ListFlowVersions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_ListFlowVersions_RequestSyntax) **   <a name="bedrock-agent_ListFlowVersions-request-uri-flowIdentifier"></a>
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) **   <a name="bedrock-agent_ListFlowVersions-request-uri-maxResults"></a>
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) **   <a name="bedrock-agent_ListFlowVersions-request-uri-nextToken"></a>
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
<a name="API_agent_ListFlowVersions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_ListFlowVersions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "flowVersionSummaries": [ 
      { 
         "arn": "string",
         "createdAt": "string",
         "id": "string",
         "status": "string",
         "version": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_agent_ListFlowVersions_ResponseElements"></a>

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 name="bedrock-agent_ListFlowVersions-response-flowVersionSummaries"></a>
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) **   <a name="bedrock-agent_ListFlowVersions-response-nextToken"></a>
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
<a name="API_agent_ListFlowVersions_Errors"></a>

For information about 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
<a name="API_agent_ListFlowVersions_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListIngestionJobs"></a>

Lists the data ingestion jobs for a data source. The list also includes information about each job.

## Request Syntax
<a name="API_agent_ListIngestionJobs_RequestSyntax"></a>

```
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
<a name="API_agent_ListIngestionJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_ListIngestionJobs_RequestSyntax) **   <a name="bedrock-agent_ListIngestionJobs-request-uri-dataSourceId"></a>
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) **   <a name="bedrock-agent_ListIngestionJobs-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base for the list of data ingestion jobs.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_ListIngestionJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [filters](#API_agent_ListIngestionJobs_RequestSyntax) **   <a name="bedrock-agent_ListIngestionJobs-request-filters"></a>
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) **   <a name="bedrock-agent_ListIngestionJobs-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListIngestionJobs-request-nextToken"></a>
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) **   <a name="bedrock-agent_ListIngestionJobs-request-sortBy"></a>
Contains details about how to sort the data.  
Type: [IngestionJobSortBy](API_agent_IngestionJobSortBy.md) object  
Required: No

## Response Syntax
<a name="API_agent_ListIngestionJobs_ResponseSyntax"></a>

```
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
<a name="API_agent_ListIngestionJobs_ResponseElements"></a>

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 name="bedrock-agent_ListIngestionJobs-response-ingestionJobSummaries"></a>
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) **   <a name="bedrock-agent_ListIngestionJobs-response-nextToken"></a>
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
<a name="API_agent_ListIngestionJobs_Errors"></a>

For information about 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
<a name="API_agent_ListIngestionJobs_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListKnowledgeBaseDocuments"></a>

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
<a name="API_agent_ListKnowledgeBaseDocuments_RequestSyntax"></a>

```
POST /knowledgebases/knowledgeBaseId/datasources/dataSourceId/documents HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListKnowledgeBaseDocuments_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_ListKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_ListKnowledgeBaseDocuments-request-uri-dataSourceId"></a>
The unique identifier of the data source that contains the documents.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [knowledgeBaseId](#API_agent_ListKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_ListKnowledgeBaseDocuments-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base that is connected to the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_ListKnowledgeBaseDocuments_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListKnowledgeBaseDocuments_RequestSyntax) **   <a name="bedrock-agent_ListKnowledgeBaseDocuments-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListKnowledgeBaseDocuments-request-nextToken"></a>
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
<a name="API_agent_ListKnowledgeBaseDocuments_ResponseSyntax"></a>

```
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
<a name="API_agent_ListKnowledgeBaseDocuments_ResponseElements"></a>

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 name="bedrock-agent_ListKnowledgeBaseDocuments-response-documentDetails"></a>
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) **   <a name="bedrock-agent_ListKnowledgeBaseDocuments-response-nextToken"></a>
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
<a name="API_agent_ListKnowledgeBaseDocuments_Errors"></a>

For information about 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
<a name="API_agent_ListKnowledgeBaseDocuments_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListKnowledgeBases"></a>

Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.

## Request Syntax
<a name="API_agent_ListKnowledgeBases_RequestSyntax"></a>

```
POST /knowledgebases/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_agent_ListKnowledgeBases_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent_ListKnowledgeBases_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_agent_ListKnowledgeBases_RequestSyntax) **   <a name="bedrock-agent_ListKnowledgeBases-request-maxResults"></a>
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) **   <a name="bedrock-agent_ListKnowledgeBases-request-nextToken"></a>
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
<a name="API_agent_ListKnowledgeBases_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "knowledgeBaseSummaries": [ 
      { 
         "description": "string",
         "knowledgeBaseId": "string",
         "name": "string",
         "status": "string",
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_agent_ListKnowledgeBases_ResponseElements"></a>

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 name="bedrock-agent_ListKnowledgeBases-response-knowledgeBaseSummaries"></a>
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) **   <a name="bedrock-agent_ListKnowledgeBases-response-nextToken"></a>
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
<a name="API_agent_ListKnowledgeBases_Errors"></a>

For information about 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
<a name="API_agent_ListKnowledgeBases_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListPrompts"></a>

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
<a name="API_agent_ListPrompts_RequestSyntax"></a>

```
GET /prompts/?maxResults=maxResults&nextToken=nextToken&promptIdentifier=promptIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_ListPrompts_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_agent_ListPrompts_RequestSyntax) **   <a name="bedrock-agent_ListPrompts-request-uri-maxResults"></a>
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) **   <a name="bedrock-agent_ListPrompts-request-uri-nextToken"></a>
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) **   <a name="bedrock-agent_ListPrompts-request-uri-promptIdentifier"></a>
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
<a name="API_agent_ListPrompts_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_ListPrompts_ResponseSyntax"></a>

```
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
<a name="API_agent_ListPrompts_ResponseElements"></a>

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) **   <a name="bedrock-agent_ListPrompts-response-nextToken"></a>
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 name="bedrock-agent_ListPrompts-response-promptSummaries"></a>
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
<a name="API_agent_ListPrompts_Errors"></a>

For information about 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
<a name="API_agent_ListPrompts_Examples"></a>

### List information about all prompts in an account
<a name="API_agent_ListPrompts_Example_1"></a>

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
<a name="API_agent_ListPrompts_Example_2"></a>

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
<a name="API_agent_ListPrompts_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ListTagsForResource"></a>

List all the tags for the resource you specify.

## Request Syntax
<a name="API_agent_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_agent_ListTagsForResource_RequestSyntax) **   <a name="bedrock-agent_ListTagsForResource-request-uri-resourceArn"></a>
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
<a name="API_agent_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_agent_ListTagsForResource_ResponseElements"></a>

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) **   <a name="bedrock-agent_ListTagsForResource-response-tags"></a>
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
<a name="API_agent_ListTagsForResource_Errors"></a>

For information about 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
<a name="API_agent_ListTagsForResource_Examples"></a>

### Example request
<a name="API_agent_ListTagsForResource_Example_1"></a>

This example illustrates one usage of ListTagsForResource.

```
GET /tags/arn:aws:bedrock:us-west-2:123456789012:agent/ABCDEFGHIJ HTTP/1.1
```

## See Also
<a name="API_agent_ListTagsForResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_PrepareAgent"></a>

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

## Request Syntax
<a name="API_agent_PrepareAgent_RequestSyntax"></a>

```
POST /agents/agentId/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_PrepareAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_PrepareAgent_RequestSyntax) **   <a name="bedrock-agent_PrepareAgent-request-uri-agentId"></a>
The unique identifier of the agent for which to create a `DRAFT` version.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_PrepareAgent_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_PrepareAgent_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "agentId": "string",
   "agentStatus": "string",
   "agentVersion": "string",
   "preparedAt": "string"
}
```

## Response Elements
<a name="API_agent_PrepareAgent_ResponseElements"></a>

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) **   <a name="bedrock-agent_PrepareAgent-response-agentId"></a>
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) **   <a name="bedrock-agent_PrepareAgent-response-agentStatus"></a>
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) **   <a name="bedrock-agent_PrepareAgent-response-agentVersion"></a>
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) **   <a name="bedrock-agent_PrepareAgent-response-preparedAt"></a>
The time at which the `DRAFT` version of the agent was last prepared.  
Type: Timestamp

## Errors
<a name="API_agent_PrepareAgent_Errors"></a>

For information about 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
<a name="API_agent_PrepareAgent_Examples"></a>

### Example request
<a name="API_agent_PrepareAgent_Example_1"></a>

This example illustrates one usage of PrepareAgent.

```
POST /agents/ABCDEFGHIJ/ HTTP/1.1
```

## See Also
<a name="API_agent_PrepareAgent_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_PrepareFlow"></a>

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
<a name="API_agent_PrepareFlow_RequestSyntax"></a>

```
POST /flows/flowIdentifier/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_PrepareFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_PrepareFlow_RequestSyntax) **   <a name="bedrock-agent_PrepareFlow-request-uri-flowIdentifier"></a>
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
<a name="API_agent_PrepareFlow_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_PrepareFlow_ResponseSyntax"></a>

```
HTTP/1.1 202
Content-type: application/json

{
   "id": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_agent_PrepareFlow_ResponseElements"></a>

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) **   <a name="bedrock-agent_PrepareFlow-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [status](#API_agent_PrepareFlow_ResponseSyntax) **   <a name="bedrock-agent_PrepareFlow-response-status"></a>
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
<a name="API_agent_PrepareFlow_Errors"></a>

For information about 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
<a name="API_agent_PrepareFlow_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_StartIngestionJob"></a>

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
<a name="API_agent_StartIngestionJob_RequestSyntax"></a>

```
PUT /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string"
}
```

## URI Request Parameters
<a name="API_agent_StartIngestionJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_StartIngestionJob_RequestSyntax) **   <a name="bedrock-agent_StartIngestionJob-request-uri-dataSourceId"></a>
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) **   <a name="bedrock-agent_StartIngestionJob-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base for the data ingestion job.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_StartIngestionJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_agent_StartIngestionJob_RequestSyntax) **   <a name="bedrock-agent_StartIngestionJob-request-clientToken"></a>
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 name="bedrock-agent_StartIngestionJob-request-description"></a>
A description of the data ingestion job.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

## Response Syntax
<a name="API_agent_StartIngestionJob_ResponseSyntax"></a>

```
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
<a name="API_agent_StartIngestionJob_ResponseElements"></a>

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) **   <a name="bedrock-agent_StartIngestionJob-response-ingestionJob"></a>
Contains information about the data ingestion job.  
Type: [IngestionJob](API_agent_IngestionJob.md) object

## Errors
<a name="API_agent_StartIngestionJob_Errors"></a>

For information about 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
<a name="API_agent_StartIngestionJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_StopIngestionJob"></a>

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
<a name="API_agent_StopIngestionJob_RequestSyntax"></a>

```
POST /knowledgebases/knowledgeBaseId/datasources/dataSourceId/ingestionjobs/ingestionJobId/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_StopIngestionJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_StopIngestionJob_RequestSyntax) **   <a name="bedrock-agent_StopIngestionJob-request-uri-dataSourceId"></a>
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) **   <a name="bedrock-agent_StopIngestionJob-request-uri-ingestionJobId"></a>
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) **   <a name="bedrock-agent_StopIngestionJob-request-uri-knowledgeBaseId"></a>
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
<a name="API_agent_StopIngestionJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_StopIngestionJob_ResponseSyntax"></a>

```
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
<a name="API_agent_StopIngestionJob_ResponseElements"></a>

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) **   <a name="bedrock-agent_StopIngestionJob-response-ingestionJob"></a>
Contains information about the stopped data ingestion job.  
Type: [IngestionJob](API_agent_IngestionJob.md) object

## Errors
<a name="API_agent_StopIngestionJob_Errors"></a>

For information about 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
<a name="API_agent_StopIngestionJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_TagResource"></a>

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
<a name="API_agent_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_agent_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_agent_TagResource_RequestSyntax) **   <a name="bedrock-agent_TagResource-request-uri-resourceArn"></a>
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
<a name="API_agent_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_agent_TagResource_RequestSyntax) **   <a name="bedrock-agent_TagResource-request-tags"></a>
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
<a name="API_agent_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_agent_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_agent_TagResource_Errors"></a>

For information about 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
<a name="API_agent_TagResource_Examples"></a>

### Example request
<a name="API_agent_TagResource_Example_1"></a>

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
<a name="API_agent_TagResource_Example_2"></a>

This example illustrates one usage of TagResource.

```
HTTP/1.1 200
```

## See Also
<a name="API_agent_TagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UntagResource"></a>

Remove tags from a resource.

## Request Syntax
<a name="API_agent_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_agent_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_agent_UntagResource_RequestSyntax) **   <a name="bedrock-agent_UntagResource-request-uri-resourceArn"></a>
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 name="bedrock-agent_UntagResource-request-uri-tagKeys"></a>
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
<a name="API_agent_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_agent_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_agent_UntagResource_Errors"></a>

For information about 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
<a name="API_agent_UntagResource_Examples"></a>

### Example request
<a name="API_agent_UntagResource_Example_1"></a>

This example illustrates one usage of UntagResource.

```
DELETE /tags/arn:aws:bedrock:us-west-2:123456789012:agent/ABCDEFGHIJ HTTP/1.1
```

### Example response
<a name="API_agent_UntagResource_Example_2"></a>

This example illustrates one usage of UntagResource.

```
HTTP/1.1 200
```

## See Also
<a name="API_agent_UntagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateAgent"></a>

Updates the configuration of an agent.

## Request Syntax
<a name="API_agent_UpdateAgent_RequestSyntax"></a>

```
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
<a name="API_agent_UpdateAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_UpdateAgent_RequestSyntax) **   <a name="bedrock-agent_UpdateAgent-request-uri-agentId"></a>
The unique identifier of the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_UpdateAgent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [agentCollaboration](#API_agent_UpdateAgent_RequestSyntax) **   <a name="bedrock-agent_UpdateAgent-request-agentCollaboration"></a>
The agent's collaboration role.  
Type: String  
Valid Values: `SUPERVISOR | SUPERVISOR_ROUTER | DISABLED`   
Required: No

 ** [agentName](#API_agent_UpdateAgent_RequestSyntax) **   <a name="bedrock-agent_UpdateAgent-request-agentName"></a>
Specifies a new name for the agent.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [agentResourceRoleArn](#API_agent_UpdateAgent_RequestSyntax) **   <a name="bedrock-agent_UpdateAgent-request-agentResourceRoleArn"></a>
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) **   <a name="bedrock-agent_UpdateAgent-request-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_UpdateAgent-request-customOrchestration"></a>
 Contains details of the custom orchestration configured for the agent.   
Type: [CustomOrchestration](API_agent_CustomOrchestration.md) object  
Required: No

 ** [description](#API_agent_UpdateAgent_RequestSyntax) **   <a name="bedrock-agent_UpdateAgent-request-description"></a>
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) **   <a name="bedrock-agent_UpdateAgent-request-foundationModel"></a>
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) **   <a name="bedrock-agent_UpdateAgent-request-guardrailConfiguration"></a>
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) **   <a name="bedrock-agent_UpdateAgent-request-idleSessionTTLInSeconds"></a>
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) **   <a name="bedrock-agent_UpdateAgent-request-instruction"></a>
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) **   <a name="bedrock-agent_UpdateAgent-request-memoryConfiguration"></a>
Specifies the new memory configuration for the agent.   
Type: [MemoryConfiguration](API_agent_MemoryConfiguration.md) object  
Required: No

 ** [orchestrationType](#API_agent_UpdateAgent_RequestSyntax) **   <a name="bedrock-agent_UpdateAgent-request-orchestrationType"></a>
 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) **   <a name="bedrock-agent_UpdateAgent-request-promptOverrideConfiguration"></a>
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
<a name="API_agent_UpdateAgent_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateAgent_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateAgent-response-agent"></a>
Contains details about the agent that was updated.  
Type: [Agent](API_agent_Agent.md) object

## Errors
<a name="API_agent_UpdateAgent_Errors"></a>

For information about 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
<a name="API_agent_UpdateAgent_Examples"></a>

### Example request
<a name="API_agent_UpdateAgent_Example_1"></a>

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
<a name="API_agent_UpdateAgent_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateAgentActionGroup"></a>

Updates the configuration for an action group for an agent.

## Request Syntax
<a name="API_agent_UpdateAgentActionGroup_RequestSyntax"></a>

```
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
<a name="API_agent_UpdateAgentActionGroup_RequestParameters"></a>

The request uses the following URI parameters.

 ** [actionGroupId](#API_agent_UpdateAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-uri-actionGroupId"></a>
The unique identifier of the action group.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentId](#API_agent_UpdateAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-uri-agentVersion"></a>
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
<a name="API_agent_UpdateAgentActionGroup_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actionGroupExecutor](#API_agent_UpdateAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-actionGroupExecutor"></a>
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) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-actionGroupName"></a>
Specifies a new name for the action group.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [actionGroupState](#API_agent_UpdateAgentActionGroup_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-actionGroupState"></a>
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) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-apiSchema"></a>
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) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-description"></a>
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) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-functionSchema"></a>
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) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-parentActionGroupSignature"></a>
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) **   <a name="bedrock-agent_UpdateAgentActionGroup-request-parentActionGroupSignatureParams"></a>
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
<a name="API_agent_UpdateAgentActionGroup_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateAgentActionGroup_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateAgentActionGroup-response-agentActionGroup"></a>
Contains details about the action group that was updated.  
Type: [AgentActionGroup](API_agent_AgentActionGroup.md) object

## Errors
<a name="API_agent_UpdateAgentActionGroup_Errors"></a>

For information about 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
<a name="API_agent_UpdateAgentActionGroup_Examples"></a>

### Example request
<a name="API_agent_UpdateAgentActionGroup_Example_1"></a>

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
<a name="API_agent_UpdateAgentActionGroup_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateAgentAlias"></a>

Updates configurations for an alias of an agent.

## Request Syntax
<a name="API_agent_UpdateAgentAlias_RequestSyntax"></a>

```
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
<a name="API_agent_UpdateAgentAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentAliasId](#API_agent_UpdateAgentAlias_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentAlias-request-uri-agentAliasId"></a>
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) **   <a name="bedrock-agent_UpdateAgentAlias-request-uri-agentId"></a>
The unique identifier of the agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_UpdateAgentAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [agentAliasName](#API_agent_UpdateAgentAlias_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentAlias-request-agentAliasName"></a>
Specifies a new name for the alias.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [aliasInvocationState](#API_agent_UpdateAgentAlias_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentAlias-request-aliasInvocationState"></a>
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) **   <a name="bedrock-agent_UpdateAgentAlias-request-description"></a>
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) **   <a name="bedrock-agent_UpdateAgentAlias-request-routingConfiguration"></a>
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
<a name="API_agent_UpdateAgentAlias_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateAgentAlias_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateAgentAlias-response-agentAlias"></a>
Contains details about the alias that was updated.  
Type: [AgentAlias](API_agent_AgentAlias.md) object

## Errors
<a name="API_agent_UpdateAgentAlias_Errors"></a>

For information about 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
<a name="API_agent_UpdateAgentAlias_Examples"></a>

### Example request
<a name="API_agent_UpdateAgentAlias_Example_1"></a>

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
<a name="API_agent_UpdateAgentAlias_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateAgentCollaborator"></a>

Updates an agent's collaborator.

## Request Syntax
<a name="API_agent_UpdateAgentCollaborator_RequestSyntax"></a>

```
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
<a name="API_agent_UpdateAgentCollaborator_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_UpdateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentCollaborator-request-uri-agentId"></a>
The agent's ID.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [agentVersion](#API_agent_UpdateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentCollaborator-request-uri-agentVersion"></a>
The agent's version.  
Length Constraints: Fixed length of 5.  
Pattern: `DRAFT`   
Required: Yes

 ** [collaboratorId](#API_agent_UpdateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentCollaborator-request-uri-collaboratorId"></a>
The collaborator's ID.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_UpdateAgentCollaborator_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [agentDescriptor](#API_agent_UpdateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentCollaborator-request-agentDescriptor"></a>
An agent descriptor for the agent collaborator.  
Type: [AgentDescriptor](API_agent_AgentDescriptor.md) object  
Required: Yes

 ** [collaborationInstruction](#API_agent_UpdateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentCollaborator-request-collaborationInstruction"></a>
Instruction for the collaborator.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 4000.  
Required: Yes

 ** [collaboratorName](#API_agent_UpdateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentCollaborator-request-collaboratorName"></a>
The collaborator's name.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [relayConversationHistory](#API_agent_UpdateAgentCollaborator_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentCollaborator-request-relayConversationHistory"></a>
A relay conversation history for the collaborator.  
Type: String  
Valid Values: `TO_COLLABORATOR | DISABLED`   
Required: No

## Response Syntax
<a name="API_agent_UpdateAgentCollaborator_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateAgentCollaborator_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateAgentCollaborator-response-agentCollaborator"></a>
Details about the collaborator.  
Type: [AgentCollaborator](API_agent_AgentCollaborator.md) object

## Errors
<a name="API_agent_UpdateAgentCollaborator_Errors"></a>

For information about 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
<a name="API_agent_UpdateAgentCollaborator_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateAgentKnowledgeBase"></a>

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

## Request Syntax
<a name="API_agent_UpdateAgentKnowledgeBase_RequestSyntax"></a>

```
PUT /agents/agentId/agentversions/agentVersion/knowledgebases/knowledgeBaseId/ HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "knowledgeBaseState": "string"
}
```

## URI Request Parameters
<a name="API_agent_UpdateAgentKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentId](#API_agent_UpdateAgentKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentKnowledgeBase-request-uri-agentId"></a>
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) **   <a name="bedrock-agent_UpdateAgentKnowledgeBase-request-uri-agentVersion"></a>
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) **   <a name="bedrock-agent_UpdateAgentKnowledgeBase-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base that has been associated with an agent.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_UpdateAgentKnowledgeBase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_agent_UpdateAgentKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_UpdateAgentKnowledgeBase-request-description"></a>
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) **   <a name="bedrock-agent_UpdateAgentKnowledgeBase-request-knowledgeBaseState"></a>
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
<a name="API_agent_UpdateAgentKnowledgeBase_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateAgentKnowledgeBase_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateAgentKnowledgeBase-response-agentKnowledgeBase"></a>
Contains details about the knowledge base that has been associated with an agent.  
Type: [AgentKnowledgeBase](API_agent_AgentKnowledgeBase.md) object

## Errors
<a name="API_agent_UpdateAgentKnowledgeBase_Errors"></a>

For information about 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
<a name="API_agent_UpdateAgentKnowledgeBase_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateDataSource"></a>

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
<a name="API_agent_UpdateDataSource_RequestSyntax"></a>

```
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
<a name="API_agent_UpdateDataSource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [dataSourceId](#API_agent_UpdateDataSource_RequestSyntax) **   <a name="bedrock-agent_UpdateDataSource-request-uri-dataSourceId"></a>
The unique identifier of the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

 ** [knowledgeBaseId](#API_agent_UpdateDataSource_RequestSyntax) **   <a name="bedrock-agent_UpdateDataSource-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base for the data source.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_UpdateDataSource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [dataDeletionPolicy](#API_agent_UpdateDataSource_RequestSyntax) **   <a name="bedrock-agent_UpdateDataSource-request-dataDeletionPolicy"></a>
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) **   <a name="bedrock-agent_UpdateDataSource-request-dataSourceConfiguration"></a>
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) **   <a name="bedrock-agent_UpdateDataSource-request-description"></a>
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) **   <a name="bedrock-agent_UpdateDataSource-request-name"></a>
Specifies a new name for the data source.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [serverSideEncryptionConfiguration](#API_agent_UpdateDataSource_RequestSyntax) **   <a name="bedrock-agent_UpdateDataSource-request-serverSideEncryptionConfiguration"></a>
Contains details about server-side encryption of the data source.  
Type: [ServerSideEncryptionConfiguration](API_agent_ServerSideEncryptionConfiguration.md) object  
Required: No

 ** [vectorIngestionConfiguration](#API_agent_UpdateDataSource_RequestSyntax) **   <a name="bedrock-agent_UpdateDataSource-request-vectorIngestionConfiguration"></a>
Contains details about how to ingest the documents in the data source.  
Type: [VectorIngestionConfiguration](API_agent_VectorIngestionConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_agent_UpdateDataSource_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateDataSource_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateDataSource-response-dataSource"></a>
Contains details about the data source.  
Type: [DataSource](API_agent_DataSource.md) object

## Errors
<a name="API_agent_UpdateDataSource_Errors"></a>

For information about 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
<a name="API_agent_UpdateDataSource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateFlow"></a>

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
<a name="API_agent_UpdateFlow_RequestSyntax"></a>

```
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
<a name="API_agent_UpdateFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowIdentifier](#API_agent_UpdateFlow_RequestSyntax) **   <a name="bedrock-agent_UpdateFlow-request-uri-flowIdentifier"></a>
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
<a name="API_agent_UpdateFlow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [customerEncryptionKeyArn](#API_agent_UpdateFlow_RequestSyntax) **   <a name="bedrock-agent_UpdateFlow-request-customerEncryptionKeyArn"></a>
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 name="bedrock-agent_UpdateFlow-request-definition"></a>
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 name="bedrock-agent_UpdateFlow-request-description"></a>
A description for the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [executionRoleArn](#API_agent_UpdateFlow_RequestSyntax) **   <a name="bedrock-agent_UpdateFlow-request-executionRoleArn"></a>
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="bedrock-agent_UpdateFlow-request-name"></a>
A name for the flow.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

## Response Syntax
<a name="API_agent_UpdateFlow_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateFlow_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateFlow-response-arn"></a>
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) **   <a name="bedrock-agent_UpdateFlow-response-createdAt"></a>
The time at which the flow was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_UpdateFlow_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlow-response-customerEncryptionKeyArn"></a>
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 name="bedrock-agent_UpdateFlow-response-definition"></a>
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) **   <a name="bedrock-agent_UpdateFlow-response-description"></a>
The description of the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [executionRoleArn](#API_agent_UpdateFlow_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlow-response-executionRoleArn"></a>
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) **   <a name="bedrock-agent_UpdateFlow-response-id"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_UpdateFlow_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlow-response-name"></a>
The name of the flow.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [status](#API_agent_UpdateFlow_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlow-response-status"></a>
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) **   <a name="bedrock-agent_UpdateFlow-response-updatedAt"></a>
The time at which the flow was last updated.  
Type: Timestamp

 ** [version](#API_agent_UpdateFlow_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlow-response-version"></a>
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
<a name="API_agent_UpdateFlow_Errors"></a>

For information about 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
<a name="API_agent_UpdateFlow_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateFlowAlias"></a>

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
<a name="API_agent_UpdateFlowAlias_RequestSyntax"></a>

```
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
<a name="API_agent_UpdateFlowAlias_RequestParameters"></a>

The request uses the following URI parameters.

 ** [aliasIdentifier](#API_agent_UpdateFlowAlias_RequestSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-request-uri-aliasIdentifier"></a>
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) **   <a name="bedrock-agent_UpdateFlowAlias-request-uri-flowIdentifier"></a>
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
<a name="API_agent_UpdateFlowAlias_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [concurrencyConfiguration](#API_agent_UpdateFlowAlias_RequestSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-request-concurrencyConfiguration"></a>
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 name="bedrock-agent_UpdateFlowAlias-request-description"></a>
A description for the alias.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Required: No

 ** [name](#API_agent_UpdateFlowAlias_RequestSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-request-name"></a>
The name of the alias.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [routingConfiguration](#API_agent_UpdateFlowAlias_RequestSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-request-routingConfiguration"></a>
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
<a name="API_agent_UpdateFlowAlias_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateFlowAlias_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateFlowAlias-response-arn"></a>
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) **   <a name="bedrock-agent_UpdateFlowAlias-response-concurrencyConfiguration"></a>
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) **   <a name="bedrock-agent_UpdateFlowAlias-response-createdAt"></a>
The time at which the flow was created.  
Type: Timestamp

 ** [description](#API_agent_UpdateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-response-description"></a>
The description of the flow.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [flowId](#API_agent_UpdateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-response-flowId"></a>
The unique identifier of the flow.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [id](#API_agent_UpdateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-response-id"></a>
The unique identifier of the alias.  
Type: String  
Pattern: `(TSTALIASID|[0-9a-zA-Z]{10})` 

 ** [name](#API_agent_UpdateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-response-name"></a>
The name of the alias.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [routingConfiguration](#API_agent_UpdateFlowAlias_ResponseSyntax) **   <a name="bedrock-agent_UpdateFlowAlias-response-routingConfiguration"></a>
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) **   <a name="bedrock-agent_UpdateFlowAlias-response-updatedAt"></a>
The time at which the alias was last updated.  
Type: Timestamp

## Errors
<a name="API_agent_UpdateFlowAlias_Errors"></a>

For information about 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
<a name="API_agent_UpdateFlowAlias_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdateKnowledgeBase"></a>

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
<a name="API_agent_UpdateKnowledgeBase_RequestSyntax"></a>

```
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
<a name="API_agent_UpdateKnowledgeBase_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_agent_UpdateKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_UpdateKnowledgeBase-request-uri-knowledgeBaseId"></a>
The unique identifier of the knowledge base to update.  
Pattern: `[0-9a-zA-Z]{10}`   
Required: Yes

## Request Body
<a name="API_agent_UpdateKnowledgeBase_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_agent_UpdateKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_UpdateKnowledgeBase-request-description"></a>
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) **   <a name="bedrock-agent_UpdateKnowledgeBase-request-knowledgeBaseConfiguration"></a>
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) **   <a name="bedrock-agent_UpdateKnowledgeBase-request-name"></a>
Specifies a new name for the knowledge base.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [roleArn](#API_agent_UpdateKnowledgeBase_RequestSyntax) **   <a name="bedrock-agent_UpdateKnowledgeBase-request-roleArn"></a>
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) **   <a name="bedrock-agent_UpdateKnowledgeBase-request-storageConfiguration"></a>
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
<a name="API_agent_UpdateKnowledgeBase_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdateKnowledgeBase_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdateKnowledgeBase-response-knowledgeBase"></a>
Contains details about the knowledge base.  
Type: [KnowledgeBase](API_agent_KnowledgeBase.md) object

## Errors
<a name="API_agent_UpdateKnowledgeBase_Errors"></a>

For information about 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
<a name="API_agent_UpdateKnowledgeBase_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_UpdatePrompt"></a>

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
<a name="API_agent_UpdatePrompt_RequestSyntax"></a>

```
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
<a name="API_agent_UpdatePrompt_RequestParameters"></a>

The request uses the following URI parameters.

 ** [promptIdentifier](#API_agent_UpdatePrompt_RequestSyntax) **   <a name="bedrock-agent_UpdatePrompt-request-uri-promptIdentifier"></a>
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
<a name="API_agent_UpdatePrompt_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [customerEncryptionKeyArn](#API_agent_UpdatePrompt_RequestSyntax) **   <a name="bedrock-agent_UpdatePrompt-request-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_UpdatePrompt-request-defaultVariant"></a>
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 name="bedrock-agent_UpdatePrompt-request-description"></a>
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="bedrock-agent_UpdatePrompt-request-name"></a>
A name for the prompt.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: Yes

 ** [variants](#API_agent_UpdatePrompt_RequestSyntax) **   <a name="bedrock-agent_UpdatePrompt-request-variants"></a>
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
<a name="API_agent_UpdatePrompt_ResponseSyntax"></a>

```
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
<a name="API_agent_UpdatePrompt_ResponseElements"></a>

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) **   <a name="bedrock-agent_UpdatePrompt-response-arn"></a>
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) **   <a name="bedrock-agent_UpdatePrompt-response-createdAt"></a>
The time at which the prompt was created.  
Type: Timestamp

 ** [customerEncryptionKeyArn](#API_agent_UpdatePrompt_ResponseSyntax) **   <a name="bedrock-agent_UpdatePrompt-response-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent_UpdatePrompt-response-defaultVariant"></a>
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) **   <a name="bedrock-agent_UpdatePrompt-response-description"></a>
The description of the prompt.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.

 ** [id](#API_agent_UpdatePrompt_ResponseSyntax) **   <a name="bedrock-agent_UpdatePrompt-response-id"></a>
The unique identifier of the prompt.  
Type: String  
Pattern: `[0-9a-zA-Z]{10}` 

 ** [name](#API_agent_UpdatePrompt_ResponseSyntax) **   <a name="bedrock-agent_UpdatePrompt-response-name"></a>
The name of the prompt.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}` 

 ** [updatedAt](#API_agent_UpdatePrompt_ResponseSyntax) **   <a name="bedrock-agent_UpdatePrompt-response-updatedAt"></a>
The time at which the prompt was last updated.  
Type: Timestamp

 ** [variants](#API_agent_UpdatePrompt_ResponseSyntax) **   <a name="bedrock-agent_UpdatePrompt-response-variants"></a>
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) **   <a name="bedrock-agent_UpdatePrompt-response-version"></a>
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
<a name="API_agent_UpdatePrompt_Errors"></a>

For information about 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
<a name="API_agent_UpdatePrompt_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent_ValidateFlowDefinition"></a>

Validates the definition of a flow.

## Request Syntax
<a name="API_agent_ValidateFlowDefinition_RequestSyntax"></a>

```
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
<a name="API_agent_ValidateFlowDefinition_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent_ValidateFlowDefinition_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [definition](#API_agent_ValidateFlowDefinition_RequestSyntax) **   <a name="bedrock-agent_ValidateFlowDefinition-request-definition"></a>
The definition of a flow to validate.  
Type: [FlowDefinition](API_agent_FlowDefinition.md) object  
Required: Yes

## Response Syntax
<a name="API_agent_ValidateFlowDefinition_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "validations": [ 
      { 
         "details": { ... },
         "message": "string",
         "severity": "string",
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_agent_ValidateFlowDefinition_ResponseElements"></a>

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) **   <a name="bedrock-agent_ValidateFlowDefinition-response-validations"></a>
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
<a name="API_agent_ValidateFlowDefinition_Errors"></a>

For information about 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
<a name="API_agent_ValidateFlowDefinition_SeeAlso"></a>

For more information about using this API 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
<a name="API_Operations_Agents_for_Amazon_Bedrock_Runtime"></a>

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
<a name="API_agent-runtime_CreateInvocation"></a>

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
<a name="API_agent-runtime_CreateInvocation_RequestSyntax"></a>

```
PUT /sessions/sessionIdentifier/invocations/ HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "invocationId": "string"
}
```

## URI Request Parameters
<a name="API_agent-runtime_CreateInvocation_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sessionIdentifier](#API_agent-runtime_CreateInvocation_RequestSyntax) **   <a name="bedrock-agent-runtime_CreateInvocation-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_CreateInvocation_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [description](#API_agent-runtime_CreateInvocation_RequestSyntax) **   <a name="bedrock-agent-runtime_CreateInvocation-request-description"></a>
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 name="bedrock-agent-runtime_CreateInvocation-request-invocationId"></a>
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
<a name="API_agent-runtime_CreateInvocation_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdAt": "string",
   "invocationId": "string",
   "sessionId": "string"
}
```

## Response Elements
<a name="API_agent-runtime_CreateInvocation_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_CreateInvocation-response-createdAt"></a>
The timestamp for when the invocation was created.  
Type: Timestamp

 ** [invocationId](#API_agent-runtime_CreateInvocation_ResponseSyntax) **   <a name="bedrock-agent-runtime_CreateInvocation-response-invocationId"></a>
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) **   <a name="bedrock-agent-runtime_CreateInvocation-response-sessionId"></a>
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
<a name="API_agent-runtime_CreateInvocation_Errors"></a>

For information about 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
<a name="API_agent-runtime_CreateInvocation_Examples"></a>

### Request example
<a name="API_agent-runtime_CreateInvocation_Example_1"></a>

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
<a name="API_agent-runtime_CreateInvocation_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_CreateSession"></a>

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
<a name="API_agent-runtime_CreateSession_RequestSyntax"></a>

```
PUT /sessions/ HTTP/1.1
Content-type: application/json

{
   "encryptionKeyArn": "string",
   "sessionMetadata": { 
      "string" : "string" 
   },
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_agent-runtime_CreateSession_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent-runtime_CreateSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [encryptionKeyArn](#API_agent-runtime_CreateSession_RequestSyntax) **   <a name="bedrock-agent-runtime_CreateSession-request-encryptionKeyArn"></a>
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 name="bedrock-agent-runtime_CreateSession-request-sessionMetadata"></a>
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) **   <a name="bedrock-agent-runtime_CreateSession-request-tags"></a>
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
<a name="API_agent-runtime_CreateSession_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "createdAt": "string",
   "sessionArn": "string",
   "sessionId": "string",
   "sessionStatus": "string"
}
```

## Response Elements
<a name="API_agent-runtime_CreateSession_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_CreateSession-response-createdAt"></a>
The timestamp for when the session was created.  
Type: Timestamp

 ** [sessionArn](#API_agent-runtime_CreateSession_ResponseSyntax) **   <a name="bedrock-agent-runtime_CreateSession-response-sessionArn"></a>
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) **   <a name="bedrock-agent-runtime_CreateSession-response-sessionId"></a>
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) **   <a name="bedrock-agent-runtime_CreateSession-response-sessionStatus"></a>
The current status of the session.  
Type: String  
Valid Values: `ACTIVE | EXPIRED | ENDED` 

## Errors
<a name="API_agent-runtime_CreateSession_Errors"></a>

For information about 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
<a name="API_agent-runtime_CreateSession_Examples"></a>

### Example request
<a name="API_agent-runtime_CreateSession_Example_1"></a>

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
<a name="API_agent-runtime_CreateSession_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_DeleteAgentMemory"></a>

Deletes memory from the specified memory identifier.

## Request Syntax
<a name="API_agent-runtime_DeleteAgentMemory_RequestSyntax"></a>

```
DELETE /agents/agentId/agentAliases/agentAliasId/memories?memoryId=memoryId&sessionId=sessionId HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_DeleteAgentMemory_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentAliasId](#API_agent-runtime_DeleteAgentMemory_RequestSyntax) **   <a name="bedrock-agent-runtime_DeleteAgentMemory-request-uri-agentAliasId"></a>
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) **   <a name="bedrock-agent-runtime_DeleteAgentMemory-request-uri-agentId"></a>
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) **   <a name="bedrock-agent-runtime_DeleteAgentMemory-request-uri-memoryId"></a>
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) **   <a name="bedrock-agent-runtime_DeleteAgentMemory-request-uri-sessionId"></a>
The unique session identifier of the memory.  
Length Constraints: Minimum length of 2. Maximum length of 100.  
Pattern: `[0-9a-zA-Z._:-]+` 

## Request Body
<a name="API_agent-runtime_DeleteAgentMemory_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_DeleteAgentMemory_ResponseSyntax"></a>

```
HTTP/1.1 202
```

## Response Elements
<a name="API_agent-runtime_DeleteAgentMemory_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 202 response with an empty HTTP body.

## Errors
<a name="API_agent-runtime_DeleteAgentMemory_Errors"></a>

For information about 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
<a name="API_agent-runtime_DeleteAgentMemory_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_DeleteSession"></a>

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
<a name="API_agent-runtime_DeleteSession_RequestSyntax"></a>

```
DELETE /sessions/sessionIdentifier/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_DeleteSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sessionIdentifier](#API_agent-runtime_DeleteSession_RequestSyntax) **   <a name="bedrock-agent-runtime_DeleteSession-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_DeleteSession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_DeleteSession_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_agent-runtime_DeleteSession_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_agent-runtime_DeleteSession_Errors"></a>

For information about 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
<a name="API_agent-runtime_DeleteSession_Examples"></a>

### Example request
<a name="API_agent-runtime_DeleteSession_Example_1"></a>

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
<a name="API_agent-runtime_DeleteSession_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_EndSession"></a>

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
<a name="API_agent-runtime_EndSession_RequestSyntax"></a>

```
PATCH /sessions/sessionIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_EndSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sessionIdentifier](#API_agent-runtime_EndSession_RequestSyntax) **   <a name="bedrock-agent-runtime_EndSession-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_EndSession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_EndSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "sessionArn": "string",
   "sessionId": "string",
   "sessionStatus": "string"
}
```

## Response Elements
<a name="API_agent-runtime_EndSession_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_EndSession-response-sessionArn"></a>
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) **   <a name="bedrock-agent-runtime_EndSession-response-sessionId"></a>
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) **   <a name="bedrock-agent-runtime_EndSession-response-sessionStatus"></a>
The current status of the session you ended.  
Type: String  
Valid Values: `ACTIVE | EXPIRED | ENDED` 

## Errors
<a name="API_agent-runtime_EndSession_Errors"></a>

For information about 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
<a name="API_agent-runtime_EndSession_Examples"></a>

### Example request
<a name="API_agent-runtime_EndSession_Example_1"></a>

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
<a name="API_agent-runtime_EndSession_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_GenerateQuery"></a>

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
<a name="API_agent-runtime_GenerateQuery_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_GenerateQuery_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent-runtime_GenerateQuery_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [queryGenerationInput](#API_agent-runtime_GenerateQuery_RequestSyntax) **   <a name="bedrock-agent-runtime_GenerateQuery-request-queryGenerationInput"></a>
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) **   <a name="bedrock-agent-runtime_GenerateQuery-request-transformationConfiguration"></a>
Specifies configurations for transforming the natural language query into SQL.  
Type: [TransformationConfiguration](API_agent-runtime_TransformationConfiguration.md) object  
Required: Yes

## Response Syntax
<a name="API_agent-runtime_GenerateQuery_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "queries": [ 
      { 
         "sql": "string",
         "type": "string"
      }
   ]
}
```

## Response Elements
<a name="API_agent-runtime_GenerateQuery_ResponseElements"></a>

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 name="bedrock-agent-runtime_GenerateQuery-response-queries"></a>
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
<a name="API_agent-runtime_GenerateQuery_Errors"></a>

For information about 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
<a name="API_agent-runtime_GenerateQuery_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_GetAgentMemory"></a>

Gets the sessions stored in the memory of the agent.

## Request Syntax
<a name="API_agent-runtime_GetAgentMemory_RequestSyntax"></a>

```
GET /agents/agentId/agentAliases/agentAliasId/memories?maxItems=maxItems&memoryId=memoryId&memoryType=memoryType&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_GetAgentMemory_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentAliasId](#API_agent-runtime_GetAgentMemory_RequestSyntax) **   <a name="bedrock-agent-runtime_GetAgentMemory-request-uri-agentAliasId"></a>
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) **   <a name="bedrock-agent-runtime_GetAgentMemory-request-uri-agentId"></a>
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) **   <a name="bedrock-agent-runtime_GetAgentMemory-request-uri-maxItems"></a>
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) **   <a name="bedrock-agent-runtime_GetAgentMemory-request-uri-memoryId"></a>
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) **   <a name="bedrock-agent-runtime_GetAgentMemory-request-uri-memoryType"></a>
The type of memory.  
Valid Values: `SESSION_SUMMARY`   
Required: Yes

 ** [nextToken](#API_agent-runtime_GetAgentMemory_RequestSyntax) **   <a name="bedrock-agent-runtime_GetAgentMemory-request-uri-nextToken"></a>
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
<a name="API_agent-runtime_GetAgentMemory_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_GetAgentMemory_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "memoryContents": [ 
      { ... }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_agent-runtime_GetAgentMemory_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_GetAgentMemory-response-memoryContents"></a>
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) **   <a name="bedrock-agent-runtime_GetAgentMemory-response-nextToken"></a>
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
<a name="API_agent-runtime_GetAgentMemory_Errors"></a>

For information about 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
<a name="API_agent-runtime_GetAgentMemory_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_GetExecutionFlowSnapshot"></a>

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
<a name="API_agent-runtime_GetExecutionFlowSnapshot_RequestSyntax"></a>

```
GET /flows/flowIdentifier/aliases/flowAliasIdentifier/executions/executionIdentifier/flowsnapshot HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_GetExecutionFlowSnapshot_RequestParameters"></a>

The request uses the following URI parameters.

 ** [executionIdentifier](#API_agent-runtime_GetExecutionFlowSnapshot_RequestSyntax) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-request-uri-executionIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-request-uri-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-request-uri-flowIdentifier"></a>
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
<a name="API_agent-runtime_GetExecutionFlowSnapshot_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_GetExecutionFlowSnapshot_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "customerEncryptionKeyArn": "string",
   "definition": "string",
   "executionRoleArn": "string",
   "flowAliasIdentifier": "string",
   "flowIdentifier": "string",
   "flowVersion": "string"
}
```

## Response Elements
<a name="API_agent-runtime_GetExecutionFlowSnapshot_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-response-customerEncryptionKeyArn"></a>
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) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-response-definition"></a>
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) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-response-executionRoleArn"></a>
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) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-response-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-response-flowIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_GetExecutionFlowSnapshot-response-flowVersion"></a>
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
<a name="API_agent-runtime_GetExecutionFlowSnapshot_Errors"></a>

For information about 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
<a name="API_agent-runtime_GetExecutionFlowSnapshot_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_GetFlowExecution"></a>

Retrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.

## Request Syntax
<a name="API_agent-runtime_GetFlowExecution_RequestSyntax"></a>

```
GET /flows/flowIdentifier/aliases/flowAliasIdentifier/executions/executionIdentifier HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_GetFlowExecution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [executionIdentifier](#API_agent-runtime_GetFlowExecution_RequestSyntax) **   <a name="bedrock-agent-runtime_GetFlowExecution-request-uri-executionIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_GetFlowExecution-request-uri-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_GetFlowExecution-request-uri-flowIdentifier"></a>
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
<a name="API_agent-runtime_GetFlowExecution_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_GetFlowExecution_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_GetFlowExecution_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_GetFlowExecution-response-endedAt"></a>
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 name="bedrock-agent-runtime_GetFlowExecution-response-errors"></a>
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) **   <a name="bedrock-agent-runtime_GetFlowExecution-response-executionArn"></a>
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) **   <a name="bedrock-agent-runtime_GetFlowExecution-response-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_GetFlowExecution-response-flowIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_GetFlowExecution-response-flowVersion"></a>
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) **   <a name="bedrock-agent-runtime_GetFlowExecution-response-startedAt"></a>
The timestamp when the flow execution started.  
Type: Timestamp

 ** [status](#API_agent-runtime_GetFlowExecution_ResponseSyntax) **   <a name="bedrock-agent-runtime_GetFlowExecution-response-status"></a>
The current status of the flow execution.  
Flow executions time out after 24 hours.  
Type: String  
Valid Values: `Running | Succeeded | Failed | TimedOut | Aborted` 

## Errors
<a name="API_agent-runtime_GetFlowExecution_Errors"></a>

For information about 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
<a name="API_agent-runtime_GetFlowExecution_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_GetInvocationStep"></a>

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
<a name="API_agent-runtime_GetInvocationStep_RequestSyntax"></a>

```
POST /sessions/sessionIdentifier/invocationSteps/invocationStepId HTTP/1.1
Content-type: application/json

{
   "invocationIdentifier": "string"
}
```

## URI Request Parameters
<a name="API_agent-runtime_GetInvocationStep_RequestParameters"></a>

The request uses the following URI parameters.

 ** [invocationStepId](#API_agent-runtime_GetInvocationStep_RequestSyntax) **   <a name="bedrock-agent-runtime_GetInvocationStep-request-uri-invocationStepId"></a>
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) **   <a name="bedrock-agent-runtime_GetInvocationStep-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_GetInvocationStep_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [invocationIdentifier](#API_agent-runtime_GetInvocationStep_RequestSyntax) **   <a name="bedrock-agent-runtime_GetInvocationStep-request-invocationIdentifier"></a>
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
<a name="API_agent-runtime_GetInvocationStep_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "invocationStep": { 
      "invocationId": "string",
      "invocationStepId": "string",
      "invocationStepTime": "string",
      "payload": { ... },
      "sessionId": "string"
   }
}
```

## Response Elements
<a name="API_agent-runtime_GetInvocationStep_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_GetInvocationStep-response-invocationStep"></a>
The complete details of the requested invocation step.  
Type: [InvocationStep](API_agent-runtime_InvocationStep.md) object

## Errors
<a name="API_agent-runtime_GetInvocationStep_Errors"></a>

For information about 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
<a name="API_agent-runtime_GetInvocationStep_Examples"></a>

### Example request
<a name="API_agent-runtime_GetInvocationStep_Example_1"></a>

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
<a name="API_agent-runtime_GetInvocationStep_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_GetSession"></a>

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
<a name="API_agent-runtime_GetSession_RequestSyntax"></a>

```
GET /sessions/sessionIdentifier/ HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_GetSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sessionIdentifier](#API_agent-runtime_GetSession_RequestSyntax) **   <a name="bedrock-agent-runtime_GetSession-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_GetSession_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_GetSession_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_GetSession_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_GetSession-response-createdAt"></a>
The timestamp for when the session was created.  
Type: Timestamp

 ** [encryptionKeyArn](#API_agent-runtime_GetSession_ResponseSyntax) **   <a name="bedrock-agent-runtime_GetSession-response-encryptionKeyArn"></a>
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) **   <a name="bedrock-agent-runtime_GetSession-response-lastUpdatedAt"></a>
The timestamp for when the session was last modified.  
Type: Timestamp

 ** [sessionArn](#API_agent-runtime_GetSession_ResponseSyntax) **   <a name="bedrock-agent-runtime_GetSession-response-sessionArn"></a>
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) **   <a name="bedrock-agent-runtime_GetSession-response-sessionId"></a>
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 name="bedrock-agent-runtime_GetSession-response-sessionMetadata"></a>
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) **   <a name="bedrock-agent-runtime_GetSession-response-sessionStatus"></a>
The current status of the session.  
Type: String  
Valid Values: `ACTIVE | EXPIRED | ENDED` 

## Errors
<a name="API_agent-runtime_GetSession_Errors"></a>

For information about 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
<a name="API_agent-runtime_GetSession_Examples"></a>

### Example request
<a name="API_agent-runtime_GetSession_Example_1"></a>

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
<a name="API_agent-runtime_GetSession_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_InvokeAgent"></a>

**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
<a name="API_agent-runtime_InvokeAgent_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_InvokeAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [agentAliasId](#API_agent-runtime_InvokeAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeAgent-request-uri-agentAliasId"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-request-uri-agentId"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-request-uri-sessionId"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-request-sourceArn"></a>
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
<a name="API_agent-runtime_InvokeAgent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [bedrockModelConfigurations](#API_agent-runtime_InvokeAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeAgent-request-bedrockModelConfigurations"></a>
Model performance settings for the request.  
Type: [BedrockModelConfigurations](API_agent-runtime_BedrockModelConfigurations.md) object  
Required: No

 ** [enableTrace](#API_agent-runtime_InvokeAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeAgent-request-enableTrace"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-request-endSession"></a>
Specifies whether to end the session with the agent or not.  
Type: Boolean  
Required: No

 ** [inputText](#API_agent-runtime_InvokeAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeAgent-request-inputText"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-request-memoryId"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-request-promptCreationConfigurations"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-request-sessionState"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-request-streamingConfigurations"></a>
 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
<a name="API_agent-runtime_InvokeAgent_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_InvokeAgent_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-contentType"></a>
The MIME type of the input data in the request. The default value is `application/json`.

 ** [memoryId](#API_agent-runtime_InvokeAgent_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeAgent-response-memoryId"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-sessionId"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-accessDeniedException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-badGatewayException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-chunk"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-conflictException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-dependencyFailedException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-files"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500

 ** [modelNotReadyException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeAgent-response-modelNotReadyException"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-resourceNotFoundException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-returnControl"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-serviceQuotaExceededException"></a>
The number of requests exceeds the service quota. Resubmit your request later.  
Type: Exception  
HTTP Status Code: 400

 ** [throttlingException](#API_agent-runtime_InvokeAgent_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeAgent-response-throttlingException"></a>
The number of requests exceeds the limit. Resubmit your request later.  
Type: Exception  
HTTP Status Code: 429

 ** [trace](#API_agent-runtime_InvokeAgent_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeAgent-response-trace"></a>
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) **   <a name="bedrock-agent-runtime_InvokeAgent-response-validationException"></a>
Input validation failed. Check your request parameters and retry the request.  
Type: Exception  
HTTP Status Code: 400

## Errors
<a name="API_agent-runtime_InvokeAgent_Errors"></a>

For information about 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
<a name="API_agent-runtime_InvokeAgent_Examples"></a>

### Example simple request
<a name="API_agent-runtime_InvokeAgent_Example_1"></a>

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)
<a name="API_agent-runtime_InvokeAgent_Example_2"></a>

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)
<a name="API_agent-runtime_InvokeAgent_Example_3"></a>

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)
<a name="API_agent-runtime_InvokeAgent_Example_4"></a>

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)
<a name="API_agent-runtime_InvokeAgent_Example_5"></a>

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
<a name="API_agent-runtime_InvokeAgent_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_InvokeFlow"></a>

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
<a name="API_agent-runtime_InvokeFlow_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_InvokeFlow_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowAliasIdentifier](#API_agent-runtime_InvokeFlow_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeFlow-request-uri-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-request-uri-flowIdentifier"></a>
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
<a name="API_agent-runtime_InvokeFlow_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [enableTrace](#API_agent-runtime_InvokeFlow_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeFlow-request-enableTrace"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-request-executionId"></a>
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 name="bedrock-agent-runtime_InvokeFlow-request-inputs"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-request-modelPerformanceConfiguration"></a>
Model performance settings for the request.  
Type: [ModelPerformanceConfiguration](API_agent-runtime_ModelPerformanceConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_agent-runtime_InvokeFlow_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_InvokeFlow_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-executionId"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-accessDeniedException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-badGatewayException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-conflictException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-dependencyFailedException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-flowCompletionEvent"></a>
Contains information about why the flow completed.  
Type: [FlowCompletionEvent](API_agent-runtime_FlowCompletionEvent.md) object

 ** [flowMultiTurnInputRequestEvent](#API_agent-runtime_InvokeFlow_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeFlow-response-flowMultiTurnInputRequestEvent"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-flowOutputEvent"></a>
Contains information about an output from flow invocation.  
Type: [FlowOutputEvent](API_agent-runtime_FlowOutputEvent.md) object

 ** [flowTraceEvent](#API_agent-runtime_InvokeFlow_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeFlow-response-flowTraceEvent"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500

 ** [resourceNotFoundException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeFlow-response-resourceNotFoundException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeFlow-response-serviceQuotaExceededException"></a>
The number of requests exceeds the service quota. Resubmit your request later.  
Type: Exception  
HTTP Status Code: 400

 ** [throttlingException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeFlow-response-throttlingException"></a>
The number of requests exceeds the limit. Resubmit your request later.  
Type: Exception  
HTTP Status Code: 429

 ** [validationException](#API_agent-runtime_InvokeFlow_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeFlow-response-validationException"></a>
Input validation failed. Check your request parameters and retry the request.  
Type: Exception  
HTTP Status Code: 400

## Errors
<a name="API_agent-runtime_InvokeFlow_Errors"></a>

For information about 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
<a name="API_agent-runtime_InvokeFlow_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_InvokeInlineAgent"></a>

 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
<a name="API_agent-runtime_InvokeInlineAgent_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_InvokeInlineAgent_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sessionId](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-uri-sessionId"></a>
 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
<a name="API_agent-runtime_InvokeInlineAgent_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [actionGroups](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-actionGroups"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-agentCollaboration"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-agentName"></a>
The name for the agent.  
Type: String  
Pattern: `([0-9a-zA-Z][_-]?){1,100}`   
Required: No

 ** [bedrockModelConfigurations](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-bedrockModelConfigurations"></a>
Model settings for the request.  
Type: [InlineBedrockModelConfigurations](API_agent-runtime_InlineBedrockModelConfigurations.md) object  
Required: No

 ** [collaboratorConfigurations](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-collaboratorConfigurations"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-collaborators"></a>
 List of collaborator inline agents.   
Type: Array of [Collaborator](API_agent-runtime_Collaborator.md) objects  
Required: No

 ** [customerEncryptionKeyArn](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-customerEncryptionKeyArn"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-customOrchestration"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-enableTrace"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-endSession"></a>
 Specifies whether to end the session with the inline agent or not.   
Type: Boolean  
Required: No

 ** [foundationModel](#API_agent-runtime_InvokeInlineAgent_RequestSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-foundationModel"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-guardrailConfiguration"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-idleSessionTTLInSeconds"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-inlineSessionState"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-inputText"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-instruction"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-knowledgeBases"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-orchestrationType"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-promptCreationConfigurations"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-promptOverrideConfiguration"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-request-streamingConfigurations"></a>
 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
<a name="API_agent-runtime_InvokeInlineAgent_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_InvokeInlineAgent_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-contentType"></a>
 The MIME type of the input data in the request. The default value is application/json. 

 ** [sessionId](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-sessionId"></a>
 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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-accessDeniedException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-badGatewayException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-chunk"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-conflictException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-dependencyFailedException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-files"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500

 ** [resourceNotFoundException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-resourceNotFoundException"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-returnControl"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-serviceQuotaExceededException"></a>
The number of requests exceeds the service quota. Resubmit your request later.  
Type: Exception  
HTTP Status Code: 400

 ** [throttlingException](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-throttlingException"></a>
The number of requests exceeds the limit. Resubmit your request later.  
Type: Exception  
HTTP Status Code: 429

 ** [trace](#API_agent-runtime_InvokeInlineAgent_ResponseSyntax) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-trace"></a>
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) **   <a name="bedrock-agent-runtime_InvokeInlineAgent-response-validationException"></a>
Input validation failed. Check your request parameters and retry the request.  
Type: Exception  
HTTP Status Code: 400

## Errors
<a name="API_agent-runtime_InvokeInlineAgent_Errors"></a>

For information about 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
<a name="API_agent-runtime_InvokeInlineAgent_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_ListFlowExecutionEvents"></a>

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
<a name="API_agent-runtime_ListFlowExecutionEvents_RequestSyntax"></a>

```
GET /flows/flowIdentifier/aliases/flowAliasIdentifier/executions/executionIdentifier/events?eventType=eventType&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_ListFlowExecutionEvents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [eventType](#API_agent-runtime_ListFlowExecutionEvents_RequestSyntax) **   <a name="bedrock-agent-runtime_ListFlowExecutionEvents-request-uri-eventType"></a>
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) **   <a name="bedrock-agent-runtime_ListFlowExecutionEvents-request-uri-executionIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_ListFlowExecutionEvents-request-uri-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_ListFlowExecutionEvents-request-uri-flowIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_ListFlowExecutionEvents-request-uri-maxResults"></a>
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 name="bedrock-agent-runtime_ListFlowExecutionEvents-request-uri-nextToken"></a>
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
<a name="API_agent-runtime_ListFlowExecutionEvents_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_ListFlowExecutionEvents_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "flowExecutionEvents": [ 
      { ... }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_agent-runtime_ListFlowExecutionEvents_ResponseElements"></a>

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 name="bedrock-agent-runtime_ListFlowExecutionEvents-response-flowExecutionEvents"></a>
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 name="bedrock-agent-runtime_ListFlowExecutionEvents-response-nextToken"></a>
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
<a name="API_agent-runtime_ListFlowExecutionEvents_Errors"></a>

For information about 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
<a name="API_agent-runtime_ListFlowExecutionEvents_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_ListFlowExecutions"></a>

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
<a name="API_agent-runtime_ListFlowExecutions_RequestSyntax"></a>

```
GET /flows/flowIdentifier/executions?flowAliasIdentifier=flowAliasIdentifier&maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_ListFlowExecutions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowAliasIdentifier](#API_agent-runtime_ListFlowExecutions_RequestSyntax) **   <a name="bedrock-agent-runtime_ListFlowExecutions-request-uri-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_ListFlowExecutions-request-uri-flowIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_ListFlowExecutions-request-uri-maxResults"></a>
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 name="bedrock-agent-runtime_ListFlowExecutions-request-uri-nextToken"></a>
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
<a name="API_agent-runtime_ListFlowExecutions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_ListFlowExecutions_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_ListFlowExecutions_ResponseElements"></a>

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 name="bedrock-agent-runtime_ListFlowExecutions-response-flowExecutionSummaries"></a>
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 name="bedrock-agent-runtime_ListFlowExecutions-response-nextToken"></a>
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
<a name="API_agent-runtime_ListFlowExecutions_Errors"></a>

For information about 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
<a name="API_agent-runtime_ListFlowExecutions_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_ListInvocations"></a>

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
<a name="API_agent-runtime_ListInvocations_RequestSyntax"></a>

```
POST /sessions/sessionIdentifier/invocations/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_ListInvocations_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_agent-runtime_ListInvocations_RequestSyntax) **   <a name="bedrock-agent-runtime_ListInvocations-request-uri-maxResults"></a>
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) **   <a name="bedrock-agent-runtime_ListInvocations-request-uri-nextToken"></a>
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) **   <a name="bedrock-agent-runtime_ListInvocations-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_ListInvocations_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_ListInvocations_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "invocationSummaries": [ 
      { 
         "createdAt": "string",
         "invocationId": "string",
         "sessionId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_agent-runtime_ListInvocations_ResponseElements"></a>

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 name="bedrock-agent-runtime_ListInvocations-response-invocationSummaries"></a>
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) **   <a name="bedrock-agent-runtime_ListInvocations-response-nextToken"></a>
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
<a name="API_agent-runtime_ListInvocations_Errors"></a>

For information about 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
<a name="API_agent-runtime_ListInvocations_Examples"></a>

### Example request
<a name="API_agent-runtime_ListInvocations_Example_1"></a>

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
<a name="API_agent-runtime_ListInvocations_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_ListInvocationSteps"></a>

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
<a name="API_agent-runtime_ListInvocationSteps_RequestSyntax"></a>

```
POST /sessions/sessionIdentifier/invocationSteps/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
Content-type: application/json

{
   "invocationIdentifier": "string"
}
```

## URI Request Parameters
<a name="API_agent-runtime_ListInvocationSteps_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_agent-runtime_ListInvocationSteps_RequestSyntax) **   <a name="bedrock-agent-runtime_ListInvocationSteps-request-uri-maxResults"></a>
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) **   <a name="bedrock-agent-runtime_ListInvocationSteps-request-uri-nextToken"></a>
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) **   <a name="bedrock-agent-runtime_ListInvocationSteps-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_ListInvocationSteps_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [invocationIdentifier](#API_agent-runtime_ListInvocationSteps_RequestSyntax) **   <a name="bedrock-agent-runtime_ListInvocationSteps-request-invocationIdentifier"></a>
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
<a name="API_agent-runtime_ListInvocationSteps_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "invocationStepSummaries": [ 
      { 
         "invocationId": "string",
         "invocationStepId": "string",
         "invocationStepTime": "string",
         "sessionId": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_agent-runtime_ListInvocationSteps_ResponseElements"></a>

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 name="bedrock-agent-runtime_ListInvocationSteps-response-invocationStepSummaries"></a>
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) **   <a name="bedrock-agent-runtime_ListInvocationSteps-response-nextToken"></a>
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
<a name="API_agent-runtime_ListInvocationSteps_Errors"></a>

For information about 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
<a name="API_agent-runtime_ListInvocationSteps_Examples"></a>

### Example request
<a name="API_agent-runtime_ListInvocationSteps_Example_1"></a>

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
<a name="API_agent-runtime_ListInvocationSteps_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_ListSessions"></a>

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
<a name="API_agent-runtime_ListSessions_RequestSyntax"></a>

```
POST /sessions/?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_ListSessions_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_agent-runtime_ListSessions_RequestSyntax) **   <a name="bedrock-agent-runtime_ListSessions-request-uri-maxResults"></a>
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) **   <a name="bedrock-agent-runtime_ListSessions-request-uri-nextToken"></a>
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
<a name="API_agent-runtime_ListSessions_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_ListSessions_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "sessionSummaries": [ 
      { 
         "createdAt": "string",
         "lastUpdatedAt": "string",
         "sessionArn": "string",
         "sessionId": "string",
         "sessionStatus": "string"
      }
   ]
}
```

## Response Elements
<a name="API_agent-runtime_ListSessions_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_ListSessions-response-nextToken"></a>
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 name="bedrock-agent-runtime_ListSessions-response-sessionSummaries"></a>
A list of summaries for each session in your AWS account.  
Type: Array of [SessionSummary](API_agent-runtime_SessionSummary.md) objects

## Errors
<a name="API_agent-runtime_ListSessions_Errors"></a>

For information about 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
<a name="API_agent-runtime_ListSessions_Examples"></a>

### Example request
<a name="API_agent-runtime_ListSessions_Example_1"></a>

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
<a name="API_agent-runtime_ListSessions_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_ListTagsForResource"></a>

List all the tags for the resource you specify.

## Request Syntax
<a name="API_agent-runtime_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_ListTagsForResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_agent-runtime_ListTagsForResource_RequestSyntax) **   <a name="bedrock-agent-runtime_ListTagsForResource-request-uri-resourceArn"></a>
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
<a name="API_agent-runtime_ListTagsForResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_agent-runtime_ListTagsForResource_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_ListTagsForResource-response-tags"></a>
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
<a name="API_agent-runtime_ListTagsForResource_Errors"></a>

For information about 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
<a name="API_agent-runtime_ListTagsForResource_Examples"></a>

### Example request
<a name="API_agent-runtime_ListTagsForResource_Example_1"></a>

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
<a name="API_agent-runtime_ListTagsForResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_OptimizePrompt"></a>

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
<a name="API_agent-runtime_OptimizePrompt_RequestSyntax"></a>

```
POST /optimize-prompt HTTP/1.1
Content-type: application/json

{
   "input": { ... },
   "targetModelId": "string"
}
```

## URI Request Parameters
<a name="API_agent-runtime_OptimizePrompt_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent-runtime_OptimizePrompt_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [input](#API_agent-runtime_OptimizePrompt_RequestSyntax) **   <a name="bedrock-agent-runtime_OptimizePrompt-request-input"></a>
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) **   <a name="bedrock-agent-runtime_OptimizePrompt-request-targetModelId"></a>
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
<a name="API_agent-runtime_OptimizePrompt_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "accessDeniedException": { 
   },
   "analyzePromptEvent": { 
      "message": "string"
   },
   "badGatewayException": { 
   },
   "dependencyFailedException": { 
   },
   "internalServerException": { 
   },
   "optimizedPromptEvent": { 
      "optimizedPrompt": { ... }
   },
   "throttlingException": { 
   },
   "validationException": { 
   }
}
```

## Response Elements
<a name="API_agent-runtime_OptimizePrompt_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_OptimizePrompt-response-accessDeniedException"></a>
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) **   <a name="bedrock-agent-runtime_OptimizePrompt-response-analyzePromptEvent"></a>
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) **   <a name="bedrock-agent-runtime_OptimizePrompt-response-badGatewayException"></a>
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) **   <a name="bedrock-agent-runtime_OptimizePrompt-response-dependencyFailedException"></a>
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) **   <a name="bedrock-agent-runtime_OptimizePrompt-response-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500

 ** [optimizedPromptEvent](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **   <a name="bedrock-agent-runtime_OptimizePrompt-response-optimizedPromptEvent"></a>
An event in which the prompt was optimized.  
Type: [OptimizedPromptEvent](API_agent-runtime_OptimizedPromptEvent.md) object

 ** [throttlingException](#API_agent-runtime_OptimizePrompt_ResponseSyntax) **   <a name="bedrock-agent-runtime_OptimizePrompt-response-throttlingException"></a>
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) **   <a name="bedrock-agent-runtime_OptimizePrompt-response-validationException"></a>
Input validation failed. Check your request parameters and retry the request.  
Type: Exception  
HTTP Status Code: 400

## Errors
<a name="API_agent-runtime_OptimizePrompt_Errors"></a>

For information about 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
<a name="API_agent-runtime_OptimizePrompt_Examples"></a>

### Example
<a name="API_agent-runtime_OptimizePrompt_Example_1"></a>

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
<a name="API_agent-runtime_OptimizePrompt_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_PutInvocationStep"></a>

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
<a name="API_agent-runtime_PutInvocationStep_RequestSyntax"></a>

```
PUT /sessions/sessionIdentifier/invocationSteps/ HTTP/1.1
Content-type: application/json

{
   "invocationIdentifier": "string",
   "invocationStepId": "string",
   "invocationStepTime": "string",
   "payload": { ... }
}
```

## URI Request Parameters
<a name="API_agent-runtime_PutInvocationStep_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sessionIdentifier](#API_agent-runtime_PutInvocationStep_RequestSyntax) **   <a name="bedrock-agent-runtime_PutInvocationStep-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_PutInvocationStep_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [invocationIdentifier](#API_agent-runtime_PutInvocationStep_RequestSyntax) **   <a name="bedrock-agent-runtime_PutInvocationStep-request-invocationIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_PutInvocationStep-request-invocationStepId"></a>
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) **   <a name="bedrock-agent-runtime_PutInvocationStep-request-invocationStepTime"></a>
The timestamp for when the invocation step occurred.  
Type: Timestamp  
Required: Yes

 ** [payload](#API_agent-runtime_PutInvocationStep_RequestSyntax) **   <a name="bedrock-agent-runtime_PutInvocationStep-request-payload"></a>
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
<a name="API_agent-runtime_PutInvocationStep_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "invocationStepId": "string"
}
```

## Response Elements
<a name="API_agent-runtime_PutInvocationStep_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_PutInvocationStep-response-invocationStepId"></a>
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
<a name="API_agent-runtime_PutInvocationStep_Errors"></a>

For information about 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
<a name="API_agent-runtime_PutInvocationStep_Examples"></a>

### Example request
<a name="API_agent-runtime_PutInvocationStep_Example_1"></a>

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
<a name="API_agent-runtime_PutInvocationStep_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_Rerank"></a>

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
<a name="API_agent-runtime_Rerank_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_Rerank_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent-runtime_Rerank_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [nextToken](#API_agent-runtime_Rerank_RequestSyntax) **   <a name="bedrock-agent-runtime_Rerank-request-nextToken"></a>
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) **   <a name="bedrock-agent-runtime_Rerank-request-queries"></a>
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) **   <a name="bedrock-agent-runtime_Rerank-request-rerankingConfiguration"></a>
Contains configurations for reranking.  
Type: [RerankingConfiguration](API_agent-runtime_RerankingConfiguration.md) object  
Required: Yes

 ** [sources](#API_agent-runtime_Rerank_RequestSyntax) **   <a name="bedrock-agent-runtime_Rerank-request-sources"></a>
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
<a name="API_agent-runtime_Rerank_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_Rerank_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_Rerank-response-nextToken"></a>
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) **   <a name="bedrock-agent-runtime_Rerank-response-results"></a>
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
<a name="API_agent-runtime_Rerank_Errors"></a>

For information about 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
<a name="API_agent-runtime_Rerank_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_Retrieve"></a>

Queries a knowledge base and retrieves information from it.

## Request Syntax
<a name="API_agent-runtime_Retrieve_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_Retrieve_RequestParameters"></a>

The request uses the following URI parameters.

 ** [knowledgeBaseId](#API_agent-runtime_Retrieve_RequestSyntax) **   <a name="bedrock-agent-runtime_Retrieve-request-uri-knowledgeBaseId"></a>
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
<a name="API_agent-runtime_Retrieve_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [guardrailConfiguration](#API_agent-runtime_Retrieve_RequestSyntax) **   <a name="bedrock-agent-runtime_Retrieve-request-guardrailConfiguration"></a>
Guardrail settings.  
Type: [GuardrailConfiguration](API_agent-runtime_GuardrailConfiguration.md) object  
Required: No

 ** [nextToken](#API_agent-runtime_Retrieve_RequestSyntax) **   <a name="bedrock-agent-runtime_Retrieve-request-nextToken"></a>
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) **   <a name="bedrock-agent-runtime_Retrieve-request-retrievalConfiguration"></a>
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) **   <a name="bedrock-agent-runtime_Retrieve-request-retrievalQuery"></a>
Contains the query to send the knowledge base.  
Type: [KnowledgeBaseQuery](API_agent-runtime_KnowledgeBaseQuery.md) object  
Required: Yes

## Response Syntax
<a name="API_agent-runtime_Retrieve_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_Retrieve_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_Retrieve-response-guardrailAction"></a>
Specifies if there is a guardrail intervention in the response.  
Type: String  
Valid Values: `INTERVENED | NONE` 

 ** [nextToken](#API_agent-runtime_Retrieve_ResponseSyntax) **   <a name="bedrock-agent-runtime_Retrieve-response-nextToken"></a>
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 name="bedrock-agent-runtime_Retrieve-response-retrievalResults"></a>
A list of results from querying the knowledge base.  
Type: Array of [KnowledgeBaseRetrievalResult](API_agent-runtime_KnowledgeBaseRetrievalResult.md) objects

## Errors
<a name="API_agent-runtime_Retrieve_Errors"></a>

For information about 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
<a name="API_agent-runtime_Retrieve_Examples"></a>

### Send a basic query
<a name="API_agent-runtime_Retrieve_Example_1"></a>

The following example queries a knowledge base.

#### Sample Request
<a name="API_agent-runtime_Retrieve_Example_1_Request"></a>

```
POST /knowledgebases/KB12345678/retrieve HTTP/1.1
Content-type: application/json

{
    "retrievalQuery": {
        "text": "What is AWS?"
    }
}
```

### Send a query and include filters
<a name="API_agent-runtime_Retrieve_Example_2"></a>

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
<a name="API_agent-runtime_Retrieve_Example_2_Request"></a>

```
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
<a name="API_agent-runtime_Retrieve_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_RetrieveAndGenerate"></a>

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
<a name="API_agent-runtime_RetrieveAndGenerate_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_RetrieveAndGenerate_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent-runtime_RetrieveAndGenerate_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [input](#API_agent-runtime_RetrieveAndGenerate_RequestSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerate-request-input"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerate-request-retrieveAndGenerateConfiguration"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerate-request-sessionConfiguration"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerate-request-sessionId"></a>
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
<a name="API_agent-runtime_RetrieveAndGenerate_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_RetrieveAndGenerate_ResponseElements"></a>

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 name="bedrock-agent-runtime_RetrieveAndGenerate-response-citations"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerate-response-guardrailAction"></a>
Specifies if there is a guardrail intervention in the response.  
Type: String  
Valid Values: `INTERVENED | NONE` 

 ** [output](#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerate-response-output"></a>
Contains the response generated from querying the knowledge base.  
Type: [RetrieveAndGenerateOutput](API_agent-runtime_RetrieveAndGenerateOutput.md) object

 ** [sessionId](#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerate-response-sessionId"></a>
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
<a name="API_agent-runtime_RetrieveAndGenerate_Errors"></a>

For information about 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
<a name="API_agent-runtime_RetrieveAndGenerate_Examples"></a>

### Send a basic query
<a name="API_agent-runtime_RetrieveAndGenerate_Example_1"></a>

The following example uses the minimally required fields to generate a response after querying a knowledge base.

#### Sample Request
<a name="API_agent-runtime_RetrieveAndGenerate_Example_1_Request"></a>

```
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
<a name="API_agent-runtime_RetrieveAndGenerate_Example_2"></a>

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
<a name="API_agent-runtime_RetrieveAndGenerate_Example_2_Request"></a>

```
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
<a name="API_agent-runtime_RetrieveAndGenerate_Example_3"></a>

The following example uses an inference profile in generating a response after querying a knowledge base.

#### Sample Request
<a name="API_agent-runtime_RetrieveAndGenerate_Example_3_Request"></a>

```
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
<a name="API_agent-runtime_RetrieveAndGenerate_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_RetrieveAndGenerateStream"></a>

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
<a name="API_agent-runtime_RetrieveAndGenerateStream_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_RetrieveAndGenerateStream_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_agent-runtime_RetrieveAndGenerateStream_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [input](#API_agent-runtime_RetrieveAndGenerateStream_RequestSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-request-input"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-request-retrieveAndGenerateConfiguration"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-request-sessionConfiguration"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-request-sessionId"></a>
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
<a name="API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax"></a>

```
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
<a name="API_agent-runtime_RetrieveAndGenerateStream_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-sessionId"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-accessDeniedException"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-badGatewayException"></a>
The request failed due to a bad gateway error.  
Type: Exception  
HTTP Status Code: 502

 ** [citation](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-citation"></a>
A citation event.  
Type: [CitationEvent](API_agent-runtime_CitationEvent.md) object

 ** [conflictException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-conflictException"></a>
Error occurred because of a conflict while performing an operation.  
Type: Exception  
HTTP Status Code: 409

 ** [dependencyFailedException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-dependencyFailedException"></a>
The request failed due to a dependency error.  
Type: Exception  
HTTP Status Code: 424

 ** [guardrail](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-guardrail"></a>
A guardrail event.  
Type: [GuardrailEvent](API_agent-runtime_GuardrailEvent.md) object

 ** [internalServerException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500

 ** [output](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-output"></a>
An output event.  
Type: [RetrieveAndGenerateOutputEvent](API_agent-runtime_RetrieveAndGenerateOutputEvent.md) object

 ** [resourceNotFoundException](#API_agent-runtime_RetrieveAndGenerateStream_ResponseSyntax) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-resourceNotFoundException"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-serviceQuotaExceededException"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-throttlingException"></a>
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) **   <a name="bedrock-agent-runtime_RetrieveAndGenerateStream-response-validationException"></a>
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
<a name="API_agent-runtime_RetrieveAndGenerateStream_Errors"></a>

For information about 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
<a name="API_agent-runtime_RetrieveAndGenerateStream_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_StartFlowExecution"></a>

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
<a name="API_agent-runtime_StartFlowExecution_RequestSyntax"></a>

```
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
<a name="API_agent-runtime_StartFlowExecution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [flowAliasIdentifier](#API_agent-runtime_StartFlowExecution_RequestSyntax) **   <a name="bedrock-agent-runtime_StartFlowExecution-request-uri-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_StartFlowExecution-request-uri-flowIdentifier"></a>
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
<a name="API_agent-runtime_StartFlowExecution_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [flowExecutionName](#API_agent-runtime_StartFlowExecution_RequestSyntax) **   <a name="bedrock-agent-runtime_StartFlowExecution-request-flowExecutionName"></a>
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) **   <a name="bedrock-agent-runtime_StartFlowExecution-request-inputs"></a>
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) **   <a name="bedrock-agent-runtime_StartFlowExecution-request-modelPerformanceConfiguration"></a>
The performance settings for the foundation model used in the flow execution.  
Type: [ModelPerformanceConfiguration](API_agent-runtime_ModelPerformanceConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_agent-runtime_StartFlowExecution_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "executionArn": "string"
}
```

## Response Elements
<a name="API_agent-runtime_StartFlowExecution_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_StartFlowExecution-response-executionArn"></a>
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
<a name="API_agent-runtime_StartFlowExecution_Errors"></a>

For information about 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
<a name="API_agent-runtime_StartFlowExecution_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_StopFlowExecution"></a>

Stops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to `Aborted`.

## Request Syntax
<a name="API_agent-runtime_StopFlowExecution_RequestSyntax"></a>

```
POST /flows/flowIdentifier/aliases/flowAliasIdentifier/executions/executionIdentifier/stop HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_StopFlowExecution_RequestParameters"></a>

The request uses the following URI parameters.

 ** [executionIdentifier](#API_agent-runtime_StopFlowExecution_RequestSyntax) **   <a name="bedrock-agent-runtime_StopFlowExecution-request-uri-executionIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_StopFlowExecution-request-uri-flowAliasIdentifier"></a>
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) **   <a name="bedrock-agent-runtime_StopFlowExecution-request-uri-flowIdentifier"></a>
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
<a name="API_agent-runtime_StopFlowExecution_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_StopFlowExecution_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "executionArn": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_agent-runtime_StopFlowExecution_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_StopFlowExecution-response-executionArn"></a>
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) **   <a name="bedrock-agent-runtime_StopFlowExecution-response-status"></a>
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
<a name="API_agent-runtime_StopFlowExecution_Errors"></a>

For information about 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
<a name="API_agent-runtime_StopFlowExecution_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_TagResource"></a>

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
<a name="API_agent-runtime_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "tags": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_agent-runtime_TagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_agent-runtime_TagResource_RequestSyntax) **   <a name="bedrock-agent-runtime_TagResource-request-uri-resourceArn"></a>
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
<a name="API_agent-runtime_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [tags](#API_agent-runtime_TagResource_RequestSyntax) **   <a name="bedrock-agent-runtime_TagResource-request-tags"></a>
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
<a name="API_agent-runtime_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_agent-runtime_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_agent-runtime_TagResource_Errors"></a>

For information about 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
<a name="API_agent-runtime_TagResource_Examples"></a>

### Example request
<a name="API_agent-runtime_TagResource_Example_1"></a>

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
<a name="API_agent-runtime_TagResource_Example_2"></a>

This example illustrates one usage of TagResource.

```
HTTP/1.1 200
```

## See Also
<a name="API_agent-runtime_TagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_UntagResource"></a>

Remove tags from a resource.

## Request Syntax
<a name="API_agent-runtime_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```

## URI Request Parameters
<a name="API_agent-runtime_UntagResource_RequestParameters"></a>

The request uses the following URI parameters.

 ** [resourceArn](#API_agent-runtime_UntagResource_RequestSyntax) **   <a name="bedrock-agent-runtime_UntagResource-request-uri-resourceArn"></a>
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 name="bedrock-agent-runtime_UntagResource-request-uri-tagKeys"></a>
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
<a name="API_agent-runtime_UntagResource_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_agent-runtime_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_agent-runtime_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_agent-runtime_UntagResource_Errors"></a>

For information about 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
<a name="API_agent-runtime_UntagResource_Examples"></a>

### Example request
<a name="API_agent-runtime_UntagResource_Example_1"></a>

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
<a name="API_agent-runtime_UntagResource_Example_2"></a>

This example illustrates one usage of UntagResource.

```
HTTP/1.1 200
```

## See Also
<a name="API_agent-runtime_UntagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_agent-runtime_UpdateSession"></a>

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
<a name="API_agent-runtime_UpdateSession_RequestSyntax"></a>

```
PUT /sessions/sessionIdentifier/ HTTP/1.1
Content-type: application/json

{
   "sessionMetadata": { 
      "string" : "string" 
   }
}
```

## URI Request Parameters
<a name="API_agent-runtime_UpdateSession_RequestParameters"></a>

The request uses the following URI parameters.

 ** [sessionIdentifier](#API_agent-runtime_UpdateSession_RequestSyntax) **   <a name="bedrock-agent-runtime_UpdateSession-request-uri-sessionIdentifier"></a>
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
<a name="API_agent-runtime_UpdateSession_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [sessionMetadata](#API_agent-runtime_UpdateSession_RequestSyntax) **   <a name="bedrock-agent-runtime_UpdateSession-request-sessionMetadata"></a>
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
<a name="API_agent-runtime_UpdateSession_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "lastUpdatedAt": "string",
   "sessionArn": "string",
   "sessionId": "string",
   "sessionStatus": "string"
}
```

## Response Elements
<a name="API_agent-runtime_UpdateSession_ResponseElements"></a>

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) **   <a name="bedrock-agent-runtime_UpdateSession-response-createdAt"></a>
The timestamp for when the session was created.  
Type: Timestamp

 ** [lastUpdatedAt](#API_agent-runtime_UpdateSession_ResponseSyntax) **   <a name="bedrock-agent-runtime_UpdateSession-response-lastUpdatedAt"></a>
The timestamp for when the session was last modified.  
Type: Timestamp

 ** [sessionArn](#API_agent-runtime_UpdateSession_ResponseSyntax) **   <a name="bedrock-agent-runtime_UpdateSession-response-sessionArn"></a>
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) **   <a name="bedrock-agent-runtime_UpdateSession-response-sessionId"></a>
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) **   <a name="bedrock-agent-runtime_UpdateSession-response-sessionStatus"></a>
The status of the session you updated.  
Type: String  
Valid Values: `ACTIVE | EXPIRED | ENDED` 

## Errors
<a name="API_agent-runtime_UpdateSession_Errors"></a>

For information about 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
<a name="API_agent-runtime_UpdateSession_Examples"></a>

### Example request
<a name="API_agent-runtime_UpdateSession_Example_1"></a>

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
<a name="API_agent-runtime_UpdateSession_SeeAlso"></a>

For more information about using this API 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
<a name="API_Operations_Data_Automation_for_Amazon_Bedrock"></a>

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
<a name="API_data-automation_CopyBlueprintStage"></a>

Copies a blueprint from one stage to another.

## Request Syntax
<a name="API_data-automation_CopyBlueprintStage_RequestSyntax"></a>

```
PUT /blueprints/blueprintArn/copy-stage HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "sourceStage": "string",
   "targetStage": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_CopyBlueprintStage_RequestParameters"></a>

The request uses the following URI parameters.

 ** [blueprintArn](#API_data-automation_CopyBlueprintStage_RequestSyntax) **   <a name="bedrock-data-automation_CopyBlueprintStage-request-uri-blueprintArn"></a>
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
<a name="API_data-automation_CopyBlueprintStage_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_data-automation_CopyBlueprintStage_RequestSyntax) **   <a name="bedrock-data-automation_CopyBlueprintStage-request-clientToken"></a>
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) **   <a name="bedrock-data-automation_CopyBlueprintStage-request-sourceStage"></a>
The stage to copy from.  
Type: String  
Valid Values: `DEVELOPMENT | LIVE`   
Required: Yes

 ** [targetStage](#API_data-automation_CopyBlueprintStage_RequestSyntax) **   <a name="bedrock-data-automation_CopyBlueprintStage-request-targetStage"></a>
The stage to copy to.  
Type: String  
Valid Values: `DEVELOPMENT | LIVE`   
Required: Yes

## Response Syntax
<a name="API_data-automation_CopyBlueprintStage_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_data-automation_CopyBlueprintStage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_data-automation_CopyBlueprintStage_Errors"></a>

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
<a name="API_data-automation_CopyBlueprintStage_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_CreateBlueprint"></a>

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
<a name="API_data-automation_CreateBlueprint_RequestSyntax"></a>

```
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
<a name="API_data-automation_CreateBlueprint_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_CreateBlueprint_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blueprintName](#API_data-automation_CreateBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_CreateBlueprint-request-blueprintName"></a>
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) **   <a name="bedrock-data-automation_CreateBlueprint-request-blueprintStage"></a>
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) **   <a name="bedrock-data-automation_CreateBlueprint-request-clientToken"></a>
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) **   <a name="bedrock-data-automation_CreateBlueprint-request-encryptionConfiguration"></a>
Encryption settings for the blueprint.  
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object  
Required: No

 ** [schema](#API_data-automation_CreateBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_CreateBlueprint-request-schema"></a>
The blueprint's schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.  
Required: Yes

 ** [tags](#API_data-automation_CreateBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_CreateBlueprint-request-tags"></a>
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) **   <a name="bedrock-data-automation_CreateBlueprint-request-type"></a>
The type of blueprint to create.  
Type: String  
Valid Values: `DOCUMENT | IMAGE | AUDIO`   
Required: Yes

## Response Syntax
<a name="API_data-automation_CreateBlueprint_ResponseSyntax"></a>

```
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
<a name="API_data-automation_CreateBlueprint_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_CreateBlueprint-response-blueprint"></a>
Details about the blueprint.  
Type: [Blueprint](API_data-automation_Blueprint.md) object

## Errors
<a name="API_data-automation_CreateBlueprint_Errors"></a>

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
<a name="API_data-automation_CreateBlueprint_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_CreateBlueprintVersion"></a>

Creates an immutable snapshot of a blueprint.

## Request Syntax
<a name="API_data-automation_CreateBlueprintVersion_RequestSyntax"></a>

```
POST /blueprints/blueprintArn/versions/ HTTP/1.1
Content-type: application/json

{
   "clientToken": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_CreateBlueprintVersion_RequestParameters"></a>

The request uses the following URI parameters.

 ** [blueprintArn](#API_data-automation_CreateBlueprintVersion_RequestSyntax) **   <a name="bedrock-data-automation_CreateBlueprintVersion-request-uri-blueprintArn"></a>
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
<a name="API_data-automation_CreateBlueprintVersion_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_data-automation_CreateBlueprintVersion_RequestSyntax) **   <a name="bedrock-data-automation_CreateBlueprintVersion-request-clientToken"></a>
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
<a name="API_data-automation_CreateBlueprintVersion_ResponseSyntax"></a>

```
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
<a name="API_data-automation_CreateBlueprintVersion_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_CreateBlueprintVersion-response-blueprint"></a>
Details about the blueprint.  
Type: [Blueprint](API_data-automation_Blueprint.md) object

## Errors
<a name="API_data-automation_CreateBlueprintVersion_Errors"></a>

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
<a name="API_data-automation_CreateBlueprintVersion_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_CreateDataAutomationLibrary"></a>

Creates a data automation library.

## Request Syntax
<a name="API_data-automation_CreateDataAutomationLibrary_RequestSyntax"></a>

```
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
<a name="API_data-automation_CreateDataAutomationLibrary_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_CreateDataAutomationLibrary_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) **   <a name="bedrock-data-automation_CreateDataAutomationLibrary-request-clientToken"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationLibrary-request-encryptionConfiguration"></a>
Encryption settings for the library.  
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object  
Required: No

 ** [libraryDescription](#API_data-automation_CreateDataAutomationLibrary_RequestSyntax) **   <a name="bedrock-data-automation_CreateDataAutomationLibrary-request-libraryDescription"></a>
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="bedrock-data-automation_CreateDataAutomationLibrary-request-libraryName"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationLibrary-request-tags"></a>
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
<a name="API_data-automation_CreateDataAutomationLibrary_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "libraryArn": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_data-automation_CreateDataAutomationLibrary_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_CreateDataAutomationLibrary-response-libraryArn"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationLibrary-response-status"></a>
The library's status.  
Type: String  
Valid Values: `ACTIVE | DELETING` 

## Errors
<a name="API_data-automation_CreateDataAutomationLibrary_Errors"></a>

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
<a name="API_data-automation_CreateDataAutomationLibrary_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_CreateDataAutomationProject"></a>

Creates a data automation project.

## Request Syntax
<a name="API_data-automation_CreateDataAutomationProject_RequestSyntax"></a>

```
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
<a name="API_data-automation_CreateDataAutomationProject_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_CreateDataAutomationProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-clientToken"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-customOutputConfiguration"></a>
Blueprints to enabled for the project.  
Type: [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md) object  
Required: No

 ** [dataAutomationLibraryConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-dataAutomationLibraryConfiguration"></a>
Library configuration for the project.  
Type: [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md) object  
Required: No

 ** [encryptionConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-encryptionConfiguration"></a>
Encryption settings for the project.  
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object  
Required: No

 ** [overrideConfiguration](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-overrideConfiguration"></a>
Additional settings to apply to the project.  
Type: [OverrideConfiguration](API_data-automation_OverrideConfiguration.md) object  
Required: No

 ** [projectDescription](#API_data-automation_CreateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-projectDescription"></a>
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="bedrock-data-automation_CreateDataAutomationProject-request-projectName"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-projectStage"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-projectType"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-standardOutputConfiguration"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationProject-request-tags"></a>
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
<a name="API_data-automation_CreateDataAutomationProject_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "projectArn": "string",
   "projectStage": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_data-automation_CreateDataAutomationProject_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_CreateDataAutomationProject-response-projectArn"></a>
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) **   <a name="bedrock-data-automation_CreateDataAutomationProject-response-projectStage"></a>
The project's stage.  
Type: String  
Valid Values: `DEVELOPMENT | LIVE` 

 ** [status](#API_data-automation_CreateDataAutomationProject_ResponseSyntax) **   <a name="bedrock-data-automation_CreateDataAutomationProject-response-status"></a>
The project's status.  
Type: String  
Valid Values: `COMPLETED | IN_PROGRESS | FAILED` 

## Errors
<a name="API_data-automation_CreateDataAutomationProject_Errors"></a>

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
<a name="API_data-automation_CreateDataAutomationProject_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_DeleteBlueprint"></a>

Deletes a blueprint or blueprint version.

## Request Syntax
<a name="API_data-automation_DeleteBlueprint_RequestSyntax"></a>

```
DELETE /blueprints/blueprintArn/?blueprintVersion=blueprintVersion HTTP/1.1
```

## URI Request Parameters
<a name="API_data-automation_DeleteBlueprint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [blueprintArn](#API_data-automation_DeleteBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_DeleteBlueprint-request-uri-blueprintArn"></a>
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) **   <a name="bedrock-data-automation_DeleteBlueprint-request-uri-blueprintVersion"></a>
To delete a blueprint version, specify the version.  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `[0-9]*` 

## Request Body
<a name="API_data-automation_DeleteBlueprint_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_data-automation_DeleteBlueprint_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_data-automation_DeleteBlueprint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_data-automation_DeleteBlueprint_Errors"></a>

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
<a name="API_data-automation_DeleteBlueprint_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_DeleteDataAutomationLibrary"></a>

Deletes a data automation library.

## Request Syntax
<a name="API_data-automation_DeleteDataAutomationLibrary_RequestSyntax"></a>

```
DELETE /data-automation-libraries/libraryArn/ HTTP/1.1
```

## URI Request Parameters
<a name="API_data-automation_DeleteDataAutomationLibrary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [libraryArn](#API_data-automation_DeleteDataAutomationLibrary_RequestSyntax) **   <a name="bedrock-data-automation_DeleteDataAutomationLibrary-request-uri-libraryArn"></a>
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
<a name="API_data-automation_DeleteDataAutomationLibrary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_data-automation_DeleteDataAutomationLibrary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "libraryArn": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_data-automation_DeleteDataAutomationLibrary_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_DeleteDataAutomationLibrary-response-libraryArn"></a>
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) **   <a name="bedrock-data-automation_DeleteDataAutomationLibrary-response-status"></a>
The library's status.  
Type: String  
Valid Values: `ACTIVE | DELETING` 

## Errors
<a name="API_data-automation_DeleteDataAutomationLibrary_Errors"></a>

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
<a name="API_data-automation_DeleteDataAutomationLibrary_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_DeleteDataAutomationProject"></a>

Deletes a data automation project.

## Request Syntax
<a name="API_data-automation_DeleteDataAutomationProject_RequestSyntax"></a>

```
DELETE /data-automation-projects/projectArn/ HTTP/1.1
```

## URI Request Parameters
<a name="API_data-automation_DeleteDataAutomationProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [projectArn](#API_data-automation_DeleteDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_DeleteDataAutomationProject-request-uri-projectArn"></a>
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
<a name="API_data-automation_DeleteDataAutomationProject_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_data-automation_DeleteDataAutomationProject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "projectArn": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_data-automation_DeleteDataAutomationProject_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_DeleteDataAutomationProject-response-projectArn"></a>
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) **   <a name="bedrock-data-automation_DeleteDataAutomationProject-response-status"></a>
The project's status.  
Type: String  
Valid Values: `COMPLETED | IN_PROGRESS | FAILED` 

## Errors
<a name="API_data-automation_DeleteDataAutomationProject_Errors"></a>

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
<a name="API_data-automation_DeleteDataAutomationProject_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_GetBlueprint"></a>

Gets details about a blueprint or blueprint version.

## Request Syntax
<a name="API_data-automation_GetBlueprint_RequestSyntax"></a>

```
POST /blueprints/blueprintArn/ HTTP/1.1
Content-type: application/json

{
   "blueprintStage": "string",
   "blueprintVersion": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_GetBlueprint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [blueprintArn](#API_data-automation_GetBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_GetBlueprint-request-uri-blueprintArn"></a>
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
<a name="API_data-automation_GetBlueprint_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blueprintStage](#API_data-automation_GetBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_GetBlueprint-request-blueprintStage"></a>
To view the development stage, set to `DEVELOPMENT`.  
Type: String  
Valid Values: `DEVELOPMENT | LIVE`   
Required: No

 ** [blueprintVersion](#API_data-automation_GetBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_GetBlueprint-request-blueprintVersion"></a>
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
<a name="API_data-automation_GetBlueprint_ResponseSyntax"></a>

```
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
<a name="API_data-automation_GetBlueprint_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_GetBlueprint-response-blueprint"></a>
Details about the blueprint.  
Type: [Blueprint](API_data-automation_Blueprint.md) object

## Errors
<a name="API_data-automation_GetBlueprint_Errors"></a>

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
<a name="API_data-automation_GetBlueprint_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_GetBlueprintOptimizationStatus"></a>

Gets the status of a blueprint optimization job.

## Request Syntax
<a name="API_data-automation_GetBlueprintOptimizationStatus_RequestSyntax"></a>

```
POST /getBlueprintOptimizationStatus/invocationArn HTTP/1.1
```

## URI Request Parameters
<a name="API_data-automation_GetBlueprintOptimizationStatus_RequestParameters"></a>

The request uses the following URI parameters.

 ** [invocationArn](#API_data-automation_GetBlueprintOptimizationStatus_RequestSyntax) **   <a name="bedrock-data-automation_GetBlueprintOptimizationStatus-request-uri-invocationArn"></a>
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
<a name="API_data-automation_GetBlueprintOptimizationStatus_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "errorMessage": "string",
   "errorType": "string",
   "outputConfiguration": { 
      "s3Object": { 
         "s3Uri": "string",
         "version": "string"
      }
   },
   "status": "string"
}
```

## Response Elements
<a name="API_data-automation_GetBlueprintOptimizationStatus_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_GetBlueprintOptimizationStatus-response-errorMessage"></a>
The error message if the job failed.  
Type: String

 ** [errorType](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) **   <a name="bedrock-data-automation_GetBlueprintOptimizationStatus-response-errorType"></a>
The type of error if the job failed.  
Type: String

 ** [outputConfiguration](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) **   <a name="bedrock-data-automation_GetBlueprintOptimizationStatus-response-outputConfiguration"></a>
The location of the optimization results.  
Type: [BlueprintOptimizationOutputConfiguration](API_data-automation_BlueprintOptimizationOutputConfiguration.md) object

 ** [status](#API_data-automation_GetBlueprintOptimizationStatus_ResponseSyntax) **   <a name="bedrock-data-automation_GetBlueprintOptimizationStatus-response-status"></a>
The job's status.  
Type: String  
Valid Values: `Created | InProgress | Success | ServiceError | ClientError` 

## Errors
<a name="API_data-automation_GetBlueprintOptimizationStatus_Errors"></a>

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
<a name="API_data-automation_GetBlueprintOptimizationStatus_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_GetDataAutomationLibrary"></a>

Gets details about a data automation library.

## Request Syntax
<a name="API_data-automation_GetDataAutomationLibrary_RequestSyntax"></a>

```
POST /data-automation-libraries/libraryArn/ HTTP/1.1
```

## URI Request Parameters
<a name="API_data-automation_GetDataAutomationLibrary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [libraryArn](#API_data-automation_GetDataAutomationLibrary_RequestSyntax) **   <a name="bedrock-data-automation_GetDataAutomationLibrary-request-uri-libraryArn"></a>
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
<a name="API_data-automation_GetDataAutomationLibrary_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_data-automation_GetDataAutomationLibrary_ResponseSyntax"></a>

```
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
<a name="API_data-automation_GetDataAutomationLibrary_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_GetDataAutomationLibrary-response-library"></a>
Details about the library.  
Type: [DataAutomationLibrary](API_data-automation_DataAutomationLibrary.md) object

## Errors
<a name="API_data-automation_GetDataAutomationLibrary_Errors"></a>

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
<a name="API_data-automation_GetDataAutomationLibrary_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_GetDataAutomationLibraryEntity"></a>

Gets details about a data automation library entity.

## Request Syntax
<a name="API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax"></a>

```
POST /data-automation-libraries/libraryArn/entityType/entityType/entities/entityId HTTP/1.1
```

## URI Request Parameters
<a name="API_data-automation_GetDataAutomationLibraryEntity_RequestParameters"></a>

The request uses the following URI parameters.

 ** [entityId](#API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax) **   <a name="bedrock-data-automation_GetDataAutomationLibraryEntity-request-uri-entityId"></a>
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) **   <a name="bedrock-data-automation_GetDataAutomationLibraryEntity-request-uri-entityType"></a>
The entity type.  
Valid Values: `VOCABULARY`   
Required: Yes

 ** [libraryArn](#API_data-automation_GetDataAutomationLibraryEntity_RequestSyntax) **   <a name="bedrock-data-automation_GetDataAutomationLibraryEntity-request-uri-libraryArn"></a>
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
<a name="API_data-automation_GetDataAutomationLibraryEntity_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_data-automation_GetDataAutomationLibraryEntity_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "entity": { ... }
}
```

## Response Elements
<a name="API_data-automation_GetDataAutomationLibraryEntity_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_GetDataAutomationLibraryEntity-response-entity"></a>
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
<a name="API_data-automation_GetDataAutomationLibraryEntity_Errors"></a>

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
<a name="API_data-automation_GetDataAutomationLibraryEntity_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_GetDataAutomationLibraryIngestionJob"></a>

Gets details about a data automation library ingestion job.

## Request Syntax
<a name="API_data-automation_GetDataAutomationLibraryIngestionJob_RequestSyntax"></a>

```
POST /data-automation-libraries/libraryArn/library-ingestion-jobs/jobArn HTTP/1.1
```

## URI Request Parameters
<a name="API_data-automation_GetDataAutomationLibraryIngestionJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [jobArn](#API_data-automation_GetDataAutomationLibraryIngestionJob_RequestSyntax) **   <a name="bedrock-data-automation_GetDataAutomationLibraryIngestionJob-request-uri-jobArn"></a>
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) **   <a name="bedrock-data-automation_GetDataAutomationLibraryIngestionJob-request-uri-libraryArn"></a>
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
<a name="API_data-automation_GetDataAutomationLibraryIngestionJob_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_data-automation_GetDataAutomationLibraryIngestionJob_ResponseSyntax"></a>

```
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
<a name="API_data-automation_GetDataAutomationLibraryIngestionJob_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_GetDataAutomationLibraryIngestionJob-response-job"></a>
Details about the job.  
Type: [DataAutomationLibraryIngestionJob](API_data-automation_DataAutomationLibraryIngestionJob.md) object

## Errors
<a name="API_data-automation_GetDataAutomationLibraryIngestionJob_Errors"></a>

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
<a name="API_data-automation_GetDataAutomationLibraryIngestionJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_GetDataAutomationProject"></a>

Gets details about a data automation project.

## Request Syntax
<a name="API_data-automation_GetDataAutomationProject_RequestSyntax"></a>

```
POST /data-automation-projects/projectArn/ HTTP/1.1
Content-type: application/json

{
   "projectStage": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_GetDataAutomationProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [projectArn](#API_data-automation_GetDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_GetDataAutomationProject-request-uri-projectArn"></a>
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
<a name="API_data-automation_GetDataAutomationProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [projectStage](#API_data-automation_GetDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_GetDataAutomationProject-request-projectStage"></a>
To view the development stage, set to `DEVELOPMENT`.  
Type: String  
Valid Values: `DEVELOPMENT | LIVE`   
Required: No

## Response Syntax
<a name="API_data-automation_GetDataAutomationProject_ResponseSyntax"></a>

```
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
<a name="API_data-automation_GetDataAutomationProject_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_GetDataAutomationProject-response-project"></a>
Details about the project.  
Type: [DataAutomationProject](API_data-automation_DataAutomationProject.md) object

## Errors
<a name="API_data-automation_GetDataAutomationProject_Errors"></a>

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
<a name="API_data-automation_GetDataAutomationProject_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_InvokeBlueprintOptimizationAsync"></a>

Starts an asynchronous job to optimize a blueprint using sample data.

## Request Syntax
<a name="API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax"></a>

```
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
<a name="API_data-automation_InvokeBlueprintOptimizationAsync_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_InvokeBlueprintOptimizationAsync_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blueprint](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **   <a name="bedrock-data-automation_InvokeBlueprintOptimizationAsync-request-blueprint"></a>
The blueprint to optimize.  
Type: [BlueprintOptimizationObject](API_data-automation_BlueprintOptimizationObject.md) object  
Required: Yes

 ** [dataAutomationProfileArn](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **   <a name="bedrock-data-automation_InvokeBlueprintOptimizationAsync-request-dataAutomationProfileArn"></a>
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) **   <a name="bedrock-data-automation_InvokeBlueprintOptimizationAsync-request-encryptionConfiguration"></a>
Encryption settings for the optimization job.  
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object  
Required: No

 ** [outputConfiguration](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **   <a name="bedrock-data-automation_InvokeBlueprintOptimizationAsync-request-outputConfiguration"></a>
Where to store the optimization results.  
Type: [BlueprintOptimizationOutputConfiguration](API_data-automation_BlueprintOptimizationOutputConfiguration.md) object  
Required: Yes

 ** [samples](#API_data-automation_InvokeBlueprintOptimizationAsync_RequestSyntax) **   <a name="bedrock-data-automation_InvokeBlueprintOptimizationAsync-request-samples"></a>
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) **   <a name="bedrock-data-automation_InvokeBlueprintOptimizationAsync-request-tags"></a>
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
<a name="API_data-automation_InvokeBlueprintOptimizationAsync_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "invocationArn": "string"
}
```

## Response Elements
<a name="API_data-automation_InvokeBlueprintOptimizationAsync_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_InvokeBlueprintOptimizationAsync-response-invocationArn"></a>
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
<a name="API_data-automation_InvokeBlueprintOptimizationAsync_Errors"></a>

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
<a name="API_data-automation_InvokeBlueprintOptimizationAsync_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_InvokeDataAutomationLibraryIngestionJob"></a>

Invokes a data automation library ingestion job.

## Request Syntax
<a name="API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax"></a>

```
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
<a name="API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestParameters"></a>

The request uses the following URI parameters.

 ** [libraryArn](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-request-uri-libraryArn"></a>
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
<a name="API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-request-clientToken"></a>
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) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-request-entityType"></a>
The entity type.  
Type: String  
Valid Values: `VOCABULARY`   
Required: Yes

 ** [inputConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-request-inputConfiguration"></a>
Input configuration for the job.  
Type: [InputConfiguration](API_data-automation_InputConfiguration.md) object  
Required: Yes

 ** [notificationConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-request-notificationConfiguration"></a>
Notification configuration for the job.  
Type: [NotificationConfiguration](API_data-automation_NotificationConfiguration.md) object  
Required: No

 ** [operationType](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-request-operationType"></a>
The operation type.  
Type: String  
Valid Values: `UPSERT | DELETE`   
Required: Yes

 ** [outputConfiguration](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-request-outputConfiguration"></a>
Output configuration for the job.  
Type: [OutputConfiguration](API_data-automation_OutputConfiguration.md) object  
Required: Yes

 ** [tags](#API_data-automation_InvokeDataAutomationLibraryIngestionJob_RequestSyntax) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-request-tags"></a>
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
<a name="API_data-automation_InvokeDataAutomationLibraryIngestionJob_ResponseSyntax"></a>

```
HTTP/1.1 201
Content-type: application/json

{
   "jobArn": "string"
}
```

## Response Elements
<a name="API_data-automation_InvokeDataAutomationLibraryIngestionJob_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_InvokeDataAutomationLibraryIngestionJob-response-jobArn"></a>
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
<a name="API_data-automation_InvokeDataAutomationLibraryIngestionJob_Errors"></a>

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
<a name="API_data-automation_InvokeDataAutomationLibraryIngestionJob_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_ListBlueprints"></a>

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
<a name="API_data-automation_ListBlueprints_RequestSyntax"></a>

```
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
<a name="API_data-automation_ListBlueprints_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_ListBlueprints_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blueprintArn](#API_data-automation_ListBlueprints_RequestSyntax) **   <a name="bedrock-data-automation_ListBlueprints-request-blueprintArn"></a>
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) **   <a name="bedrock-data-automation_ListBlueprints-request-blueprintStageFilter"></a>
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) **   <a name="bedrock-data-automation_ListBlueprints-request-maxResults"></a>
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) **   <a name="bedrock-data-automation_ListBlueprints-request-nextToken"></a>
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) **   <a name="bedrock-data-automation_ListBlueprints-request-projectFilter"></a>
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) **   <a name="bedrock-data-automation_ListBlueprints-request-resourceOwner"></a>
The blueprints' owner. To view public blueprints, specify `SERVICE`.  
Type: String  
Valid Values: `SERVICE | ACCOUNT`   
Required: No

## Response Syntax
<a name="API_data-automation_ListBlueprints_ResponseSyntax"></a>

```
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
<a name="API_data-automation_ListBlueprints_ResponseElements"></a>

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 name="bedrock-data-automation_ListBlueprints-response-blueprints"></a>
A list of blueprint summaries.  
Type: Array of [BlueprintSummary](API_data-automation_BlueprintSummary.md) objects

 ** [nextToken](#API_data-automation_ListBlueprints_ResponseSyntax) **   <a name="bedrock-data-automation_ListBlueprints-response-nextToken"></a>
A pagination token returned if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `\S*` 

## Errors
<a name="API_data-automation_ListBlueprints_Errors"></a>

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
<a name="API_data-automation_ListBlueprints_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_ListDataAutomationLibraries"></a>

Gets a list of data automation libraries in your account.

## Request Syntax
<a name="API_data-automation_ListDataAutomationLibraries_RequestSyntax"></a>

```
POST /data-automation-libraries/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string",
   "projectFilter": { 
      "projectArn": "string",
      "projectStage": "string"
   }
}
```

## URI Request Parameters
<a name="API_data-automation_ListDataAutomationLibraries_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_ListDataAutomationLibraries_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_data-automation_ListDataAutomationLibraries_RequestSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraries-request-maxResults"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationLibraries-request-nextToken"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationLibraries-request-projectFilter"></a>
To view libraries associated with a project, specify the project.  
Type: [DataAutomationProjectFilter](API_data-automation_DataAutomationProjectFilter.md) object  
Required: No

## Response Syntax
<a name="API_data-automation_ListDataAutomationLibraries_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "libraries": [ 
      { 
         "creationTime": "string",
         "libraryArn": "string",
         "libraryName": "string"
      }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_data-automation_ListDataAutomationLibraries_ResponseElements"></a>

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 name="bedrock-data-automation_ListDataAutomationLibraries-response-libraries"></a>
A list of library summaries.  
Type: Array of [DataAutomationLibrarySummary](API_data-automation_DataAutomationLibrarySummary.md) objects

 ** [nextToken](#API_data-automation_ListDataAutomationLibraries_ResponseSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraries-response-nextToken"></a>
A pagination token returned if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `\S*` 

## Errors
<a name="API_data-automation_ListDataAutomationLibraries_Errors"></a>

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
<a name="API_data-automation_ListDataAutomationLibraries_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_ListDataAutomationLibraryEntities"></a>

Gets a list of data automation library entities.

## Request Syntax
<a name="API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax"></a>

```
POST /data-automation-libraries/libraryArn/entityType/entityType/entities/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_ListDataAutomationLibraryEntities_RequestParameters"></a>

The request uses the following URI parameters.

 ** [entityType](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraryEntities-request-uri-entityType"></a>
The entity type.  
Valid Values: `VOCABULARY`   
Required: Yes

 ** [libraryArn](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraryEntities-request-uri-libraryArn"></a>
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
<a name="API_data-automation_ListDataAutomationLibraryEntities_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_data-automation_ListDataAutomationLibraryEntities_RequestSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraryEntities-request-maxResults"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationLibraryEntities-request-nextToken"></a>
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
<a name="API_data-automation_ListDataAutomationLibraryEntities_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "entities": [ 
      { ... }
   ],
   "nextToken": "string"
}
```

## Response Elements
<a name="API_data-automation_ListDataAutomationLibraryEntities_ResponseElements"></a>

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 name="bedrock-data-automation_ListDataAutomationLibraryEntities-response-entities"></a>
A list of entity summaries.  
Type: Array of [DataAutomationLibraryEntitySummary](API_data-automation_DataAutomationLibraryEntitySummary.md) objects

 ** [nextToken](#API_data-automation_ListDataAutomationLibraryEntities_ResponseSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraryEntities-response-nextToken"></a>
A pagination token returned if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `\S*` 

## Errors
<a name="API_data-automation_ListDataAutomationLibraryEntities_Errors"></a>

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
<a name="API_data-automation_ListDataAutomationLibraryEntities_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_ListDataAutomationLibraryIngestionJobs"></a>

Gets a list of data automation library ingestion jobs.

## Request Syntax
<a name="API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestSyntax"></a>

```
POST /data-automation-libraries/libraryArn/library-ingestion-jobs/ HTTP/1.1
Content-type: application/json

{
   "maxResults": number,
   "nextToken": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestParameters"></a>

The request uses the following URI parameters.

 ** [libraryArn](#API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraryIngestionJobs-request-uri-libraryArn"></a>
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
<a name="API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [maxResults](#API_data-automation_ListDataAutomationLibraryIngestionJobs_RequestSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraryIngestionJobs-request-maxResults"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationLibraryIngestionJobs-request-nextToken"></a>
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
<a name="API_data-automation_ListDataAutomationLibraryIngestionJobs_ResponseSyntax"></a>

```
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
<a name="API_data-automation_ListDataAutomationLibraryIngestionJobs_ResponseElements"></a>

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 name="bedrock-data-automation_ListDataAutomationLibraryIngestionJobs-response-jobs"></a>
A list of job summaries.  
Type: Array of [DataAutomationLibraryIngestionJobSummary](API_data-automation_DataAutomationLibraryIngestionJobSummary.md) objects

 ** [nextToken](#API_data-automation_ListDataAutomationLibraryIngestionJobs_ResponseSyntax) **   <a name="bedrock-data-automation_ListDataAutomationLibraryIngestionJobs-response-nextToken"></a>
A pagination token returned if more results are available.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `\S*` 

## Errors
<a name="API_data-automation_ListDataAutomationLibraryIngestionJobs_Errors"></a>

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
<a name="API_data-automation_ListDataAutomationLibraryIngestionJobs_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_ListDataAutomationProjects"></a>

Gets a list of data automation projects in your account, or public projects provided by the service.

## Request Syntax
<a name="API_data-automation_ListDataAutomationProjects_RequestSyntax"></a>

```
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
<a name="API_data-automation_ListDataAutomationProjects_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_ListDataAutomationProjects_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blueprintFilter](#API_data-automation_ListDataAutomationProjects_RequestSyntax) **   <a name="bedrock-data-automation_ListDataAutomationProjects-request-blueprintFilter"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationProjects-request-libraryFilter"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationProjects-request-maxResults"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationProjects-request-nextToken"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationProjects-request-projectStageFilter"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationProjects-request-projectTypeFilter"></a>
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) **   <a name="bedrock-data-automation_ListDataAutomationProjects-request-resourceOwner"></a>
The projects' owner. To view public projects, specify `SERVICE`.  
Type: String  
Valid Values: `SERVICE | ACCOUNT`   
Required: No

## Response Syntax
<a name="API_data-automation_ListDataAutomationProjects_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "projects": [ 
      { 
         "creationTime": "string",
         "projectArn": "string",
         "projectName": "string",
         "projectStage": "string",
         "projectType": "string"
      }
   ]
}
```

## Response Elements
<a name="API_data-automation_ListDataAutomationProjects_ResponseElements"></a>

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 name="bedrock-data-automation_ListDataAutomationProjects-response-nextToken"></a>
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 name="bedrock-data-automation_ListDataAutomationProjects-response-projects"></a>
A list of project summaries.  
Type: Array of [DataAutomationProjectSummary](API_data-automation_DataAutomationProjectSummary.md) objects

## Errors
<a name="API_data-automation_ListDataAutomationProjects_Errors"></a>

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
<a name="API_data-automation_ListDataAutomationProjects_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_ListTagsForResource"></a>

Lists a resources tags.

## Request Syntax
<a name="API_data-automation_ListTagsForResource_RequestSyntax"></a>

```
POST /listTagsForResource HTTP/1.1
Content-type: application/json

{
   "resourceARN": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_ListTagsForResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_ListTagsForResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resourceARN](#API_data-automation_ListTagsForResource_RequestSyntax) **   <a name="bedrock-data-automation_ListTagsForResource-request-resourceARN"></a>
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
<a name="API_data-automation_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_data-automation_ListTagsForResource_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_ListTagsForResource-response-tags"></a>
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
<a name="API_data-automation_ListTagsForResource_Errors"></a>

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
<a name="API_data-automation_ListTagsForResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_TagResource"></a>

Lets you add a tag to an already created resource.

## Request Syntax
<a name="API_data-automation_TagResource_RequestSyntax"></a>

```
POST /tagResource HTTP/1.1
Content-type: application/json

{
   "resourceARN": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## URI Request Parameters
<a name="API_data-automation_TagResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_TagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resourceARN](#API_data-automation_TagResource_RequestSyntax) **   <a name="bedrock-data-automation_TagResource-request-resourceARN"></a>
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) **   <a name="bedrock-data-automation_TagResource-request-tags"></a>
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
<a name="API_data-automation_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_data-automation_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_data-automation_TagResource_Errors"></a>

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
<a name="API_data-automation_TagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_UntagResource"></a>

Remove the tags from a resource.

## Request Syntax
<a name="API_data-automation_UntagResource_RequestSyntax"></a>

```
POST /untagResource HTTP/1.1
Content-type: application/json

{
   "resourceARN": "string",
   "tagKeys": [ "string" ]
}
```

## URI Request Parameters
<a name="API_data-automation_UntagResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_data-automation_UntagResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resourceARN](#API_data-automation_UntagResource_RequestSyntax) **   <a name="bedrock-data-automation_UntagResource-request-resourceARN"></a>
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) **   <a name="bedrock-data-automation_UntagResource-request-tagKeys"></a>
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
<a name="API_data-automation_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Response Elements
<a name="API_data-automation_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_data-automation_UntagResource_Errors"></a>

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
<a name="API_data-automation_UntagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_UpdateBlueprint"></a>

Updates a blueprint.

## Request Syntax
<a name="API_data-automation_UpdateBlueprint_RequestSyntax"></a>

```
PUT /blueprints/blueprintArn/ HTTP/1.1
Content-type: application/json

{
   "blueprintStage": "string",
   "encryptionConfiguration": { 
      "kmsEncryptionContext": { 
         "string" : "string" 
      },
      "kmsKeyId": "string"
   },
   "schema": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_UpdateBlueprint_RequestParameters"></a>

The request uses the following URI parameters.

 ** [blueprintArn](#API_data-automation_UpdateBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_UpdateBlueprint-request-uri-blueprintArn"></a>
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
<a name="API_data-automation_UpdateBlueprint_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [blueprintStage](#API_data-automation_UpdateBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_UpdateBlueprint-request-blueprintStage"></a>
To update the development stage, set to `DEVELOPMENT`.  
Type: String  
Valid Values: `DEVELOPMENT | LIVE`   
Required: No

 ** [encryptionConfiguration](#API_data-automation_UpdateBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_UpdateBlueprint-request-encryptionConfiguration"></a>
Encryption for the updated blueprint.  
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object  
Required: No

 ** [schema](#API_data-automation_UpdateBlueprint_RequestSyntax) **   <a name="bedrock-data-automation_UpdateBlueprint-request-schema"></a>
The blueprint's schema.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100000.  
Required: Yes

## Response Syntax
<a name="API_data-automation_UpdateBlueprint_ResponseSyntax"></a>

```
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
<a name="API_data-automation_UpdateBlueprint_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_UpdateBlueprint-response-blueprint"></a>
Details about the blueprint.  
Type: [Blueprint](API_data-automation_Blueprint.md) object

## Errors
<a name="API_data-automation_UpdateBlueprint_Errors"></a>

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
<a name="API_data-automation_UpdateBlueprint_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_UpdateDataAutomationLibrary"></a>

Updates a data automation library.

## Request Syntax
<a name="API_data-automation_UpdateDataAutomationLibrary_RequestSyntax"></a>

```
PUT /data-automation-libraries/libraryArn/ HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "libraryDescription": "string"
}
```

## URI Request Parameters
<a name="API_data-automation_UpdateDataAutomationLibrary_RequestParameters"></a>

The request uses the following URI parameters.

 ** [libraryArn](#API_data-automation_UpdateDataAutomationLibrary_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationLibrary-request-uri-libraryArn"></a>
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
<a name="API_data-automation_UpdateDataAutomationLibrary_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientToken](#API_data-automation_UpdateDataAutomationLibrary_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationLibrary-request-clientToken"></a>
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 name="bedrock-data-automation_UpdateDataAutomationLibrary-request-libraryDescription"></a>
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
<a name="API_data-automation_UpdateDataAutomationLibrary_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "libraryArn": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_data-automation_UpdateDataAutomationLibrary_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_UpdateDataAutomationLibrary-response-libraryArn"></a>
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) **   <a name="bedrock-data-automation_UpdateDataAutomationLibrary-response-status"></a>
The library's status.  
Type: String  
Valid Values: `ACTIVE | DELETING` 

## Errors
<a name="API_data-automation_UpdateDataAutomationLibrary_Errors"></a>

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
<a name="API_data-automation_UpdateDataAutomationLibrary_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation_UpdateDataAutomationProject"></a>

Updates a data automation project.

## Request Syntax
<a name="API_data-automation_UpdateDataAutomationProject_RequestSyntax"></a>

```
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
<a name="API_data-automation_UpdateDataAutomationProject_RequestParameters"></a>

The request uses the following URI parameters.

 ** [projectArn](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-request-uri-projectArn"></a>
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
<a name="API_data-automation_UpdateDataAutomationProject_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [customOutputConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-request-customOutputConfiguration"></a>
Blueprints to enable for the project.  
Type: [CustomOutputConfiguration](API_data-automation_CustomOutputConfiguration.md) object  
Required: No

 ** [dataAutomationLibraryConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-request-dataAutomationLibraryConfiguration"></a>
Library configuration for the project.  
Type: [DataAutomationLibraryConfiguration](API_data-automation_DataAutomationLibraryConfiguration.md) object  
Required: No

 ** [encryptionConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-request-encryptionConfiguration"></a>
Encryption for the created project.  
Type: [EncryptionConfiguration](API_data-automation_EncryptionConfiguration.md) object  
Required: No

 ** [overrideConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-request-overrideConfiguration"></a>
Additional settings to apply to the project.  
Type: [OverrideConfiguration](API_data-automation_OverrideConfiguration.md) object  
Required: No

 ** [projectDescription](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-request-projectDescription"></a>
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) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-request-projectStage"></a>
To update the development stage, set to `DEVELOPMENT`.  
Type: String  
Valid Values: `DEVELOPMENT | LIVE`   
Required: No

 ** [standardOutputConfiguration](#API_data-automation_UpdateDataAutomationProject_RequestSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-request-standardOutputConfiguration"></a>
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
<a name="API_data-automation_UpdateDataAutomationProject_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "projectArn": "string",
   "projectStage": "string",
   "status": "string"
}
```

## Response Elements
<a name="API_data-automation_UpdateDataAutomationProject_ResponseElements"></a>

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) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-response-projectArn"></a>
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) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-response-projectStage"></a>
The project's stage.  
Type: String  
Valid Values: `DEVELOPMENT | LIVE` 

 ** [status](#API_data-automation_UpdateDataAutomationProject_ResponseSyntax) **   <a name="bedrock-data-automation_UpdateDataAutomationProject-response-status"></a>
The project's status.  
Type: String  
Valid Values: `COMPLETED | IN_PROGRESS | FAILED` 

## Errors
<a name="API_data-automation_UpdateDataAutomationProject_Errors"></a>

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
<a name="API_data-automation_UpdateDataAutomationProject_SeeAlso"></a>

For more information about using this API 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
<a name="API_Operations_Runtime_for_Amazon_Bedrock_Data_Automation"></a>

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
<a name="API_data-automation-runtime_GetDataAutomationStatus"></a>

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
<a name="API_data-automation-runtime_GetDataAutomationStatus_RequestSyntax"></a>

```
{
   "invocationArn": "string"
}
```

## Request Parameters
<a name="API_data-automation-runtime_GetDataAutomationStatus_RequestParameters"></a>

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) **   <a name="bedrock-data-automation-runtime_GetDataAutomationStatus-request-invocationArn"></a>
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
<a name="API_data-automation-runtime_GetDataAutomationStatus_ResponseSyntax"></a>

```
{
   "errorMessage": "string",
   "errorType": "string",
   "outputConfiguration": { 
      "s3Uri": "string"
   },
   "status": "string"
}
```

## Response Elements
<a name="API_data-automation-runtime_GetDataAutomationStatus_ResponseElements"></a>

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) **   <a name="bedrock-data-automation-runtime_GetDataAutomationStatus-response-errorMessage"></a>
If an error ocurred, the error message.  
Type: String

 ** [errorType](#API_data-automation-runtime_GetDataAutomationStatus_ResponseSyntax) **   <a name="bedrock-data-automation-runtime_GetDataAutomationStatus-response-errorType"></a>
If an error ocurred, the error's type.  
Type: String

 ** [outputConfiguration](#API_data-automation-runtime_GetDataAutomationStatus_ResponseSyntax) **   <a name="bedrock-data-automation-runtime_GetDataAutomationStatus-response-outputConfiguration"></a>
The path of the output metadata object.  
Type: [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md) object

 ** [status](#API_data-automation-runtime_GetDataAutomationStatus_ResponseSyntax) **   <a name="bedrock-data-automation-runtime_GetDataAutomationStatus-response-status"></a>
The invocation's status.  
Type: String  
Valid Values: `Created | InProgress | Success | ServiceError | ClientError` 

## Errors
<a name="API_data-automation-runtime_GetDataAutomationStatus_Errors"></a>

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
<a name="API_data-automation-runtime_GetDataAutomationStatus_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation-runtime_InvokeDataAutomation"></a>

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
<a name="API_data-automation-runtime_InvokeDataAutomation_RequestSyntax"></a>

```
{
   "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
<a name="API_data-automation-runtime_InvokeDataAutomation_RequestParameters"></a>

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 name="bedrock-data-automation-runtime_InvokeDataAutomation-request-blueprints"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomation-request-dataAutomationConfiguration"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomation-request-dataAutomationProfileArn"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomation-request-encryptionConfiguration"></a>
Encryption settings for the invocation.  
Type: [EncryptionConfiguration](API_data-automation-runtime_EncryptionConfiguration.md) object  
Required: No

 ** [inputConfiguration](#API_data-automation-runtime_InvokeDataAutomation_RequestSyntax) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomation-request-inputConfiguration"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomation-request-outputConfiguration"></a>
Where to store the output.  
Type: [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md) object  
Required: No

## Response Syntax
<a name="API_data-automation-runtime_InvokeDataAutomation_ResponseSyntax"></a>

```
{
   "outputConfiguration": { 
      "s3Uri": "string"
   },
   "outputSegments": [ 
      { 
         "customOutput": "string",
         "customOutputStatus": "string",
         "standardOutput": "string"
      }
   ],
   "semanticModality": "string"
}
```

## Response Elements
<a name="API_data-automation-runtime_InvokeDataAutomation_ResponseElements"></a>

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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomation-response-outputConfiguration"></a>
Where to store the output.  
Type: [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md) object

 ** [outputSegments](#API_data-automation-runtime_InvokeDataAutomation_ResponseSyntax) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomation-response-outputSegments"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomation-response-semanticModality"></a>
Detected semantic modality.  
Type: String  
Valid Values: `DOCUMENT | IMAGE | AUDIO | VIDEO` 

## Errors
<a name="API_data-automation-runtime_InvokeDataAutomation_Errors"></a>

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
<a name="API_data-automation-runtime_InvokeDataAutomation_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation-runtime_InvokeDataAutomationAsync"></a>

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
<a name="API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax"></a>

```
{
   "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
<a name="API_data-automation-runtime_InvokeDataAutomationAsync_RequestParameters"></a>

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 name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-blueprints"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-clientToken"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-dataAutomationConfiguration"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-dataAutomationProfileArn"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-encryptionConfiguration"></a>
Encryption settings for the invocation.  
Type: [EncryptionConfiguration](API_data-automation-runtime_EncryptionConfiguration.md) object  
Required: No

 ** [inputConfiguration](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-inputConfiguration"></a>
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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-notificationConfiguration"></a>
Notification settings for the invocation.  
Type: [NotificationConfiguration](API_data-automation-runtime_NotificationConfiguration.md) object  
Required: No

 ** [outputConfiguration](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-outputConfiguration"></a>
Where to store the output.  
Type: [OutputConfiguration](API_data-automation-runtime_OutputConfiguration.md) object  
Required: Yes

 ** [tags](#API_data-automation-runtime_InvokeDataAutomationAsync_RequestSyntax) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-request-tags"></a>
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
<a name="API_data-automation-runtime_InvokeDataAutomationAsync_ResponseSyntax"></a>

```
{
   "invocationArn": "string"
}
```

## Response Elements
<a name="API_data-automation-runtime_InvokeDataAutomationAsync_ResponseElements"></a>

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) **   <a name="bedrock-data-automation-runtime_InvokeDataAutomationAsync-response-invocationArn"></a>
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
<a name="API_data-automation-runtime_InvokeDataAutomationAsync_Errors"></a>

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
<a name="API_data-automation-runtime_InvokeDataAutomationAsync_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation-runtime_ListTagsForResource"></a>

Lists a resources tags.

## Request Syntax
<a name="API_data-automation-runtime_ListTagsForResource_RequestSyntax"></a>

```
{
   "resourceARN": "string"
}
```

## Request Parameters
<a name="API_data-automation-runtime_ListTagsForResource_RequestParameters"></a>

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) **   <a name="bedrock-data-automation-runtime_ListTagsForResource-request-resourceARN"></a>
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
<a name="API_data-automation-runtime_ListTagsForResource_ResponseSyntax"></a>

```
{
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_data-automation-runtime_ListTagsForResource_ResponseElements"></a>

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) **   <a name="bedrock-data-automation-runtime_ListTagsForResource-response-tags"></a>
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
<a name="API_data-automation-runtime_ListTagsForResource_Errors"></a>

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
<a name="API_data-automation-runtime_ListTagsForResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation-runtime_TagResource"></a>

Lets you add a tag to an already created resource.

## Request Syntax
<a name="API_data-automation-runtime_TagResource_RequestSyntax"></a>

```
{
   "resourceARN": "string",
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_data-automation-runtime_TagResource_RequestParameters"></a>

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) **   <a name="bedrock-data-automation-runtime_TagResource-request-resourceARN"></a>
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) **   <a name="bedrock-data-automation-runtime_TagResource-request-tags"></a>
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
<a name="API_data-automation-runtime_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_data-automation-runtime_TagResource_Errors"></a>

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
<a name="API_data-automation-runtime_TagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_data-automation-runtime_UntagResource"></a>

Remove the tags from a resource.

## Request Syntax
<a name="API_data-automation-runtime_UntagResource_RequestSyntax"></a>

```
{
   "resourceARN": "string",
   "tagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_data-automation-runtime_UntagResource_RequestParameters"></a>

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) **   <a name="bedrock-data-automation-runtime_UntagResource-request-resourceARN"></a>
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) **   <a name="bedrock-data-automation-runtime_UntagResource-request-tagKeys"></a>
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
<a name="API_data-automation-runtime_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_data-automation-runtime_UntagResource_Errors"></a>

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
<a name="API_data-automation-runtime_UntagResource_SeeAlso"></a>

For more information about using this API 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
<a name="API_Operations_Amazon_Bedrock_Runtime"></a>

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
<a name="API_runtime_ApplyGuardrail"></a>

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
<a name="API_runtime_ApplyGuardrail_RequestSyntax"></a>

```
POST /guardrail/guardrailIdentifier/version/guardrailVersion/apply HTTP/1.1
Content-type: application/json

{
   "content": [ 
      { ... }
   ],
   "outputScope": "string",
   "source": "string"
}
```

## URI Request Parameters
<a name="API_runtime_ApplyGuardrail_RequestParameters"></a>

The request uses the following URI parameters.

 ** [guardrailIdentifier](#API_runtime_ApplyGuardrail_RequestSyntax) **   <a name="bedrock-runtime_ApplyGuardrail-request-uri-guardrailIdentifier"></a>
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) **   <a name="bedrock-runtime_ApplyGuardrail-request-uri-guardrailVersion"></a>
The guardrail version used in the request to apply the guardrail.  
Pattern: `(|([1-9][0-9]{0,7})|(DRAFT))`   
Required: Yes

## Request Body
<a name="API_runtime_ApplyGuardrail_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [content](#API_runtime_ApplyGuardrail_RequestSyntax) **   <a name="bedrock-runtime_ApplyGuardrail-request-content"></a>
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) **   <a name="bedrock-runtime_ApplyGuardrail-request-outputScope"></a>
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) **   <a name="bedrock-runtime_ApplyGuardrail-request-source"></a>
The source of data used in the request to apply the guardrail.  
Type: String  
Valid Values: `INPUT | OUTPUT`   
Required: Yes

## Response Syntax
<a name="API_runtime_ApplyGuardrail_ResponseSyntax"></a>

```
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
<a name="API_runtime_ApplyGuardrail_ResponseElements"></a>

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) **   <a name="bedrock-runtime_ApplyGuardrail-response-action"></a>
The action taken in the response from the guardrail.  
Type: String  
Valid Values: `NONE | GUARDRAIL_INTERVENED` 

 ** [actionReason](#API_runtime_ApplyGuardrail_ResponseSyntax) **   <a name="bedrock-runtime_ApplyGuardrail-response-actionReason"></a>
The reason for the action taken when harmful content is detected.  
Type: String

 ** [assessments](#API_runtime_ApplyGuardrail_ResponseSyntax) **   <a name="bedrock-runtime_ApplyGuardrail-response-assessments"></a>
The assessment details in the response from the guardrail.  
Type: Array of [GuardrailAssessment](API_runtime_GuardrailAssessment.md) objects

 ** [guardrailCoverage](#API_runtime_ApplyGuardrail_ResponseSyntax) **   <a name="bedrock-runtime_ApplyGuardrail-response-guardrailCoverage"></a>
The guardrail coverage details in the apply guardrail response.  
Type: [GuardrailCoverage](API_runtime_GuardrailCoverage.md) object

 ** [outputs](#API_runtime_ApplyGuardrail_ResponseSyntax) **   <a name="bedrock-runtime_ApplyGuardrail-response-outputs"></a>
The output details in the response from the guardrail.  
Type: Array of [GuardrailOutputContent](API_runtime_GuardrailOutputContent.md) objects

 ** [usage](#API_runtime_ApplyGuardrail_ResponseSyntax) **   <a name="bedrock-runtime_ApplyGuardrail-response-usage"></a>
The usage details in the response from the guardrail.  
Type: [GuardrailUsage](API_runtime_GuardrailUsage.md) object

## Errors
<a name="API_runtime_ApplyGuardrail_Errors"></a>

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
<a name="API_runtime_ApplyGuardrail_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_Converse"></a>

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
<a name="API_runtime_Converse_RequestSyntax"></a>

```
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
<a name="API_runtime_Converse_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelId](#API_runtime_Converse_RequestSyntax) **   <a name="bedrock-runtime_Converse-request-uri-modelId"></a>
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
<a name="API_runtime_Converse_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [additionalModelRequestFields](#API_runtime_Converse_RequestSyntax) **   <a name="bedrock-runtime_Converse-request-additionalModelRequestFields"></a>
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) **   <a name="bedrock-runtime_Converse-request-additionalModelResponseFieldPaths"></a>
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) **   <a name="bedrock-runtime_Converse-request-guardrailConfig"></a>
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) **   <a name="bedrock-runtime_Converse-request-inferenceConfig"></a>
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) **   <a name="bedrock-runtime_Converse-request-messages"></a>
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) **   <a name="bedrock-runtime_Converse-request-outputConfig"></a>
Output configuration for a model response.  
Type: [OutputConfig](API_runtime_OutputConfig.md) object  
Required: No

 ** [performanceConfig](#API_runtime_Converse_RequestSyntax) **   <a name="bedrock-runtime_Converse-request-performanceConfig"></a>
Model performance settings for the request.  
Type: [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) object  
Required: No

 ** [promptVariables](#API_runtime_Converse_RequestSyntax) **   <a name="bedrock-runtime_Converse-request-promptVariables"></a>
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) **   <a name="bedrock-runtime_Converse-request-requestMetadata"></a>
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) **   <a name="bedrock-runtime_Converse-request-serviceTier"></a>
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 name="bedrock-runtime_Converse-request-system"></a>
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) **   <a name="bedrock-runtime_Converse-request-toolConfig"></a>
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
<a name="API_runtime_Converse_ResponseSyntax"></a>

```
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
<a name="API_runtime_Converse_ResponseElements"></a>

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) **   <a name="bedrock-runtime_Converse-response-additionalModelResponseFields"></a>
Additional fields in the response that are unique to the model.   
Type: JSON value

 ** [metrics](#API_runtime_Converse_ResponseSyntax) **   <a name="bedrock-runtime_Converse-response-metrics"></a>
Metrics for the call to `Converse`.  
Type: [ConverseMetrics](API_runtime_ConverseMetrics.md) object

 ** [output](#API_runtime_Converse_ResponseSyntax) **   <a name="bedrock-runtime_Converse-response-output"></a>
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) **   <a name="bedrock-runtime_Converse-response-performanceConfig"></a>
Model performance settings for the request.  
Type: [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) object

 ** [serviceTier](#API_runtime_Converse_ResponseSyntax) **   <a name="bedrock-runtime_Converse-response-serviceTier"></a>
Specifies the processing tier configuration used for serving the request.  
Type: [ServiceTier](API_runtime_ServiceTier.md) object

 ** [stopReason](#API_runtime_Converse_ResponseSyntax) **   <a name="bedrock-runtime_Converse-response-stopReason"></a>
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 name="bedrock-runtime_Converse-response-trace"></a>
A trace object that contains information about the Guardrail behavior.  
Type: [ConverseTrace](API_runtime_ConverseTrace.md) object

 ** [usage](#API_runtime_Converse_ResponseSyntax) **   <a name="bedrock-runtime_Converse-response-usage"></a>
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
<a name="API_runtime_Converse_Errors"></a>

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
<a name="API_runtime_Converse_Examples"></a>

### Send a message to a model
<a name="API_runtime_Converse_Example_1"></a>

Send a messsage to Anthropic Claude Sonnet with `Converse`. 

#### Sample Request
<a name="API_runtime_Converse_Example_1_Request"></a>

```
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
<a name="API_runtime_Converse_Example_2"></a>

Response for the above request.

#### Sample Request
<a name="API_runtime_Converse_Example_2_Request"></a>

```
HTTP/1.1 200
Content-type: application/json

{
    "output": {
        "message": {
            "content": [
                {
                    "text": "<text generated by the model>"
                }
            ],
            "role": "assistant"
        }
    },
    "stopReason": "end_turn",
    "usage": {
        "inputTokens": 30,
        "outputTokens": 628,
        "totalTokens": 658
    },
    "metrics": {
        "latencyMs": 1275
    }
}
```

### Send a message with additional model fields
<a name="API_runtime_Converse_Example_3"></a>

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
<a name="API_runtime_Converse_Example_3_Request"></a>

```
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
<a name="API_runtime_Converse_Example_4"></a>

Response for the above example.

#### Sample Request
<a name="API_runtime_Converse_Example_4_Request"></a>

```
HTTP/1.1 200
Content-type: application/json

{
    "output": {
        "message": {
            "content": [
                {
                    "text": "<text generated by the model>"
                }
            ],
            "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
<a name="API_runtime_Converse_Example_5"></a>

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
<a name="API_runtime_Converse_Example_5_Request"></a>

```
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
<a name="API_runtime_Converse_Example_6"></a>

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
<a name="API_runtime_Converse_Example_6_Request"></a>

```
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
<a name="API_runtime_Converse_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_ConverseStream"></a>

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
<a name="API_runtime_ConverseStream_RequestSyntax"></a>

```
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
<a name="API_runtime_ConverseStream_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelId](#API_runtime_ConverseStream_RequestSyntax) **   <a name="bedrock-runtime_ConverseStream-request-uri-modelId"></a>
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
<a name="API_runtime_ConverseStream_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [additionalModelRequestFields](#API_runtime_ConverseStream_RequestSyntax) **   <a name="bedrock-runtime_ConverseStream-request-additionalModelRequestFields"></a>
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) **   <a name="bedrock-runtime_ConverseStream-request-additionalModelResponseFieldPaths"></a>
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) **   <a name="bedrock-runtime_ConverseStream-request-guardrailConfig"></a>
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) **   <a name="bedrock-runtime_ConverseStream-request-inferenceConfig"></a>
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) **   <a name="bedrock-runtime_ConverseStream-request-messages"></a>
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) **   <a name="bedrock-runtime_ConverseStream-request-outputConfig"></a>
Output configuration for a model response.  
Type: [OutputConfig](API_runtime_OutputConfig.md) object  
Required: No

 ** [performanceConfig](#API_runtime_ConverseStream_RequestSyntax) **   <a name="bedrock-runtime_ConverseStream-request-performanceConfig"></a>
Model performance settings for the request.  
Type: [PerformanceConfiguration](API_runtime_PerformanceConfiguration.md) object  
Required: No

 ** [promptVariables](#API_runtime_ConverseStream_RequestSyntax) **   <a name="bedrock-runtime_ConverseStream-request-promptVariables"></a>
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) **   <a name="bedrock-runtime_ConverseStream-request-requestMetadata"></a>
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) **   <a name="bedrock-runtime_ConverseStream-request-serviceTier"></a>
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 name="bedrock-runtime_ConverseStream-request-system"></a>
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) **   <a name="bedrock-runtime_ConverseStream-request-toolConfig"></a>
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
<a name="API_runtime_ConverseStream_ResponseSyntax"></a>

```
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
<a name="API_runtime_ConverseStream_ResponseElements"></a>

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) **   <a name="bedrock-runtime_ConverseStream-response-contentBlockDelta"></a>
The messages output content block delta.  
Type: [ContentBlockDeltaEvent](API_runtime_ContentBlockDeltaEvent.md) object

 ** [contentBlockStart](#API_runtime_ConverseStream_ResponseSyntax) **   <a name="bedrock-runtime_ConverseStream-response-contentBlockStart"></a>
Start information for a content block.  
Type: [ContentBlockStartEvent](API_runtime_ContentBlockStartEvent.md) object

 ** [contentBlockStop](#API_runtime_ConverseStream_ResponseSyntax) **   <a name="bedrock-runtime_ConverseStream-response-contentBlockStop"></a>
Stop information for a content block.  
Type: [ContentBlockStopEvent](API_runtime_ContentBlockStopEvent.md) object

 ** [internalServerException](#API_runtime_ConverseStream_ResponseSyntax) **   <a name="bedrock-runtime_ConverseStream-response-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500

 ** [messageStart](#API_runtime_ConverseStream_ResponseSyntax) **   <a name="bedrock-runtime_ConverseStream-response-messageStart"></a>
Message start information.  
Type: [MessageStartEvent](API_runtime_MessageStartEvent.md) object

 ** [messageStop](#API_runtime_ConverseStream_ResponseSyntax) **   <a name="bedrock-runtime_ConverseStream-response-messageStop"></a>
Message stop information.  
Type: [MessageStopEvent](API_runtime_MessageStopEvent.md) object

 ** [metadata](#API_runtime_ConverseStream_ResponseSyntax) **   <a name="bedrock-runtime_ConverseStream-response-metadata"></a>
Metadata for the converse output stream.  
Type: [ConverseStreamMetadataEvent](API_runtime_ConverseStreamMetadataEvent.md) object

 ** [modelStreamErrorException](#API_runtime_ConverseStream_ResponseSyntax) **   <a name="bedrock-runtime_ConverseStream-response-modelStreamErrorException"></a>
A streaming error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 424

 ** [serviceUnavailableException](#API_runtime_ConverseStream_ResponseSyntax) **   <a name="bedrock-runtime_ConverseStream-response-serviceUnavailableException"></a>
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) **   <a name="bedrock-runtime_ConverseStream-response-throttlingException"></a>
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) **   <a name="bedrock-runtime_ConverseStream-response-validationException"></a>
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
<a name="API_runtime_ConverseStream_Errors"></a>

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
<a name="API_runtime_ConverseStream_Examples"></a>

### Send a message to a model and stream the response.
<a name="API_runtime_ConverseStream_Example_1"></a>

Send a message to Anthropic Claude Sonnet with `ConverseStream` and stream the response.

#### Sample Request
<a name="API_runtime_ConverseStream_Example_1_Request"></a>

```
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
<a name="API_runtime_ConverseStream_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_CountTokens"></a>

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
<a name="API_runtime_CountTokens_RequestSyntax"></a>

```
POST /model/modelId/count-tokens HTTP/1.1
Content-type: application/json

{
   "input": { ... }
}
```

## URI Request Parameters
<a name="API_runtime_CountTokens_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelId](#API_runtime_CountTokens_RequestSyntax) **   <a name="bedrock-runtime_CountTokens-request-uri-modelId"></a>
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
<a name="API_runtime_CountTokens_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [input](#API_runtime_CountTokens_RequestSyntax) **   <a name="bedrock-runtime_CountTokens-request-input"></a>
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
<a name="API_runtime_CountTokens_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "inputTokens": number
}
```

## Response Elements
<a name="API_runtime_CountTokens_ResponseElements"></a>

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) **   <a name="bedrock-runtime_CountTokens-response-inputTokens"></a>
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
<a name="API_runtime_CountTokens_Errors"></a>

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
<a name="API_runtime_CountTokens_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_GetAsyncInvoke"></a>

Retrieve information about an asynchronous invocation.

## Request Syntax
<a name="API_runtime_GetAsyncInvoke_RequestSyntax"></a>

```
GET /async-invoke/invocationArn HTTP/1.1
```

## URI Request Parameters
<a name="API_runtime_GetAsyncInvoke_RequestParameters"></a>

The request uses the following URI parameters.

 ** [invocationArn](#API_runtime_GetAsyncInvoke_RequestSyntax) **   <a name="bedrock-runtime_GetAsyncInvoke-request-uri-invocationArn"></a>
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
<a name="API_runtime_GetAsyncInvoke_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_runtime_GetAsyncInvoke_ResponseSyntax"></a>

```
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
<a name="API_runtime_GetAsyncInvoke_ResponseElements"></a>

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) **   <a name="bedrock-runtime_GetAsyncInvoke-response-clientRequestToken"></a>
The invocation's idempotency token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[!-~]*` 

 ** [endTime](#API_runtime_GetAsyncInvoke_ResponseSyntax) **   <a name="bedrock-runtime_GetAsyncInvoke-response-endTime"></a>
When the invocation ended.  
Type: Timestamp

 ** [failureMessage](#API_runtime_GetAsyncInvoke_ResponseSyntax) **   <a name="bedrock-runtime_GetAsyncInvoke-response-failureMessage"></a>
An error message.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 2048.

 ** [invocationArn](#API_runtime_GetAsyncInvoke_ResponseSyntax) **   <a name="bedrock-runtime_GetAsyncInvoke-response-invocationArn"></a>
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) **   <a name="bedrock-runtime_GetAsyncInvoke-response-lastModifiedTime"></a>
The invocation's last modified time.  
Type: Timestamp

 ** [modelArn](#API_runtime_GetAsyncInvoke_ResponseSyntax) **   <a name="bedrock-runtime_GetAsyncInvoke-response-modelArn"></a>
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) **   <a name="bedrock-runtime_GetAsyncInvoke-response-outputDataConfig"></a>
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) **   <a name="bedrock-runtime_GetAsyncInvoke-response-status"></a>
The invocation's status.  
Type: String  
Valid Values: `InProgress | Completed | Failed` 

 ** [submitTime](#API_runtime_GetAsyncInvoke_ResponseSyntax) **   <a name="bedrock-runtime_GetAsyncInvoke-response-submitTime"></a>
When the invocation request was submitted.  
Type: Timestamp

## Errors
<a name="API_runtime_GetAsyncInvoke_Errors"></a>

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
<a name="API_runtime_GetAsyncInvoke_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_InvokeModel"></a>

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
<a name="API_runtime_InvokeModel_RequestSyntax"></a>

```
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
<a name="API_runtime_InvokeModel_RequestParameters"></a>

The request uses the following URI parameters.

 ** [accept](#API_runtime_InvokeModel_RequestSyntax) **   <a name="bedrock-runtime_InvokeModel-request-accept"></a>
The desired MIME type of the inference body in the response. The default value is `application/json`.

 ** [contentType](#API_runtime_InvokeModel_RequestSyntax) **   <a name="bedrock-runtime_InvokeModel-request-contentType"></a>
The MIME type of the input data in the request. You must specify `application/json`.

 ** [guardrailIdentifier](#API_runtime_InvokeModel_RequestSyntax) **   <a name="bedrock-runtime_InvokeModel-request-guardrailIdentifier"></a>
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) **   <a name="bedrock-runtime_InvokeModel-request-guardrailVersion"></a>
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) **   <a name="bedrock-runtime_InvokeModel-request-uri-modelId"></a>
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) **   <a name="bedrock-runtime_InvokeModel-request-performanceConfigLatency"></a>
Model performance settings for the request.  
Valid Values: `standard | optimized` 

 ** [serviceTier](#API_runtime_InvokeModel_RequestSyntax) **   <a name="bedrock-runtime_InvokeModel-request-serviceTier"></a>
Specifies the processing tier type used for serving the request.  
Valid Values: `priority | default | flex | reserved` 

 ** [trace](#API_runtime_InvokeModel_RequestSyntax) **   <a name="bedrock-runtime_InvokeModel-request-trace"></a>
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
<a name="API_runtime_InvokeModel_RequestBody"></a>

The request accepts the following binary data.

 ** [body](#API_runtime_InvokeModel_RequestSyntax) **   <a name="bedrock-runtime_InvokeModel-request-body"></a>
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
<a name="API_runtime_InvokeModel_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-Type: contentType
X-Amzn-Bedrock-PerformanceConfig-Latency: performanceConfigLatency
X-Amzn-Bedrock-Service-Tier: serviceTier

body
```

## Response Elements
<a name="API_runtime_InvokeModel_ResponseElements"></a>

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) **   <a name="bedrock-runtime_InvokeModel-response-contentType"></a>
The MIME type of the inference result.

 ** [performanceConfigLatency](#API_runtime_InvokeModel_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModel-response-performanceConfigLatency"></a>
Model performance settings for the request.  
Valid Values: `standard | optimized` 

 ** [serviceTier](#API_runtime_InvokeModel_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModel-response-serviceTier"></a>
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) **   <a name="bedrock-runtime_InvokeModel-response-body"></a>
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
<a name="API_runtime_InvokeModel_Errors"></a>

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
<a name="API_runtime_InvokeModel_Examples"></a>

### Run inference on a text model
<a name="API_runtime_InvokeModel_Example_1"></a>

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
<a name="API_runtime_InvokeModel_Example_1_Request"></a>

```
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
<a name="API_runtime_InvokeModel_Example_2"></a>

In the following example, the request sets the `accept` parameter to `image/png`.

#### Sample Request
<a name="API_runtime_InvokeModel_Example_2_Request"></a>

```
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
<a name="API_runtime_InvokeModel_Example_3"></a>

This example shows how to use a guardrail with `InvokeModel`.

#### Sample Request
<a name="API_runtime_InvokeModel_Example_3_Request"></a>

```
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
<a name="API_runtime_InvokeModel_Example_4"></a>

This is an example response from `InvokeModel` when using a guardrail.

#### Sample Request
<a name="API_runtime_InvokeModel_Example_4_Request"></a>

```
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
<a name="API_runtime_InvokeModel_Example_5"></a>

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
<a name="API_runtime_InvokeModel_Example_5_Request"></a>

```
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
<a name="API_runtime_InvokeModel_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_InvokeModelWithBidirectionalStream"></a>

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
<a name="API_runtime_InvokeModelWithBidirectionalStream_RequestSyntax"></a>

```
POST /model/modelId/invoke-with-bidirectional-stream HTTP/1.1
Content-type: application/json

{
   "chunk": { 
      "bytes": blob
   }
}
```

## URI Request Parameters
<a name="API_runtime_InvokeModelWithBidirectionalStream_RequestParameters"></a>

The request uses the following URI parameters.

 ** [modelId](#API_runtime_InvokeModelWithBidirectionalStream_RequestSyntax) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-request-uri-modelId"></a>
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
<a name="API_runtime_InvokeModelWithBidirectionalStream_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [chunk](#API_runtime_InvokeModelWithBidirectionalStream_RequestSyntax) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-request-chunk"></a>
The audio chunk that is used as input for the invocation step.  
Type: [BidirectionalInputPayloadPart](API_runtime_BidirectionalInputPayloadPart.md) object  
Required: No

## Response Syntax
<a name="API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "chunk": { 
      "bytes": blob
   },
   "internalServerException": { 
   },
   "modelStreamErrorException": { 
   },
   "modelTimeoutException": { 
   },
   "serviceUnavailableException": { 
   },
   "throttlingException": { 
   },
   "validationException": { 
   }
}
```

## Response Elements
<a name="API_runtime_InvokeModelWithBidirectionalStream_ResponseElements"></a>

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) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-response-chunk"></a>
The speech chunk that was provided as output from the invocation step.  
Type: [BidirectionalOutputPayloadPart](API_runtime_BidirectionalOutputPayloadPart.md) object

 ** [internalServerException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-response-internalServerException"></a>
The request encountered an unknown internal error.  
Type: Exception  
HTTP Status Code: 500

 ** [modelStreamErrorException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-response-modelStreamErrorException"></a>
The request encountered an error with the model stream.  
Type: Exception  
HTTP Status Code: 424

 ** [modelTimeoutException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-response-modelTimeoutException"></a>
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) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-response-serviceUnavailableException"></a>
The request has failed due to a temporary failure of the server.  
Type: Exception  
HTTP Status Code: 503

 ** [throttlingException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-response-throttlingException"></a>
The request was denied due to request throttling.  
Type: Exception  
HTTP Status Code: 429

 ** [validationException](#API_runtime_InvokeModelWithBidirectionalStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithBidirectionalStream-response-validationException"></a>
The input fails to satisfy the constraints specified by an AWS service.  
Type: Exception  
HTTP Status Code: 400

## Errors
<a name="API_runtime_InvokeModelWithBidirectionalStream_Errors"></a>

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
<a name="API_runtime_InvokeModelWithBidirectionalStream_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_InvokeModelWithResponseStream"></a>

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
<a name="API_runtime_InvokeModelWithResponseStream_RequestSyntax"></a>

```
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
<a name="API_runtime_InvokeModelWithResponseStream_RequestParameters"></a>

The request uses the following URI parameters.

 ** [accept](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-accept"></a>
The desired MIME type of the inference body in the response. The default value is `application/json`.

 ** [contentType](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-contentType"></a>
The MIME type of the input data in the request. You must specify `application/json`.

 ** [guardrailIdentifier](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-guardrailIdentifier"></a>
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) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-guardrailVersion"></a>
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) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-uri-modelId"></a>
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) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-performanceConfigLatency"></a>
Model performance settings for the request.  
Valid Values: `standard | optimized` 

 ** [serviceTier](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-serviceTier"></a>
Specifies the processing tier type used for serving the request.  
Valid Values: `priority | default | flex | reserved` 

 ** [trace](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-trace"></a>
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
<a name="API_runtime_InvokeModelWithResponseStream_RequestBody"></a>

The request accepts the following binary data.

 ** [body](#API_runtime_InvokeModelWithResponseStream_RequestSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-request-body"></a>
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
<a name="API_runtime_InvokeModelWithResponseStream_ResponseSyntax"></a>

```
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
<a name="API_runtime_InvokeModelWithResponseStream_ResponseElements"></a>

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) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-contentType"></a>
The MIME type of the inference result.

 ** [performanceConfigLatency](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-performanceConfigLatency"></a>
Model performance settings for the request.  
Valid Values: `standard | optimized` 

 ** [serviceTier](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-serviceTier"></a>
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) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-chunk"></a>
Content included in the response.  
Type: [PayloadPart](API_runtime_PayloadPart.md) object

 ** [internalServerException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-internalServerException"></a>
An internal server error occurred. Retry your request.  
Type: Exception  
HTTP Status Code: 500

 ** [modelStreamErrorException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-modelStreamErrorException"></a>
An error occurred while streaming the response. Retry your request.  
Type: Exception  
HTTP Status Code: 424

 ** [modelTimeoutException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-modelTimeoutException"></a>
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) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-serviceUnavailableException"></a>
The service isn't available. Try again later.  
Type: Exception  
HTTP Status Code: 503

 ** [throttlingException](#API_runtime_InvokeModelWithResponseStream_ResponseSyntax) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-throttlingException"></a>
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) **   <a name="bedrock-runtime_InvokeModelWithResponseStream-response-validationException"></a>
Input validation failed. Check your request parameters and retry the request.  
Type: Exception  
HTTP Status Code: 400

## Errors
<a name="API_runtime_InvokeModelWithResponseStream_Errors"></a>

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
<a name="API_runtime_InvokeModelWithResponseStream_Examples"></a>

### Run inference with streaming on a text model
<a name="API_runtime_InvokeModelWithResponseStream_Example_1"></a>

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
<a name="API_runtime_InvokeModelWithResponseStream_Example_1_Request"></a>

```
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
<a name="API_runtime_InvokeModelWithResponseStream_Example_2"></a>

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
<a name="API_runtime_InvokeModelWithResponseStream_Example_2_Request"></a>

```
-H content-type: application/vnd.amazon.eventstream
-H x-amzn-bedrock-content-type: application/json

Payload (stream events)
<response chunk>
```

### Use a guardrail
<a name="API_runtime_InvokeModelWithResponseStream_Example_3"></a>

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
<a name="API_runtime_InvokeModelWithResponseStream_Example_4"></a>

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
<a name="API_runtime_InvokeModelWithResponseStream_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_ListAsyncInvokes"></a>

Lists asynchronous invocations.

## Request Syntax
<a name="API_runtime_ListAsyncInvokes_RequestSyntax"></a>

```
GET /async-invoke?maxResults=maxResults&nextToken=nextToken&sortBy=sortBy&sortOrder=sortOrder&statusEquals=statusEquals&submitTimeAfter=submitTimeAfter&submitTimeBefore=submitTimeBefore HTTP/1.1
```

## URI Request Parameters
<a name="API_runtime_ListAsyncInvokes_RequestParameters"></a>

The request uses the following URI parameters.

 ** [maxResults](#API_runtime_ListAsyncInvokes_RequestSyntax) **   <a name="bedrock-runtime_ListAsyncInvokes-request-uri-maxResults"></a>
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) **   <a name="bedrock-runtime_ListAsyncInvokes-request-uri-nextToken"></a>
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) **   <a name="bedrock-runtime_ListAsyncInvokes-request-uri-sortBy"></a>
How to sort the response.  
Valid Values: `SubmissionTime` 

 ** [sortOrder](#API_runtime_ListAsyncInvokes_RequestSyntax) **   <a name="bedrock-runtime_ListAsyncInvokes-request-uri-sortOrder"></a>
The sorting order for the response.  
Valid Values: `Ascending | Descending` 

 ** [statusEquals](#API_runtime_ListAsyncInvokes_RequestSyntax) **   <a name="bedrock-runtime_ListAsyncInvokes-request-uri-statusEquals"></a>
Filter invocations by status.  
Valid Values: `InProgress | Completed | Failed` 

 ** [submitTimeAfter](#API_runtime_ListAsyncInvokes_RequestSyntax) **   <a name="bedrock-runtime_ListAsyncInvokes-request-uri-submitTimeAfter"></a>
Include invocations submitted after this time.

 ** [submitTimeBefore](#API_runtime_ListAsyncInvokes_RequestSyntax) **   <a name="bedrock-runtime_ListAsyncInvokes-request-uri-submitTimeBefore"></a>
Include invocations submitted before this time.

## Request Body
<a name="API_runtime_ListAsyncInvokes_RequestBody"></a>

The request does not have a request body.

## Response Syntax
<a name="API_runtime_ListAsyncInvokes_ResponseSyntax"></a>

```
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
<a name="API_runtime_ListAsyncInvokes_ResponseElements"></a>

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 name="bedrock-runtime_ListAsyncInvokes-response-asyncInvokeSummaries"></a>
A list of invocation summaries.  
Type: Array of [AsyncInvokeSummary](API_runtime_AsyncInvokeSummary.md) objects

 ** [nextToken](#API_runtime_ListAsyncInvokes_ResponseSyntax) **   <a name="bedrock-runtime_ListAsyncInvokes-response-nextToken"></a>
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
<a name="API_runtime_ListAsyncInvokes_Errors"></a>

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
<a name="API_runtime_ListAsyncInvokes_SeeAlso"></a>

For more information about using this API 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
<a name="API_runtime_StartAsyncInvoke"></a>

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
<a name="API_runtime_StartAsyncInvoke_RequestSyntax"></a>

```
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
<a name="API_runtime_StartAsyncInvoke_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_runtime_StartAsyncInvoke_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [clientRequestToken](#API_runtime_StartAsyncInvoke_RequestSyntax) **   <a name="bedrock-runtime_StartAsyncInvoke-request-clientRequestToken"></a>
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) **   <a name="bedrock-runtime_StartAsyncInvoke-request-modelId"></a>
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) **   <a name="bedrock-runtime_StartAsyncInvoke-request-modelInput"></a>
Input to send to the model.  
Type: JSON value  
Required: Yes

 ** [outputDataConfig](#API_runtime_StartAsyncInvoke_RequestSyntax) **   <a name="bedrock-runtime_StartAsyncInvoke-request-outputDataConfig"></a>
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) **   <a name="bedrock-runtime_StartAsyncInvoke-request-tags"></a>
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
<a name="API_runtime_StartAsyncInvoke_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "invocationArn": "string"
}
```

## Response Elements
<a name="API_runtime_StartAsyncInvoke_ResponseElements"></a>

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) **   <a name="bedrock-runtime_StartAsyncInvoke-response-invocationArn"></a>
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
<a name="API_runtime_StartAsyncInvoke_Errors"></a>

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
<a name="API_runtime_StartAsyncInvoke_SeeAlso"></a>

For more information about using this API 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)