com.amazonaws.services.bedrock

Class AmazonBedrockClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.bedrock.AmazonBedrockClient

All Implemented Interfaces:

AmazonBedrock

Direct Known Subclasses:

AmazonBedrockAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonBedrockClient
extends AmazonWebServiceClient
implements AmazonBedrock

Client for accessing Amazon Bedrock. All service calls made using this client are blocking, and will not return until the service call completes.

Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.bedrock.AmazonBedrock

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonBedrockClientBuilder	builder()
CreateEvaluationJobResult	createEvaluationJob(CreateEvaluationJobRequest request) API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.
CreateGuardrailResult	createGuardrail(CreateGuardrailRequest request) Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
CreateGuardrailVersionResult	createGuardrailVersion(CreateGuardrailVersionRequest request) Creates a version of the guardrail.
CreateModelCustomizationJobResult	createModelCustomizationJob(CreateModelCustomizationJobRequest request) Creates a fine-tuning job to customize a base model.
CreateProvisionedModelThroughputResult	createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest request) Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.
DeleteCustomModelResult	deleteCustomModel(DeleteCustomModelRequest request) Deletes a custom model that you created earlier.
DeleteGuardrailResult	deleteGuardrail(DeleteGuardrailRequest request) Deletes a guardrail.
DeleteModelInvocationLoggingConfigurationResult	deleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest request) Delete the invocation logging.
DeleteProvisionedModelThroughputResult	deleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest request) Deletes a Provisioned Throughput.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetCustomModelResult	getCustomModel(GetCustomModelRequest request) 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.
GetEvaluationJobResult	getEvaluationJob(GetEvaluationJobRequest request) Retrieves the properties associated with a model evaluation job, including the status of the job.
GetFoundationModelResult	getFoundationModel(GetFoundationModelRequest request) Get details about a Amazon Bedrock foundation model.
GetGuardrailResult	getGuardrail(GetGuardrailRequest request) Gets details about a guardrail.
GetModelCustomizationJobResult	getModelCustomizationJob(GetModelCustomizationJobRequest request) Retrieves the properties associated with a model-customization job, including the status of the job.
GetModelInvocationLoggingConfigurationResult	getModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest request) Get the current configuration values for model invocation logging.
GetProvisionedModelThroughputResult	getProvisionedModelThroughput(GetProvisionedModelThroughputRequest request) Returns details for a Provisioned Throughput.
ListCustomModelsResult	listCustomModels(ListCustomModelsRequest request) Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
ListEvaluationJobsResult	listEvaluationJobs(ListEvaluationJobsRequest request) Lists model evaluation jobs.
ListFoundationModelsResult	listFoundationModels(ListFoundationModelsRequest request) Lists Amazon Bedrock foundation models that you can use.
ListGuardrailsResult	listGuardrails(ListGuardrailsRequest request) Lists details about all the guardrails in an account.
ListModelCustomizationJobsResult	listModelCustomizationJobs(ListModelCustomizationJobsRequest request) Returns a list of model customization jobs that you have submitted.
ListProvisionedModelThroughputsResult	listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest request) Lists the Provisioned Throughputs in the account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List the tags associated with the specified resource.
PutModelInvocationLoggingConfigurationResult	putModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest request) Set the configuration values for model invocation logging.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StopEvaluationJobResult	stopEvaluationJob(StopEvaluationJobRequest request) Stops an in progress model evaluation job.
StopModelCustomizationJobResult	stopModelCustomizationJob(StopModelCustomizationJobRequest request) Stops an active model customization job.
TagResourceResult	tagResource(TagResourceRequest request) Associate tags with a resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Remove one or more tags from a resource.
UpdateGuardrailResult	updateGuardrail(UpdateGuardrailRequest request) Updates a guardrail with the values you specify.
UpdateProvisionedModelThroughputResult	updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest request) Updates the name or associated model for a Provisioned Throughput.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonBedrockClientBuilder builder()

createEvaluationJob

public CreateEvaluationJobResult createEvaluationJob(CreateEvaluationJobRequest request)

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 evaluations.

Specified by:

createEvaluationJob in interface AmazonBedrock

Parameters:

createEvaluationJobRequest -

Returns:

Result of the CreateEvaluationJob operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

ServiceQuotaExceededException - The number of requests exceeds the service quota. Resubmit your request later.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

createGuardrail

public CreateGuardrailResult createGuardrail(CreateGuardrailRequest request)

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.

Specified by:

createGuardrail in interface AmazonBedrock

Parameters:

createGuardrailRequest -

Returns:

Result of the CreateGuardrail operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException - The number of requests exceeds the service quota. Resubmit your request later.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

createGuardrailVersion

public CreateGuardrailVersionResult createGuardrailVersion(CreateGuardrailVersionRequest request)

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.

Specified by:

