Interface BedrockAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Describes the API operations for creating and managing Bedrock models.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic BedrockAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aBedrockAsyncClient
.static BedrockAsyncClient
create()
Create aBedrockAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createModelCustomizationJob
(Consumer<CreateModelCustomizationJobRequest.Builder> createModelCustomizationJobRequest) Creates a fine-tuning job to customize a base model.createModelCustomizationJob
(CreateModelCustomizationJobRequest createModelCustomizationJobRequest) Creates a fine-tuning job to customize a base model.createProvisionedModelThroughput
(Consumer<CreateProvisionedModelThroughputRequest.Builder> createProvisionedModelThroughputRequest) Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.createProvisionedModelThroughput
(CreateProvisionedModelThroughputRequest createProvisionedModelThroughputRequest) Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.deleteCustomModel
(Consumer<DeleteCustomModelRequest.Builder> deleteCustomModelRequest) Deletes a custom model that you created earlier.deleteCustomModel
(DeleteCustomModelRequest deleteCustomModelRequest) Deletes a custom model that you created earlier.deleteModelInvocationLoggingConfiguration
(Consumer<DeleteModelInvocationLoggingConfigurationRequest.Builder> deleteModelInvocationLoggingConfigurationRequest) Delete the invocation logging.deleteModelInvocationLoggingConfiguration
(DeleteModelInvocationLoggingConfigurationRequest deleteModelInvocationLoggingConfigurationRequest) Delete the invocation logging.deleteProvisionedModelThroughput
(Consumer<DeleteProvisionedModelThroughputRequest.Builder> deleteProvisionedModelThroughputRequest) Deletes a provisioned throughput.deleteProvisionedModelThroughput
(DeleteProvisionedModelThroughputRequest deleteProvisionedModelThroughputRequest) Deletes a provisioned throughput.default CompletableFuture
<GetCustomModelResponse> getCustomModel
(Consumer<GetCustomModelRequest.Builder> getCustomModelRequest) Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.default CompletableFuture
<GetCustomModelResponse> getCustomModel
(GetCustomModelRequest getCustomModelRequest) Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.getFoundationModel
(Consumer<GetFoundationModelRequest.Builder> getFoundationModelRequest) Get details about a Bedrock foundation model.getFoundationModel
(GetFoundationModelRequest getFoundationModelRequest) Get details about a Bedrock foundation model.getModelCustomizationJob
(Consumer<GetModelCustomizationJobRequest.Builder> getModelCustomizationJobRequest) Retrieves the properties associated with a model-customization job, including the status of the job.getModelCustomizationJob
(GetModelCustomizationJobRequest getModelCustomizationJobRequest) Retrieves the properties associated with a model-customization job, including the status of the job.getModelInvocationLoggingConfiguration
(Consumer<GetModelInvocationLoggingConfigurationRequest.Builder> getModelInvocationLoggingConfigurationRequest) Get the current configuration values for model invocation logging.getModelInvocationLoggingConfiguration
(GetModelInvocationLoggingConfigurationRequest getModelInvocationLoggingConfigurationRequest) Get the current configuration values for model invocation logging.getProvisionedModelThroughput
(Consumer<GetProvisionedModelThroughputRequest.Builder> getProvisionedModelThroughputRequest) Get details for a provisioned throughput.getProvisionedModelThroughput
(GetProvisionedModelThroughputRequest getProvisionedModelThroughputRequest) Get details for a provisioned throughput.listCustomModels
(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest) Returns a list of the custom models that you have created with theCreateModelCustomizationJob
operation.listCustomModels
(ListCustomModelsRequest listCustomModelsRequest) Returns a list of the custom models that you have created with theCreateModelCustomizationJob
operation.default ListCustomModelsPublisher
listCustomModelsPaginator
(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest) Returns a list of the custom models that you have created with theCreateModelCustomizationJob
operation.default ListCustomModelsPublisher
listCustomModelsPaginator
(ListCustomModelsRequest listCustomModelsRequest) Returns a list of the custom models that you have created with theCreateModelCustomizationJob
operation.listFoundationModels
(Consumer<ListFoundationModelsRequest.Builder> listFoundationModelsRequest) List of Bedrock foundation models that you can use.listFoundationModels
(ListFoundationModelsRequest listFoundationModelsRequest) List of Bedrock foundation models that you can use.listModelCustomizationJobs
(Consumer<ListModelCustomizationJobsRequest.Builder> listModelCustomizationJobsRequest) Returns a list of model customization jobs that you have submitted.listModelCustomizationJobs
(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest) Returns a list of model customization jobs that you have submitted.listModelCustomizationJobsPaginator
(Consumer<ListModelCustomizationJobsRequest.Builder> listModelCustomizationJobsRequest) Returns a list of model customization jobs that you have submitted.listModelCustomizationJobsPaginator
(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest) Returns a list of model customization jobs that you have submitted.listProvisionedModelThroughputs
(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) List the provisioned capacities.listProvisionedModelThroughputs
(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) List the provisioned capacities.listProvisionedModelThroughputsPaginator
(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) List the provisioned capacities.listProvisionedModelThroughputsPaginator
(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) List the provisioned capacities.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags associated with the specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags associated with the specified resource.putModelInvocationLoggingConfiguration
(Consumer<PutModelInvocationLoggingConfigurationRequest.Builder> putModelInvocationLoggingConfigurationRequest) Set the configuration values for model invocation logging.putModelInvocationLoggingConfiguration
(PutModelInvocationLoggingConfigurationRequest putModelInvocationLoggingConfigurationRequest) Set the configuration values for model invocation logging.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstopModelCustomizationJob
(Consumer<StopModelCustomizationJobRequest.Builder> stopModelCustomizationJobRequest) Stops an active model customization job.stopModelCustomizationJob
(StopModelCustomizationJobRequest stopModelCustomizationJobRequest) Stops an active model customization job.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associate tags with a resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Associate tags with a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove one or more tags from a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Remove one or more tags from a resource.updateProvisionedModelThroughput
(Consumer<UpdateProvisionedModelThroughputRequest.Builder> updateProvisionedModelThroughputRequest) Update a provisioned throughput.updateProvisionedModelThroughput
(UpdateProvisionedModelThroughputRequest updateProvisionedModelThroughputRequest) Update a provisioned throughput.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createModelCustomizationJob
default CompletableFuture<CreateModelCustomizationJobResponse> 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. 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:
- A Java Future containing the result of the CreateModelCustomizationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createModelCustomizationJob
default CompletableFuture<CreateModelCustomizationJobResponse> createModelCustomizationJob(Consumer<CreateModelCustomizationJobRequest.Builder> 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. 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.
This is a convenience which creates an instance of the
CreateModelCustomizationJobRequest.Builder
avoiding the need to create one manually viaCreateModelCustomizationJobRequest.builder()
- Parameters:
createModelCustomizationJobRequest
- AConsumer
that will call methods onCreateModelCustomizationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateModelCustomizationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProvisionedModelThroughput
default CompletableFuture<CreateProvisionedModelThroughputResponse> 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:
- A Java Future containing the result of the CreateProvisionedModelThroughput operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProvisionedModelThroughput
default CompletableFuture<CreateProvisionedModelThroughputResponse> createProvisionedModelThroughput(Consumer<CreateProvisionedModelThroughputRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateProvisionedModelThroughputRequest.Builder
avoiding the need to create one manually viaCreateProvisionedModelThroughputRequest.builder()
- Parameters:
createProvisionedModelThroughputRequest
- AConsumer
that will call methods onCreateProvisionedModelThroughputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProvisionedModelThroughput operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomModel
default CompletableFuture<DeleteCustomModelResponse> 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:
- A Java Future containing the result of the DeleteCustomModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCustomModel
default CompletableFuture<DeleteCustomModelResponse> deleteCustomModel(Consumer<DeleteCustomModelRequest.Builder> deleteCustomModelRequest) Deletes a custom model that you created earlier. For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the
DeleteCustomModelRequest.Builder
avoiding the need to create one manually viaDeleteCustomModelRequest.builder()
- Parameters:
deleteCustomModelRequest
- AConsumer
that will call methods onDeleteCustomModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCustomModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteModelInvocationLoggingConfiguration
default CompletableFuture<DeleteModelInvocationLoggingConfigurationResponse> deleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest deleteModelInvocationLoggingConfigurationRequest) Delete the invocation logging.
- Parameters:
deleteModelInvocationLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteModelInvocationLoggingConfiguration operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteModelInvocationLoggingConfiguration
default CompletableFuture<DeleteModelInvocationLoggingConfigurationResponse> deleteModelInvocationLoggingConfiguration(Consumer<DeleteModelInvocationLoggingConfigurationRequest.Builder> deleteModelInvocationLoggingConfigurationRequest) Delete the invocation logging.
This is a convenience which creates an instance of the
DeleteModelInvocationLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteModelInvocationLoggingConfigurationRequest.builder()
- Parameters:
deleteModelInvocationLoggingConfigurationRequest
- AConsumer
that will call methods onDeleteModelInvocationLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteModelInvocationLoggingConfiguration operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProvisionedModelThroughput
default CompletableFuture<DeleteProvisionedModelThroughputResponse> deleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest deleteProvisionedModelThroughputRequest) Deletes a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
- Parameters:
deleteProvisionedModelThroughputRequest
-- Returns:
- A Java Future containing the result of the DeleteProvisionedModelThroughput operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProvisionedModelThroughput
default CompletableFuture<DeleteProvisionedModelThroughputResponse> deleteProvisionedModelThroughput(Consumer<DeleteProvisionedModelThroughputRequest.Builder> deleteProvisionedModelThroughputRequest) Deletes a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the
DeleteProvisionedModelThroughputRequest.Builder
avoiding the need to create one manually viaDeleteProvisionedModelThroughputRequest.builder()
- Parameters:
deleteProvisionedModelThroughputRequest
- AConsumer
that will call methods onDeleteProvisionedModelThroughputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProvisionedModelThroughput operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCustomModel
default CompletableFuture<GetCustomModelResponse> getCustomModel(GetCustomModelRequest getCustomModelRequest) Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
- Parameters:
getCustomModelRequest
-- Returns:
- A Java Future containing the result of the GetCustomModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCustomModel
default CompletableFuture<GetCustomModelResponse> getCustomModel(Consumer<GetCustomModelRequest.Builder> getCustomModelRequest) Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the
GetCustomModelRequest.Builder
avoiding the need to create one manually viaGetCustomModelRequest.builder()
- Parameters:
getCustomModelRequest
- AConsumer
that will call methods onGetCustomModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCustomModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFoundationModel
default CompletableFuture<GetFoundationModelResponse> getFoundationModel(GetFoundationModelRequest getFoundationModelRequest) Get details about a Bedrock foundation model.
- Parameters:
getFoundationModelRequest
-- Returns:
- A Java Future containing the result of the GetFoundationModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getFoundationModel
default CompletableFuture<GetFoundationModelResponse> getFoundationModel(Consumer<GetFoundationModelRequest.Builder> getFoundationModelRequest) Get details about a Bedrock foundation model.
This is a convenience which creates an instance of the
GetFoundationModelRequest.Builder
avoiding the need to create one manually viaGetFoundationModelRequest.builder()
- Parameters:
getFoundationModelRequest
- AConsumer
that will call methods onGetFoundationModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetFoundationModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getModelCustomizationJob
default CompletableFuture<GetModelCustomizationJobResponse> 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:
- A Java Future containing the result of the GetModelCustomizationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getModelCustomizationJob
default CompletableFuture<GetModelCustomizationJobResponse> getModelCustomizationJob(Consumer<GetModelCustomizationJobRequest.Builder> 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.
This is a convenience which creates an instance of the
GetModelCustomizationJobRequest.Builder
avoiding the need to create one manually viaGetModelCustomizationJobRequest.builder()
- Parameters:
getModelCustomizationJobRequest
- AConsumer
that will call methods onGetModelCustomizationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetModelCustomizationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getModelInvocationLoggingConfiguration
default CompletableFuture<GetModelInvocationLoggingConfigurationResponse> getModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest getModelInvocationLoggingConfigurationRequest) Get the current configuration values for model invocation logging.
- Parameters:
getModelInvocationLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the GetModelInvocationLoggingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getModelInvocationLoggingConfiguration
default CompletableFuture<GetModelInvocationLoggingConfigurationResponse> getModelInvocationLoggingConfiguration(Consumer<GetModelInvocationLoggingConfigurationRequest.Builder> getModelInvocationLoggingConfigurationRequest) Get the current configuration values for model invocation logging.
This is a convenience which creates an instance of the
GetModelInvocationLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaGetModelInvocationLoggingConfigurationRequest.builder()
- Parameters:
getModelInvocationLoggingConfigurationRequest
- AConsumer
that will call methods onGetModelInvocationLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetModelInvocationLoggingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProvisionedModelThroughput
default CompletableFuture<GetProvisionedModelThroughputResponse> getProvisionedModelThroughput(GetProvisionedModelThroughputRequest getProvisionedModelThroughputRequest) Get details for a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
- Parameters:
getProvisionedModelThroughputRequest
-- Returns:
- A Java Future containing the result of the GetProvisionedModelThroughput operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProvisionedModelThroughput
default CompletableFuture<GetProvisionedModelThroughputResponse> getProvisionedModelThroughput(Consumer<GetProvisionedModelThroughputRequest.Builder> getProvisionedModelThroughputRequest) Get details for a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the
GetProvisionedModelThroughputRequest.Builder
avoiding the need to create one manually viaGetProvisionedModelThroughputRequest.builder()
- Parameters:
getProvisionedModelThroughputRequest
- AConsumer
that will call methods onGetProvisionedModelThroughputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProvisionedModelThroughput operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomModels
default CompletableFuture<ListCustomModelsResponse> 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:
- A Java Future containing the result of the ListCustomModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomModels
default CompletableFuture<ListCustomModelsResponse> listCustomModels(Consumer<ListCustomModelsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListCustomModelsRequest.Builder
avoiding the need to create one manually viaListCustomModelsRequest.builder()
- Parameters:
listCustomModelsRequest
- AConsumer
that will call methods onListCustomModelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListCustomModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomModelsPaginator
default ListCustomModelsPublisher listCustomModelsPaginator(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.
This is a variant of
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.bedrock.paginators.ListCustomModelsPublisher publisher = client.listCustomModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.bedrock.paginators.ListCustomModelsPublisher publisher = client.listCustomModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListCustomModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListCustomModelsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)
operation.- Parameters:
listCustomModelsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listCustomModelsPaginator
default ListCustomModelsPublisher listCustomModelsPaginator(Consumer<ListCustomModelsRequest.Builder> 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.
This is a variant of
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.bedrock.paginators.ListCustomModelsPublisher publisher = client.listCustomModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.bedrock.paginators.ListCustomModelsPublisher publisher = client.listCustomModelsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListCustomModelsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListCustomModelsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)
operation.This is a convenience which creates an instance of the
ListCustomModelsRequest.Builder
avoiding the need to create one manually viaListCustomModelsRequest.builder()
- Parameters:
listCustomModelsRequest
- AConsumer
that will call methods onListCustomModelsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFoundationModels
default CompletableFuture<ListFoundationModelsResponse> listFoundationModels(ListFoundationModelsRequest listFoundationModelsRequest) List of Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.
- Parameters:
listFoundationModelsRequest
-- Returns:
- A Java Future containing the result of the ListFoundationModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFoundationModels
default CompletableFuture<ListFoundationModelsResponse> listFoundationModels(Consumer<ListFoundationModelsRequest.Builder> listFoundationModelsRequest) List of Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.
This is a convenience which creates an instance of the
ListFoundationModelsRequest.Builder
avoiding the need to create one manually viaListFoundationModelsRequest.builder()
- Parameters:
listFoundationModelsRequest
- AConsumer
that will call methods onListFoundationModelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListFoundationModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listModelCustomizationJobs
default CompletableFuture<ListModelCustomizationJobsResponse> 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:
- A Java Future containing the result of the ListModelCustomizationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listModelCustomizationJobs
default CompletableFuture<ListModelCustomizationJobsResponse> listModelCustomizationJobs(Consumer<ListModelCustomizationJobsRequest.Builder> 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.
This is a convenience which creates an instance of the
ListModelCustomizationJobsRequest.Builder
avoiding the need to create one manually viaListModelCustomizationJobsRequest.builder()
- Parameters:
listModelCustomizationJobsRequest
- AConsumer
that will call methods onListModelCustomizationJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListModelCustomizationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listModelCustomizationJobsPaginator
default ListModelCustomizationJobsPublisher listModelCustomizationJobsPaginator(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.
This is a variant of
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsPublisher publisher = client.listModelCustomizationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsPublisher publisher = client.listModelCustomizationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)
operation.- Parameters:
listModelCustomizationJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listModelCustomizationJobsPaginator
default ListModelCustomizationJobsPublisher listModelCustomizationJobsPaginator(Consumer<ListModelCustomizationJobsRequest.Builder> 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.
This is a variant of
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsPublisher publisher = client.listModelCustomizationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsPublisher publisher = client.listModelCustomizationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)
operation.This is a convenience which creates an instance of the
ListModelCustomizationJobsRequest.Builder
avoiding the need to create one manually viaListModelCustomizationJobsRequest.builder()
- Parameters:
listModelCustomizationJobsRequest
- AConsumer
that will call methods onListModelCustomizationJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProvisionedModelThroughputs
default CompletableFuture<ListProvisionedModelThroughputsResponse> listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
- Parameters:
listProvisionedModelThroughputsRequest
-- Returns:
- A Java Future containing the result of the ListProvisionedModelThroughputs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProvisionedModelThroughputs
default CompletableFuture<ListProvisionedModelThroughputsResponse> listProvisionedModelThroughputs(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the
ListProvisionedModelThroughputsRequest.Builder
avoiding the need to create one manually viaListProvisionedModelThroughputsRequest.builder()
- Parameters:
listProvisionedModelThroughputsRequest
- AConsumer
that will call methods onListProvisionedModelThroughputsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProvisionedModelThroughputs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProvisionedModelThroughputsPaginator
default ListProvisionedModelThroughputsPublisher listProvisionedModelThroughputsPaginator(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a variant of
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsPublisher publisher = client.listProvisionedModelThroughputsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsPublisher publisher = client.listProvisionedModelThroughputsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)
operation.- Parameters:
listProvisionedModelThroughputsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProvisionedModelThroughputsPaginator
default ListProvisionedModelThroughputsPublisher listProvisionedModelThroughputsPaginator(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a variant of
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsPublisher publisher = client.listProvisionedModelThroughputsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsPublisher publisher = client.listProvisionedModelThroughputsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)
operation.This is a convenience which creates an instance of the
ListProvisionedModelThroughputsRequest.Builder
avoiding the need to create one manually viaListProvisionedModelThroughputsRequest.builder()
- Parameters:
listProvisionedModelThroughputsRequest
- AConsumer
that will call methods onListProvisionedModelThroughputsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> 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:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags associated with the specified resource.
For more information, see Tagging resources in the Bedrock User Guide.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putModelInvocationLoggingConfiguration
default CompletableFuture<PutModelInvocationLoggingConfigurationResponse> putModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest putModelInvocationLoggingConfigurationRequest) Set the configuration values for model invocation logging.
- Parameters:
putModelInvocationLoggingConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutModelInvocationLoggingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putModelInvocationLoggingConfiguration
default CompletableFuture<PutModelInvocationLoggingConfigurationResponse> putModelInvocationLoggingConfiguration(Consumer<PutModelInvocationLoggingConfigurationRequest.Builder> putModelInvocationLoggingConfigurationRequest) Set the configuration values for model invocation logging.
This is a convenience which creates an instance of the
PutModelInvocationLoggingConfigurationRequest.Builder
avoiding the need to create one manually viaPutModelInvocationLoggingConfigurationRequest.builder()
- Parameters:
putModelInvocationLoggingConfigurationRequest
- AConsumer
that will call methods onPutModelInvocationLoggingConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutModelInvocationLoggingConfiguration operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopModelCustomizationJob
default CompletableFuture<StopModelCustomizationJobResponse> stopModelCustomizationJob(StopModelCustomizationJobRequest stopModelCustomizationJobRequest) Stops an active model customization job. For more information, see Custom models in the Bedrock User Guide.
- Parameters:
stopModelCustomizationJobRequest
-- Returns:
- A Java Future containing the result of the StopModelCustomizationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopModelCustomizationJob
default CompletableFuture<StopModelCustomizationJobResponse> stopModelCustomizationJob(Consumer<StopModelCustomizationJobRequest.Builder> stopModelCustomizationJobRequest) Stops an active model customization job. For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the
StopModelCustomizationJobRequest.Builder
avoiding the need to create one manually viaStopModelCustomizationJobRequest.builder()
- Parameters:
stopModelCustomizationJobRequest
- AConsumer
that will call methods onStopModelCustomizationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopModelCustomizationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Associate tags with a resource. For more information, see Tagging resources in the Bedrock User Guide.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associate tags with a resource. For more information, see Tagging resources in the Bedrock User Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> 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:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove one or more tags from a resource. For more information, see Tagging resources in the Bedrock User Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProvisionedModelThroughput
default CompletableFuture<UpdateProvisionedModelThroughputResponse> updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest updateProvisionedModelThroughputRequest) Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
- Parameters:
updateProvisionedModelThroughputRequest
-- Returns:
- A Java Future containing the result of the UpdateProvisionedModelThroughput operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProvisionedModelThroughput
default CompletableFuture<UpdateProvisionedModelThroughputResponse> updateProvisionedModelThroughput(Consumer<UpdateProvisionedModelThroughputRequest.Builder> updateProvisionedModelThroughputRequest) Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the
UpdateProvisionedModelThroughputRequest.Builder
avoiding the need to create one manually viaUpdateProvisionedModelThroughputRequest.builder()
- Parameters:
updateProvisionedModelThroughputRequest
- AConsumer
that will call methods onUpdateProvisionedModelThroughputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProvisionedModelThroughput operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- BedrockException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aBedrockAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aBedrockAsyncClient
.
-