Interface BedrockAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic BedrockAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aBedrockAsyncClient.static BedrockAsyncClientcreate()Create aBedrockAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createEvaluationJob(Consumer<CreateEvaluationJobRequest.Builder> createEvaluationJobRequest) API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.createEvaluationJob(CreateEvaluationJobRequest createEvaluationJobRequest) API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers.default CompletableFuture<CreateGuardrailResponse> createGuardrail(Consumer<CreateGuardrailRequest.Builder> createGuardrailRequest) Creates a guardrail to block topics and to implement safeguards for your generative AI applications.default CompletableFuture<CreateGuardrailResponse> createGuardrail(CreateGuardrailRequest createGuardrailRequest) Creates a guardrail to block topics and to implement safeguards for your generative AI applications.createGuardrailVersion(Consumer<CreateGuardrailVersionRequest.Builder> createGuardrailVersionRequest) Creates a version of the guardrail.createGuardrailVersion(CreateGuardrailVersionRequest createGuardrailVersionRequest) Creates a version of the guardrail.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 dedicated throughput for a base or custom model with the model units and for the duration that you specify.createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest createProvisionedModelThroughputRequest) Creates dedicated throughput for a base or custom model with the model units and for the duration that you specify.deleteCustomModel(Consumer<DeleteCustomModelRequest.Builder> deleteCustomModelRequest) Deletes a custom model that you created earlier.deleteCustomModel(DeleteCustomModelRequest deleteCustomModelRequest) Deletes a custom model that you created earlier.default CompletableFuture<DeleteGuardrailResponse> deleteGuardrail(Consumer<DeleteGuardrailRequest.Builder> deleteGuardrailRequest) Deletes a guardrail.default CompletableFuture<DeleteGuardrailResponse> deleteGuardrail(DeleteGuardrailRequest deleteGuardrailRequest) Deletes a guardrail.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 Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.default CompletableFuture<GetCustomModelResponse> getCustomModel(GetCustomModelRequest getCustomModelRequest) Get the properties associated with a Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.getEvaluationJob(Consumer<GetEvaluationJobRequest.Builder> getEvaluationJobRequest) Retrieves the properties associated with a model evaluation job, including the status of the job.getEvaluationJob(GetEvaluationJobRequest getEvaluationJobRequest) Retrieves the properties associated with a model evaluation job, including the status of the job.getFoundationModel(Consumer<GetFoundationModelRequest.Builder> getFoundationModelRequest) Get details about a Amazon Bedrock foundation model.getFoundationModel(GetFoundationModelRequest getFoundationModelRequest) Get details about a Amazon Bedrock foundation model.default CompletableFuture<GetGuardrailResponse> getGuardrail(Consumer<GetGuardrailRequest.Builder> getGuardrailRequest) Gets details about a guardrail.default CompletableFuture<GetGuardrailResponse> getGuardrail(GetGuardrailRequest getGuardrailRequest) Gets details about a guardrail.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) Returns details for a Provisioned Throughput.getProvisionedModelThroughput(GetProvisionedModelThroughputRequest getProvisionedModelThroughputRequest) Returns details for a Provisioned Throughput.listCustomModels(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest) Returns a list of the custom models that you have created with theCreateModelCustomizationJoboperation.listCustomModels(ListCustomModelsRequest listCustomModelsRequest) Returns a list of the custom models that you have created with theCreateModelCustomizationJoboperation.default ListCustomModelsPublisherlistCustomModelsPaginator(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest) This is a variant oflistCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)operation.default ListCustomModelsPublisherlistCustomModelsPaginator(ListCustomModelsRequest listCustomModelsRequest) This is a variant oflistCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest)operation.listEvaluationJobs(Consumer<ListEvaluationJobsRequest.Builder> listEvaluationJobsRequest) Lists model evaluation jobs.listEvaluationJobs(ListEvaluationJobsRequest listEvaluationJobsRequest) Lists model evaluation jobs.default ListEvaluationJobsPublisherlistEvaluationJobsPaginator(Consumer<ListEvaluationJobsRequest.Builder> listEvaluationJobsRequest) This is a variant oflistEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation.default ListEvaluationJobsPublisherlistEvaluationJobsPaginator(ListEvaluationJobsRequest listEvaluationJobsRequest) This is a variant oflistEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation.listFoundationModels(Consumer<ListFoundationModelsRequest.Builder> listFoundationModelsRequest) Lists Amazon Bedrock foundation models that you can use.listFoundationModels(ListFoundationModelsRequest listFoundationModelsRequest) Lists Amazon Bedrock foundation models that you can use.default CompletableFuture<ListGuardrailsResponse> listGuardrails(Consumer<ListGuardrailsRequest.Builder> listGuardrailsRequest) Lists details about all the guardrails in an account.default CompletableFuture<ListGuardrailsResponse> listGuardrails(ListGuardrailsRequest listGuardrailsRequest) Lists details about all the guardrails in an account.default ListGuardrailsPublisherlistGuardrailsPaginator(Consumer<ListGuardrailsRequest.Builder> listGuardrailsRequest) This is a variant oflistGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation.default ListGuardrailsPublisherlistGuardrailsPaginator(ListGuardrailsRequest listGuardrailsRequest) This is a variant oflistGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation.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) This is a variant oflistModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)operation.listModelCustomizationJobsPaginator(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest) This is a variant oflistModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)operation.listProvisionedModelThroughputs(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) Lists the Provisioned Throughputs in the account.listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) Lists the Provisioned Throughputs in the account.listProvisionedModelThroughputsPaginator(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest) This is a variant oflistProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)operation.listProvisionedModelThroughputsPaginator(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest) This is a variant oflistProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)operation.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., ClientOverrideConfigurationstopEvaluationJob(Consumer<StopEvaluationJobRequest.Builder> stopEvaluationJobRequest) Stops an in progress model evaluation job.stopEvaluationJob(StopEvaluationJobRequest stopEvaluationJobRequest) Stops an in progress model evaluation job.stopModelCustomizationJob(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.default CompletableFuture<UpdateGuardrailResponse> updateGuardrail(Consumer<UpdateGuardrailRequest.Builder> updateGuardrailRequest) Updates a guardrail with the values you specify.default CompletableFuture<UpdateGuardrailResponse> updateGuardrail(UpdateGuardrailRequest updateGuardrailRequest) Updates a guardrail with the values you specify.updateProvisionedModelThroughput(Consumer<UpdateProvisionedModelThroughputRequest.Builder> updateProvisionedModelThroughputRequest) Updates the name or associated model for a Provisioned Throughput.updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest updateProvisionedModelThroughputRequest) Updates the name or associated model for a Provisioned Throughput.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
-
createEvaluationJob
default CompletableFuture<CreateEvaluationJobResponse> createEvaluationJob(CreateEvaluationJobRequest createEvaluationJobRequest) API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluations.
- Parameters:
createEvaluationJobRequest-- Returns:
- A Java Future containing the result of the CreateEvaluationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
createEvaluationJob
default CompletableFuture<CreateEvaluationJobResponse> createEvaluationJob(Consumer<CreateEvaluationJobRequest.Builder> createEvaluationJobRequest) API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, Model evaluations.
This is a convenience which creates an instance of the
CreateEvaluationJobRequest.Builderavoiding the need to create one manually viaCreateEvaluationJobRequest.builder()- Parameters:
createEvaluationJobRequest- AConsumerthat will call methods onCreateEvaluationJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateEvaluationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
createGuardrail
default CompletableFuture<CreateGuardrailResponse> createGuardrail(CreateGuardrailRequest createGuardrailRequest) Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
-
Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
-
Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
-
Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
-
Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
For more information, see Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
createGuardrailRequest-- Returns:
- A Java Future containing the result of the CreateGuardrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
-
createGuardrail
default CompletableFuture<CreateGuardrailResponse> createGuardrail(Consumer<CreateGuardrailRequest.Builder> createGuardrailRequest) Creates a guardrail to block topics and to implement safeguards for your generative AI applications.
You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.
-
Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
-
Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
-
Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
-
Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.
In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.
For more information, see Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreateGuardrailRequest.Builderavoiding the need to create one manually viaCreateGuardrailRequest.builder()- Parameters:
createGuardrailRequest- AConsumerthat will call methods onCreateGuardrailRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateGuardrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
-
createGuardrailVersion
default CompletableFuture<CreateGuardrailVersionResponse> createGuardrailVersion(CreateGuardrailVersionRequest createGuardrailVersionRequest) Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
- Parameters:
createGuardrailVersionRequest-- Returns:
- A Java Future containing the result of the CreateGuardrailVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
createGuardrailVersion
default CompletableFuture<CreateGuardrailVersionResponse> createGuardrailVersion(Consumer<CreateGuardrailVersionRequest.Builder> createGuardrailVersionRequest) Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.
This is a convenience which creates an instance of the
CreateGuardrailVersionRequest.Builderavoiding the need to create one manually viaCreateGuardrailVersionRequest.builder()- Parameters:
createGuardrailVersionRequest- AConsumerthat will call methods onCreateGuardrailVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateGuardrailVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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(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. Amazon Bedrock returns validation loss metrics and output generations after the job completes.
For information on the format of training and validation data, see Prepare the datasets.
Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the
GetModelCustomizationJoboperation to retrieve the job status.For more information, see Custom models in the Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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. Amazon Bedrock returns validation loss metrics and output generations after the job completes.
For information on the format of training and validation data, see Prepare the datasets.
Model-customization jobs are asynchronous and the completion time depends on the base model and the training/validation data size. To monitor a job, use the
GetModelCustomizationJoboperation to retrieve the job status.For more information, see Custom models in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreateModelCustomizationJobRequest.Builderavoiding the need to create one manually viaCreateModelCustomizationJobRequest.builder()- Parameters:
createModelCustomizationJobRequest- AConsumerthat will call methods onCreateModelCustomizationJobRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 dedicated throughput for a base or custom model with the model units and for the duration that you specify. For pricing details, see Amazon Bedrock Pricing. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreateProvisionedModelThroughputRequest.Builderavoiding the need to create one manually viaCreateProvisionedModelThroughputRequest.builder()- Parameters:
createProvisionedModelThroughputRequest- AConsumerthat will call methods onCreateProvisionedModelThroughputRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
DeleteCustomModelRequest.Builderavoiding the need to create one manually viaDeleteCustomModelRequest.builder()- Parameters:
deleteCustomModelRequest- AConsumerthat will call methods onDeleteCustomModelRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
deleteGuardrail
default CompletableFuture<DeleteGuardrailResponse> deleteGuardrail(DeleteGuardrailRequest deleteGuardrailRequest) Deletes a guardrail.
-
To delete a guardrail, only specify the ARN of the guardrail in the
guardrailIdentifierfield. If you delete a guardrail, all of its versions will be deleted. -
To delete a version of a guardrail, specify the ARN of the guardrail in the
guardrailIdentifierfield and the version in theguardrailVersionfield.
- Parameters:
deleteGuardrailRequest-- Returns:
- A Java Future containing the result of the DeleteGuardrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
-
deleteGuardrail
default CompletableFuture<DeleteGuardrailResponse> deleteGuardrail(Consumer<DeleteGuardrailRequest.Builder> deleteGuardrailRequest) Deletes a guardrail.
-
To delete a guardrail, only specify the ARN of the guardrail in the
guardrailIdentifierfield. If you delete a guardrail, all of its versions will be deleted. -
To delete a version of a guardrail, specify the ARN of the guardrail in the
guardrailIdentifierfield and the version in theguardrailVersionfield.
This is a convenience which creates an instance of the
DeleteGuardrailRequest.Builderavoiding the need to create one manually viaDeleteGuardrailRequest.builder()- Parameters:
deleteGuardrailRequest- AConsumerthat will call methods onDeleteGuardrailRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteGuardrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaDeleteModelInvocationLoggingConfigurationRequest.builder()- Parameters:
deleteModelInvocationLoggingConfigurationRequest- AConsumerthat will call methods onDeleteModelInvocationLoggingConfigurationRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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. You can't delete a Provisioned Throughput before the commitment term is over. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
DeleteProvisionedModelThroughputRequest.Builderavoiding the need to create one manually viaDeleteProvisionedModelThroughputRequest.builder()- Parameters:
deleteProvisionedModelThroughputRequest- AConsumerthat will call methods onDeleteProvisionedModelThroughputRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock custom model that you have created.For more information, see Custom models in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetCustomModelRequest.Builderavoiding the need to create one manually viaGetCustomModelRequest.builder()- Parameters:
getCustomModelRequest- AConsumerthat will call methods onGetCustomModelRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
getEvaluationJob
default CompletableFuture<GetEvaluationJobResponse> getEvaluationJob(GetEvaluationJobRequest getEvaluationJobRequest) Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluations.
- Parameters:
getEvaluationJobRequest-- Returns:
- A Java Future containing the result of the GetEvaluationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
getEvaluationJob
default CompletableFuture<GetEvaluationJobResponse> getEvaluationJob(Consumer<GetEvaluationJobRequest.Builder> getEvaluationJobRequest) Retrieves the properties associated with a model evaluation job, including the status of the job. For more information, see Model evaluations.
This is a convenience which creates an instance of the
GetEvaluationJobRequest.Builderavoiding the need to create one manually viaGetEvaluationJobRequest.builder()- Parameters:
getEvaluationJobRequest- AConsumerthat will call methods onGetEvaluationJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetEvaluationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock foundation model.
This is a convenience which creates an instance of the
GetFoundationModelRequest.Builderavoiding the need to create one manually viaGetFoundationModelRequest.builder()- Parameters:
getFoundationModelRequest- AConsumerthat will call methods onGetFoundationModelRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
getGuardrail
default CompletableFuture<GetGuardrailResponse> getGuardrail(GetGuardrailRequest getGuardrailRequest) Gets details about a guardrail. If you don't specify a version, the response returns details for the
DRAFTversion.- Parameters:
getGuardrailRequest-- Returns:
- A Java Future containing the result of the GetGuardrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
getGuardrail
default CompletableFuture<GetGuardrailResponse> getGuardrail(Consumer<GetGuardrailRequest.Builder> getGuardrailRequest) Gets details about a guardrail. If you don't specify a version, the response returns details for the
DRAFTversion.
This is a convenience which creates an instance of the
GetGuardrailRequest.Builderavoiding the need to create one manually viaGetGuardrailRequest.builder()- Parameters:
getGuardrailRequest- AConsumerthat will call methods onGetGuardrailRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetGuardrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetModelCustomizationJobRequest.Builderavoiding the need to create one manually viaGetModelCustomizationJobRequest.builder()- Parameters:
getModelCustomizationJobRequest- AConsumerthat will call methods onGetModelCustomizationJobRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaGetModelInvocationLoggingConfigurationRequest.builder()- Parameters:
getModelInvocationLoggingConfigurationRequest- AConsumerthat will call methods onGetModelInvocationLoggingConfigurationRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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) Returns details for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetProvisionedModelThroughputRequest.Builderavoiding the need to create one manually viaGetProvisionedModelThroughputRequest.builder()- Parameters:
getProvisionedModelThroughputRequest- AConsumerthat will call methods onGetProvisionedModelThroughputRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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
CreateModelCustomizationJoboperation.For more information, see Custom models in the Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
CreateModelCustomizationJoboperation.For more information, see Custom models in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListCustomModelsRequest.Builderavoiding the need to create one manually viaListCustomModelsRequest.builder()- Parameters:
listCustomModelsRequest- AConsumerthat will call methods onListCustomModelsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListCustomModelsPublisher publisher = client.listCustomModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListCustomModelsPublisher publisher = client.listCustomModelsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListCustomModelsRequest.builder()- Parameters:
listCustomModelsRequest- AConsumerthat will call methods onListCustomModelsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listEvaluationJobs
default CompletableFuture<ListEvaluationJobsResponse> listEvaluationJobs(ListEvaluationJobsRequest listEvaluationJobsRequest) Lists model evaluation jobs.
- Parameters:
listEvaluationJobsRequest-- Returns:
- A Java Future containing the result of the ListEvaluationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listEvaluationJobs
default CompletableFuture<ListEvaluationJobsResponse> listEvaluationJobs(Consumer<ListEvaluationJobsRequest.Builder> listEvaluationJobsRequest) Lists model evaluation jobs.
This is a convenience which creates an instance of the
ListEvaluationJobsRequest.Builderavoiding the need to create one manually viaListEvaluationJobsRequest.builder()- Parameters:
listEvaluationJobsRequest- AConsumerthat will call methods onListEvaluationJobsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListEvaluationJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listEvaluationJobsPaginator
default ListEvaluationJobsPublisher listEvaluationJobsPaginator(ListEvaluationJobsRequest listEvaluationJobsRequest) This is a variant of
listEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsPublisher publisher = client.listEvaluationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsPublisher publisher = client.listEvaluationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsResponse 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
listEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation.- Parameters:
listEvaluationJobsRequest-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listEvaluationJobsPaginator
default ListEvaluationJobsPublisher listEvaluationJobsPaginator(Consumer<ListEvaluationJobsRequest.Builder> listEvaluationJobsRequest) This is a variant of
listEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsPublisher publisher = client.listEvaluationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.bedrock.paginators.ListEvaluationJobsPublisher publisher = client.listEvaluationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsResponse 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
listEvaluationJobs(software.amazon.awssdk.services.bedrock.model.ListEvaluationJobsRequest)operation.
This is a convenience which creates an instance of the
ListEvaluationJobsRequest.Builderavoiding the need to create one manually viaListEvaluationJobsRequest.builder()- Parameters:
listEvaluationJobsRequest- AConsumerthat will call methods onListEvaluationJobsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Lists Amazon Bedrock foundation models that you can use. You can filter the results with the request parameters. For more information, see Foundation models in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListFoundationModelsRequest.Builderavoiding the need to create one manually viaListFoundationModelsRequest.builder()- Parameters:
listFoundationModelsRequest- AConsumerthat will call methods onListFoundationModelsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listGuardrails
default CompletableFuture<ListGuardrailsResponse> listGuardrails(ListGuardrailsRequest listGuardrailsRequest) Lists details about all the guardrails in an account. To list the
DRAFTversion of all your guardrails, don't specify theguardrailIdentifierfield. To list all versions of a guardrail, specify the ARN of the guardrail in theguardrailIdentifierfield.You can set the maximum number of results to return in a response in the
maxResultsfield. If there are more results than the number you set, the response returns anextTokenthat you can send in anotherListGuardrailsrequest to see the next batch of results.- Parameters:
listGuardrailsRequest-- Returns:
- A Java Future containing the result of the ListGuardrails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
listGuardrails
default CompletableFuture<ListGuardrailsResponse> listGuardrails(Consumer<ListGuardrailsRequest.Builder> listGuardrailsRequest) Lists details about all the guardrails in an account. To list the
DRAFTversion of all your guardrails, don't specify theguardrailIdentifierfield. To list all versions of a guardrail, specify the ARN of the guardrail in theguardrailIdentifierfield.You can set the maximum number of results to return in a response in the
maxResultsfield. If there are more results than the number you set, the response returns anextTokenthat you can send in anotherListGuardrailsrequest to see the next batch of results.
This is a convenience which creates an instance of the
ListGuardrailsRequest.Builderavoiding the need to create one manually viaListGuardrailsRequest.builder()- Parameters:
listGuardrailsRequest- AConsumerthat will call methods onListGuardrailsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListGuardrails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
listGuardrailsPaginator
default ListGuardrailsPublisher listGuardrailsPaginator(ListGuardrailsRequest listGuardrailsRequest) This is a variant of
listGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListGuardrailsPublisher publisher = client.listGuardrailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.bedrock.paginators.ListGuardrailsPublisher publisher = client.listGuardrailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListGuardrailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListGuardrailsResponse 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
listGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation.- Parameters:
listGuardrailsRequest-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
listGuardrailsPaginator
default ListGuardrailsPublisher listGuardrailsPaginator(Consumer<ListGuardrailsRequest.Builder> listGuardrailsRequest) This is a variant of
listGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListGuardrailsPublisher publisher = client.listGuardrailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.bedrock.paginators.ListGuardrailsPublisher publisher = client.listGuardrailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrock.model.ListGuardrailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.bedrock.model.ListGuardrailsResponse 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
listGuardrails(software.amazon.awssdk.services.bedrock.model.ListGuardrailsRequest)operation.
This is a convenience which creates an instance of the
ListGuardrailsRequest.Builderavoiding the need to create one manually viaListGuardrailsRequest.builder()- Parameters:
listGuardrailsRequest- AConsumerthat will call methods onListGuardrailsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListModelCustomizationJobsRequest.Builderavoiding the need to create one manually viaListModelCustomizationJobsRequest.builder()- Parameters:
listModelCustomizationJobsRequest- AConsumerthat will call methods onListModelCustomizationJobsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsPublisher publisher = client.listModelCustomizationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsPublisher publisher = client.listModelCustomizationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListModelCustomizationJobsRequest.builder()- Parameters:
listModelCustomizationJobsRequest- AConsumerthat will call methods onListModelCustomizationJobsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Lists the Provisioned Throughputs in the account. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListProvisionedModelThroughputsRequest.Builderavoiding the need to create one manually viaListProvisionedModelThroughputsRequest.builder()- Parameters:
listProvisionedModelThroughputsRequest- AConsumerthat will call methods onListProvisionedModelThroughputsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsPublisher publisher = client.listProvisionedModelThroughputsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsPublisher publisher = client.listProvisionedModelThroughputsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListProvisionedModelThroughputsRequest.builder()- Parameters:
listProvisionedModelThroughputsRequest- AConsumerthat will call methods onListProvisionedModelThroughputsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaPutModelInvocationLoggingConfigurationRequest.builder()- Parameters:
putModelInvocationLoggingConfigurationRequest- AConsumerthat will call methods onPutModelInvocationLoggingConfigurationRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
stopEvaluationJob
default CompletableFuture<StopEvaluationJobResponse> stopEvaluationJob(StopEvaluationJobRequest stopEvaluationJobRequest) Stops an in progress model evaluation job.
- Parameters:
stopEvaluationJobRequest-- Returns:
- A Java Future containing the result of the StopEvaluationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
stopEvaluationJob
default CompletableFuture<StopEvaluationJobResponse> stopEvaluationJob(Consumer<StopEvaluationJobRequest.Builder> stopEvaluationJobRequest) Stops an in progress model evaluation job.
This is a convenience which creates an instance of the
StopEvaluationJobRequest.Builderavoiding the need to create one manually viaStopEvaluationJobRequest.builder()- Parameters:
stopEvaluationJobRequest- AConsumerthat will call methods onStopEvaluationJobRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StopEvaluationJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
StopModelCustomizationJobRequest.Builderavoiding the need to create one manually viaStopModelCustomizationJobRequest.builder()- Parameters:
stopModelCustomizationJobRequest- AConsumerthat will call methods onStopModelCustomizationJobRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- TooManyTagsException The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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 Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
updateGuardrail
default CompletableFuture<UpdateGuardrailResponse> updateGuardrail(UpdateGuardrailRequest updateGuardrailRequest) Updates a guardrail with the values you specify.
-
Specify a
nameand optionaldescription. -
Specify messages for when the guardrail successfully blocks a prompt or a model response in the
blockedInputMessagingandblockedOutputsMessagingfields. -
Specify topics for the guardrail to deny in the
topicPolicyConfigobject. Each GuardrailTopicConfig object in thetopicsConfiglist pertains to one topic.-
Give a
nameanddescriptionso that the guardrail can properly identify the topic. -
Specify
DENYin thetypefield. -
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the
exampleslist.
-
-
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the
contentPolicyConfigobject. Each GuardrailContentFilterConfig object in thefiltersConfiglist pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.-
Specify the category in the
typefield. -
Specify the strength of the filter for prompts in the
inputStrengthfield and for model responses in thestrengthfield of the GuardrailContentFilterConfig.
-
-
(Optional) For security, include the ARN of a KMS key in the
kmsKeyIdfield.
- Parameters:
updateGuardrailRequest-- Returns:
- A Java Future containing the result of the UpdateGuardrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:
-
-
updateGuardrail
default CompletableFuture<UpdateGuardrailResponse> updateGuardrail(Consumer<UpdateGuardrailRequest.Builder> updateGuardrailRequest) Updates a guardrail with the values you specify.
-
Specify a
nameand optionaldescription. -
Specify messages for when the guardrail successfully blocks a prompt or a model response in the
blockedInputMessagingandblockedOutputsMessagingfields. -
Specify topics for the guardrail to deny in the
topicPolicyConfigobject. Each GuardrailTopicConfig object in thetopicsConfiglist pertains to one topic.-
Give a
nameanddescriptionso that the guardrail can properly identify the topic. -
Specify
DENYin thetypefield. -
(Optional) Provide up to five prompts that you would categorize as belonging to the topic in the
exampleslist.
-
-
Specify filter strengths for the harmful categories defined in Amazon Bedrock in the
contentPolicyConfigobject. Each GuardrailContentFilterConfig object in thefiltersConfiglist pertains to a harmful category. For more information, see Content filters. For more information about the fields in a content filter, see GuardrailContentFilterConfig.-
Specify the category in the
typefield. -
Specify the strength of the filter for prompts in the
inputStrengthfield and for model responses in thestrengthfield of the GuardrailContentFilterConfig.
-
-
(Optional) For security, include the ARN of a KMS key in the
kmsKeyIdfield.
This is a convenience which creates an instance of the
UpdateGuardrailRequest.Builderavoiding the need to create one manually viaUpdateGuardrailRequest.builder()- Parameters:
updateGuardrailRequest- AConsumerthat will call methods onUpdateGuardrailRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateGuardrail operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- ConflictException Error occurred because of a conflict while performing an operation.
- InternalServerException An internal server error occurred. Retry your request.
- ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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) Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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) Updates the name or associated model for a Provisioned Throughput. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
UpdateProvisionedModelThroughputRequest.Builderavoiding the need to create one manually viaUpdateProvisionedModelThroughputRequest.builder()- Parameters:
updateProvisionedModelThroughputRequest- AConsumerthat will call methods onUpdateProvisionedModelThroughputRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
- AccessDeniedException The request is denied because of missing access permissions.
- ValidationException Input validation failed. Check your request parameters and retry the request.
- InternalServerException An internal server error occurred. Retry your request.
- ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
- 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:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aBedrockAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aBedrockAsyncClient.
-