com.amazonaws.services.bedrock

Interface AmazonBedrock

All Known Subinterfaces:

AmazonBedrockAsync

All Known Implementing Classes:

AbstractAmazonBedrock, AbstractAmazonBedrockAsync, AmazonBedrockAsyncClient, AmazonBedrockClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonBedrock

Interface for accessing Amazon Bedrock.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonBedrock instead.

Describes the API operations for creating and managing Amazon Bedrock models.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateModelCustomizationJobResult	createModelCustomizationJob(CreateModelCustomizationJobRequest createModelCustomizationJobRequest) Creates a fine-tuning job to customize a base model.
CreateProvisionedModelThroughputResult	createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest createProvisionedModelThroughputRequest) Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.
DeleteCustomModelResult	deleteCustomModel(DeleteCustomModelRequest deleteCustomModelRequest) Deletes a custom model that you created earlier.
DeleteModelInvocationLoggingConfigurationResult	deleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest deleteModelInvocationLoggingConfigurationRequest) Delete the invocation logging.
DeleteProvisionedModelThroughputResult	deleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest deleteProvisionedModelThroughputRequest) 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 getCustomModelRequest) Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
GetFoundationModelResult	getFoundationModel(GetFoundationModelRequest getFoundationModelRequest) Get details about a Amazon Bedrock foundation model.
GetModelCustomizationJobResult	getModelCustomizationJob(GetModelCustomizationJobRequest getModelCustomizationJobRequest) Retrieves the properties associated with a model-customization job, including the status of the job.
GetModelInvocationLoggingConfigurationResult	getModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest getModelInvocationLoggingConfigurationRequest) Get the current configuration values for model invocation logging.
GetProvisionedModelThroughputResult	getProvisionedModelThroughput(GetProvisionedModelThroughputRequest getProvisionedModelThroughputRequest) Get details for a provisioned throughput.
ListCustomModelsResult	listCustomModels(ListCustomModelsRequest listCustomModelsRequest) Returns a list of the custom models that you have created with the CreateModelCustomizationJob operation.
ListFoundationModelsResult	listFoundationModels(ListFoundationModelsRequest listFoundationModelsRequest) List of Amazon Bedrock foundation models that you can use.
ListModelCustomizationJobsResult	listModelCustomizationJobs(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest) Returns a list of model customization jobs that you have submitted.
ListProvisionedModelThroughputsResult	listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) List the provisioned capacities.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags associated with the specified resource.
PutModelInvocationLoggingConfigurationResult	putModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest putModelInvocationLoggingConfigurationRequest) 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 stopModelCustomizationJobRequest) Stops an active model customization job.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Associate tags with a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Remove one or more tags from a resource.
UpdateProvisionedModelThroughputResult	updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest updateProvisionedModelThroughputRequest) Update a provisioned throughput.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createModelCustomizationJob

CreateModelCustomizationJobResult createModelCustomizationJob(CreateModelCustomizationJobRequest createModelCustomizationJobRequest)

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

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

CreateProvisionedModelThroughputResult createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest createProvisionedModelThroughputRequest)

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.

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

DeleteCustomModelResult deleteCustomModel(DeleteCustomModelRequest deleteCustomModelRequest)

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

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

DeleteModelInvocationLoggingConfigurationResult deleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest deleteModelInvocationLoggingConfigurationRequest)

Delete the invocation logging.

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

DeleteProvisionedModelThroughputResult deleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest deleteProvisionedModelThroughputRequest)

Deletes a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.

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

GetCustomModelResult getCustomModel(GetCustomModelRequest getCustomModelRequest)

Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.

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

GetFoundationModelResult getFoundationModel(GetFoundationModelRequest getFoundationModelRequest)

Get details about a Amazon Bedrock foundation model.

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

GetModelCustomizationJobResult getModelCustomizationJob(GetModelCustomizationJobRequest getModelCustomizationJobRequest)

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.

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

GetModelInvocationLoggingConfigurationResult getModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest getModelInvocationLoggingConfigurationRequest)

Get the current configuration values for model invocation logging.

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

GetProvisionedModelThroughputResult getProvisionedModelThroughput(GetProvisionedModelThroughputRequest getProvisionedModelThroughputRequest)

Get details for a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.

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

ListCustomModelsResult listCustomModels(ListCustomModelsRequest listCustomModelsRequest)

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.

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

ListFoundationModelsResult listFoundationModels(ListFoundationModelsRequest listFoundationModelsRequest)

List of Amazon Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.

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

ListModelCustomizationJobsResult listModelCustomizationJobs(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest)

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.

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

ListProvisionedModelThroughputsResult listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest)

List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List the tags associated with the specified resource.

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

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

PutModelInvocationLoggingConfigurationResult putModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest putModelInvocationLoggingConfigurationRequest)

Set the configuration values for model invocation logging.

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

StopModelCustomizationJobResult stopModelCustomizationJob(StopModelCustomizationJobRequest stopModelCustomizationJobRequest)

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

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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

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

UpdateProvisionedModelThroughputResult updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest updateProvisionedModelThroughputRequest)

Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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