Data retrieval APIs for Amazon Bedrock
Amazon Bedrock provides the following APIs for data retrieval.
Actions | Description | Access level |
---|---|---|
ApplyGuardrail | Apply a guardrail | Read |
CallWithBearerToken | Use bearer token | Read |
DetectGeneratedContent | Detect if the provided content is generated using Amazon Bedrock | Read |
ExportAutomatedReasoningPolicyVersion | Retrieve an automated reasoning policy version artifact | Read |
GenerateQuery | Generate queries associated with user input | Read |
GetAgent | Retrieve an existing agent | Read |
GetAgentActionGroup | Retrieve an existing action group | Read |
GetAgentAlias | Retrieve an existing alias | Read |
GetAgentCollaborator | Retrieve an existing collaborator | Read |
GetAgentKnowledgeBase | Describe a knowledge base associated with an agent | Read |
GetAgentMemory | Retrieve existing memory for an alias | Read |
GetAgentVersion | Retrieve an existing version of an agent | Read |
GetAsyncInvoke | Get the properties associated with an asynchronous invocation that you have submitted | Read |
GetAutomatedReasoningPolicy | Retrieve an automated reasoning policy or its version | Read |
GetAutomatedReasoningPolicyAnnotations | Retrieve annotations for a build workflow for an automated reasoning policy | Read |
GetAutomatedReasoningPolicyBuildWorkflow | Retrieve a build workflow for an automated reasoning policy | Read |
GetAutomatedReasoningPolicyBuildWorkflowResultAssets | Retrieve assets for a build workflow for an automated reasoning policy | Read |
GetAutomatedReasoningPolicyNextScenario | Retrieve the next unreviewed generated scenario for a build workflow for an automated reasoning policy | Read |
GetAutomatedReasoningPolicyTestCase | Retrieve a test case for an automated reasoning policy | Read |
GetAutomatedReasoningPolicyTestResult | Retrieve result for a test case for an automated reasoning policy | Read |
GetBlueprint | Retrieve an existing blueprint for data automation | Read |
GetBlueprintRecommendation | Retrieve blueprint recommendation | Read |
GetCustomModel | Get the properties associated with a Bedrock custom model that you have created | Read |
GetCustomModelDeployment | Get the properties associated with a custom model deployment. Use this operation to get the status of a custom model deployment | Read |
GetDataAutomationProject | Retrieve an existing data automation project | Read |
GetDataAutomationStatus | Retrieve the status of a data automation invocation job | Read |
GetDataSource | Retrieve an existing data source | Read |
GetEvaluationJob | Get the properties associated with a evaluation job. Use this operation to get the status of a evaluation job | Read |
GetExecutionFlowSnapshot | Retrieve the flow definition for a flow execution | Read |
GetFlow | Retrieve an existing prompt flow | Read |
GetFlowAlias | Retrieve an existing alias of a prompt flow | Read |
GetFlowExecution | Retrieve an existing execution of a flow alias | Read |
GetFlowVersion | Retrieve an existing version of a prompt flow | Read |
GetFoundationModel | Get the properties associated with a Bedrock foundation model | Read |
GetFoundationModelAvailability | Get the availability of a foundation model | Read |
GetGuardrail | Retrieve a guardrail or its version | Read |
GetImportedModel | Get the properties associated with Bedrock imported model | Read |
GetInferenceProfile | Get the properties associated with an inference profile | Read |
GetIngestionJob | Retrieve an existing ingestion job | Read |
GetInvocationStep | Get an invocation step from a session | Read |
GetKnowledgeBase | Retrieve an existing knowledge base | Read |
GetKnowledgeBaseDocuments | Get details for documents in a knowledge base | Read |
GetMarketplaceModelEndpoint | Get the properties of a marketplace model endpoint | Read |
GetModelCopyJob | Get the properties associated with a model-copy job. Use this operation to get the status of a model-copy job | Read |
GetModelCustomizationJob | Get the properties associated with a model-customization job. Use this operation to get the status of a model-customization job | Read |
GetModelEvaluationJob | Get the properties associated with a model-evaluation job. Use this operation to get the status of a model-evaluation job | Read |
GetModelImportJob | Get the properties associated with a model import job and is used to get the status of a model import job | Read |
GetModelInvocationJob | Retrieve a model invocation job | Read |
GetModelInvocationLoggingConfiguration | Retrieve an existing Invocation logging configuration | Read |
GetPrompt | Retrieve an existing prompt or its version | Read |
GetPromptRouter | Get the properties associated with a prompt router | Read |
GetProvisionedModelThroughput | Retrieve a provisioned model throughput | Read |
GetResourcePolicy | Gets the resource policy document for a Bedrock resource | Read |
GetSession | Retrieve an existing session | Read |
GetUseCaseForModelAccess | Retrieve a use case for model access | Read |
InvokeAgent | Send user input (text-only) to the alias of an agent for Bedrock | Read |
InvokeAutomatedReasoningPolicy | Invoke an Automated Reasoning policy | Read |
InvokeFlow | Invoke a prompt flow with user input | Read |
InvokeInlineAgent | Send user input (text-only) to the inline agent for Bedrock | Read |
InvokeModel | Invoke the specified Bedrock model to run inference using the input provided in the request body | Read |
InvokeModelWithResponseStream | Invoke the specified Bedrock model to run inference using the input provided in the request body with streaming response | Read |
ListAgentActionGroups | List action groups in an agent | List |
ListAgentAliases | List aliases for an agent | List |
ListAgentCollaborators | List collaborators for an agent | List |
ListAgentKnowledgeBases | List knowledge bases associated with an agent | List |
ListAgentVersions | List existing versions of an agent | List |
ListAgents | List existing agents | List |
ListAsyncInvokes | Get a list of asynchronous invocations that you have submitted | List |
ListAutomatedReasoningPolicies | List automated reasoning policies or its versions | List |
ListAutomatedReasoningPolicyBuildWorkflows | List build workflows for an automated reasoning policy | List |
ListAutomatedReasoningPolicyTestCases | List test cases for an automated reasoning policy | List |
ListAutomatedReasoningPolicyTestResults | List test result for an automated reasoning policy | List |
ListBlueprints | List existing blueprints for data automation | List |
ListCustomModelDeployments | Get the list of custom model deployments that you have submitted | List |
ListCustomModels | Get a list of Bedrock custom models that you have created | List |
ListDataAutomationProjects | List existing data automation projects | List |
ListDataSources | List existing data sources in an knowledge base | List |
ListEvaluationJobs | Get the list of evaluation jobs that you have submitted | List |
ListFlowAliases | List existing aliases of a prompt flow | List |
ListFlowExecutionEvents | Retrieve events for a flow execution | List |
ListFlowExecutions | List executions of a flow or a flow alias | List |
ListFlowVersions | List existing versions of a prompt flow | List |
ListFlows | List existing prompt flows | List |
ListFoundationModelAgreementOffers | Get a list of foundation model agreement offers | List |
ListFoundationModels | List Bedrock foundation models that you can use | List |
ListGuardrails | List guardrails or its versions | List |
ListImportedModels | Get list of Bedrock imported models | List |
ListInferenceProfiles | List inference profiles that you can use | List |
ListIngestionJobs | List ingestion jobs in a data source | List |
ListInvocationSteps | Get list of invocation step from a session | List |
ListInvocations | List invocations in a session | List |
ListKnowledgeBaseDocuments | List documents in a knowledge base | List |
ListKnowledgeBases | List existing knowledge bases | List |
ListMarketplaceModelEndpoints | List marketplace model endpoints that you can use | Read |
ListModelCopyJobs | Get the list of model copy jobs that you have submitted | List |
ListModelCustomizationJobs | Get the list of model customization jobs that you have submitted | List |
ListModelEvaluationJobs | Get the list of model evaluation jobs that you have submitted | List |
ListModelImportJobs | Get list of model import jobs | List |
ListModelInvocationJobs | List model invocation jobs that you created earlier | List |
ListPromptRouters | List prompt routers that you can use | List |
ListPrompts | List existing prompts | List |
ListProvisionedModelThroughputs | List provisioned model throughputs that you created earlier | List |
ListSessions | List existing sessions | List |
ListTagsForResource | List tags for a Bedrock resource | Read |
OptimizePrompt | Optimize a prompt with user input | Read |
RenderPrompt | Render an existing prompt or its version | Read |
Retrieve | Retrieve ingested data from a knowledge base | Read |
ValidateFlowDefinition | Validate prompt flow definitions | Read |