createGuardrailVersion in interface AmazonBedrock

Parameters:

createGuardrailVersionRequest -

Returns:

Result of the CreateGuardrailVersion operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

ServiceQuotaExceededException - The number of requests exceeds the service quota. Resubmit your request later.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

createModelCustomizationJob

public CreateModelCustomizationJobResult createModelCustomizationJob(CreateModelCustomizationJobRequest request)

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.

Specified by:

createModelCustomizationJob in interface AmazonBedrock

Parameters:

createModelCustomizationJobRequest -

Returns:

Result of the CreateModelCustomizationJob operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException - The number of requests exceeds the service quota. Resubmit your request later.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

createProvisionedModelThroughput

public CreateProvisionedModelThroughputResult createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest request)

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.

Specified by:

createProvisionedModelThroughput in interface AmazonBedrock

Parameters:

createProvisionedModelThroughputRequest -

Returns:

Result of the CreateProvisionedModelThroughput operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ServiceQuotaExceededException - The number of requests exceeds the service quota. Resubmit your request later.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

deleteCustomModel

public DeleteCustomModelResult deleteCustomModel(DeleteCustomModelRequest request)

Deletes a custom model that you created earlier. For more information, see Custom models in the Amazon Bedrock User Guide.

Specified by:

deleteCustomModel in interface AmazonBedrock

Parameters:

deleteCustomModelRequest -

Returns:

Result of the DeleteCustomModel operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

deleteGuardrail

public DeleteGuardrailResult deleteGuardrail(DeleteGuardrailRequest request)

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 the guardrailVersion field.

Specified by:

deleteGuardrail in interface AmazonBedrock

Parameters:

deleteGuardrailRequest -

Returns:

Result of the DeleteGuardrail operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

deleteModelInvocationLoggingConfiguration

public DeleteModelInvocationLoggingConfigurationResult deleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest request)

Delete the invocation logging.

Specified by:

deleteModelInvocationLoggingConfiguration in interface AmazonBedrock

Parameters:

deleteModelInvocationLoggingConfigurationRequest -

Returns:

Result of the DeleteModelInvocationLoggingConfiguration operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

deleteProvisionedModelThroughput

public DeleteProvisionedModelThroughputResult deleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest request)

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.

Specified by:

deleteProvisionedModelThroughput in interface AmazonBedrock

Parameters:

deleteProvisionedModelThroughputRequest -

Returns:

Result of the DeleteProvisionedModelThroughput operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

getCustomModel

public GetCustomModelResult getCustomModel(GetCustomModelRequest request)

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.

Specified by:

getCustomModel in interface AmazonBedrock

Parameters:

getCustomModelRequest -

Returns:

Result of the GetCustomModel operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

getEvaluationJob

public GetEvaluationJobResult getEvaluationJob(GetEvaluationJobRequest request)

Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluations.

Specified by:

getEvaluationJob in interface AmazonBedrock

Parameters:

getEvaluationJobRequest -

Returns:

Result of the GetEvaluationJob operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

getFoundationModel

public GetFoundationModelResult getFoundationModel(GetFoundationModelRequest request)

Get details about a Amazon Bedrock foundation model.

Specified by:

getFoundationModel in interface AmazonBedrock

Parameters:

getFoundationModelRequest -

Returns:

Result of the GetFoundationModel operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

getGuardrail

public GetGuardrailResult getGuardrail(GetGuardrailRequest request)

Gets details about a guardrail. If you don't specify a version, the response returns details for the DRAFT version.

Specified by:

getGuardrail in interface AmazonBedrock

Parameters:

getGuardrailRequest -

Returns:

Result of the GetGuardrail operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

getModelCustomizationJob

public GetModelCustomizationJobResult getModelCustomizationJob(GetModelCustomizationJobRequest request)

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.

Specified by:

getModelCustomizationJob in interface AmazonBedrock

Parameters:

getModelCustomizationJobRequest -

Returns:

Result of the GetModelCustomizationJob operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

getModelInvocationLoggingConfiguration

public GetModelInvocationLoggingConfigurationResult getModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest request)

Get the current configuration values for model invocation logging.

Specified by:

getModelInvocationLoggingConfiguration in interface AmazonBedrock

Parameters:

getModelInvocationLoggingConfigurationRequest -

Returns:

Result of the GetModelInvocationLoggingConfiguration operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

getProvisionedModelThroughput

public GetProvisionedModelThroughputResult getProvisionedModelThroughput(GetProvisionedModelThroughputRequest request)

Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Specified by:

getProvisionedModelThroughput in interface AmazonBedrock

Parameters:

getProvisionedModelThroughputRequest -

Returns:

Result of the GetProvisionedModelThroughput operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

listCustomModels

public ListCustomModelsResult listCustomModels(ListCustomModelsRequest request)

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.

