@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface EmrServerlessAsyncClient extends AwsClient
builder()
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. The emr-serverless prefix 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.
| 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<CancelJobRunResponse> cancelJobRun(CancelJobRunRequest cancelJobRunRequest)
Cancels a job run.
cancelJobRunRequest - default CompletableFuture<CancelJobRunResponse> cancelJobRun(Consumer<CancelJobRunRequest.Builder> cancelJobRunRequest)
Cancels a job run.
This is a convenience which creates an instance of the CancelJobRunRequest.Builder avoiding the need to
create one manually via CancelJobRunRequest.builder()
cancelJobRunRequest - A Consumer that will call methods on
CancelJobRunRequest.Builder to create a
request.default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application.
createApplicationRequest - default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
Creates an application.
This is a convenience which creates an instance of the CreateApplicationRequest.Builder avoiding the need
to create one manually via CreateApplicationRequest.builder()
createApplicationRequest - A Consumer that will call methods on
CreateApplicationRequest.Builder to create a
request.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.
deleteApplicationRequest - 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.Builder avoiding the need
to create one manually via DeleteApplicationRequest.builder()
deleteApplicationRequest - A Consumer that will call methods on
DeleteApplicationRequest.Builder to create a
request.default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest)
Displays detailed information about a specified application.
getApplicationRequest - 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.Builder avoiding the need to
create one manually via GetApplicationRequest.builder()
getApplicationRequest - A Consumer that will call methods on
GetApplicationRequest.Builder to create a
request.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.
getDashboardForJobRunRequest - 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.Builder avoiding the
need to create one manually via GetDashboardForJobRunRequest.builder()
getDashboardForJobRunRequest - A Consumer that will call methods on
GetDashboardForJobRunRequest.Builder to create
a request.default CompletableFuture<GetJobRunResponse> getJobRun(GetJobRunRequest getJobRunRequest)
Displays detailed information about a job run.
getJobRunRequest - 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.Builder avoiding the need to
create one manually via GetJobRunRequest.builder()
getJobRunRequest - A Consumer that will call methods on
GetJobRunRequest.Builder to create a request.default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest)
Lists applications based on a set of parameters.
listApplicationsRequest - 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.Builder avoiding the need
to create one manually via ListApplicationsRequest.builder()
listApplicationsRequest - A Consumer that will call methods on
ListApplicationsRequest.Builder to create a
request.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 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.emrserverless.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
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
listApplications(software.amazon.awssdk.services.emrserverless.model.ListApplicationsRequest)
operation.
listApplicationsRequest - 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 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.emrserverless.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
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
listApplications(software.amazon.awssdk.services.emrserverless.model.ListApplicationsRequest)
operation.
This is a convenience which creates an instance of the ListApplicationsRequest.Builder avoiding the need
to create one manually via ListApplicationsRequest.builder()
listApplicationsRequest - A Consumer that will call methods on
ListApplicationsRequest.Builder to create a
request.default CompletableFuture<ListJobRunsResponse> listJobRuns(ListJobRunsRequest listJobRunsRequest)
Lists job runs based on a set of parameters.
listJobRunsRequest - 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.Builder avoiding the need to
create one manually via ListJobRunsRequest.builder()
listJobRunsRequest - A Consumer that will call methods on
ListJobRunsRequest.Builder to create a
request.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 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.emrserverless.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
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
listJobRuns(software.amazon.awssdk.services.emrserverless.model.ListJobRunsRequest) operation.
listJobRunsRequest - 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 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.emrserverless.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
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
listJobRuns(software.amazon.awssdk.services.emrserverless.model.ListJobRunsRequest) operation.
This is a convenience which creates an instance of the ListJobRunsRequest.Builder avoiding the need to
create one manually via ListJobRunsRequest.builder()
listJobRunsRequest - A Consumer that will call methods on
ListJobRunsRequest.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to the resources.
listTagsForResourceRequest - 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.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<StartApplicationResponse> startApplication(StartApplicationRequest startApplicationRequest)
Starts a specified application and initializes initial capacity if configured.
startApplicationRequest - 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.Builder avoiding the need
to create one manually via StartApplicationRequest.builder()
startApplicationRequest - A Consumer that will call methods on
StartApplicationRequest.Builder to create a
request.default CompletableFuture<StartJobRunResponse> startJobRun(StartJobRunRequest startJobRunRequest)
Starts a job run.
startJobRunRequest - default CompletableFuture<StartJobRunResponse> startJobRun(Consumer<StartJobRunRequest.Builder> startJobRunRequest)
Starts a job run.
This is a convenience which creates an instance of the StartJobRunRequest.Builder avoiding the need to
create one manually via StartJobRunRequest.builder()
startJobRunRequest - A Consumer that will call methods on
StartJobRunRequest.Builder to create a
request.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.
stopApplicationRequest - 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.Builder avoiding the need
to create one manually via StopApplicationRequest.builder()
stopApplicationRequest - A Consumer that will call methods on
StopApplicationRequest.Builder to create a
request.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.
tagResourceRequest - 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.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)
Removes tags from resources.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from resources.
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<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates a specified application. An application has to be in a stopped or created state in order to be updated.
updateApplicationRequest - 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.Builder avoiding the need
to create one manually via UpdateApplicationRequest.builder()
updateApplicationRequest - A Consumer that will call methods on
UpdateApplicationRequest.Builder to create a
request.default EmrServerlessServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic EmrServerlessAsyncClient create()
EmrServerlessAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static EmrServerlessAsyncClientBuilder builder()
EmrServerlessAsyncClient.Copyright © 2023. All rights reserved.