View Source AWS.Bedrock (aws-elixir v1.0.10)

Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.

Link to this section Summary

Functions

Deletes a batch of evaluation jobs.

Creates an Automated Reasoning policy for Amazon Bedrock Guardrails.

Creates a new version of an existing Automated Reasoning policy.

Creates a new custom model in Amazon Bedrock.

Deploys a custom model for on-demand inference in Amazon Bedrock.

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 an application inference profile to track metrics and costs when invoking a model.

Creates an endpoint for a model from Amazon Bedrock Marketplace.

Copies a model to another region so that it can be used there.

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.

Creates a batch inference job to invoke a model on multiple prompts.

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.

Deletes an Automated Reasoning policy or policy version.

Deletes an Automated Reasoning policy build workflow and its associated artifacts.

Deletes a custom model that you created earlier.

Delete the model access agreement for the specified model.

Deletes a custom model that you imported earlier.

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

Deregisters an endpoint for a model from Amazon Bedrock Marketplace.

Exports the policy definition for an Automated Reasoning policy version.

Retrieves details about an Automated Reasoning policy or policy version.

Retrieves the current annotations for an Automated Reasoning policy build workflow.

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.

Retrieves details about a specific Automated Reasoning policy test.

Retrieves the test result for a specific Automated Reasoning policy test.

Get the properties associated with a Amazon Bedrock custom model that you have created.

Retrieves information about a custom model deployment, including its status, configuration, and metadata.

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 properties associated with a customized model you imported.

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

Retrieves information about a model copy job.

Retrieves the properties associated with a model-customization job, including the status of the job.

Retrieves the properties associated with import model job, including the status of the job.

Gets details about a batch inference job.

Get the current configuration values for model invocation logging.

Retrieves details about a prompt router.

Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN.

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

Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.

Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.

List the tags associated with the specified resource.

Set the configuration values for model invocation logging.

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

Initiates a test workflow to validate Automated Reasoning policy tests.

Stops an evaluation job that is current being created or running.

Associate tags with a resource.

Remove one or more tags from a resource.

Updates an existing Automated Reasoning policy with new rules, variables, or configuration.

Updates the annotations for an Automated Reasoning policy build workflow.

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.

Link to this section Functions

Link to this function

batch_delete_evaluation_job(client, input, options \\ [])

View Source

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.

Link to this function

cancel_automated_reasoning_policy_build_workflow(client, build_workflow_id, policy_arn, input, options \\ [])

View Source

Cancels a running Automated Reasoning policy build workflow.

This stops the policy generation process and prevents further processing of the source documents.

Link to this function

create_automated_reasoning_policy(client, input, options \\ [])

View Source

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.

Link to this function

create_automated_reasoning_policy_test_case(client, policy_arn, input, options \\ [])

View Source

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.

Link to this function

create_automated_reasoning_policy_version(client, policy_arn, input, options \\ [])

View Source

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.

Link to this function

create_custom_model(client, input, options \\ [])

View Source

Creates a new custom model in Amazon Bedrock.

After the model is active, you can use it for inference.

To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see Provisioned Throughput.

The model appears in ListCustomModels with a customizationType of imported. 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

GetCustomModel ListCustomModels

* DeleteCustomModel

Link to this function

create_custom_model_deployment(client, input, options \\ [])

View Source

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.

The following actions are related to the CreateCustomModelDeployment operation:

GetCustomModelDeployment ListCustomModelDeployments

* DeleteCustomModelDeployment

Link to this function

create_evaluation_job(client, input, options \\ [])

View Source

Creates an evaluation job.

Link to this function

create_foundation_model_agreement(client, input, options \\ [])

View Source

Request a model access agreement for the specified model.

Link to this function

create_guardrail(client, input, options \\ [])

View Source

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.

  • Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.

  • Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.

  • Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.

  • Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.

In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.

For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.

Link to this function

create_guardrail_version(client, guardrail_identifier, input, options \\ [])

View Source

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.

Link to this function

create_inference_profile(client, input, options \\ [])

View Source

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.

Link to this function

