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.
444 445 446 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 444 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.
483 484 485 486 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 483 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.
637 638 639 640 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 637 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.
813 814 815 816 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 813 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.
864 865 866 867 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 864 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.
936 937 938 939 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 936 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.
1090 1091 1092 1093 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1090 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
1181 1182 1183 1184 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1181 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.
1302 1303 1304 1305 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1302 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.
1413 1414 1415 1416 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1413 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.
1441 1442 1443 1444 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1441 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1475 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.
1504 1505 1506 1507 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1504 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.
1517 1518 1519 1520 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1517 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.
1546 1547 1548 1549 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1546 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.
1610 1611 1612 1613 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1610 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.
1688 1689 1690 1691 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1688 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.
1729 1730 1731 1732 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1729 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.
1821 1822 1823 1824 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1821 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.
1863 1864 1865 1866 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1863 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.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1909 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.
1966 1967 1968 1969 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1966 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.
2047 2048 2049 2050 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2047 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.
2109 2110 2111 2112 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2109 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
2177 2178 2179 2180 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2177 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.
2204 2205 2206 2207 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2204 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.
2262 2263 2264 2265 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2262 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.
2355 2356 2357 2358 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2355 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.
2427 2428 2429 2430 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2427 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.
2502 2503 2504 2505 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2502 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.
2560 2561 2562 2563 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2560 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.
2634 2635 2636 2637 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2634 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.
2686 2687 2688 2689 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2686 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.
2786 2787 2788 2789 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2786 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.
2872 2873 2874 2875 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2872 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.
2955 2956 2957 2958 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2955 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.
3052 3053 3054 3055 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3052 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.
3147 3148 3149 3150 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3147 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.
3185 3186 3187 3188 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3185 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.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3223 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.
3245 3246 3247 3248 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3245 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.
3273 3274 3275 3276 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3273 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.
3301 3302 3303 3304 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3301 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.
3338 3339 3340 3341 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3338 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.
3370 3371 3372 3373 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3370 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.
3535 3536 3537 3538 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3535 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.
3583 3584 3585 3586 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3583 def update_provisioned_model_throughput(params = {}, = {}) req = build_request(:update_provisioned_model_throughput, params) req.send_request() end |