Data retrieval APIs for Amazon Bedrock - AWS Online Register of Data Formats

Data retrieval APIs for Amazon Bedrock

Amazon Bedrock provides the following APIs for data retrieval.

Actions Description Access level
ApplyGuardrailApply a guardrailRead
CallWithBearerTokenUse bearer tokenRead
DetectGeneratedContentDetect if the provided content is generated using Amazon BedrockRead
ExportAutomatedReasoningPolicyVersionRetrieve an automated reasoning policy version artifactRead
GenerateQueryGenerate queries associated with user inputRead
GetAgentRetrieve an existing agentRead
GetAgentActionGroupRetrieve an existing action groupRead
GetAgentAliasRetrieve an existing aliasRead
GetAgentCollaboratorRetrieve an existing collaboratorRead
GetAgentKnowledgeBaseDescribe a knowledge base associated with an agentRead
GetAgentMemoryRetrieve existing memory for an aliasRead
GetAgentVersionRetrieve an existing version of an agentRead
GetAsyncInvokeGet the properties associated with an asynchronous invocation that you have submittedRead
GetAutomatedReasoningPolicyRetrieve an automated reasoning policy or its versionRead
GetAutomatedReasoningPolicyAnnotationsRetrieve annotations for a build workflow for an automated reasoning policyRead
GetAutomatedReasoningPolicyBuildWorkflowRetrieve a build workflow for an automated reasoning policyRead
GetAutomatedReasoningPolicyBuildWorkflowResultAssetsRetrieve assets for a build workflow for an automated reasoning policyRead
GetAutomatedReasoningPolicyNextScenarioRetrieve the next unreviewed generated scenario for a build workflow for an automated reasoning policyRead
GetAutomatedReasoningPolicyTestCaseRetrieve a test case for an automated reasoning policyRead
GetAutomatedReasoningPolicyTestResultRetrieve result for a test case for an automated reasoning policyRead
GetBlueprintRetrieve an existing blueprint for data automationRead
GetBlueprintRecommendationRetrieve blueprint recommendationRead
GetCustomModelGet the properties associated with a Bedrock custom model that you have createdRead
GetCustomModelDeploymentGet the properties associated with a custom model deployment. Use this operation to get the status of a custom model deploymentRead
GetDataAutomationProjectRetrieve an existing data automation projectRead
GetDataAutomationStatusRetrieve the status of a data automation invocation jobRead
GetDataSourceRetrieve an existing data sourceRead
GetEvaluationJobGet the properties associated with a evaluation job. Use this operation to get the status of a evaluation jobRead
GetExecutionFlowSnapshotRetrieve the flow definition for a flow executionRead
GetFlowRetrieve an existing prompt flowRead
GetFlowAliasRetrieve an existing alias of a prompt flowRead
GetFlowExecutionRetrieve an existing execution of a flow aliasRead
GetFlowVersionRetrieve an existing version of a prompt flowRead
GetFoundationModelGet the properties associated with a Bedrock foundation modelRead
GetFoundationModelAvailabilityGet the availability of a foundation modelRead
GetGuardrailRetrieve a guardrail or its versionRead
GetImportedModelGet the properties associated with Bedrock imported modelRead
GetInferenceProfileGet the properties associated with an inference profileRead
GetIngestionJobRetrieve an existing ingestion jobRead
GetInvocationStepGet an invocation step from a sessionRead
GetKnowledgeBaseRetrieve an existing knowledge baseRead
GetKnowledgeBaseDocumentsGet details for documents in a knowledge baseRead
GetMarketplaceModelEndpointGet the properties of a marketplace model endpointRead
GetModelCopyJobGet the properties associated with a model-copy job. Use this operation to get the status of a model-copy jobRead
GetModelCustomizationJobGet the properties associated with a model-customization job. Use this operation to get the status of a model-customization jobRead
GetModelEvaluationJobGet the properties associated with a model-evaluation job. Use this operation to get the status of a model-evaluation jobRead
GetModelImportJobGet the properties associated with a model import job and is used to get the status of a model import jobRead
GetModelInvocationJobRetrieve a model invocation jobRead
GetModelInvocationLoggingConfigurationRetrieve an existing Invocation logging configurationRead
GetPromptRetrieve an existing prompt or its versionRead
GetPromptRouterGet the properties associated with a prompt routerRead
GetProvisionedModelThroughputRetrieve a provisioned model throughputRead
GetResourcePolicyGets the resource policy document for a Bedrock resourceRead
GetSessionRetrieve an existing sessionRead
GetUseCaseForModelAccessRetrieve a use case for model accessRead
InvokeAgentSend user input (text-only) to the alias of an agent for BedrockRead
InvokeAutomatedReasoningPolicyInvoke an Automated Reasoning policyRead
InvokeFlowInvoke a prompt flow with user inputRead
InvokeInlineAgentSend user input (text-only) to the inline agent for BedrockRead
InvokeModelInvoke the specified Bedrock model to run inference using the input provided in the request bodyRead
InvokeModelWithResponseStreamInvoke the specified Bedrock model to run inference using the input provided in the request body with streaming responseRead
ListAgentActionGroupsList action groups in an agentList
ListAgentAliasesList aliases for an agentList
ListAgentCollaboratorsList collaborators for an agentList
ListAgentKnowledgeBasesList knowledge bases associated with an agentList
ListAgentVersionsList existing versions of an agentList
ListAgentsList existing agentsList
ListAsyncInvokesGet a list of asynchronous invocations that you have submittedList
ListAutomatedReasoningPoliciesList automated reasoning policies or its versionsList
ListAutomatedReasoningPolicyBuildWorkflowsList build workflows for an automated reasoning policyList
ListAutomatedReasoningPolicyTestCasesList test cases for an automated reasoning policyList
ListAutomatedReasoningPolicyTestResultsList test result for an automated reasoning policyList
ListBlueprintsList existing blueprints for data automationList
ListCustomModelDeploymentsGet the list of custom model deployments that you have submittedList
ListCustomModelsGet a list of Bedrock custom models that you have createdList
ListDataAutomationProjectsList existing data automation projectsList
ListDataSourcesList existing data sources in an knowledge baseList
ListEvaluationJobsGet the list of evaluation jobs that you have submittedList
ListFlowAliasesList existing aliases of a prompt flowList
ListFlowExecutionEventsRetrieve events for a flow executionList
ListFlowExecutionsList executions of a flow or a flow aliasList
ListFlowVersionsList existing versions of a prompt flowList
ListFlowsList existing prompt flowsList
ListFoundationModelAgreementOffersGet a list of foundation model agreement offersList
ListFoundationModelsList Bedrock foundation models that you can useList
ListGuardrailsList guardrails or its versionsList
ListImportedModelsGet list of Bedrock imported modelsList
ListInferenceProfilesList inference profiles that you can useList
ListIngestionJobsList ingestion jobs in a data sourceList
ListInvocationStepsGet list of invocation step from a sessionList
ListInvocationsList invocations in a sessionList
ListKnowledgeBaseDocumentsList documents in a knowledge baseList
ListKnowledgeBasesList existing knowledge basesList
ListMarketplaceModelEndpointsList marketplace model endpoints that you can useRead
ListModelCopyJobsGet the list of model copy jobs that you have submittedList
ListModelCustomizationJobsGet the list of model customization jobs that you have submittedList
ListModelEvaluationJobsGet the list of model evaluation jobs that you have submittedList
ListModelImportJobsGet list of model import jobsList
ListModelInvocationJobsList model invocation jobs that you created earlierList
ListPromptRoutersList prompt routers that you can useList
ListPromptsList existing promptsList
ListProvisionedModelThroughputsList provisioned model throughputs that you created earlierList
ListSessionsList existing sessionsList
ListTagsForResourceList tags for a Bedrock resourceRead
OptimizePromptOptimize a prompt with user inputRead
RenderPromptRender an existing prompt or its versionRead
RetrieveRetrieve ingested data from a knowledge baseRead
ValidateFlowDefinitionValidate prompt flow definitionsRead