Specified by:

listCustomModels in interface AmazonBedrock

Parameters:

listCustomModelsRequest -

Returns:

Result of the ListCustomModels operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

listEvaluationJobs

public ListEvaluationJobsResult listEvaluationJobs(ListEvaluationJobsRequest request)

Lists model evaluation jobs.

Specified by:

listEvaluationJobs in interface AmazonBedrock

Parameters:

listEvaluationJobsRequest -

Returns:

Result of the ListEvaluationJobs operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

listFoundationModels

public ListFoundationModelsResult listFoundationModels(ListFoundationModelsRequest request)

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.

Specified by:

listFoundationModels in interface AmazonBedrock

Parameters:

listFoundationModelsRequest -

Returns:

Result of the ListFoundationModels operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

listGuardrails

public ListGuardrailsResult listGuardrails(ListGuardrailsRequest request)

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.

Specified by:

listGuardrails in interface AmazonBedrock

Parameters:

listGuardrailsRequest -

Returns:

Result of the ListGuardrails operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

listModelCustomizationJobs

public ListModelCustomizationJobsResult listModelCustomizationJobs(ListModelCustomizationJobsRequest request)

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.

Specified by:

listModelCustomizationJobs in interface AmazonBedrock

Parameters:

listModelCustomizationJobsRequest -

Returns:

Result of the ListModelCustomizationJobs operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

listProvisionedModelThroughputs

public ListProvisionedModelThroughputsResult listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest request)

Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Specified by:

listProvisionedModelThroughputs in interface AmazonBedrock

Parameters:

listProvisionedModelThroughputsRequest -

Returns:

Result of the ListProvisionedModelThroughputs operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

List the tags associated with the specified resource.

For more information, see Tagging resources in the Amazon Bedrock User Guide.

Specified by:

listTagsForResource in interface AmazonBedrock

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

putModelInvocationLoggingConfiguration

public PutModelInvocationLoggingConfigurationResult putModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest request)

Set the configuration values for model invocation logging.

Specified by:

putModelInvocationLoggingConfiguration in interface AmazonBedrock

Parameters:

putModelInvocationLoggingConfigurationRequest -

Returns:

Result of the PutModelInvocationLoggingConfiguration operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

stopEvaluationJob

public StopEvaluationJobResult stopEvaluationJob(StopEvaluationJobRequest request)

Stops an in progress model evaluation job.

Specified by:

stopEvaluationJob in interface AmazonBedrock

Parameters:

stopEvaluationJobRequest -

Returns:

Result of the StopEvaluationJob operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

stopModelCustomizationJob

public StopModelCustomizationJobResult stopModelCustomizationJob(StopModelCustomizationJobRequest request)

Stops an active model customization job. For more information, see Custom models in the Amazon Bedrock User Guide.

Specified by:

stopModelCustomizationJob in interface AmazonBedrock

Parameters:

stopModelCustomizationJobRequest -

Returns:

Result of the StopModelCustomizationJob operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Specified by:

tagResource in interface AmazonBedrock

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

TooManyTagsException - The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Remove one or more tags from a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Specified by:

untagResource in interface AmazonBedrock

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

updateGuardrail

public UpdateGuardrailResult updateGuardrail(UpdateGuardrailRequest request)

Updates a guardrail with the values you specify.

• Specify a name and optional description.

• Specify messages for when the guardrail successfully blocks a prompt or a model response in the blockedInputMessaging and blockedOutputsMessaging fields.

• Specify topics for the guardrail to deny in the topicPolicyConfig object. Each GuardrailTopicConfig object in the topicsConfig list pertains to one topic.

  • Give a name and description so that the guardrail can properly identify the topic.

  • Specify DENY in the type 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 the filtersConfig 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 the strength field of the GuardrailContentFilterConfig.

• (Optional) For security, include the ARN of a KMS key in the kmsKeyId field.

Specified by:

updateGuardrail in interface AmazonBedrock

Parameters:

updateGuardrailRequest -

Returns:

Result of the UpdateGuardrail operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ConflictException - Error occurred because of a conflict while performing an operation.

InternalServerException - An internal server error occurred. Retry your request.

ServiceQuotaExceededException - The number of requests exceeds the service quota. Resubmit your request later.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

updateProvisionedModelThroughput

public UpdateProvisionedModelThroughputResult updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest request)

Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.

Specified by:

updateProvisionedModelThroughput in interface AmazonBedrock

Parameters:

updateProvisionedModelThroughputRequest -

Returns:

Result of the UpdateProvisionedModelThroughput operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

AccessDeniedException - The request is denied because of missing access permissions.

ValidationException - Input validation failed. Check your request parameters and retry the request.

InternalServerException - An internal server error occurred. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonBedrock

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonBedrock

Overrides:

shutdown in class AmazonWebServiceClient