@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface BedrockAsyncClient extends AwsClient
builder()
method.
Describes the API operations for creating and managing Bedrock models.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateModelCustomizationJobResponse> createModelCustomizationJob(CreateModelCustomizationJobRequest createModelCustomizationJobRequest)
Creates a fine-tuning job to customize a base model.
You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Training data contains input and output text for each record in a JSONL format. Optionally, you can specify validation data in the same format as the training data. Bedrock returns validation loss metrics and output generations after the job completes.
Model-customization jobs are asynchronous and the completion time depends on the base model and the
training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to
retrieve the job status.
For more information, see Custom models in the Bedrock User Guide.
createModelCustomizationJobRequest - default CompletableFuture<CreateModelCustomizationJobResponse> createModelCustomizationJob(Consumer<CreateModelCustomizationJobRequest.Builder> createModelCustomizationJobRequest)
Creates a fine-tuning job to customize a base model.
You specify the base foundation model and the location of the training data. After the model-customization job completes successfully, your custom model resource will be ready to use. Training data contains input and output text for each record in a JSONL format. Optionally, you can specify validation data in the same format as the training data. Bedrock returns validation loss metrics and output generations after the job completes.
Model-customization jobs are asynchronous and the completion time depends on the base model and the
training/validation data size. To monitor a job, use the GetModelCustomizationJob operation to
retrieve the job status.
For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the CreateModelCustomizationJobRequest.Builder
avoiding the need to create one manually via CreateModelCustomizationJobRequest.builder()
createModelCustomizationJobRequest - A Consumer that will call methods on
CreateModelCustomizationJobRequest.Builder to create
a request.default CompletableFuture<CreateProvisionedModelThroughputResponse> createProvisionedModelThroughput(CreateProvisionedModelThroughputRequest createProvisionedModelThroughputRequest)
Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.
For more information, see Provisioned throughput in the Bedrock User Guide.
createProvisionedModelThroughputRequest - default CompletableFuture<CreateProvisionedModelThroughputResponse> createProvisionedModelThroughput(Consumer<CreateProvisionedModelThroughputRequest.Builder> createProvisionedModelThroughputRequest)
Creates a provisioned throughput with dedicated capacity for a foundation model or a fine-tuned model.
For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the CreateProvisionedModelThroughputRequest.Builder
avoiding the need to create one manually via CreateProvisionedModelThroughputRequest.builder()
createProvisionedModelThroughputRequest - A Consumer that will call methods on
CreateProvisionedModelThroughputRequest.Builder to
create a request.default CompletableFuture<DeleteCustomModelResponse> deleteCustomModel(DeleteCustomModelRequest deleteCustomModelRequest)
Deletes a custom model that you created earlier. For more information, see Custom models in the Bedrock User Guide.
deleteCustomModelRequest - default CompletableFuture<DeleteCustomModelResponse> deleteCustomModel(Consumer<DeleteCustomModelRequest.Builder> deleteCustomModelRequest)
Deletes a custom model that you created earlier. For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the DeleteCustomModelRequest.Builder avoiding the need
to create one manually via DeleteCustomModelRequest.builder()
deleteCustomModelRequest - A Consumer that will call methods on
DeleteCustomModelRequest.Builder to create a
request.default CompletableFuture<DeleteModelInvocationLoggingConfigurationResponse> deleteModelInvocationLoggingConfiguration(DeleteModelInvocationLoggingConfigurationRequest deleteModelInvocationLoggingConfigurationRequest)
Delete the invocation logging.
deleteModelInvocationLoggingConfigurationRequest - default CompletableFuture<DeleteModelInvocationLoggingConfigurationResponse> deleteModelInvocationLoggingConfiguration(Consumer<DeleteModelInvocationLoggingConfigurationRequest.Builder> deleteModelInvocationLoggingConfigurationRequest)
Delete the invocation logging.
This is a convenience which creates an instance of the
DeleteModelInvocationLoggingConfigurationRequest.Builder avoiding the need to create one manually via
DeleteModelInvocationLoggingConfigurationRequest.builder()
deleteModelInvocationLoggingConfigurationRequest - A Consumer that will call methods on
DeleteModelInvocationLoggingConfigurationRequest.Builder
to create a request.default CompletableFuture<DeleteProvisionedModelThroughputResponse> deleteProvisionedModelThroughput(DeleteProvisionedModelThroughputRequest deleteProvisionedModelThroughputRequest)
Deletes a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
deleteProvisionedModelThroughputRequest - default CompletableFuture<DeleteProvisionedModelThroughputResponse> deleteProvisionedModelThroughput(Consumer<DeleteProvisionedModelThroughputRequest.Builder> deleteProvisionedModelThroughputRequest)
Deletes a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the DeleteProvisionedModelThroughputRequest.Builder
avoiding the need to create one manually via DeleteProvisionedModelThroughputRequest.builder()
deleteProvisionedModelThroughputRequest - A Consumer that will call methods on
DeleteProvisionedModelThroughputRequest.Builder to
create a request.default CompletableFuture<GetCustomModelResponse> getCustomModel(GetCustomModelRequest getCustomModelRequest)
Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
getCustomModelRequest - default CompletableFuture<GetCustomModelResponse> getCustomModel(Consumer<GetCustomModelRequest.Builder> getCustomModelRequest)
Get the properties associated with a Bedrock custom model that you have created.For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the GetCustomModelRequest.Builder avoiding the need to
create one manually via GetCustomModelRequest.builder()
getCustomModelRequest - A Consumer that will call methods on
GetCustomModelRequest.Builder to create a request.default CompletableFuture<GetFoundationModelResponse> getFoundationModel(GetFoundationModelRequest getFoundationModelRequest)
Get details about a Bedrock foundation model.
getFoundationModelRequest - default CompletableFuture<GetFoundationModelResponse> getFoundationModel(Consumer<GetFoundationModelRequest.Builder> getFoundationModelRequest)
Get details about a Bedrock foundation model.
This is a convenience which creates an instance of the GetFoundationModelRequest.Builder avoiding the
need to create one manually via GetFoundationModelRequest.builder()
getFoundationModelRequest - A Consumer that will call methods on
GetFoundationModelRequest.Builder to create a
request.default CompletableFuture<GetModelCustomizationJobResponse> getModelCustomizationJob(GetModelCustomizationJobRequest getModelCustomizationJobRequest)
Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Bedrock User Guide.
getModelCustomizationJobRequest - default CompletableFuture<GetModelCustomizationJobResponse> getModelCustomizationJob(Consumer<GetModelCustomizationJobRequest.Builder> getModelCustomizationJobRequest)
Retrieves the properties associated with a model-customization job, including the status of the job. For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the GetModelCustomizationJobRequest.Builder avoiding
the need to create one manually via GetModelCustomizationJobRequest.builder()
getModelCustomizationJobRequest - A Consumer that will call methods on
GetModelCustomizationJobRequest.Builder to create a
request.default CompletableFuture<GetModelInvocationLoggingConfigurationResponse> getModelInvocationLoggingConfiguration(GetModelInvocationLoggingConfigurationRequest getModelInvocationLoggingConfigurationRequest)
Get the current configuration values for model invocation logging.
getModelInvocationLoggingConfigurationRequest - default CompletableFuture<GetModelInvocationLoggingConfigurationResponse> getModelInvocationLoggingConfiguration(Consumer<GetModelInvocationLoggingConfigurationRequest.Builder> getModelInvocationLoggingConfigurationRequest)
Get the current configuration values for model invocation logging.
This is a convenience which creates an instance of the
GetModelInvocationLoggingConfigurationRequest.Builder avoiding the need to create one manually via
GetModelInvocationLoggingConfigurationRequest.builder()
getModelInvocationLoggingConfigurationRequest - A Consumer that will call methods on
GetModelInvocationLoggingConfigurationRequest.Builder
to create a request.default CompletableFuture<GetProvisionedModelThroughputResponse> getProvisionedModelThroughput(GetProvisionedModelThroughputRequest getProvisionedModelThroughputRequest)
Get details for a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
getProvisionedModelThroughputRequest - default CompletableFuture<GetProvisionedModelThroughputResponse> getProvisionedModelThroughput(Consumer<GetProvisionedModelThroughputRequest.Builder> getProvisionedModelThroughputRequest)
Get details for a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the GetProvisionedModelThroughputRequest.Builder
avoiding the need to create one manually via GetProvisionedModelThroughputRequest.builder()
getProvisionedModelThroughputRequest - A Consumer that will call methods on
GetProvisionedModelThroughputRequest.Builder to
create a request.default CompletableFuture<ListCustomModelsResponse> listCustomModels(ListCustomModelsRequest listCustomModelsRequest)
Returns a list of the custom models that you have created with the CreateModelCustomizationJob
operation.
For more information, see Custom models in the Bedrock User Guide.
listCustomModelsRequest - default CompletableFuture<ListCustomModelsResponse> listCustomModels(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest)
Returns a list of the custom models that you have created with the CreateModelCustomizationJob
operation.
For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the ListCustomModelsRequest.Builder avoiding the need
to create one manually via ListCustomModelsRequest.builder()
listCustomModelsRequest - A Consumer that will call methods on
ListCustomModelsRequest.Builder to create a request.default ListCustomModelsPublisher listCustomModelsPaginator(ListCustomModelsRequest listCustomModelsRequest)
Returns a list of the custom models that you have created with the CreateModelCustomizationJob
operation.
For more information, see Custom models in the Bedrock User Guide.
This is a variant of
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.bedrock.paginators.ListCustomModelsPublisher publisher = client.listCustomModelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listCustomModelsRequest - default ListCustomModelsPublisher listCustomModelsPaginator(Consumer<ListCustomModelsRequest.Builder> listCustomModelsRequest)
Returns a list of the custom models that you have created with the CreateModelCustomizationJob
operation.
For more information, see Custom models in the Bedrock User Guide.
This is a variant of
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.bedrock.paginators.ListCustomModelsPublisher publisher = client.listCustomModelsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCustomModels(software.amazon.awssdk.services.bedrock.model.ListCustomModelsRequest) operation.
This is a convenience which creates an instance of the ListCustomModelsRequest.Builder avoiding the need
to create one manually via ListCustomModelsRequest.builder()
listCustomModelsRequest - A Consumer that will call methods on
ListCustomModelsRequest.Builder to create a request.default CompletableFuture<ListFoundationModelsResponse> listFoundationModels(ListFoundationModelsRequest listFoundationModelsRequest)
List of Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.
listFoundationModelsRequest - default CompletableFuture<ListFoundationModelsResponse> listFoundationModels(Consumer<ListFoundationModelsRequest.Builder> listFoundationModelsRequest)
List of Bedrock foundation models that you can use. For more information, see Foundation models in the Bedrock User Guide.
This is a convenience which creates an instance of the ListFoundationModelsRequest.Builder avoiding the
need to create one manually via ListFoundationModelsRequest.builder()
listFoundationModelsRequest - A Consumer that will call methods on
ListFoundationModelsRequest.Builder to create a
request.default CompletableFuture<ListModelCustomizationJobsResponse> listModelCustomizationJobs(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest)
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
For more information, see Custom models in the Bedrock User Guide.
listModelCustomizationJobsRequest - default CompletableFuture<ListModelCustomizationJobsResponse> listModelCustomizationJobs(Consumer<ListModelCustomizationJobsRequest.Builder> listModelCustomizationJobsRequest)
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the ListModelCustomizationJobsRequest.Builder avoiding
the need to create one manually via ListModelCustomizationJobsRequest.builder()
listModelCustomizationJobsRequest - A Consumer that will call methods on
ListModelCustomizationJobsRequest.Builder to create
a request.default ListModelCustomizationJobsPublisher listModelCustomizationJobsPaginator(ListModelCustomizationJobsRequest listModelCustomizationJobsRequest)
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
For more information, see Custom models in the Bedrock User Guide.
This is a variant of
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsPublisher publisher = client.listModelCustomizationJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listModelCustomizationJobsRequest - default ListModelCustomizationJobsPublisher listModelCustomizationJobsPaginator(Consumer<ListModelCustomizationJobsRequest.Builder> listModelCustomizationJobsRequest)
Returns a list of model customization jobs that you have submitted. You can filter the jobs to return based on one or more criteria.
For more information, see Custom models in the Bedrock User Guide.
This is a variant of
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.bedrock.paginators.ListModelCustomizationJobsPublisher publisher = client.listModelCustomizationJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listModelCustomizationJobs(software.amazon.awssdk.services.bedrock.model.ListModelCustomizationJobsRequest)
operation.
This is a convenience which creates an instance of the ListModelCustomizationJobsRequest.Builder avoiding
the need to create one manually via ListModelCustomizationJobsRequest.builder()
listModelCustomizationJobsRequest - A Consumer that will call methods on
ListModelCustomizationJobsRequest.Builder to create
a request.default CompletableFuture<ListProvisionedModelThroughputsResponse> listProvisionedModelThroughputs(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest)
List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
listProvisionedModelThroughputsRequest - default CompletableFuture<ListProvisionedModelThroughputsResponse> listProvisionedModelThroughputs(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest)
List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the ListProvisionedModelThroughputsRequest.Builder
avoiding the need to create one manually via ListProvisionedModelThroughputsRequest.builder()
listProvisionedModelThroughputsRequest - A Consumer that will call methods on
ListProvisionedModelThroughputsRequest.Builder to
create a request.default ListProvisionedModelThroughputsPublisher listProvisionedModelThroughputsPaginator(ListProvisionedModelThroughputsRequest listProvisionedModelThroughputsRequest)
List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a variant of
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsPublisher publisher = client.listProvisionedModelThroughputsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listProvisionedModelThroughputsRequest - default ListProvisionedModelThroughputsPublisher listProvisionedModelThroughputsPaginator(Consumer<ListProvisionedModelThroughputsRequest.Builder> listProvisionedModelThroughputsRequest)
List the provisioned capacities. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a variant of
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.bedrock.paginators.ListProvisionedModelThroughputsPublisher publisher = client.listProvisionedModelThroughputsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProvisionedModelThroughputs(software.amazon.awssdk.services.bedrock.model.ListProvisionedModelThroughputsRequest)
operation.
This is a convenience which creates an instance of the ListProvisionedModelThroughputsRequest.Builder
avoiding the need to create one manually via ListProvisionedModelThroughputsRequest.builder()
listProvisionedModelThroughputsRequest - A Consumer that will call methods on
ListProvisionedModelThroughputsRequest.Builder to
create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags associated with the specified resource.
For more information, see Tagging resources in the Bedrock User Guide.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List the tags associated with the specified resource.
For more information, see Tagging resources in the Bedrock User Guide.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<PutModelInvocationLoggingConfigurationResponse> putModelInvocationLoggingConfiguration(PutModelInvocationLoggingConfigurationRequest putModelInvocationLoggingConfigurationRequest)
Set the configuration values for model invocation logging.
putModelInvocationLoggingConfigurationRequest - default CompletableFuture<PutModelInvocationLoggingConfigurationResponse> putModelInvocationLoggingConfiguration(Consumer<PutModelInvocationLoggingConfigurationRequest.Builder> putModelInvocationLoggingConfigurationRequest)
Set the configuration values for model invocation logging.
This is a convenience which creates an instance of the
PutModelInvocationLoggingConfigurationRequest.Builder avoiding the need to create one manually via
PutModelInvocationLoggingConfigurationRequest.builder()
putModelInvocationLoggingConfigurationRequest - A Consumer that will call methods on
PutModelInvocationLoggingConfigurationRequest.Builder
to create a request.default CompletableFuture<StopModelCustomizationJobResponse> stopModelCustomizationJob(StopModelCustomizationJobRequest stopModelCustomizationJobRequest)
Stops an active model customization job. For more information, see Custom models in the Bedrock User Guide.
stopModelCustomizationJobRequest - default CompletableFuture<StopModelCustomizationJobResponse> stopModelCustomizationJob(Consumer<StopModelCustomizationJobRequest.Builder> stopModelCustomizationJobRequest)
Stops an active model customization job. For more information, see Custom models in the Bedrock User Guide.
This is a convenience which creates an instance of the StopModelCustomizationJobRequest.Builder avoiding
the need to create one manually via StopModelCustomizationJobRequest.builder()
stopModelCustomizationJobRequest - A Consumer that will call methods on
StopModelCustomizationJobRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Associate tags with a resource. For more information, see Tagging resources in the Bedrock User Guide.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associate tags with a resource. For more information, see Tagging resources in the Bedrock User Guide.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Remove one or more tags from a resource. For more information, see Tagging resources in the Bedrock User Guide.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Remove one or more tags from a resource. For more information, see Tagging resources in the Bedrock User Guide.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateProvisionedModelThroughputResponse> updateProvisionedModelThroughput(UpdateProvisionedModelThroughputRequest updateProvisionedModelThroughputRequest)
Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
updateProvisionedModelThroughputRequest - default CompletableFuture<UpdateProvisionedModelThroughputResponse> updateProvisionedModelThroughput(Consumer<UpdateProvisionedModelThroughputRequest.Builder> updateProvisionedModelThroughputRequest)
Update a provisioned throughput. For more information, see Provisioned throughput in the Bedrock User Guide.
This is a convenience which creates an instance of the UpdateProvisionedModelThroughputRequest.Builder
avoiding the need to create one manually via UpdateProvisionedModelThroughputRequest.builder()
updateProvisionedModelThroughputRequest - A Consumer that will call methods on
UpdateProvisionedModelThroughputRequest.Builder to
create a request.default BedrockServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic BedrockAsyncClient create()
BedrockAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BedrockAsyncClientBuilder builder()
BedrockAsyncClient.Copyright © 2023. All rights reserved.