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 and managing Bedrock models.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonBedrockClientBuilder	builder()
CreateModelCustomizationJobResult	createModelCustomizationJob(CreateModelCustomizationJobRequest request) Creates a fine-tuning job to customize a base model.
CreateProvisionedModelThroughputResult	createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest request) Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.
DeleteCustomModelResult	deleteCustomModel(DeleteCustomModelRequest request) Deletes a custom model that you created earlier.
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 Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
GetFoundationModelResult	getFoundationModel(GetFoundationModelRequest request) Get details about a Bedrock foundation model.
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) Get details for a provisioned throughput.
ListCustomModelsResult	listCustomModels(ListCustomModelsRequest request) Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
ListFoundationModelsResult	listFoundationModels(ListFoundationModelsRequest request) List of Bedrock foundation models that you can use.
ListModelCustomizationJobsResult	listModelCustomizationJobs(ListModelCustomizationJobsRequest request) Returns a list of model customization jobs that you have submitted.
ListProvisionedModelThroughputsResult	listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest request) List the provisioned capacities.
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.
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.
UpdateProvisionedModelThroughputResult	updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest request) Update a provisioned throughput.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonBedrockClientBuilder builder()

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. Training data contains input and output text for each record in a JSONL format. Optionally, you can specify validation data in the same format as the training data. Bedrock returns validation loss metrics and output generations after the job completes.

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 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 ARN was not found. Check the 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 a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.

For more information, see Provisioned throughput in the 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 ARN was not found. Check the 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 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 ARN was not found. Check the 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. For more information, see Provisioned throughput in the 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 ARN was not found. Check the 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 Bedrock custom model that you have created.For more information, see Custom models in the 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 ARN was not found. Check the 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 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 ARN was not found. Check the 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 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 ARN was not found. Check the 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)

Get details for a provisioned throughput. For more information, see Provisioned throughput in the 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 ARN was not found. Check the 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 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

listFoundationModels

public ListFoundationModelsResult listFoundationModels(ListFoundationModelsRequest request)

List of Bedrock foundation models that you can use. For more information, see Foundation models in the 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

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 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)

List the provisioned capacities. For more information, see Provisioned throughput in the 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 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 ARN was not found. Check the 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

stopModelCustomizationJob

public StopModelCustomizationJobResult stopModelCustomizationJob(StopModelCustomizationJobRequest request)

Stops an active model customization job. For more information, see Custom models in the 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 ARN was not found. Check the 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 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 ARN was not found. Check the 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 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 ARN was not found. Check the 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

updateProvisionedModelThroughput

public UpdateProvisionedModelThroughputResult updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest request)

Update a provisioned throughput. For more information, see Provisioned throughput in the 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 ARN was not found. Check the 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 interface: AmazonBedrock

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. 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