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_evaluation_job(params = {}) ⇒ Types::BatchDeleteEvaluationJobResponse
Creates a batch deletion job.
-
#create_evaluation_job(params = {}) ⇒ Types::CreateEvaluationJobResponse
API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.
-
#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_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_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_custom_model(params = {}) ⇒ Struct
Deletes a custom model that you created earlier.
-
#delete_guardrail(params = {}) ⇒ Struct
Deletes a guardrail.
-
#delete_imported_model(params = {}) ⇒ Struct
Deletes a custom model that you imported earlier.
-
#delete_model_invocation_logging_configuration(params = {}) ⇒ Struct
Delete the invocation logging.
-
#delete_provisioned_model_throughput(params = {}) ⇒ Struct
Deletes a Provisioned Throughput.
-
#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][1] in the [Amazon Bedrock User Guide][2].
-
#get_evaluation_job(params = {}) ⇒ Types::GetEvaluationJobResponse
Retrieves the properties associated with a model evaluation job, including the status of the job.
-
#get_foundation_model(params = {}) ⇒ Types::GetFoundationModelResponse
Get details about a Amazon Bedrock foundation model.
-
#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_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_provisioned_model_throughput(params = {}) ⇒ Types::GetProvisionedModelThroughputResponse
Returns details for a Provisioned Throughput.
-
#list_custom_models(params = {}) ⇒ Types::ListCustomModelsResponse
Returns a list of the custom models that you have created with the
CreateModelCustomizationJob
operation. -
#list_evaluation_jobs(params = {}) ⇒ Types::ListEvaluationJobsResponse
Lists model evaluation jobs.
-
#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_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_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_model_invocation_logging_configuration(params = {}) ⇒ Struct
Set the configuration values for model invocation logging.
-
#stop_evaluation_job(params = {}) ⇒ Struct
Stops an in progress model evaluation job.
-
#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_guardrail(params = {}) ⇒ Types::UpdateGuardrailResponse
Updates a guardrail with the values you specify.
-
#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.
422 423 424 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#batch_delete_evaluation_job(params = {}) ⇒ Types::BatchDeleteEvaluationJobResponse
Creates a batch deletion job. A model 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.
461 462 463 464 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 461 def batch_delete_evaluation_job(params = {}, = {}) req = build_request(:batch_delete_evaluation_job, params) req.send_request() end |
#create_evaluation_job(params = {}) ⇒ Types::CreateEvaluationJobResponse
API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluation.
610 611 612 613 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 610 def create_evaluation_job(params = {}, = {}) req = build_request(:create_evaluation_job, 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 Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide.
786 787 788 789 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 786 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.
837 838 839 840 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 837 def create_guardrail_version(params = {}, = {}) req = build_request(:create_guardrail_version, 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.
909 910 911 912 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 909 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.
1059 1060 1061 1062 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1059 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
1150 1151 1152 1153 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1150 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.
1256 1257 1258 1259 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1256 def create_model_invocation_job(params = {}, = {}) req = build_request(:create_model_invocation_job, 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.
1367 1368 1369 1370 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1367 def create_provisioned_model_throughput(params = {}, = {}) req = build_request(:create_provisioned_model_throughput, 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.
1395 1396 1397 1398 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1395 def delete_custom_model(params = {}, = {}) req = build_request(:delete_custom_model, 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
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 theguardrailVersion
field.
1429 1430 1431 1432 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1429 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.
1458 1459 1460 1461 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1458 def delete_imported_model(params = {}, = {}) req = build_request(:delete_imported_model, params) req.send_request() end |
#delete_model_invocation_logging_configuration(params = {}) ⇒ Struct
Delete the invocation logging.
1471 1472 1473 1474 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1471 def delete_model_invocation_logging_configuration(params = {}, = {}) req = build_request(:delete_model_invocation_logging_configuration, 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.
1500 1501 1502 1503 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1500 def delete_provisioned_model_throughput(params = {}, = {}) req = build_request(:delete_provisioned_model_throughput, 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.
1564 1565 1566 1567 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1564 def get_custom_model(params = {}, = {}) req = build_request(:get_custom_model, params) req.send_request() end |
#get_evaluation_job(params = {}) ⇒ Types::GetEvaluationJobResponse
Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluation.
1642 1643 1644 1645 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1642 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.
1683 1684 1685 1686 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1683 def get_foundation_model(params = {}, = {}) req = build_request(:get_foundation_model, 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.
1775 1776 1777 1778 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1775 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.
1817 1818 1819 1820 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1817 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 the Amazon Bedrock User Guide.
1863 1864 1865 1866 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1863 def get_inference_profile(params = {}, = {}) req = build_request(:get_inference_profile, 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.
1920 1921 1922 1923 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1920 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.
2001 2002 2003 2004 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2001 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.
2063 2064 2065 2066 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2063 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 View details about a batch inference job
2124 2125 2126 2127 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2124 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.
2151 2152 2153 2154 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2151 def get_model_invocation_logging_configuration(params = {}, = {}) req = build_request(:get_model_invocation_logging_configuration, 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.
2209 2210 2211 2212 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2209 def get_provisioned_model_throughput(params = {}, = {}) req = build_request(:get_provisioned_model_throughput, 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.
2302 2303 2304 2305 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2302 def list_custom_models(params = {}, = {}) req = build_request(:list_custom_models, params) req.send_request() end |
#list_evaluation_jobs(params = {}) ⇒ Types::ListEvaluationJobsResponse
Lists model evaluation jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2374 2375 2376 2377 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2374 def list_evaluation_jobs(params = {}, = {}) req = build_request(:list_evaluation_jobs, 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.
2449 2450 2451 2452 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2449 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.
2507 2508 2509 2510 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2507 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.
2581 2582 2583 2584 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2581 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2633 2634 2635 2636 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2633 def list_inference_profiles(params = {}, = {}) req = build_request(:list_inference_profiles, 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.
2733 2734 2735 2736 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2733 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.
2819 2820 2821 2822 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2819 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.
2902 2903 2904 2905 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2902 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.
2993 2994 2995 2996 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2993 def list_model_invocation_jobs(params = {}, = {}) req = build_request(:list_model_invocation_jobs, 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.
3088 3089 3090 3091 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3088 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.
3126 3127 3128 3129 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3126 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_model_invocation_logging_configuration(params = {}) ⇒ Struct
Set the configuration values for model invocation logging.
3164 3165 3166 3167 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3164 def put_model_invocation_logging_configuration(params = {}, = {}) req = build_request(:put_model_invocation_logging_configuration, params) req.send_request() end |
#stop_evaluation_job(params = {}) ⇒ Struct
Stops an in progress model evaluation job.
3186 3187 3188 3189 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3186 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.
3214 3215 3216 3217 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3214 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.
3242 3243 3244 3245 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3242 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.
3279 3280 3281 3282 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3279 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.
3311 3312 3313 3314 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3311 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_guardrail(params = {}) ⇒ Types::UpdateGuardrailResponse
Updates a guardrail with the values you specify.
Specify a
name
and optionaldescription
.Specify messages for when the guardrail successfully blocks a prompt or a model response in the
blockedInputMessaging
andblockedOutputsMessaging
fields.Specify topics for the guardrail to deny in the
topicPolicyConfig
object. Each GuardrailTopicConfig object in thetopicsConfig
list pertains to one topic.Give a
name
anddescription
so that the guardrail can properly identify the topic.Specify
DENY
in thetype
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 thefiltersConfig
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 thestrength
field of the GuardrailContentFilterConfig.
(Optional) For security, include the ARN of a KMS key in the
kmsKeyId
field.
3476 3477 3478 3479 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3476 def update_guardrail(params = {}, = {}) req = build_request(:update_guardrail, 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.
3524 3525 3526 3527 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3524 def update_provisioned_model_throughput(params = {}, = {}) req = build_request(:update_provisioned_model_throughput, params) req.send_request() end |