create_marketplace_model_endpoint(client, input, options \\ [])

View Source

Creates an endpoint for a model from Amazon Bedrock Marketplace.

The endpoint is hosted by Amazon SageMaker.

Link to this function

create_model_copy_job(client, input, options \\ [])

View Source

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.

Link to this function

create_model_customization_job(client, input, options \\ [])

View Source

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.

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 in the Amazon Bedrock User Guide.

Link to this function

create_model_import_job(client, input, options \\ [])

View Source

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

Link to this function

create_model_invocation_job(client, input, options \\ [])

View Source

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.

The response returns a jobArn that you can use to stop or get details about the job.

Link to this function

create_prompt_router(client, input, options \\ [])

View Source

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

Link to this function

create_provisioned_model_throughput(client, input, options \\ [])

View Source

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.

Link to this function

delete_automated_reasoning_policy(client, policy_arn, input, options \\ [])

View Source

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.

Link to this function

delete_automated_reasoning_policy_build_workflow(client, build_workflow_id, policy_arn, input, options \\ [])

View Source

Deletes an Automated Reasoning policy build workflow and its associated artifacts.

This permanently removes the workflow history and any generated assets.

Link to this function

delete_automated_reasoning_policy_test_case(client, policy_arn, test_case_id, input, options \\ [])

View Source

Deletes an Automated Reasoning policy test.

This operation is idempotent; if you delete a test more than once, each call succeeds.

Link to this function

delete_custom_model(client, model_identifier, input, options \\ [])

View Source

Deletes a custom model that you created earlier.

For more information, see Custom models in the Amazon Bedrock User Guide.

Link to this function

delete_custom_model_deployment(client, custom_model_deployment_identifier, input, options \\ [])

View Source

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 GetCustomModelDeployment

* ListCustomModelDeployments

Link to this function

delete_foundation_model_agreement(client, input, options \\ [])

View Source

Delete the model access agreement for the specified model.

Link to this function

delete_guardrail(client, guardrail_identifier, input, options \\ [])

View Source

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.

Link to this function

delete_imported_model(client, model_identifier, input, options \\ [])

View Source

Deletes a custom model that you imported earlier.

For more information, see Import a customized model in the Amazon Bedrock User Guide.

Link to this function

delete_inference_profile(client, inference_profile_identifier, input, options \\ [])

View Source

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.

Link to this function

delete_marketplace_model_endpoint(client, endpoint_arn, input, options \\ [])

View Source

Deletes an endpoint for a model from Amazon Bedrock Marketplace.

Link to this function

delete_model_invocation_logging_configuration(client, input, options \\ [])

View Source

Delete the invocation logging.

Link to this function

delete_prompt_router(client, prompt_router_arn, input, options \\ [])

View Source

Deletes a specified prompt router.

This action cannot be undone.

Link to this function

delete_provisioned_model_throughput(client, provisioned_model_id, input, options \\ [])

View Source

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.

Link to this function

deregister_marketplace_model_endpoint(client, endpoint_arn, input, options \\ [])

View Source

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.

Link to this function

export_automated_reasoning_policy_version(client, policy_arn, options \\ [])

View Source

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.

Link to this function

get_automated_reasoning_policy(client, policy_arn, options \\ [])

View Source

Retrieves details about an Automated Reasoning policy or policy version.

Returns information including the policy definition, metadata, and timestamps.

Link to this function

get_automated_reasoning_policy_annotations(client, build_workflow_id, policy_arn, options \\ [])

View Source

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.

Link to this function

get_automated_reasoning_policy_build_workflow(client, build_workflow_id, policy_arn, options \\ [])

View Source

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

Link to this function

get_automated_reasoning_policy_build_workflow_result_assets(client, build_workflow_id, policy_arn, asset_type, options \\ [])

View Source

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

Link to this function

get_automated_reasoning_policy_next_scenario(client, build_workflow_id, policy_arn, options \\ [])

View Source

Retrieves the next test scenario for validating an Automated Reasoning policy.

This is used during the interactive policy refinement process to test policy behavior.

