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_custom_model(params = {}) ⇒ Types::CreateCustomModelResponse
Creates a new custom model in Amazon Bedrock.
-
#create_custom_model_deployment(params = {}) ⇒ Types::CreateCustomModelDeploymentResponse
Deploys a custom model for on-demand inference in Amazon Bedrock.
-
#create_evaluation_job(params = {}) ⇒ Types::CreateEvaluationJobResponse
Creates an evaluation job.
-
#create_foundation_model_agreement(params = {}) ⇒ Types::CreateFoundationModelAgreementResponse
Request a model access agreement for the specified model.
-
#create_guardrail(params = {}) ⇒ Types::CreateGuardrailResponse
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
-
#create_guardrail_version(params = {}) ⇒ Types::CreateGuardrailVersionResponse
Creates a version of the guardrail.
-
#create_inference_profile(params = {}) ⇒ Types::CreateInferenceProfileResponse
Creates an application inference profile to track metrics and costs when invoking a model.
-
#create_marketplace_model_endpoint(params = {}) ⇒ Types::CreateMarketplaceModelEndpointResponse
Creates an endpoint for a model from Amazon Bedrock Marketplace.
-
#create_model_copy_job(params = {}) ⇒ Types::CreateModelCopyJobResponse
Copies a model to another region so that it can be used there.
-
#create_model_customization_job(params = {}) ⇒ Types::CreateModelCustomizationJobResponse
Creates a fine-tuning job to customize a base model.
-
#create_model_import_job(params = {}) ⇒ Types::CreateModelImportJobResponse
Creates a model import job to import model that you have customized in other environments, such as Amazon SageMaker.
-
#create_model_invocation_job(params = {}) ⇒ Types::CreateModelInvocationJobResponse
Creates a batch inference job to invoke a model on multiple prompts.
-
#create_prompt_router(params = {}) ⇒ Types::CreatePromptRouterResponse
Creates a prompt router that manages the routing of requests between multiple foundation models based on the routing criteria.
-
#create_provisioned_model_throughput(params = {}) ⇒ Types::CreateProvisionedModelThroughputResponse
Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.
-
#delete_custom_model(params = {}) ⇒ Struct
Deletes a custom model that you created earlier.
-
#delete_custom_model_deployment(params = {}) ⇒ Struct
Deletes a custom model deployment.
-
#delete_foundation_model_agreement(params = {}) ⇒ Struct
Delete the model access agreement for the specified model.
-
#delete_guardrail(params = {}) ⇒ Struct
Deletes a guardrail.
-
#delete_imported_model(params = {}) ⇒ Struct
Deletes a custom model that you imported earlier.
-
#delete_inference_profile(params = {}) ⇒ Struct
Deletes an application inference profile.
-
#delete_marketplace_model_endpoint(params = {}) ⇒ Struct
Deletes an endpoint for a model from Amazon Bedrock Marketplace.
-
#delete_model_invocation_logging_configuration(params = {}) ⇒ Struct
Delete the invocation logging.
-
#delete_prompt_router(params = {}) ⇒ Struct
Deletes a specified prompt router.
-
#delete_provisioned_model_throughput(params = {}) ⇒ Struct
Deletes a Provisioned Throughput.
-
#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.
-
#get_custom_model_deployment(params = {}) ⇒ Types::GetCustomModelDeploymentResponse
Retrieves information about a custom model deployment, including its status, configuration, and metadata.
-
#get_evaluation_job(params = {}) ⇒ Types::GetEvaluationJobResponse
Gets information about an evaluation job, such as the status of the job.
-
#get_foundation_model(params = {}) ⇒ Types::GetFoundationModelResponse
Get details about a Amazon Bedrock foundation model.
-
#get_foundation_model_availability(params = {}) ⇒ Types::GetFoundationModelAvailabilityResponse
Get information about the Foundation model availability.
-
#get_guardrail(params = {}) ⇒ Types::GetGuardrailResponse
Gets details about a guardrail.
-
#get_imported_model(params = {}) ⇒ Types::GetImportedModelResponse
Gets properties associated with a customized model you imported.
-
#get_inference_profile(params = {}) ⇒ Types::GetInferenceProfileResponse
Gets information about an inference profile.
-
#get_marketplace_model_endpoint(params = {}) ⇒ Types::GetMarketplaceModelEndpointResponse
Retrieves details about a specific endpoint for a model from Amazon Bedrock Marketplace.
-
#get_model_copy_job(params = {}) ⇒ Types::GetModelCopyJobResponse
Retrieves information about a model copy job.
-
#get_model_customization_job(params = {}) ⇒ Types::GetModelCustomizationJobResponse
Retrieves the properties associated with a model-customization job, including the status of the job.
-
#get_model_import_job(params = {}) ⇒ Types::GetModelImportJobResponse
Retrieves the properties associated with import model job, including the status of the job.
-
#get_model_invocation_job(params = {}) ⇒ Types::GetModelInvocationJobResponse
Gets details about a batch inference job.
-
#get_model_invocation_logging_configuration(params = {}) ⇒ Types::GetModelInvocationLoggingConfigurationResponse
Get the current configuration values for model invocation logging.
-
#get_prompt_router(params = {}) ⇒ Types::GetPromptRouterResponse
Retrieves details about a prompt router.
-
#get_provisioned_model_throughput(params = {}) ⇒ Types::GetProvisionedModelThroughputResponse
Returns details for a Provisioned Throughput.
-
#get_use_case_for_model_access(params = {}) ⇒ Types::GetUseCaseForModelAccessResponse
Get usecase for model access.
-
#list_custom_model_deployments(params = {}) ⇒ Types::ListCustomModelDeploymentsResponse
Lists custom model deployments in your account.
-
#list_custom_models(params = {}) ⇒ Types::ListCustomModelsResponse
Returns a list of the custom models that you have created with the
CreateModelCustomizationJob
operation. -
#list_evaluation_jobs(params = {}) ⇒ Types::ListEvaluationJobsResponse
Lists all existing evaluation jobs.
-
#list_foundation_model_agreement_offers(params = {}) ⇒ Types::ListFoundationModelAgreementOffersResponse
Get the offers associated with the specified model.
-
#list_foundation_models(params = {}) ⇒ Types::ListFoundationModelsResponse
Lists Amazon Bedrock foundation models that you can use.
-
#list_guardrails(params = {}) ⇒ Types::ListGuardrailsResponse
Lists details about all the guardrails in an account.
-
#list_imported_models(params = {}) ⇒ Types::ListImportedModelsResponse
Returns a list of models you've imported.
-
#list_inference_profiles(params = {}) ⇒ Types::ListInferenceProfilesResponse
Returns a list of inference profiles that you can use.
-
#list_marketplace_model_endpoints(params = {}) ⇒ Types::ListMarketplaceModelEndpointsResponse
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon Web Services account.
-
#list_model_copy_jobs(params = {}) ⇒ Types::ListModelCopyJobsResponse
Returns a list of model copy jobs that you have submitted.
-
#list_model_customization_jobs(params = {}) ⇒ Types::ListModelCustomizationJobsResponse
Returns a list of model customization jobs that you have submitted.
-
#list_model_import_jobs(params = {}) ⇒ Types::ListModelImportJobsResponse
Returns a list of import jobs you've submitted.
-
#list_model_invocation_jobs(params = {}) ⇒ Types::ListModelInvocationJobsResponse
Lists all batch inference jobs in the account.
-
#list_prompt_routers(params = {}) ⇒ Types::ListPromptRoutersResponse
Retrieves a list of prompt routers.
-
#list_provisioned_model_throughputs(params = {}) ⇒ Types::ListProvisionedModelThroughputsResponse
Lists the Provisioned Throughputs in the account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags associated with the specified resource.
-
#put_model_invocation_logging_configuration(params = {}) ⇒ Struct
Set the configuration values for model invocation logging.
-
#put_use_case_for_model_access(params = {}) ⇒ Struct
Put usecase for model access.
-
#register_marketplace_model_endpoint(params = {}) ⇒ Types::RegisterMarketplaceModelEndpointResponse
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
-
#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.
478 479 480 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 478 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.
547 548 549 550 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 547 def batch_delete_evaluation_job(params = {}, = {}) req = build_request(:batch_delete_evaluation_job, params) req.send_request() end |
#create_custom_model(params = {}) ⇒ Types::CreateCustomModelResponse
Creates a new custom model in Amazon Bedrock. After the model is active, you can use it for inference.
To use the model for inference, you must purchase Provisioned Throughput for it. You can't use On-demand inference with these custom models. For more information about Provisioned Throughput, see Provisioned Throughput.
The model appears in ListCustomModels
with a customizationType
of
imported
. To track the status of the new model, you use the
GetCustomModel
API operation. The model can be in the following
states:
Creating
- Initial state during validation and registrationActive
- Model is ready for use in inferenceFailed
- Creation process encountered an error
Related APIs
707 708 709 710 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 707 def create_custom_model(params = {}, = {}) req = build_request(:create_custom_model, params) req.send_request() end |
#create_custom_model_deployment(params = {}) ⇒ Types::CreateCustomModelDeploymentResponse
Deploys a custom model for on-demand inference in Amazon Bedrock.
After you deploy your custom model, you use the deployment's Amazon
Resource Name (ARN) as the modelId
parameter when you submit prompts
and generate responses with model inference.
For more information about setting up on-demand inference for custom models, see Set up inference for a custom model.
The following actions are related to the CreateCustomModelDeployment
operation:
793 794 795 796 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 793 def create_custom_model_deployment(params = {}, = {}) req = build_request(:create_custom_model_deployment, params) req.send_request() end |
#create_evaluation_job(params = {}) ⇒ Types::CreateEvaluationJobResponse
Creates an evaluation job.
1292 1293 1294 1295 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1292 def create_evaluation_job(params = {}, = {}) req = build_request(:create_evaluation_job, params) req.send_request() end |
#create_foundation_model_agreement(params = {}) ⇒ Types::CreateFoundationModelAgreementResponse
Request a model access agreement for the specified model.
1324 1325 1326 1327 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1324 def create_foundation_model_agreement(params = {}, = {}) req = build_request(:create_foundation_model_agreement, params) req.send_request() end |
#create_guardrail(params = {}) ⇒ Types::CreateGuardrailResponse
Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
For more information, see Amazon Bedrock Guardrails in the Amazon Bedrock User Guide.
1549 1550 1551 1552 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1549 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.
1600 1601 1602 1603 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1600 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.
1682 1683 1684 1685 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1682 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.
1775 1776 1777 1778 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1775 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.
1847 1848 1849 1850 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 1847 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.
2046 2047 2048 2049 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2046 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
2137 2138 2139 2140 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2137 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.
2258 2259 2260 2261 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2258 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.
2334 2335 2336 2337 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2334 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.
2445 2446 2447 2448 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2445 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.
2473 2474 2475 2476 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2473 def delete_custom_model(params = {}, = {}) req = build_request(:delete_custom_model, params) req.send_request() end |
#delete_custom_model_deployment(params = {}) ⇒ Struct
Deletes a custom model deployment. This operation stops the deployment and removes it from your account. After deletion, the deployment ARN can no longer be used for inference requests.
The following actions are related to the DeleteCustomModelDeployment
operation:
2513 2514 2515 2516 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2513 def delete_custom_model_deployment(params = {}, = {}) req = build_request(:delete_custom_model_deployment, params) req.send_request() end |
#delete_foundation_model_agreement(params = {}) ⇒ Struct
Delete the model access agreement for the specified model.
2535 2536 2537 2538 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2535 def delete_foundation_model_agreement(params = {}, = {}) req = build_request(:delete_foundation_model_agreement, params) req.send_request() end |
#delete_guardrail(params = {}) ⇒ Struct
Deletes a guardrail.
To delete a guardrail, only specify the ARN of the guardrail in the
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.
2569 2570 2571 2572 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2569 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.
2598 2599 2600 2601 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2598 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.
2627 2628 2629 2630 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2627 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.
2649 2650 2651 2652 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2649 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.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2662 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.
2684 2685 2686 2687 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2684 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.
2713 2714 2715 2716 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2713 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.
2737 2738 2739 2740 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2737 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.
2824 2825 2826 2827 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2824 def get_custom_model(params = {}, = {}) req = build_request(:get_custom_model, params) req.send_request() end |
#get_custom_model_deployment(params = {}) ⇒ Types::GetCustomModelDeploymentResponse
Retrieves information about a custom model deployment, including its status, configuration, and metadata. Use this operation to monitor the deployment status and retrieve details needed for inference requests.
The following actions are related to the GetCustomModelDeployment
operation:
2884 2885 2886 2887 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 2884 def get_custom_model_deployment(params = {}, = {}) req = build_request(:get_custom_model_deployment, params) req.send_request() end |
#get_evaluation_job(params = {}) ⇒ Types::GetEvaluationJobResponse
Gets information about an evaluation job, such as the status of the job.
3068 3069 3070 3071 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3068 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.
3109 3110 3111 3112 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3109 def get_foundation_model(params = {}, = {}) req = build_request(:get_foundation_model, params) req.send_request() end |
#get_foundation_model_availability(params = {}) ⇒ Types::GetFoundationModelAvailabilityResponse
Get information about the Foundation model availability.
3146 3147 3148 3149 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3146 def get_foundation_model_availability(params = {}, = {}) req = build_request(:get_foundation_model_availability, params) req.send_request() end |
#get_guardrail(params = {}) ⇒ Types::GetGuardrailResponse
Gets details about a guardrail. If you don't specify a version, the
response returns details for the DRAFT
version.
3273 3274 3275 3276 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3273 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.
3320 3321 3322 3323 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3320 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.
3371 3372 3373 3374 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3371 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.
3416 3417 3418 3419 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3416 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.
3473 3474 3475 3476 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3473 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.
3583 3584 3585 3586 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3583 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.
3645 3646 3647 3648 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3645 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
3713 3714 3715 3716 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3713 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.
3741 3742 3743 3744 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3741 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.
3788 3789 3790 3791 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3788 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.
3846 3847 3848 3849 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3846 def get_provisioned_model_throughput(params = {}, = {}) req = build_request(:get_provisioned_model_throughput, params) req.send_request() end |
#get_use_case_for_model_access(params = {}) ⇒ Types::GetUseCaseForModelAccessResponse
Get usecase for model access.
3865 3866 3867 3868 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3865 def get_use_case_for_model_access(params = {}, = {}) req = build_request(:get_use_case_for_model_access, params) req.send_request() end |
#list_custom_model_deployments(params = {}) ⇒ Types::ListCustomModelDeploymentsResponse
Lists custom model deployments in your account. You can filter the results by creation time, name, status, and associated model. Use this operation to manage and monitor your custom model deployments.
We recommend using pagination to ensure that the operation returns quickly and successfully.
The following actions are related to the ListCustomModelDeployments
operation:
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3961 3962 3963 3964 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 3961 def list_custom_model_deployments(params = {}, = {}) req = build_request(:list_custom_model_deployments, params) req.send_request() end |
#list_custom_models(params = {}) ⇒ Types::ListCustomModelsResponse
Returns a list of the custom models that you have created with the
CreateModelCustomizationJob
operation.
For more information, see Custom models in the Amazon Bedrock User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4070 4071 4072 4073 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4070 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.
4163 4164 4165 4166 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4163 def list_evaluation_jobs(params = {}, = {}) req = build_request(:list_evaluation_jobs, params) req.send_request() end |
#list_foundation_model_agreement_offers(params = {}) ⇒ Types::ListFoundationModelAgreementOffersResponse
Get the offers associated with the specified model.
4207 4208 4209 4210 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4207 def list_foundation_model_agreement_offers(params = {}, = {}) req = build_request(:list_foundation_model_agreement_offers, params) req.send_request() end |
#list_foundation_models(params = {}) ⇒ Types::ListFoundationModelsResponse
Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
4282 4283 4284 4285 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4282 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.
4342 4343 4344 4345 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4342 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.
4418 4419 4420 4421 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4418 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.
4489 4490 4491 4492 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4489 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.
4539 4540 4541 4542 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4539 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.
4639 4640 4641 4642 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4639 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.
4734 4735 4736 4737 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4734 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.
4817 4818 4819 4820 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4817 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.
4961 4962 4963 4964 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 4961 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.
5014 5015 5016 5017 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5014 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.
5109 5110 5111 5112 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5109 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.
5146 5147 5148 5149 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5146 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.
5185 5186 5187 5188 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5185 def put_model_invocation_logging_configuration(params = {}, = {}) req = build_request(:put_model_invocation_logging_configuration, params) req.send_request() end |
#put_use_case_for_model_access(params = {}) ⇒ Struct
Put usecase for model access.
5207 5208 5209 5210 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5207 def put_use_case_for_model_access(params = {}, = {}) req = build_request(:put_use_case_for_model_access, params) req.send_request() end |
#register_marketplace_model_endpoint(params = {}) ⇒ Types::RegisterMarketplaceModelEndpointResponse
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace, allowing it to be used with Amazon Bedrock APIs.
5257 5258 5259 5260 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5257 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.
5279 5280 5281 5282 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5279 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.
5307 5308 5309 5310 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5307 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.
5335 5336 5337 5338 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5335 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.
5371 5372 5373 5374 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5371 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.
5402 5403 5404 5405 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5402 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.
5614 5615 5616 5617 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5614 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.
5685 5686 5687 5688 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5685 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.
5733 5734 5735 5736 |
# File 'gems/aws-sdk-bedrock/lib/aws-sdk-bedrock/client.rb', line 5733 def update_provisioned_model_throughput(params = {}, = {}) req = build_request(:update_provisioned_model_throughput, params) req.send_request() end |