Class: Aws::Bedrock::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Bedrock::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb
Overview
An API client for Bedrock. To construct a client, you need to configure a :region and :credentials.
client = Aws::Bedrock::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_delete_advanced_prompt_optimization_job(params = {}) ⇒ Types::BatchDeleteAdvancedPromptOptimizationJobResponse
Deletes one or more advanced prompt optimization jobs.
-
#batch_delete_evaluation_job(params = {}) ⇒ Types::BatchDeleteEvaluationJobResponse
Deletes a batch of evaluation jobs.
-
#cancel_automated_reasoning_policy_build_workflow(params = {}) ⇒ Struct
Cancels a running Automated Reasoning policy build workflow.
-
#create_advanced_prompt_optimization_job(params = {}) ⇒ Types::CreateAdvancedPromptOptimizationJobResponse
Creates an advanced prompt optimization job.
-
#create_automated_reasoning_policy(params = {}) ⇒ Types::CreateAutomatedReasoningPolicyResponse
Creates an Automated Reasoning policy for Amazon Bedrock Guardrails.
-
#create_automated_reasoning_policy_test_case(params = {}) ⇒ Types::CreateAutomatedReasoningPolicyTestCaseResponse
Creates a test for an Automated Reasoning policy.
-
#create_automated_reasoning_policy_version(params = {}) ⇒ Types::CreateAutomatedReasoningPolicyVersionResponse
Creates a new version of an existing Automated Reasoning policy.
-
#create_custom_model(params = {}) ⇒ Types::CreateCustomModelResponse
Creates a new custom model in Amazon Bedrock.
-
#create_custom_model_deployment(params = {}) ⇒ Types::CreateCustomModelDeploymentResponse
Deploys a custom model for on-demand inference in Amazon Bedrock.
-
#create_evaluation_job(params = {}) ⇒ Types::CreateEvaluationJobResponse
Creates an evaluation job.
-
#create_foundation_model_agreement(params = {}) ⇒ Types::CreateFoundationModelAgreementResponse
Request a model access agreement for the specified model.
-
#create_guardrail(params = {}) ⇒ Types::CreateGuardrailResponse
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
-
#create_guardrail_version(params = {}) ⇒ Types::CreateGuardrailVersionResponse
Creates a version of the guardrail.
-
#create_inference_profile(params = {}) ⇒ Types::CreateInferenceProfileResponse
Creates an application inference profile to track metrics and costs when invoking a model.
-
#create_marketplace_model_endpoint(params = {}) ⇒ Types::CreateMarketplaceModelEndpointResponse
Creates an endpoint for a model from Amazon Bedrock Marketplace.
-
#create_model_copy_job(params = {}) ⇒ Types::CreateModelCopyJobResponse
Copies a model to another region so that it can be used there.
-
#create_model_customization_job(params = {}) ⇒ Types::CreateModelCustomizationJobResponse
Creates a fine-tuning job to customize a base model.
-
#create_model_import_job(params = {}) ⇒ Types::CreateModelImportJobResponse
Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker.
-
#create_model_invocation_job(params = {}) ⇒ Types::CreateModelInvocationJobResponse
Creates a batch inference job to invoke a model on multiple prompts.
-
#create_prompt_router(params = {}) ⇒ Types::CreatePromptRouterResponse
Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.
-
#create_provisioned_model_throughput(params = {}) ⇒ Types::CreateProvisionedModelThroughputResponse
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.
-
#delete_automated_reasoning_policy(params = {}) ⇒ Struct
Deletes an Automated Reasoning policy or policy version.
-
#delete_automated_reasoning_policy_build_workflow(params = {}) ⇒ Struct
Deletes an Automated Reasoning policy build workflow and its associated artifacts.
-
#delete_automated_reasoning_policy_test_case(params = {}) ⇒ Struct
Deletes an Automated Reasoning policy test.
-
#delete_custom_model(params = {}) ⇒ Struct
Deletes a custom model that you created earlier.
-
#delete_custom_model_deployment(params = {}) ⇒ Struct
Deletes a custom model deployment.
-
#delete_enforced_guardrail_configuration(params = {}) ⇒ Struct
Deletes the account-level enforced guardrail configuration.
-
#delete_foundation_model_agreement(params = {}) ⇒ Struct
Delete the model access agreement for the specified model.
-
#delete_guardrail(params = {}) ⇒ Struct
Deletes a guardrail.
-
#delete_imported_model(params = {}) ⇒ Struct
Deletes a custom model that you imported earlier.
-
#delete_inference_profile(params = {}) ⇒ Struct
Deletes an application inference profile.
-
#delete_marketplace_model_endpoint(params = {}) ⇒ Struct
Deletes an endpoint for a model from Amazon Bedrock Marketplace.
-
#delete_model_invocation_logging_configuration(params = {}) ⇒ Struct
Delete the invocation logging.
-
#delete_prompt_router(params = {}) ⇒ Struct
Deletes a specified prompt router.
-
#delete_provisioned_model_throughput(params = {}) ⇒ Struct
Deletes a Provisioned Throughput.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a previously created Bedrock resource policy.
-
#deregister_marketplace_model_endpoint(params = {}) ⇒ Struct
Deregisters an endpoint for a model from Amazon Bedrock Marketplace.
-
#export_automated_reasoning_policy_version(params = {}) ⇒ Types::ExportAutomatedReasoningPolicyVersionResponse
Exports the policy definition for an Automated Reasoning policy version.
-
#get_account_data_retention(params = {}) ⇒ Types::GetAccountDataRetentionResponse
Returns the account-wide data retention mode for Amazon Bedrock.
-
#get_advanced_prompt_optimization_job(params = {}) ⇒ Types::GetAdvancedPromptOptimizationJobResponse
Gets information about an advanced prompt optimization job.
-
#get_automated_reasoning_policy(params = {}) ⇒ Types::GetAutomatedReasoningPolicyResponse
Retrieves details about an Automated Reasoning policy or policy version.
-
#get_automated_reasoning_policy_annotations(params = {}) ⇒ Types::GetAutomatedReasoningPolicyAnnotationsResponse
Retrieves the current annotations for an Automated Reasoning policy build workflow.
-
#get_automated_reasoning_policy_build_workflow(params = {}) ⇒ Types::GetAutomatedReasoningPolicyBuildWorkflowResponse
Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.
-
#get_automated_reasoning_policy_build_workflow_result_assets(params = {}) ⇒ Types::GetAutomatedReasoningPolicyBuildWorkflowResultAssetsResponse
Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.
-
#get_automated_reasoning_policy_next_scenario(params = {}) ⇒ Types::GetAutomatedReasoningPolicyNextScenarioResponse
Retrieves the next test scenario for validating an Automated Reasoning policy.
-
#get_automated_reasoning_policy_test_case(params = {}) ⇒ Types::GetAutomatedReasoningPolicyTestCaseResponse
Retrieves details about a specific Automated Reasoning policy test.
-
#get_automated_reasoning_policy_test_result(params = {}) ⇒ Types::GetAutomatedReasoningPolicyTestResultResponse
Retrieves the test result for a specific Automated Reasoning policy test.
-
#get_custom_model(params = {}) ⇒ Types::GetCustomModelResponse
Get the properties associated with a Amazon Bedrock custom model that you have created.
-
#get_custom_model_deployment(params = {}) ⇒ Types::GetCustomModelDeploymentResponse
Retrieves information about a custom model deployment, including its status, configuration, and metadata.
-
#get_evaluation_job(params = {}) ⇒ Types::GetEvaluationJobResponse
Gets information about an evaluation job, such as the status of the job.
-
#get_foundation_model(params = {}) ⇒ Types::GetFoundationModelResponse
Get details about a Amazon Bedrock foundation model.
-
#get_foundation_model_availability(params = {}) ⇒ Types::GetFoundationModelAvailabilityResponse
Get information about the Foundation model availability.
-
#get_guardrail(params = {}) ⇒ Types::GetGuardrailResponse
Gets details about a guardrail.
-
#get_imported_model(params = {}) ⇒ Types::GetImportedModelResponse
Gets properties associated with a customized model you imported.
-
#get_inference_profile(params = {}) ⇒ Types::GetInferenceProfileResponse
Gets information about an inference profile.
-
#get_marketplace_model_endpoint(params = {}) ⇒ Types::GetMarketplaceModelEndpointResponse
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
-
#get_model_copy_job(params = {}) ⇒ Types::GetModelCopyJobResponse
Retrieves information about a model copy job.
-
#get_model_customization_job(params = {}) ⇒ Types::GetModelCustomizationJobResponse
Retrieves the properties associated with a model-customization job, including the status of the job.
-
#get_model_import_job(params = {}) ⇒ Types::GetModelImportJobResponse
Retrieves the properties associated with import model job, including the status of the job.
-
#get_model_invocation_job(params = {}) ⇒ Types::GetModelInvocationJobResponse
Gets details about a batch inference job.
-
#get_model_invocation_logging_configuration(params = {}) ⇒ Types::GetModelInvocationLoggingConfigurationResponse
Get the current configuration values for model invocation logging.
-
#get_prompt_router(params = {}) ⇒ Types::GetPromptRouterResponse
Retrieves details about a prompt router.
-
#get_provisioned_model_throughput(params = {}) ⇒ Types::GetProvisionedModelThroughputResponse
Returns details for a Provisioned Throughput.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Gets the resource policy document for a Bedrock resource.
-
#get_use_case_for_model_access(params = {}) ⇒ Types::GetUseCaseForModelAccessResponse
Get usecase for model access.
-
#list_advanced_prompt_optimization_jobs(params = {}) ⇒ Types::ListAdvancedPromptOptimizationJobsResponse
Lists the advanced prompt optimization jobs in your account.
-
#list_automated_reasoning_policies(params = {}) ⇒ Types::ListAutomatedReasoningPoliciesResponse
Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN.
-
#list_automated_reasoning_policy_build_workflows(params = {}) ⇒ Types::ListAutomatedReasoningPolicyBuildWorkflowsResponse
Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.
-
#list_automated_reasoning_policy_test_cases(params = {}) ⇒ Types::ListAutomatedReasoningPolicyTestCasesResponse
Lists tests for an Automated Reasoning policy.
-
#list_automated_reasoning_policy_test_results(params = {}) ⇒ Types::ListAutomatedReasoningPolicyTestResultsResponse
Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.
-
#list_custom_model_deployments(params = {}) ⇒ Types::ListCustomModelDeploymentsResponse
Lists custom model deployments in your account.
-
#list_custom_models(params = {}) ⇒ Types::ListCustomModelsResponse
Returns a list of the custom models that you have created with the
CreateModelCustomizationJoboperation. -
#list_enforced_guardrails_configuration(params = {}) ⇒ Types::ListEnforcedGuardrailsConfigurationResponse
Lists the account-level enforced guardrail configurations.
-
#list_evaluation_jobs(params = {}) ⇒ Types::ListEvaluationJobsResponse
Lists all existing evaluation jobs.
-
#list_foundation_model_agreement_offers(params = {}) ⇒ Types::ListFoundationModelAgreementOffersResponse
Get the offers associated with the specified model.
-
#list_foundation_models(params = {}) ⇒ Types::ListFoundationModelsResponse
Lists Amazon Bedrock foundation models that you can use.
-
#list_guardrails(params = {}) ⇒ Types::ListGuardrailsResponse
Lists details about all the guardrails in an account.
-
#list_imported_models(params = {}) ⇒ Types::ListImportedModelsResponse
Returns a list of models you've imported.
-
#list_inference_profiles(params = {}) ⇒ Types::ListInferenceProfilesResponse
Returns a list of inference profiles that you can use.
-
#list_marketplace_model_endpoints(params = {}) ⇒ Types::ListMarketplaceModelEndpointsResponse
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
-
#list_model_copy_jobs(params = {}) ⇒ Types::ListModelCopyJobsResponse
Returns a list of model copy jobs that you have submitted.
-
#list_model_customization_jobs(params = {}) ⇒ Types::ListModelCustomizationJobsResponse
Returns a list of model customization jobs that you have submitted.
-
#list_model_import_jobs(params = {}) ⇒ Types::ListModelImportJobsResponse
Returns a list of import jobs you've submitted.
-
#list_model_invocation_jobs(params = {}) ⇒ Types::ListModelInvocationJobsResponse
Lists all batch inference jobs in the account.
-
#list_prompt_routers(params = {}) ⇒ Types::ListPromptRoutersResponse
Retrieves a list of prompt routers.
-
#list_provisioned_model_throughputs(params = {}) ⇒ Types::ListProvisionedModelThroughputsResponse
Lists the Provisioned Throughputs in the account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags associated with the specified resource.
-
#put_account_data_retention(params = {}) ⇒ Types::PutAccountDataRetentionResponse
Sets the account-wide data retention mode for Amazon Bedrock.
-
#put_enforced_guardrail_configuration(params = {}) ⇒ Types::PutEnforcedGuardrailConfigurationResponse
Sets the account-level enforced guardrail configuration.
-
#put_model_invocation_logging_configuration(params = {}) ⇒ Struct
Set the configuration values for model invocation logging.
-
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Adds a resource policy for a Bedrock resource.
-
#put_use_case_for_model_access(params = {}) ⇒ Struct
Put usecase for model access.
-
#register_marketplace_model_endpoint(params = {}) ⇒ Types::RegisterMarketplaceModelEndpointResponse
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
-
#start_automated_reasoning_policy_build_workflow(params = {}) ⇒ Types::StartAutomatedReasoningPolicyBuildWorkflowResponse
Starts a new build workflow for an Automated Reasoning policy.
-
#start_automated_reasoning_policy_test_workflow(params = {}) ⇒ Types::StartAutomatedReasoningPolicyTestWorkflowResponse
Initiates a test workflow to validate Automated Reasoning policy tests.
-
#stop_advanced_prompt_optimization_job(params = {}) ⇒ Struct
Stops an advanced prompt optimization job that is in progress.
-
#stop_evaluation_job(params = {}) ⇒ Struct
Stops an evaluation job that is current being created or running.
-
#stop_model_customization_job(params = {}) ⇒ Struct
Stops an active model customization job.
-
#stop_model_invocation_job(params = {}) ⇒ Struct
Stops a batch inference job.
-
#tag_resource(params = {}) ⇒ Struct
Associate tags with a resource.
-
#untag_resource(params = {}) ⇒ Struct
Remove one or more tags from a resource.
-
#update_automated_reasoning_policy(params = {}) ⇒ Types::UpdateAutomatedReasoningPolicyResponse
Updates an existing Automated Reasoning policy with new rules, variables, or configuration.
-
#update_automated_reasoning_policy_annotations(params = {}) ⇒ Types::UpdateAutomatedReasoningPolicyAnnotationsResponse
Updates the annotations for an Automated Reasoning policy build workflow.
-
#update_automated_reasoning_policy_test_case(params = {}) ⇒ Types::UpdateAutomatedReasoningPolicyTestCaseResponse
Updates an existing Automated Reasoning policy test.
-
#update_custom_model_deployment(params = {}) ⇒ Types::UpdateCustomModelDeploymentResponse
Updates a custom model deployment with a new custom model.
-
#update_guardrail(params = {}) ⇒ Types::UpdateGuardrailResponse
Updates a guardrail with the values you specify.
-
#update_marketplace_model_endpoint(params = {}) ⇒ Types::UpdateMarketplaceModelEndpointResponse
Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
-
#update_provisioned_model_throughput(params = {}) ⇒ Struct
Updates the name or associated model for a Provisioned Throughput.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
481 482 483 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 481 def initialize(*args) super end |
Instance Method Details
#batch_delete_advanced_prompt_optimization_job(params = {}) ⇒ Types::BatchDeleteAdvancedPromptOptimizationJobResponse
Deletes one or more advanced prompt optimization jobs.
518 519 520 521 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 518 def batch_delete_advanced_prompt_optimization_job(params = {}, = {}) req = build_request(:batch_delete_advanced_prompt_optimization_job, params) req.send_request() end |
#batch_delete_evaluation_job(params = {}) ⇒ Types::BatchDeleteEvaluationJobResponse
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.
586 587 588 589 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 586 def batch_delete_evaluation_job(params = {}, = {}) req = build_request(:batch_delete_evaluation_job, params) req.send_request() end |
#cancel_automated_reasoning_policy_build_workflow(params = {}) ⇒ Struct
Cancels a running Automated Reasoning policy build workflow. This stops the policy generation process and prevents further processing of the source documents.
617 618 619 620 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 617 def cancel_automated_reasoning_policy_build_workflow(params = {}, = {}) req = build_request(:cancel_automated_reasoning_policy_build_workflow, params) req.send_request() end |
#create_advanced_prompt_optimization_job(params = {}) ⇒ Types::CreateAdvancedPromptOptimizationJobResponse
Creates an advanced prompt optimization job. The job optimizes your prompt templates for specific models using your evaluation dataset and criteria.
708 709 710 711 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 708 def create_advanced_prompt_optimization_job(params = {}, = {}) req = build_request(:create_advanced_prompt_optimization_job, params) req.send_request() end |
#create_automated_reasoning_policy(params = {}) ⇒ Types::CreateAutomatedReasoningPolicyResponse
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.
825 826 827 828 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 825 def create_automated_reasoning_policy(params = {}, = {}) req = build_request(:create_automated_reasoning_policy, params) req.send_request() end |
#create_automated_reasoning_policy_test_case(params = {}) ⇒ Types::CreateAutomatedReasoningPolicyTestCaseResponse
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.
928 929 930 931 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 928 def create_automated_reasoning_policy_test_case(params = {}, = {}) req = build_request(:create_automated_reasoning_policy_test_case, params) req.send_request() end |
#create_automated_reasoning_policy_version(params = {}) ⇒ Types::CreateAutomatedReasoningPolicyVersionResponse
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.
994 995 996 997 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 994 def create_automated_reasoning_policy_version(params = {}, = {}) req = build_request(:create_automated_reasoning_policy_version, params) req.send_request() end |
#create_custom_model(params = {}) ⇒ Types::CreateCustomModelResponse
Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.
You can provide the model data source in one of the following ways:
customModelDataSourceâ Specify a SageMaker AI model package ARN. Amazon Bedrock resolves the model package to retrieve the model artifacts. This is the preferred method for new SageMaker AI training outputs.modelSourceConfigâ Specify an Amazon S3 URI pointing to the Amazon-managed Amazon S3 bucket containing your model artifacts.
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 registrationActive- Model is ready for use in inferenceFailed- Creation process encountered an error
Related APIs
1183 1184 1185 1186 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1183 def create_custom_model(params = {}, = {}) req = build_request(:create_custom_model, params) req.send_request() end |
#create_custom_model_deployment(params = {}) ⇒ Types::CreateCustomModelDeploymentResponse
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:
1269 1270 1271 1272 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1269 def create_custom_model_deployment(params = {}, = {}) req = build_request(:create_custom_model_deployment, params) req.send_request() end |
#create_evaluation_job(params = {}) ⇒ Types::CreateEvaluationJobResponse
Creates an evaluation job.
1768 1769 1770 1771 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1768 def create_evaluation_job(params = {}, = {}) req = build_request(:create_evaluation_job, params) req.send_request() end |
#create_foundation_model_agreement(params = {}) ⇒ Types::CreateFoundationModelAgreementResponse
Request a model access agreement for the specified model.
1800 1801 1802 1803 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1800 def create_foundation_model_agreement(params = {}, = {}) req = build_request(:create_foundation_model_agreement, params) req.send_request() end |
#create_guardrail(params = {}) ⇒ Types::CreateGuardrailResponse
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.
2036 2037 2038 2039 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2036 def create_guardrail(params = {}, = {}) req = build_request(:create_guardrail, params) req.send_request() end |
#create_guardrail_version(params = {}) ⇒ Types::CreateGuardrailVersionResponse
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.
2087 2088 2089 2090 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2087 def create_guardrail_version(params = {}, = {}) req = build_request(:create_guardrail_version, params) req.send_request() end |
#create_inference_profile(params = {}) ⇒ Types::CreateInferenceProfileResponse
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.
2169 2170 2171 2172 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2169 def create_inference_profile(params = {}, = {}) req = build_request(:create_inference_profile, params) req.send_request() end |
#create_marketplace_model_endpoint(params = {}) ⇒ Types::CreateMarketplaceModelEndpointResponse
Creates an endpoint for a model from Amazon Bedrock Marketplace. The endpoint is hosted by Amazon SageMaker.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2262 def create_marketplace_model_endpoint(params = {}, = {}) req = build_request(:create_marketplace_model_endpoint, params) req.send_request() end |
#create_model_copy_job(params = {}) ⇒ Types::CreateModelCopyJobResponse
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.
2334 2335 2336 2337 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2334 def create_model_copy_job(params = {}, = {}) req = build_request(:create_model_copy_job, params) req.send_request() end |
#create_model_customization_job(params = {}) ⇒ Types::CreateModelCustomizationJobResponse
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.
2550 2551 2552 2553 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2550 def create_model_customization_job(params = {}, = {}) req = build_request(:create_model_customization_job, params) req.send_request() end |
#create_model_import_job(params = {}) ⇒ Types::CreateModelImportJobResponse
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
2641 2642 2643 2644 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2641 def create_model_import_job(params = {}, = {}) req = build_request(:create_model_import_job, params) req.send_request() end |
#create_model_invocation_job(params = {}) ⇒ Types::CreateModelInvocationJobResponse
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.
2766 2767 2768 2769 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2766 def create_model_invocation_job(params = {}, = {}) req = build_request(:create_model_invocation_job, params) req.send_request() end |
#create_prompt_router(params = {}) ⇒ Types::CreatePromptRouterResponse
Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.
2842 2843 2844 2845 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2842 def create_prompt_router(params = {}, = {}) req = build_request(:create_prompt_router, params) req.send_request() end |
#create_provisioned_model_throughput(params = {}) ⇒ Types::CreateProvisionedModelThroughputResponse
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.
2953 2954 2955 2956 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2953 def create_provisioned_model_throughput(params = {}, = {}) req = build_request(:create_provisioned_model_throughput, params) req.send_request() end |
#delete_automated_reasoning_policy(params = {}) ⇒ Struct
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.
2988 2989 2990 2991 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2988 def delete_automated_reasoning_policy(params = {}, = {}) req = build_request(:delete_automated_reasoning_policy, params) req.send_request() end |
#delete_automated_reasoning_policy_build_workflow(params = {}) ⇒ Struct
Deletes an Automated Reasoning policy build workflow and its associated artifacts. This permanently removes the workflow history and any generated assets.
3023 3024 3025 3026 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3023 def delete_automated_reasoning_policy_build_workflow(params = {}, = {}) req = build_request(:delete_automated_reasoning_policy_build_workflow, params) req.send_request() end |
#delete_automated_reasoning_policy_test_case(params = {}) ⇒ Struct
Deletes an Automated Reasoning policy test. This operation is idempotent; if you delete a test more than once, each call succeeds.
3056 3057 3058 3059 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3056 def delete_automated_reasoning_policy_test_case(params = {}, = {}) req = build_request(:delete_automated_reasoning_policy_test_case, params) req.send_request() end |
#delete_custom_model(params = {}) ⇒ Struct
Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.
3084 3085 3086 3087 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3084 def delete_custom_model(params = {}, = {}) req = build_request(:delete_custom_model, params) req.send_request() end |
#delete_custom_model_deployment(params = {}) ⇒ Struct
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:
3124 3125 3126 3127 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3124 def delete_custom_model_deployment(params = {}, = {}) req = build_request(:delete_custom_model_deployment, params) req.send_request() end |
#delete_enforced_guardrail_configuration(params = {}) ⇒ Struct
Deletes the account-level enforced guardrail configuration.
3146 3147 3148 3149 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3146 def delete_enforced_guardrail_configuration(params = {}, = {}) req = build_request(:delete_enforced_guardrail_configuration, params) req.send_request() end |
#delete_foundation_model_agreement(params = {}) ⇒ Struct
Delete the model access agreement for the specified model.
3168 3169 3170 3171 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3168 def delete_foundation_model_agreement(params = {}, = {}) req = build_request(:delete_foundation_model_agreement, params) req.send_request() end |
#delete_guardrail(params = {}) ⇒ Struct
Deletes a guardrail.
To delete a guardrail, only specify the ARN of the guardrail in the
guardrailIdentifierfield. 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
guardrailIdentifierfield and the version in theguardrailVersionfield.
3202 3203 3204 3205 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3202 def delete_guardrail(params = {}, = {}) req = build_request(:delete_guardrail, params) req.send_request() end |
#delete_imported_model(params = {}) ⇒ Struct
Deletes a custom model that you imported earlier. For more information, see Import a customized model in the Amazon Bedrock User Guide.
3231 3232 3233 3234 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3231 def delete_imported_model(params = {}, = {}) req = build_request(:delete_imported_model, params) req.send_request() end |
#delete_inference_profile(params = {}) ⇒ Struct
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.
3260 3261 3262 3263 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3260 def delete_inference_profile(params = {}, = {}) req = build_request(:delete_inference_profile, params) req.send_request() end |
#delete_marketplace_model_endpoint(params = {}) ⇒ Struct
Deletes an endpoint for a model from Amazon Bedrock Marketplace.
3282 3283 3284 3285 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3282 def delete_marketplace_model_endpoint(params = {}, = {}) req = build_request(:delete_marketplace_model_endpoint, params) req.send_request() end |
#delete_model_invocation_logging_configuration(params = {}) ⇒ Struct
Delete the invocation logging.
3295 3296 3297 3298 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3295 def delete_model_invocation_logging_configuration(params = {}, = {}) req = build_request(:delete_model_invocation_logging_configuration, params) req.send_request() end |
#delete_prompt_router(params = {}) ⇒ Struct
Deletes a specified prompt router. This action cannot be undone.
3317 3318 3319 3320 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3317 def delete_prompt_router(params = {}, = {}) req = build_request(:delete_prompt_router, params) req.send_request() end |
#delete_provisioned_model_throughput(params = {}) ⇒ Struct
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.
3346 3347 3348 3349 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3346 def delete_provisioned_model_throughput(params = {}, = {}) req = build_request(:delete_provisioned_model_throughput, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes a previously created Bedrock resource policy.
3368 3369 3370 3371 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3368 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#deregister_marketplace_model_endpoint(params = {}) ⇒ Struct
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.
3392 3393 3394 3395 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3392 def deregister_marketplace_model_endpoint(params = {}, = {}) req = build_request(:deregister_marketplace_model_endpoint, params) req.send_request() end |
#export_automated_reasoning_policy_version(params = {}) ⇒ Types::ExportAutomatedReasoningPolicyVersionResponse
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.
3438 3439 3440 3441 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3438 def export_automated_reasoning_policy_version(params = {}, = {}) req = build_request(:export_automated_reasoning_policy_version, params) req.send_request() end |
#get_account_data_retention(params = {}) ⇒ Types::GetAccountDataRetentionResponse
Returns the account-wide data retention mode for Amazon Bedrock.
3459 3460 3461 3462 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3459 def get_account_data_retention(params = {}, = {}) req = build_request(:get_account_data_retention, params) req.send_request() end |
#get_advanced_prompt_optimization_job(params = {}) ⇒ Types::GetAdvancedPromptOptimizationJobResponse
Gets information about an advanced prompt optimization job.
3514 3515 3516 3517 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3514 def get_advanced_prompt_optimization_job(params = {}, = {}) req = build_request(:get_advanced_prompt_optimization_job, params) req.send_request() end |
#get_automated_reasoning_policy(params = {}) ⇒ Types::GetAutomatedReasoningPolicyResponse
Retrieves details about an Automated Reasoning policy or policy version. Returns information including the policy definition, metadata, and timestamps.
3562 3563 3564 3565 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3562 def get_automated_reasoning_policy(params = {}, = {}) req = build_request(:get_automated_reasoning_policy, params) req.send_request() end |
#get_automated_reasoning_policy_annotations(params = {}) ⇒ Types::GetAutomatedReasoningPolicyAnnotationsResponse
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.
3644 3645 3646 3647 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3644 def get_automated_reasoning_policy_annotations(params = {}, = {}) req = build_request(:get_automated_reasoning_policy_annotations, params) req.send_request() end |
#get_automated_reasoning_policy_build_workflow(params = {}) ⇒ Types::GetAutomatedReasoningPolicyBuildWorkflowResponse
Retrieves detailed information about an Automated Reasoning policy build workflow, including its status, configuration, and metadata.
3694 3695 3696 3697 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3694 def get_automated_reasoning_policy_build_workflow(params = {}, = {}) req = build_request(:get_automated_reasoning_policy_build_workflow, params) req.send_request() end |
#get_automated_reasoning_policy_build_workflow_result_assets(params = {}) ⇒ Types::GetAutomatedReasoningPolicyBuildWorkflowResultAssetsResponse
Retrieves the resulting assets from a completed Automated Reasoning policy build workflow, including build logs, quality reports, and generated policy artifacts.
3910 3911 3912 3913 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3910 def get_automated_reasoning_policy_build_workflow_result_assets(params = {}, = {}) req = build_request(:get_automated_reasoning_policy_build_workflow_result_assets, params) req.send_request() end |
#get_automated_reasoning_policy_next_scenario(params = {}) ⇒ Types::GetAutomatedReasoningPolicyNextScenarioResponse
Retrieves the next test scenario for validating an Automated Reasoning policy. This is used during the interactive policy refinement process to test policy behavior.
3952 3953 3954 3955 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3952 def get_automated_reasoning_policy_next_scenario(params = {}, = {}) req = build_request(:get_automated_reasoning_policy_next_scenario, params) req.send_request() end |
#get_automated_reasoning_policy_test_case(params = {}) ⇒ Types::GetAutomatedReasoningPolicyTestCaseResponse
Retrieves details about a specific Automated Reasoning policy test.
3993 3994 3995 3996 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3993 def get_automated_reasoning_policy_test_case(params = {}, = {}) req = build_request(:get_automated_reasoning_policy_test_case, params) req.send_request() end |
#get_automated_reasoning_policy_test_result(params = {}) ⇒ Types::GetAutomatedReasoningPolicyTestResultResponse
Retrieves the test result for a specific Automated Reasoning policy test. Returns detailed validation findings and execution status.
4150 4151 4152 4153 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4150 def get_automated_reasoning_policy_test_result(params = {}, = {}) req = build_request(:get_automated_reasoning_policy_test_result, params) req.send_request() end |
#get_custom_model(params = {}) ⇒ Types::GetCustomModelResponse
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.
4246 4247 4248 4249 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4246 def get_custom_model(params = {}, = {}) req = build_request(:get_custom_model, params) req.send_request() end |
#get_custom_model_deployment(params = {}) ⇒ Types::GetCustomModelDeploymentResponse
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:
4309 4310 4311 4312 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4309 def get_custom_model_deployment(params = {}, = {}) req = build_request(:get_custom_model_deployment, params) req.send_request() end |
#get_evaluation_job(params = {}) ⇒ Types::GetEvaluationJobResponse
Gets information about an evaluation job, such as the status of the job.
4493 4494 4495 4496 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4493 def get_evaluation_job(params = {}, = {}) req = build_request(:get_evaluation_job, params) req.send_request() end |
#get_foundation_model(params = {}) ⇒ Types::GetFoundationModelResponse
Get details about a Amazon Bedrock foundation model.
4538 4539 4540 4541 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4538 def get_foundation_model(params = {}, = {}) req = build_request(:get_foundation_model, params) req.send_request() end |
#get_foundation_model_availability(params = {}) ⇒ Types::GetFoundationModelAvailabilityResponse
Get information about the Foundation model availability.
4575 4576 4577 4578 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4575 def get_foundation_model_availability(params = {}, = {}) req = build_request(:get_foundation_model_availability, params) req.send_request() end |
#get_guardrail(params = {}) ⇒ Types::GetGuardrailResponse
Gets details about a guardrail. If you don't specify a version, the
response returns details for the DRAFT version.
4707 4708 4709 4710 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4707 def get_guardrail(params = {}, = {}) req = build_request(:get_guardrail, params) req.send_request() end |
#get_imported_model(params = {}) ⇒ Types::GetImportedModelResponse
Gets properties associated with a customized model you imported.
4754 4755 4756 4757 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4754 def get_imported_model(params = {}, = {}) req = build_request(:get_imported_model, params) req.send_request() end |
#get_inference_profile(params = {}) ⇒ Types::GetInferenceProfileResponse
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.
4805 4806 4807 4808 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4805 def get_inference_profile(params = {}, = {}) req = build_request(:get_inference_profile, params) req.send_request() end |
#get_marketplace_model_endpoint(params = {}) ⇒ Types::GetMarketplaceModelEndpointResponse
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
4850 4851 4852 4853 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4850 def get_marketplace_model_endpoint(params = {}, = {}) req = build_request(:get_marketplace_model_endpoint, params) req.send_request() end |
#get_model_copy_job(params = {}) ⇒ Types::GetModelCopyJobResponse
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.
4907 4908 4909 4910 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4907 def get_model_copy_job(params = {}, = {}) req = build_request(:get_model_copy_job, params) req.send_request() end |
#get_model_customization_job(params = {}) ⇒ Types::GetModelCustomizationJobResponse
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.
5026 5027 5028 5029 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5026 def get_model_customization_job(params = {}, = {}) req = build_request(:get_model_customization_job, params) req.send_request() end |
#get_model_import_job(params = {}) ⇒ Types::GetModelImportJobResponse
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.
5088 5089 5090 5091 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5088 def get_model_import_job(params = {}, = {}) req = build_request(:get_model_import_job, params) req.send_request() end |
#get_model_invocation_job(params = {}) ⇒ Types::GetModelInvocationJobResponse
Gets details about a batch inference job. For more information, see Monitor batch inference jobs
5166 5167 5168 5169 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5166 def get_model_invocation_job(params = {}, = {}) req = build_request(:get_model_invocation_job, params) req.send_request() end |
#get_model_invocation_logging_configuration(params = {}) ⇒ Types::GetModelInvocationLoggingConfigurationResponse
Get the current configuration values for model invocation logging.
5195 5196 5197 5198 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5195 def get_model_invocation_logging_configuration(params = {}, = {}) req = build_request(:get_model_invocation_logging_configuration, params) req.send_request() end |
#get_prompt_router(params = {}) ⇒ Types::GetPromptRouterResponse
Retrieves details about a prompt router.
5242 5243 5244 5245 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5242 def get_prompt_router(params = {}, = {}) req = build_request(:get_prompt_router, params) req.send_request() end |
#get_provisioned_model_throughput(params = {}) ⇒ Types::GetProvisionedModelThroughputResponse
Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
5300 5301 5302 5303 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5300 def get_provisioned_model_throughput(params = {}, = {}) req = build_request(:get_provisioned_model_throughput, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Gets the resource policy document for a Bedrock resource
5328 5329 5330 5331 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5328 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#get_use_case_for_model_access(params = {}) ⇒ Types::GetUseCaseForModelAccessResponse
Get usecase for model access.
5347 5348 5349 5350 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5347 def get_use_case_for_model_access(params = {}, = {}) req = build_request(:get_use_case_for_model_access, params) req.send_request() end |
#list_advanced_prompt_optimization_jobs(params = {}) ⇒ Types::ListAdvancedPromptOptimizationJobsResponse
Lists the advanced prompt optimization jobs in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5398 5399 5400 5401 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5398 def list_advanced_prompt_optimization_jobs(params = {}, = {}) req = build_request(:list_advanced_prompt_optimization_jobs, params) req.send_request() end |
#list_automated_reasoning_policies(params = {}) ⇒ Types::ListAutomatedReasoningPoliciesResponse
Lists all Automated Reasoning policies in your account, with optional filtering by policy ARN. This helps you manage and discover existing policies.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5450 5451 5452 5453 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5450 def list_automated_reasoning_policies(params = {}, = {}) req = build_request(:list_automated_reasoning_policies, params) req.send_request() end |
#list_automated_reasoning_policy_build_workflows(params = {}) ⇒ Types::ListAutomatedReasoningPolicyBuildWorkflowsResponse
Lists all build workflows for an Automated Reasoning policy, showing the history of policy creation and modification attempts.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5500 5501 5502 5503 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5500 def list_automated_reasoning_policy_build_workflows(params = {}, = {}) req = build_request(:list_automated_reasoning_policy_build_workflows, params) req.send_request() end |
#list_automated_reasoning_policy_test_cases(params = {}) ⇒ Types::ListAutomatedReasoningPolicyTestCasesResponse
Lists tests for an Automated Reasoning policy. We recommend using pagination to ensure that the operation returns quickly and successfully.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5551 5552 5553 5554 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5551 def list_automated_reasoning_policy_test_cases(params = {}, = {}) req = build_request(:list_automated_reasoning_policy_test_cases, params) req.send_request() end |
#list_automated_reasoning_policy_test_results(params = {}) ⇒ Types::ListAutomatedReasoningPolicyTestResultsResponse
Lists test results for an Automated Reasoning policy, showing how the policy performed against various test scenarios and validation checks.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5720 5721 5722 5723 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5720 def list_automated_reasoning_policy_test_results(params = {}, = {}) req = build_request(:list_automated_reasoning_policy_test_results, params) req.send_request() end |
#list_custom_model_deployments(params = {}) ⇒ Types::ListCustomModelDeploymentsResponse
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:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5816 5817 5818 5819 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5816 def list_custom_model_deployments(params = {}, = {}) req = build_request(:list_custom_model_deployments, params) req.send_request() end |
#list_custom_models(params = {}) ⇒ Types::ListCustomModelsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5925 5926 5927 5928 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5925 def list_custom_models(params = {}, = {}) req = build_request(:list_custom_models, params) req.send_request() end |
#list_enforced_guardrails_configuration(params = {}) ⇒ Types::ListEnforcedGuardrailsConfigurationResponse
Lists the account-level enforced guardrail configurations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5973 5974 5975 5976 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5973 def list_enforced_guardrails_configuration(params = {}, = {}) req = build_request(:list_enforced_guardrails_configuration, params) req.send_request() end |
#list_evaluation_jobs(params = {}) ⇒ Types::ListEvaluationJobsResponse
Lists all existing evaluation jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6066 6067 6068 6069 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6066 def list_evaluation_jobs(params = {}, = {}) req = build_request(:list_evaluation_jobs, params) req.send_request() end |
#list_foundation_model_agreement_offers(params = {}) ⇒ Types::ListFoundationModelAgreementOffersResponse
Get the offers associated with the specified model.
6110 6111 6112 6113 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6110 def list_foundation_model_agreement_offers(params = {}, = {}) req = build_request(:list_foundation_model_agreement_offers, params) req.send_request() end |
#list_foundation_models(params = {}) ⇒ Types::ListFoundationModelsResponse
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.
6189 6190 6191 6192 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6189 def list_foundation_models(params = {}, = {}) req = build_request(:list_foundation_models, params) req.send_request() end |
#list_guardrails(params = {}) ⇒ Types::ListGuardrailsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6249 6250 6251 6252 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6249 def list_guardrails(params = {}, = {}) req = build_request(:list_guardrails, params) req.send_request() end |
#list_imported_models(params = {}) ⇒ Types::ListImportedModelsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6325 6326 6327 6328 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6325 def list_imported_models(params = {}, = {}) req = build_request(:list_imported_models, params) req.send_request() end |
#list_inference_profiles(params = {}) ⇒ Types::ListInferenceProfilesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6396 6397 6398 6399 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6396 def list_inference_profiles(params = {}, = {}) req = build_request(:list_inference_profiles, params) req.send_request() end |
#list_marketplace_model_endpoints(params = {}) ⇒ Types::ListMarketplaceModelEndpointsResponse
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6446 6447 6448 6449 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6446 def list_marketplace_model_endpoints(params = {}, = {}) req = build_request(:list_marketplace_model_endpoints, params) req.send_request() end |
#list_model_copy_jobs(params = {}) ⇒ Types::ListModelCopyJobsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6546 6547 6548 6549 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6546 def list_model_copy_jobs(params = {}, = {}) req = build_request(:list_model_copy_jobs, params) req.send_request() end |
#list_model_customization_jobs(params = {}) ⇒ Types::ListModelCustomizationJobsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6641 6642 6643 6644 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6641 def list_model_customization_jobs(params = {}, = {}) req = build_request(:list_model_customization_jobs, params) req.send_request() end |
#list_model_import_jobs(params = {}) ⇒ Types::ListModelImportJobsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6724 6725 6726 6727 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6724 def list_model_import_jobs(params = {}, = {}) req = build_request(:list_model_import_jobs, params) req.send_request() end |
#list_model_invocation_jobs(params = {}) ⇒ Types::ListModelInvocationJobsResponse
Lists all batch inference jobs in the account. For more information, see View details about a batch inference job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6873 6874 6875 6876 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6873 def list_model_invocation_jobs(params = {}, = {}) req = build_request(:list_model_invocation_jobs, params) req.send_request() end |
#list_prompt_routers(params = {}) ⇒ Types::ListPromptRoutersResponse
Retrieves a list of prompt routers.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6926 6927 6928 6929 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 6926 def list_prompt_routers(params = {}, = {}) req = build_request(:list_prompt_routers, params) req.send_request() end |
#list_provisioned_model_throughputs(params = {}) ⇒ Types::ListProvisionedModelThroughputsResponse
Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7021 7022 7023 7024 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7021 def list_provisioned_model_throughputs(params = {}, = {}) req = build_request(:list_provisioned_model_throughputs, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags associated with the specified resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
7058 7059 7060 7061 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7058 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_account_data_retention(params = {}) ⇒ Types::PutAccountDataRetentionResponse
Sets the account-wide data retention mode for Amazon Bedrock.
7088 7089 7090 7091 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7088 def put_account_data_retention(params = {}, = {}) req = build_request(:put_account_data_retention, params) req.send_request() end |
#put_enforced_guardrail_configuration(params = {}) ⇒ Types::PutEnforcedGuardrailConfigurationResponse
Sets the account-level enforced guardrail configuration.
7135 7136 7137 7138 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7135 def put_enforced_guardrail_configuration(params = {}, = {}) req = build_request(:put_enforced_guardrail_configuration, params) req.send_request() end |
#put_model_invocation_logging_configuration(params = {}) ⇒ Struct
Set the configuration values for model invocation logging.
7175 7176 7177 7178 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7175 def put_model_invocation_logging_configuration(params = {}, = {}) req = build_request(:put_model_invocation_logging_configuration, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResponse
Adds a resource policy for a Bedrock resource.
7207 7208 7209 7210 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7207 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#put_use_case_for_model_access(params = {}) ⇒ Struct
Put usecase for model access.
7229 7230 7231 7232 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7229 def put_use_case_for_model_access(params = {}, = {}) req = build_request(:put_use_case_for_model_access, params) req.send_request() end |
#register_marketplace_model_endpoint(params = {}) ⇒ Types::RegisterMarketplaceModelEndpointResponse
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
7279 7280 7281 7282 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7279 def register_marketplace_model_endpoint(params = {}, = {}) req = build_request(:register_marketplace_model_endpoint, params) req.send_request() end |
#start_automated_reasoning_policy_build_workflow(params = {}) ⇒ Types::StartAutomatedReasoningPolicyBuildWorkflowResponse
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.
7471 7472 7473 7474 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7471 def start_automated_reasoning_policy_build_workflow(params = {}, = {}) req = build_request(:start_automated_reasoning_policy_build_workflow, params) req.send_request() end |
#start_automated_reasoning_policy_test_workflow(params = {}) ⇒ Types::StartAutomatedReasoningPolicyTestWorkflowResponse
Initiates a test workflow to validate Automated Reasoning policy tests. The workflow executes the specified tests against the policy and generates validation results.
7522 7523 7524 7525 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7522 def start_automated_reasoning_policy_test_workflow(params = {}, = {}) req = build_request(:start_automated_reasoning_policy_test_workflow, params) req.send_request() end |
#stop_advanced_prompt_optimization_job(params = {}) ⇒ Struct
Stops an advanced prompt optimization job that is in progress.
7544 7545 7546 7547 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7544 def stop_advanced_prompt_optimization_job(params = {}, = {}) req = build_request(:stop_advanced_prompt_optimization_job, params) req.send_request() end |
#stop_evaluation_job(params = {}) ⇒ Struct
Stops an evaluation job that is current being created or running.
7566 7567 7568 7569 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7566 def stop_evaluation_job(params = {}, = {}) req = build_request(:stop_evaluation_job, params) req.send_request() end |
#stop_model_customization_job(params = {}) ⇒ Struct
Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.
7594 7595 7596 7597 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7594 def stop_model_customization_job(params = {}, = {}) req = build_request(:stop_model_customization_job, params) req.send_request() end |
#stop_model_invocation_job(params = {}) ⇒ Struct
Stops a batch inference job. You're only charged for tokens that were already processed. For more information, see Stop a batch inference job.
7622 7623 7624 7625 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7622 def stop_model_invocation_job(params = {}, = {}) req = build_request(:stop_model_invocation_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
7658 7659 7660 7661 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7658 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
7689 7690 7691 7692 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7689 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_automated_reasoning_policy(params = {}) ⇒ Types::UpdateAutomatedReasoningPolicyResponse
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.
7767 7768 7769 7770 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7767 def update_automated_reasoning_policy(params = {}, = {}) req = build_request(:update_automated_reasoning_policy, params) req.send_request() end |
#update_automated_reasoning_policy_annotations(params = {}) ⇒ Types::UpdateAutomatedReasoningPolicyAnnotationsResponse
Updates the annotations for an Automated Reasoning policy build workflow. This allows you to modify extracted rules, variables, and types before finalizing the policy.
7895 7896 7897 7898 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7895 def update_automated_reasoning_policy_annotations(params = {}, = {}) req = build_request(:update_automated_reasoning_policy_annotations, params) req.send_request() end |
#update_automated_reasoning_policy_test_case(params = {}) ⇒ Types::UpdateAutomatedReasoningPolicyTestCaseResponse
Updates an existing Automated Reasoning policy test. You can modify the content, query, expected result, and confidence threshold.
7963 7964 7965 7966 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7963 def update_automated_reasoning_policy_test_case(params = {}, = {}) req = build_request(:update_automated_reasoning_policy_test_case, params) req.send_request() end |
#update_custom_model_deployment(params = {}) ⇒ Types::UpdateCustomModelDeploymentResponse
Updates a custom model deployment with a new custom model. This allows you to deploy updated models without creating new deployment endpoints.
7999 8000 8001 8002 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 7999 def update_custom_model_deployment(params = {}, = {}) req = build_request(:update_custom_model_deployment, params) req.send_request() end |
#update_guardrail(params = {}) ⇒ Types::UpdateGuardrailResponse
Updates a guardrail with the values you specify.
Specify a
nameand optionaldescription.Specify messages for when the guardrail successfully blocks a prompt or a model response in the
blockedInputMessagingandblockedOutputsMessagingfields.Specify topics for the guardrail to deny in the
topicPolicyConfigobject. Each GuardrailTopicConfig object in thetopicsConfiglist pertains to one topic.Give a
nameanddescriptionso that the guardrail can properly identify the topic.Specify
DENYin thetypefield.(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the
exampleslist.
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the
contentPolicyConfigobject. Each GuardrailContentFilterConfig object in thefiltersConfiglist 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
typefield.Specify the strength of the filter for prompts in the
inputStrengthfield and for model responses in thestrengthfield of the GuardrailContentFilterConfig.
- (Optional) For security, include the ARN of a KMS key in the
kmsKeyIdfield.
8222 8223 8224 8225 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 8222 def update_guardrail(params = {}, = {}) req = build_request(:update_guardrail, params) req.send_request() end |
#update_marketplace_model_endpoint(params = {}) ⇒ Types::UpdateMarketplaceModelEndpointResponse
Updates the configuration of an existing endpoint for a model from Amazon Bedrock Marketplace.
8293 8294 8295 8296 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 8293 def update_marketplace_model_endpoint(params = {}, = {}) req = build_request(:update_marketplace_model_endpoint, params) req.send_request() end |
#update_provisioned_model_throughput(params = {}) ⇒ Struct
Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
8341 8342 8343 8344 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 8341 def update_provisioned_model_throughput(params = {}, = {}) req = build_request(:update_provisioned_model_throughput, params) req.send_request() end |