BedrockClient
Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.
Functions
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.
Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.
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.
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.
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.
Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.
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.
Creates an evaluation job.
Request a model access agreement for the specified model.
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
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.
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. in the Amazon Bedrock User Guide.
Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.
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 in the Amazon Bedrock User Guide.
Creates a fine-tuning job to customize a base model.
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
Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.
Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.
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. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
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.
Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.
Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.
Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
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.
Delete the model access agreement for the specified model.
Deletes a guardrail.
Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.
Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
Deletes an endpoint for a model from Amazon Bedrock Marketplace.
Delete the invocation logging.
Deletes a specified prompt router. This action cannot be undone.
Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
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.
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.
Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.
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.
Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.
Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.
Retrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior.
Retrieves details about a specific Automated Reasoning policy test.
Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.
Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see Custom models in the Amazon Bedrock User Guide.
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.
Gets information about an evaluation job, such as the status of the job.
Get details about a Amazon Bedrock foundation model.
Get information about the Foundation model availability.
Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.
Gets properties associated with a customized model you imported.
Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.
Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.
Gets details about a batch inference job. For more information, see Monitor batch inference jobs
Get the current configuration values for model invocation logging.
Retrieves details about a prompt router.
Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Get usecase for model access.
Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.
Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.
Lists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully.
Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.
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.
Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
Lists all existing evaluation jobs.
Get the offers associated with the specified model.
Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
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.
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 in the Amazon Bedrock User Guide.
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. in the Amazon Bedrock User Guide.
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
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 in the Amazon Bedrock User Guide.
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
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 in the Amazon Bedrock User Guide.
Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.
Retrieves a list of prompt routers.
Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
List the tags associated with the specified resource.
Set the configuration values for model invocation logging.
Put usecase for model access.
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
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.
Initiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results.
Stops an evaluation job that is current being created or running.
Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
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.
Updates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy.
Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.
Updates a guardrail with the values you specify.
Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Inherited functions
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.
Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.
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.
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.
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.
Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.
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.
Creates an evaluation job.
Request a model access agreement for the specified model.
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
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.
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. in the Amazon Bedrock User Guide.
Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.
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 in the Amazon Bedrock User Guide.
Creates a fine-tuning job to customize a base model.
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
Creates a batch inference job to invoke a model on multiple prompts. Format your data according to Format your inference data and upload it to an Amazon S3 bucket. For more information, see Process multiple prompts with batch inference.
Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.
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. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
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.
Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.
Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.
Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
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.
Delete the model access agreement for the specified model.
Deletes a guardrail.
Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.
Deletes an application inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
Deletes an endpoint for a model from Amazon Bedrock Marketplace.
Delete the invocation logging.
Deletes a specified prompt router. This action cannot be undone.
Deletes a Provisioned Throughput. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
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.
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.
Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.
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.
Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.
Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.
Retrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior.
Retrieves details about a specific Automated Reasoning policy test.
Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.
Get the properties associated with a Amazon Bedrock custom model that you have created. For more information, see Custom models in the Amazon Bedrock User Guide.
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.
Gets information about an evaluation job, such as the status of the job.
Get details about a Amazon Bedrock foundation model.
Get information about the Foundation model availability.
Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.
Gets properties associated with a customized model you imported.
Gets information about an inference profile. For more information, see Increase throughput and resilience with cross-region inference in Amazon Bedrock. in the Amazon Bedrock User Guide.
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
Retrieves information about a model copy job. For more information, see Copy models to be used in other regions in the Amazon Bedrock User Guide.
Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Amazon Bedrock User Guide.
Retrieves the properties associated with import model job, including the status of the job. For more information, see Import a customized model in the Amazon Bedrock User Guide.
Gets details about a batch inference job. For more information, see Monitor batch inference jobs
Get the current configuration values for model invocation logging.
Retrieves details about a prompt router.
Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Get usecase for model access.
Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.
Paginate over ListAutomatedReasoningPoliciesResponse results.
Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.
Paginate over ListAutomatedReasoningPolicyBuildWorkflowsResponse results.
Lists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully.
Paginate over ListAutomatedReasoningPolicyTestCasesResponse results.
Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.
Paginate over ListAutomatedReasoningPolicyTestResultsResponse results.
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.
Paginate over ListCustomModelDeploymentsResponse results.
Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
Paginate over ListCustomModelsResponse results.
Lists all existing evaluation jobs.
Paginate over ListEvaluationJobsResponse results.
Get the offers associated with the specified model.
Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
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.
Paginate over ListGuardrailsResponse results.
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 in the Amazon Bedrock User Guide.
Paginate over ListImportedModelsResponse results.
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. in the Amazon Bedrock User Guide.
Paginate over ListInferenceProfilesResponse results.
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
Paginate over ListMarketplaceModelEndpointsResponse results.
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 in the Amazon Bedrock User Guide.
Paginate over ListModelCopyJobsResponse results.
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
Paginate over ListModelCustomizationJobsResponse results.
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 in the Amazon Bedrock User Guide.
Paginate over ListModelImportJobsResponse results.
Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.
Paginate over ListModelInvocationJobsResponse results.
Retrieves a list of prompt routers.
Paginate over ListPromptRoutersResponse results.
Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Paginate over ListProvisionedModelThroughputsResponse results.
List the tags associated with the specified resource.
Set the configuration values for model invocation logging.
Put usecase for model access.
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
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.
Initiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results.
Stops an evaluation job that is current being created or running.
Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
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.
Updates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy.
Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.
Updates a guardrail with the values you specify.
Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.