Link to this function

get_automated_reasoning_policy_test_case(client, policy_arn, test_case_id, options \\ [])

View Source

Retrieves details about a specific Automated Reasoning policy test.

Link to this function

get_automated_reasoning_policy_test_result(client, build_workflow_id, policy_arn, test_case_id, options \\ [])

View Source

Retrieves the test result for a specific Automated Reasoning policy test.

Returns detailed validation findings and execution status.

Link to this function

get_custom_model(client, model_identifier, options \\ [])

View Source

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.

Link to this function

get_custom_model_deployment(client, custom_model_deployment_identifier, options \\ [])

View Source

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 ListCustomModelDeployments

* DeleteCustomModelDeployment

Link to this function

get_evaluation_job(client, job_identifier, options \\ [])

View Source

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

Link to this function

get_foundation_model(client, model_identifier, options \\ [])

View Source

Get details about a Amazon Bedrock foundation model.

Link to this function

get_foundation_model_availability(client, model_id, options \\ [])

View Source

Get information about the Foundation model availability.

Link to this function

get_guardrail(client, guardrail_identifier, guardrail_version \\ nil, options \\ [])

View Source

Gets details about a guardrail.

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

Link to this function

get_imported_model(client, model_identifier, options \\ [])

View Source

Gets properties associated with a customized model you imported.

Link to this function

get_inference_profile(client, inference_profile_identifier, options \\ [])

View Source

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.

Link to this function

get_marketplace_model_endpoint(client, endpoint_arn, options \\ [])

View Source

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

Link to this function

get_model_copy_job(client, job_arn, options \\ [])

View Source

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.

Link to this function

get_model_customization_job(client, job_identifier, options \\ [])

View Source

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.

Link to this function

get_model_import_job(client, job_identifier, options \\ [])

View Source

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.

Link to this function

get_model_invocation_job(client, job_identifier, options \\ [])

View Source

Gets details about a batch inference job.

For more information, see Monitor batch inference jobs

Link to this function

get_model_invocation_logging_configuration(client, options \\ [])

View Source

Get the current configuration values for model invocation logging.

Link to this function

get_prompt_router(client, prompt_router_arn, options \\ [])

View Source

Retrieves details about a prompt router.

Link to this function

get_provisioned_model_throughput(client, provisioned_model_id, options \\ [])

View Source

Returns details for a Provisioned Throughput.

For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Link to this function

get_use_case_for_model_access(client, options \\ [])

View Source

Get usecase for model access.

Link to this function

list_automated_reasoning_policies(client, max_results \\ nil, next_token \\ nil, policy_arn \\ nil, options \\ [])

View Source

Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN.

This helps you manage and discover existing policies.

Link to this function

