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
Deletes a batch of evaluation jobs.
-
#create_evaluation_job(params = {}) ⇒ Types::CreateEvaluationJobResponse
Creates an evaluation job.
-
#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_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_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.
-
#deregister_marketplace_model_endpoint(params = {}) ⇒ Struct
Deregisters an endpoint for a model from Amazon Bedrock Marketplace.
-
#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
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_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.
-
#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 all existing 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_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_model_invocation_logging_configuration(params = {}) ⇒ Struct
Set the configuration values for model invocation logging.
-
#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.
-
#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_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.
466 467 468 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 466 def initialize(*args) super end |
Instance Method Details
#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.
535 536 537 538 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 535 def batch_delete_evaluation_job(params = {}, = {}) req = build_request(:batch_delete_evaluation_job, params) req.send_request() end |
#create_evaluation_job(params = {}) ⇒ Types::CreateEvaluationJobResponse
Creates an evaluation job.
958 959 960 961 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 958 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 Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1177 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.
1228 1229 1230 1231 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1228 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.
1310 1311 1312 1313 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1310 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.
1403 1404 1405 1406 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1403 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1475 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.
1674 1675 1676 1677 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1674 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
1765 1766 1767 1768 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1765 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.
1886 1887 1888 1889 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1886 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.
1962 1963 1964 1965 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1962 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.
2073 2074 2075 2076 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2073 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.
2101 2102 2103 2104 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2101 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.
2135 2136 2137 2138 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2135 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.
2164 2165 2166 2167 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2164 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.
2193 2194 2195 2196 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2193 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.
2215 2216 2217 2218 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2215 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.
2228 2229 2230 2231 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2228 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.
2250 2251 2252 2253 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2250 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.
2279 2280 2281 2282 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2279 def delete_provisioned_model_throughput(params = {}, = {}) req = build_request(:delete_provisioned_model_throughput, 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.
2303 2304 2305 2306 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2303 def deregister_marketplace_model_endpoint(params = {}, = {}) req = build_request(:deregister_marketplace_model_endpoint, 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.
2386 2387 2388 2389 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2386 def get_custom_model(params = {}, = {}) req = build_request(:get_custom_model, params) req.send_request() end |
#get_evaluation_job(params = {}) ⇒ Types::GetEvaluationJobResponse
Gets information about an evaluation job, such as the status of the job.
2542 2543 2544 2545 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2542 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.
2583 2584 2585 2586 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2583 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.
2708 2709 2710 2711 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2708 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.
2755 2756 2757 2758 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2755 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.
2806 2807 2808 2809 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2806 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.
2851 2852 2853 2854 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2851 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.
2908 2909 2910 2911 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2908 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.
3018 3019 3020 3021 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3018 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.
3080 3081 3082 3083 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3080 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
3148 3149 3150 3151 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3148 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.
3176 3177 3178 3179 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3176 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.
3223 3224 3225 3226 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3223 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.
3281 3282 3283 3284 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3281 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.
3374 3375 3376 3377 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3374 def list_custom_models(params = {}, = {}) req = build_request(:list_custom_models, 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.
3467 3468 3469 3470 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3467 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.
3542 3543 3544 3545 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3542 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.
3602 3603 3604 3605 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3602 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.
3678 3679 3680 3681 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3678 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.
3749 3750 3751 3752 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3749 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.
3799 3800 3801 3802 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3799 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.
3899 3900 3901 3902 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3899 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.
3994 3995 3996 3997 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3994 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.
4077 4078 4079 4080 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4077 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.
4221 4222 4223 4224 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4221 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.
4274 4275 4276 4277 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4274 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.
4369 4370 4371 4372 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4369 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.
4406 4407 4408 4409 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4406 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.
4445 4446 4447 4448 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4445 def put_model_invocation_logging_configuration(params = {}, = {}) req = build_request(:put_model_invocation_logging_configuration, 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.
4495 4496 4497 4498 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4495 def register_marketplace_model_endpoint(params = {}, = {}) req = build_request(:register_marketplace_model_endpoint, params) req.send_request() end |
#stop_evaluation_job(params = {}) ⇒ Struct
Stops an evaluation job that is current being created or running.
4517 4518 4519 4520 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4517 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.
4545 4546 4547 4548 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4545 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.
4573 4574 4575 4576 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4573 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.
4609 4610 4611 4612 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4609 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.
4640 4641 4642 4643 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4640 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.
4846 4847 4848 4849 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4846 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.
4917 4918 4919 4920 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4917 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.
4965 4966 4967 4968 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4965 def update_provisioned_model_throughput(params = {}, = {}) req = build_request(:update_provisioned_model_throughput, params) req.send_request() end |