Interface EmrServerlessAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EmrServerlessAsyncClient extends AwsClient
Service client for accessing EMR Serverless asynchronously. This can be created using the staticbuilder()method.Amazon EMR Serverless is a new deployment option for Amazon EMR. Amazon EMR Serverless provides a serverless runtime environment that simplifies running analytics applications using the latest open source frameworks such as Apache Spark and Apache Hive. With Amazon EMR Serverless, you don’t have to configure, optimize, secure, or operate clusters to run applications with these frameworks.
The API reference to Amazon EMR Serverless is
emr-serverless. Theemr-serverlessprefix is used in the following scenarios:-
It is the prefix in the CLI commands for Amazon EMR Serverless. For example,
aws emr-serverless start-job-run. -
It is the prefix before IAM policy actions for Amazon EMR Serverless. For example,
"Action": ["emr-serverless:StartJobRun"]. For more information, see Policy actions for Amazon EMR Serverless. -
It is the prefix used in Amazon EMR Serverless service endpoints. For example,
emr-serverless.us-east-2.amazonaws.com.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
cancelJobRun
default CompletableFuture<CancelJobRunResponse> cancelJobRun(CancelJobRunRequest cancelJobRunRequest)
Cancels a job run.
- Parameters:
cancelJobRunRequest-- Returns:
- A Java Future containing the result of the CancelJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
cancelJobRun
default CompletableFuture<CancelJobRunResponse> cancelJobRun(Consumer<CancelJobRunRequest.Builder> cancelJobRunRequest)
Cancels a job run.
This is a convenience which creates an instance of the
CancelJobRunRequest.Builderavoiding the need to create one manually viaCancelJobRunRequest.builder()- Parameters:
cancelJobRunRequest- AConsumerthat will call methods onCancelJobRunRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CancelJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application.
- Parameters:
createApplicationRequest-- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createApplication
default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
Creates an application.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builderavoiding the need to create one manually viaCreateApplicationRequest.builder()- Parameters:
createApplicationRequest- AConsumerthat will call methods onCreateApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes an application. An application has to be in a stopped or created state in order to be deleted.
- Parameters:
deleteApplicationRequest-- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteApplication
default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
Deletes an application. An application has to be in a stopped or created state in order to be deleted.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builderavoiding the need to create one manually viaDeleteApplicationRequest.builder()- Parameters:
deleteApplicationRequest- AConsumerthat will call methods onDeleteApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest)
Displays detailed information about a specified application.
- Parameters:
getApplicationRequest-- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)
Displays detailed information about a specified application.
This is a convenience which creates an instance of the
GetApplicationRequest.Builderavoiding the need to create one manually viaGetApplicationRequest.builder()- Parameters:
getApplicationRequest- AConsumerthat will call methods onGetApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDashboardForJobRun
default CompletableFuture<GetDashboardForJobRunResponse> getDashboardForJobRun(GetDashboardForJobRunRequest getDashboardForJobRunRequest)
Creates and returns a URL that you can use to access the application UIs for a job run.
For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI.
The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.
- Parameters:
getDashboardForJobRunRequest-- Returns:
- A Java Future containing the result of the GetDashboardForJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDashboardForJobRun
default CompletableFuture<GetDashboardForJobRunResponse> getDashboardForJobRun(Consumer<GetDashboardForJobRunRequest.Builder> getDashboardForJobRunRequest)
Creates and returns a URL that you can use to access the application UIs for a job run.
For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI.
The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.
This is a convenience which creates an instance of the
GetDashboardForJobRunRequest.Builderavoiding the need to create one manually viaGetDashboardForJobRunRequest.builder()- Parameters:
getDashboardForJobRunRequest- AConsumerthat will call methods onGetDashboardForJobRunRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDashboardForJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getJobRun
default CompletableFuture<GetJobRunResponse> getJobRun(GetJobRunRequest getJobRunRequest)
Displays detailed information about a job run.
- Parameters:
getJobRunRequest-- Returns:
- A Java Future containing the result of the GetJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getJobRun
default CompletableFuture<GetJobRunResponse> getJobRun(Consumer<GetJobRunRequest.Builder> getJobRunRequest)
Displays detailed information about a job run.
This is a convenience which creates an instance of the
GetJobRunRequest.Builderavoiding the need to create one manually viaGetJobRunRequest.builder()- Parameters:
getJobRunRequest- AConsumerthat will call methods onGetJobRunRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)
Lists applications based on a set of parameters.
- Parameters:
listApplicationsRequest-- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
Lists applications based on a set of parameters.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListApplications operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)
Lists applications based on a set of parameters.
This is a variant of
listApplications(software.amazon.awssdk.services.emrserverless.model.ListApplicationsRequest)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.emrserverless.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(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.emrserverless.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrserverless.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrserverless.model.ListApplicationsResponse 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
listApplications(software.amazon.awssdk.services.emrserverless.model.ListApplicationsRequest)operation.- Parameters:
listApplicationsRequest-- 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
Lists applications based on a set of parameters.
This is a variant of
listApplications(software.amazon.awssdk.services.emrserverless.model.ListApplicationsRequest)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.emrserverless.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(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.emrserverless.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrserverless.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrserverless.model.ListApplicationsResponse 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
listApplications(software.amazon.awssdk.services.emrserverless.model.ListApplicationsRequest)operation.This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listJobRuns
default CompletableFuture<ListJobRunsResponse> listJobRuns(ListJobRunsRequest listJobRunsRequest)
Lists job runs based on a set of parameters.
- Parameters:
listJobRunsRequest-- Returns:
- A Java Future containing the result of the ListJobRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listJobRuns
default CompletableFuture<ListJobRunsResponse> listJobRuns(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest)
Lists job runs based on a set of parameters.
This is a convenience which creates an instance of the
ListJobRunsRequest.Builderavoiding the need to create one manually viaListJobRunsRequest.builder()- Parameters:
listJobRunsRequest- AConsumerthat will call methods onListJobRunsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListJobRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listJobRunsPaginator
default ListJobRunsPublisher listJobRunsPaginator(ListJobRunsRequest listJobRunsRequest)
Lists job runs based on a set of parameters.
This is a variant of
listJobRuns(software.amazon.awssdk.services.emrserverless.model.ListJobRunsRequest)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.emrserverless.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(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.emrserverless.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrserverless.model.ListJobRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrserverless.model.ListJobRunsResponse 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
listJobRuns(software.amazon.awssdk.services.emrserverless.model.ListJobRunsRequest)operation.- Parameters:
listJobRunsRequest-- 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listJobRunsPaginator
default ListJobRunsPublisher listJobRunsPaginator(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest)
Lists job runs based on a set of parameters.
This is a variant of
listJobRuns(software.amazon.awssdk.services.emrserverless.model.ListJobRunsRequest)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.emrserverless.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(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.emrserverless.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrserverless.model.ListJobRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrserverless.model.ListJobRunsResponse 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
listJobRuns(software.amazon.awssdk.services.emrserverless.model.ListJobRunsRequest)operation.This is a convenience which creates an instance of the
ListJobRunsRequest.Builderavoiding the need to create one manually viaListJobRunsRequest.builder()- Parameters:
listJobRunsRequest- AConsumerthat will call methods onListJobRunsRequest.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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to the resources.
- 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags assigned to the resources.
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startApplication
default CompletableFuture<StartApplicationResponse> startApplication(StartApplicationRequest startApplicationRequest)
Starts a specified application and initializes initial capacity if configured.
- Parameters:
startApplicationRequest-- Returns:
- A Java Future containing the result of the StartApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- ServiceQuotaExceededException The maximum number of resources per account has been reached.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startApplication
default CompletableFuture<StartApplicationResponse> startApplication(Consumer<StartApplicationRequest.Builder> startApplicationRequest)
Starts a specified application and initializes initial capacity if configured.
This is a convenience which creates an instance of the
StartApplicationRequest.Builderavoiding the need to create one manually viaStartApplicationRequest.builder()- Parameters:
startApplicationRequest- AConsumerthat will call methods onStartApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- ServiceQuotaExceededException The maximum number of resources per account has been reached.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startJobRun
default CompletableFuture<StartJobRunResponse> startJobRun(StartJobRunRequest startJobRunRequest)
Starts a job run.
- Parameters:
startJobRunRequest-- Returns:
- A Java Future containing the result of the StartJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
startJobRun
default CompletableFuture<StartJobRunResponse> startJobRun(Consumer<StartJobRunRequest.Builder> startJobRunRequest)
Starts a job run.
This is a convenience which creates an instance of the
StartJobRunRequest.Builderavoiding the need to create one manually viaStartJobRunRequest.builder()- Parameters:
startJobRunRequest- AConsumerthat will call methods onStartJobRunRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- ConflictException The request could not be processed because of conflict in the current state of the resource.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
stopApplication
default CompletableFuture<StopApplicationResponse> stopApplication(StopApplicationRequest stopApplicationRequest)
Stops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application.
- Parameters:
stopApplicationRequest-- Returns:
- A Java Future containing the result of the StopApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
stopApplication
default CompletableFuture<StopApplicationResponse> stopApplication(Consumer<StopApplicationRequest.Builder> stopApplicationRequest)
Stops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application.
This is a convenience which creates an instance of the
StopApplicationRequest.Builderavoiding the need to create one manually viaStopApplicationRequest.builder()- Parameters:
stopApplicationRequest- AConsumerthat will call methods onStopApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StopApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it.
- 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns tags to resources. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your Amazon Web Services resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it.
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from resources.
- 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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from resources.
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.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates a specified application. An application has to be in a stopped or created state in order to be updated.
- Parameters:
updateApplicationRequest-- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateApplication
default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
Updates a specified application. An application has to be in a stopped or created state in order to be updated.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builderavoiding the need to create one manually viaUpdateApplicationRequest.builder()- Parameters:
updateApplicationRequest- AConsumerthat will call methods onUpdateApplicationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException Request processing failed because of an error or failure with the service.
- 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.
- EmrServerlessException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default EmrServerlessServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static EmrServerlessAsyncClient create()
Create aEmrServerlessAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static EmrServerlessAsyncClientBuilder builder()
Create a builder that can be used to configure and create aEmrServerlessAsyncClient.
-
-