list_automated_reasoning_policy_build_workflows(client, policy_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_automated_reasoning_policy_test_cases(client, policy_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists tests for an Automated Reasoning policy.

We recommend using pagination to ensure that the operation returns quickly and successfully.

Link to this function

list_automated_reasoning_policy_test_results(client, build_workflow_id, policy_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.

Link to this function

list_custom_model_deployments(client, created_after \\ nil, created_before \\ nil, max_results \\ nil, model_arn_equals \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, options \\ [])

View Source

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 GetCustomModelDeployment

* DeleteCustomModelDeployment

Link to this function

list_custom_models(client, base_model_arn_equals \\ nil, creation_time_after \\ nil, creation_time_before \\ nil, foundation_model_arn_equals \\ nil, is_owned \\ nil, max_results \\ nil, model_status \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, options \\ [])

View Source

Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.

For more information, see Custom models in the Amazon Bedrock User Guide.

Link to this function

list_evaluation_jobs(client, application_type_equals \\ nil, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, options \\ [])

View Source

Lists all existing evaluation jobs.

Link to this function

list_foundation_model_agreement_offers(client, model_id, offer_type \\ nil, options \\ [])

View Source

Get the offers associated with the specified model.

Link to this function

list_foundation_models(client, by_customization_type \\ nil, by_inference_type \\ nil, by_output_modality \\ nil, by_provider \\ nil, options \\ [])

View Source

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.

Link to this function

list_guardrails(client, guardrail_identifier \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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.

Link to this function

list_imported_models(client, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, options \\ [])

View Source

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.

Link to this function

list_inference_profiles(client, max_results \\ nil, next_token \\ nil, type_equals \\ nil, options \\ [])

View Source

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.

Link to this function

list_marketplace_model_endpoints(client, max_results \\ nil, model_source_equals \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.

Link to this function

list_model_copy_jobs(client, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, source_account_equals \\ nil, source_model_arn_equals \\ nil, status_equals \\ nil, target_model_name_contains \\ nil, options \\ [])

View Source

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.

Link to this function

list_model_customization_jobs(client, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, options \\ [])

View Source

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 in the Amazon Bedrock User Guide.

Link to this function

list_model_import_jobs(client, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, options \\ [])

View Source

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.

Link to this function

list_model_invocation_jobs(client, max_results \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, submit_time_after \\ nil, submit_time_before \\ nil, options \\ [])

View Source

Lists all batch inference jobs in the account.

For more information, see View details about a batch inference job.

Link to this function

list_prompt_routers(client, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])

View Source

Retrieves a list of prompt routers.

Link to this function

list_provisioned_model_throughputs(client, creation_time_after \\ nil, creation_time_before \\ nil, max_results \\ nil, model_arn_equals \\ nil, name_contains \\ nil, next_token \\ nil, sort_by \\ nil, sort_order \\ nil, status_equals \\ nil, options \\ [])

View Source

Lists the Provisioned Throughputs in the account.

For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

List the tags associated with the specified resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

Link to this function

put_model_invocation_logging_configuration(client, input, options \\ [])

View Source

Set the configuration values for model invocation logging.

Link to this function

put_use_case_for_model_access(client, input, options \\ [])

View Source

Put usecase for model access.

Link to this function

register_marketplace_model_endpoint(client, endpoint_identifier, input, options \\ [])

View Source

Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.

Link to this function

start_automated_reasoning_policy_build_workflow(client, build_workflow_type, policy_arn, input, options \\ [])

View Source

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.

Link to this function

start_automated_reasoning_policy_test_workflow(client, build_workflow_id, policy_arn, input, options \\ [])

View Source

Initiates a test workflow to validate Automated Reasoning policy tests.

The workflow executes the specified tests against the policy and generates validation results.

Link to this function

stop_evaluation_job(client, job_identifier, input, options \\ [])

View Source

Stops an evaluation job that is current being created or running.

Link to this function

stop_model_customization_job(client, job_identifier, input, options \\ [])

View Source

Stops an active model customization job.

For more information, see Custom models in the Amazon Bedrock User Guide.

Link to this function

stop_model_invocation_job(client, job_identifier, input, options \\ [])

View Source

Stops a batch inference job.

You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Associate tags with a resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Remove one or more tags from a resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

Link to this function

update_automated_reasoning_policy(client, policy_arn, input, options \\ [])

View Source

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.

Link to this function

update_automated_reasoning_policy_annotations(client, build_workflow_id, policy_arn, input, options \\ [])

View Source

Updates the annotations for an Automated Reasoning policy build workflow.

This allows you to modify extracted rules, variables, and types before finalizing the policy.

Link to this function

update_automated_reasoning_policy_test_case(client, policy_arn, test_case_id, input, options \\ [])

View Source

Updates an existing Automated Reasoning policy test.

You can modify the content, query, expected result, and confidence threshold.

Link to this function

update_guardrail(client, guardrail_identifier, input, options \\ [])

View Source

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 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 object in the filtersConfig list pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig. * 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.

  • (Optional) For security, include the ARN of a KMS key in the kmsKeyId field.
Link to this function

update_marketplace_model_endpoint(client, endpoint_arn, input, options \\ [])

View Source

Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.

Link to this function

update_provisioned_model_throughput(client, provisioned_model_id, input, options \\ [])

View Source

Updates the name or associated model for a Provisioned Throughput.

For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.