Interface EmrContainersAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. For more information about Amazon EMR on EKS concepts and tasks, see What is Amazon EMR on EKS.
Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers
prefix is used in
the following scenarios:
-
It is the prefix in the CLI commands for Amazon EMR on EKS. For example,
aws emr-containers start-job-run
. -
It is the prefix before IAM policy actions for Amazon EMR on EKS. For example,
"Action": [ "emr-containers:StartJobRun"]
. For more information, see Policy actions for Amazon EMR on EKS. -
It is the prefix used in Amazon EMR on EKS service endpoints. For example,
emr-containers.us-east-2.amazonaws.com
. For more information, see Amazon EMR on EKSService Endpoints.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aEmrContainersAsyncClient
.default CompletableFuture
<CancelJobRunResponse> cancelJobRun
(Consumer<CancelJobRunRequest.Builder> cancelJobRunRequest) Cancels a job run.default CompletableFuture
<CancelJobRunResponse> cancelJobRun
(CancelJobRunRequest cancelJobRunRequest) Cancels a job run.static EmrContainersAsyncClient
create()
Create aEmrContainersAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createJobTemplate
(Consumer<CreateJobTemplateRequest.Builder> createJobTemplateRequest) Creates a job template.createJobTemplate
(CreateJobTemplateRequest createJobTemplateRequest) Creates a job template.createManagedEndpoint
(Consumer<CreateManagedEndpointRequest.Builder> createManagedEndpointRequest) Creates a managed endpoint.createManagedEndpoint
(CreateManagedEndpointRequest createManagedEndpointRequest) Creates a managed endpoint.createVirtualCluster
(Consumer<CreateVirtualClusterRequest.Builder> createVirtualClusterRequest) Creates a virtual cluster.createVirtualCluster
(CreateVirtualClusterRequest createVirtualClusterRequest) Creates a virtual cluster.deleteJobTemplate
(Consumer<DeleteJobTemplateRequest.Builder> deleteJobTemplateRequest) Deletes a job template.deleteJobTemplate
(DeleteJobTemplateRequest deleteJobTemplateRequest) Deletes a job template.deleteManagedEndpoint
(Consumer<DeleteManagedEndpointRequest.Builder> deleteManagedEndpointRequest) Deletes a managed endpoint.deleteManagedEndpoint
(DeleteManagedEndpointRequest deleteManagedEndpointRequest) Deletes a managed endpoint.deleteVirtualCluster
(Consumer<DeleteVirtualClusterRequest.Builder> deleteVirtualClusterRequest) Deletes a virtual cluster.deleteVirtualCluster
(DeleteVirtualClusterRequest deleteVirtualClusterRequest) Deletes a virtual cluster.default CompletableFuture
<DescribeJobRunResponse> describeJobRun
(Consumer<DescribeJobRunRequest.Builder> describeJobRunRequest) Displays detailed information about a job run.default CompletableFuture
<DescribeJobRunResponse> describeJobRun
(DescribeJobRunRequest describeJobRunRequest) Displays detailed information about a job run.describeJobTemplate
(Consumer<DescribeJobTemplateRequest.Builder> describeJobTemplateRequest) Displays detailed information about a specified job template.describeJobTemplate
(DescribeJobTemplateRequest describeJobTemplateRequest) Displays detailed information about a specified job template.describeManagedEndpoint
(Consumer<DescribeManagedEndpointRequest.Builder> describeManagedEndpointRequest) Displays detailed information about a managed endpoint.describeManagedEndpoint
(DescribeManagedEndpointRequest describeManagedEndpointRequest) Displays detailed information about a managed endpoint.describeVirtualCluster
(Consumer<DescribeVirtualClusterRequest.Builder> describeVirtualClusterRequest) Displays detailed information about a specified virtual cluster.describeVirtualCluster
(DescribeVirtualClusterRequest describeVirtualClusterRequest) Displays detailed information about a specified virtual cluster.getManagedEndpointSessionCredentials
(Consumer<GetManagedEndpointSessionCredentialsRequest.Builder> getManagedEndpointSessionCredentialsRequest) Generate a session token to connect to a managed endpoint.getManagedEndpointSessionCredentials
(GetManagedEndpointSessionCredentialsRequest getManagedEndpointSessionCredentialsRequest) Generate a session token to connect to a managed endpoint.default CompletableFuture
<ListJobRunsResponse> listJobRuns
(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest) Lists job runs based on a set of parameters.default CompletableFuture
<ListJobRunsResponse> listJobRuns
(ListJobRunsRequest listJobRunsRequest) Lists job runs based on a set of parameters.default ListJobRunsPublisher
listJobRunsPaginator
(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest) This is a variant oflistJobRuns(software.amazon.awssdk.services.emrcontainers.model.ListJobRunsRequest)
operation.default ListJobRunsPublisher
listJobRunsPaginator
(ListJobRunsRequest listJobRunsRequest) This is a variant oflistJobRuns(software.amazon.awssdk.services.emrcontainers.model.ListJobRunsRequest)
operation.listJobTemplates
(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) Lists job templates based on a set of parameters.listJobTemplates
(ListJobTemplatesRequest listJobTemplatesRequest) Lists job templates based on a set of parameters.default ListJobTemplatesPublisher
listJobTemplatesPaginator
(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) This is a variant oflistJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)
operation.default ListJobTemplatesPublisher
listJobTemplatesPaginator
(ListJobTemplatesRequest listJobTemplatesRequest) This is a variant oflistJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)
operation.listManagedEndpoints
(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest) Lists managed endpoints based on a set of parameters.listManagedEndpoints
(ListManagedEndpointsRequest listManagedEndpointsRequest) Lists managed endpoints based on a set of parameters.default ListManagedEndpointsPublisher
listManagedEndpointsPaginator
(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest) This is a variant oflistManagedEndpoints(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsRequest)
operation.default ListManagedEndpointsPublisher
listManagedEndpointsPaginator
(ListManagedEndpointsRequest listManagedEndpointsRequest) This is a variant oflistManagedEndpoints(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags assigned to the resources.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags assigned to the resources.listVirtualClusters
(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest) Lists information about the specified virtual cluster.listVirtualClusters
(ListVirtualClustersRequest listVirtualClustersRequest) Lists information about the specified virtual cluster.default ListVirtualClustersPublisher
listVirtualClustersPaginator
(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest) This is a variant oflistVirtualClusters(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersRequest)
operation.default ListVirtualClustersPublisher
listVirtualClustersPaginator
(ListVirtualClustersRequest listVirtualClustersRequest) This is a variant oflistVirtualClusters(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<StartJobRunResponse> startJobRun
(Consumer<StartJobRunRequest.Builder> startJobRunRequest) Starts a job run.default CompletableFuture
<StartJobRunResponse> startJobRun
(StartJobRunRequest startJobRunRequest) Starts a job run.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns tags to resources.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Assigns tags to resources.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from resources.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from resources.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelJobRun
default CompletableFuture<CancelJobRunResponse> cancelJobRun(CancelJobRunRequest cancelJobRunRequest) Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelJobRun
default CompletableFuture<CancelJobRunResponse> cancelJobRun(Consumer<CancelJobRunRequest.Builder> cancelJobRunRequest) Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
This is a convenience which creates an instance of the
CancelJobRunRequest.Builder
avoiding the need to create one manually viaCancelJobRunRequest.builder()
- Parameters:
cancelJobRunRequest
- AConsumer
that will call methods onCancelJobRunRequest.Builder
to 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createJobTemplate
default CompletableFuture<CreateJobTemplateResponse> createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest) Creates a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
- Parameters:
createJobTemplateRequest
-- Returns:
- A Java Future containing the result of the CreateJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createJobTemplate
default CompletableFuture<CreateJobTemplateResponse> createJobTemplate(Consumer<CreateJobTemplateRequest.Builder> createJobTemplateRequest) Creates a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
This is a convenience which creates an instance of the
CreateJobTemplateRequest.Builder
avoiding the need to create one manually viaCreateJobTemplateRequest.builder()
- Parameters:
createJobTemplateRequest
- AConsumer
that will call methods onCreateJobTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createManagedEndpoint
default CompletableFuture<CreateManagedEndpointResponse> createManagedEndpoint(CreateManagedEndpointRequest createManagedEndpointRequest) Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
- Parameters:
createManagedEndpointRequest
-- Returns:
- A Java Future containing the result of the CreateManagedEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createManagedEndpoint
default CompletableFuture<CreateManagedEndpointResponse> createManagedEndpoint(Consumer<CreateManagedEndpointRequest.Builder> createManagedEndpointRequest) Creates a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
This is a convenience which creates an instance of the
CreateManagedEndpointRequest.Builder
avoiding the need to create one manually viaCreateManagedEndpointRequest.builder()
- Parameters:
createManagedEndpointRequest
- AConsumer
that will call methods onCreateManagedEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateManagedEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVirtualCluster
default CompletableFuture<CreateVirtualClusterResponse> createVirtualCluster(CreateVirtualClusterRequest createVirtualClusterRequest) Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
- Parameters:
createVirtualClusterRequest
-- Returns:
- A Java Future containing the result of the CreateVirtualCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- EksRequestThrottledException The request exceeded the Amazon EKS API operation limits.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createVirtualCluster
default CompletableFuture<CreateVirtualClusterResponse> createVirtualCluster(Consumer<CreateVirtualClusterRequest.Builder> createVirtualClusterRequest) Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
This is a convenience which creates an instance of the
CreateVirtualClusterRequest.Builder
avoiding the need to create one manually viaCreateVirtualClusterRequest.builder()
- Parameters:
createVirtualClusterRequest
- AConsumer
that will call methods onCreateVirtualClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateVirtualCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- EksRequestThrottledException The request exceeded the Amazon EKS API operation limits.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteJobTemplate
default CompletableFuture<DeleteJobTemplateResponse> deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest) Deletes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
- Parameters:
deleteJobTemplateRequest
-- Returns:
- A Java Future containing the result of the DeleteJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteJobTemplate
default CompletableFuture<DeleteJobTemplateResponse> deleteJobTemplate(Consumer<DeleteJobTemplateRequest.Builder> deleteJobTemplateRequest) Deletes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
This is a convenience which creates an instance of the
DeleteJobTemplateRequest.Builder
avoiding the need to create one manually viaDeleteJobTemplateRequest.builder()
- Parameters:
deleteJobTemplateRequest
- AConsumer
that will call methods onDeleteJobTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteManagedEndpoint
default CompletableFuture<DeleteManagedEndpointResponse> deleteManagedEndpoint(DeleteManagedEndpointRequest deleteManagedEndpointRequest) Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
- Parameters:
deleteManagedEndpointRequest
-- Returns:
- A Java Future containing the result of the DeleteManagedEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteManagedEndpoint
default CompletableFuture<DeleteManagedEndpointResponse> deleteManagedEndpoint(Consumer<DeleteManagedEndpointRequest.Builder> deleteManagedEndpointRequest) Deletes a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
This is a convenience which creates an instance of the
DeleteManagedEndpointRequest.Builder
avoiding the need to create one manually viaDeleteManagedEndpointRequest.builder()
- Parameters:
deleteManagedEndpointRequest
- AConsumer
that will call methods onDeleteManagedEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteManagedEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVirtualCluster
default CompletableFuture<DeleteVirtualClusterResponse> deleteVirtualCluster(DeleteVirtualClusterRequest deleteVirtualClusterRequest) Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
- Parameters:
deleteVirtualClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteVirtualCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteVirtualCluster
default CompletableFuture<DeleteVirtualClusterResponse> deleteVirtualCluster(Consumer<DeleteVirtualClusterRequest.Builder> deleteVirtualClusterRequest) Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
This is a convenience which creates an instance of the
DeleteVirtualClusterRequest.Builder
avoiding the need to create one manually viaDeleteVirtualClusterRequest.builder()
- Parameters:
deleteVirtualClusterRequest
- AConsumer
that will call methods onDeleteVirtualClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteVirtualCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeJobRun
default CompletableFuture<DescribeJobRunResponse> describeJobRun(DescribeJobRunRequest describeJobRunRequest) Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
- Parameters:
describeJobRunRequest
-- Returns:
- A Java Future containing the result of the DescribeJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeJobRun
default CompletableFuture<DescribeJobRunResponse> describeJobRun(Consumer<DescribeJobRunRequest.Builder> describeJobRunRequest) Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
This is a convenience which creates an instance of the
DescribeJobRunRequest.Builder
avoiding the need to create one manually viaDescribeJobRunRequest.builder()
- Parameters:
describeJobRunRequest
- AConsumer
that will call methods onDescribeJobRunRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeJobRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeJobTemplate
default CompletableFuture<DescribeJobTemplateResponse> describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest) Displays detailed information about a specified job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
- Parameters:
describeJobTemplateRequest
-- Returns:
- A Java Future containing the result of the DescribeJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeJobTemplate
default CompletableFuture<DescribeJobTemplateResponse> describeJobTemplate(Consumer<DescribeJobTemplateRequest.Builder> describeJobTemplateRequest) Displays detailed information about a specified job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
This is a convenience which creates an instance of the
DescribeJobTemplateRequest.Builder
avoiding the need to create one manually viaDescribeJobTemplateRequest.builder()
- Parameters:
describeJobTemplateRequest
- AConsumer
that will call methods onDescribeJobTemplateRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeJobTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeManagedEndpoint
default CompletableFuture<DescribeManagedEndpointResponse> describeManagedEndpoint(DescribeManagedEndpointRequest describeManagedEndpointRequest) Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
- Parameters:
describeManagedEndpointRequest
-- Returns:
- A Java Future containing the result of the DescribeManagedEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeManagedEndpoint
default CompletableFuture<DescribeManagedEndpointResponse> describeManagedEndpoint(Consumer<DescribeManagedEndpointRequest.Builder> describeManagedEndpointRequest) Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
This is a convenience which creates an instance of the
DescribeManagedEndpointRequest.Builder
avoiding the need to create one manually viaDescribeManagedEndpointRequest.builder()
- Parameters:
describeManagedEndpointRequest
- AConsumer
that will call methods onDescribeManagedEndpointRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeManagedEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVirtualCluster
default CompletableFuture<DescribeVirtualClusterResponse> describeVirtualCluster(DescribeVirtualClusterRequest describeVirtualClusterRequest) Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
- Parameters:
describeVirtualClusterRequest
-- Returns:
- A Java Future containing the result of the DescribeVirtualCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeVirtualCluster
default CompletableFuture<DescribeVirtualClusterResponse> describeVirtualCluster(Consumer<DescribeVirtualClusterRequest.Builder> describeVirtualClusterRequest) Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
This is a convenience which creates an instance of the
DescribeVirtualClusterRequest.Builder
avoiding the need to create one manually viaDescribeVirtualClusterRequest.builder()
- Parameters:
describeVirtualClusterRequest
- AConsumer
that will call methods onDescribeVirtualClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeVirtualCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getManagedEndpointSessionCredentials
default CompletableFuture<GetManagedEndpointSessionCredentialsResponse> getManagedEndpointSessionCredentials(GetManagedEndpointSessionCredentialsRequest getManagedEndpointSessionCredentialsRequest) Generate a session token to connect to a managed endpoint.
- Parameters:
getManagedEndpointSessionCredentialsRequest
-- Returns:
- A Java Future containing the result of the GetManagedEndpointSessionCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- RequestThrottledException The request throttled.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getManagedEndpointSessionCredentials
default CompletableFuture<GetManagedEndpointSessionCredentialsResponse> getManagedEndpointSessionCredentials(Consumer<GetManagedEndpointSessionCredentialsRequest.Builder> getManagedEndpointSessionCredentialsRequest) Generate a session token to connect to a managed endpoint.
This is a convenience which creates an instance of the
GetManagedEndpointSessionCredentialsRequest.Builder
avoiding the need to create one manually viaGetManagedEndpointSessionCredentialsRequest.builder()
- Parameters:
getManagedEndpointSessionCredentialsRequest
- AConsumer
that will call methods onGetManagedEndpointSessionCredentialsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetManagedEndpointSessionCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- RequestThrottledException The request throttled.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobRuns
Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobRuns
default CompletableFuture<ListJobRunsResponse> listJobRuns(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest) Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
This is a convenience which creates an instance of the
ListJobRunsRequest.Builder
avoiding the need to create one manually viaListJobRunsRequest.builder()
- Parameters:
listJobRunsRequest
- AConsumer
that will call methods onListJobRunsRequest.Builder
to 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobRunsPaginator
This is a variant of
listJobRuns(software.amazon.awssdk.services.emrcontainers.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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrcontainers.model.ListJobRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrcontainers.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.emrcontainers.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobRunsPaginator
default ListJobRunsPublisher listJobRunsPaginator(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest) This is a variant of
listJobRuns(software.amazon.awssdk.services.emrcontainers.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 newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsPublisher publisher = client.listJobRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrcontainers.model.ListJobRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrcontainers.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.emrcontainers.model.ListJobRunsRequest)
operation.
This is a convenience which creates an instance of the
ListJobRunsRequest.Builder
avoiding the need to create one manually viaListJobRunsRequest.builder()
- Parameters:
listJobRunsRequest
- AConsumer
that will call methods onListJobRunsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobTemplates
default CompletableFuture<ListJobTemplatesResponse> listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest) Lists job templates based on a set of parameters. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
- Parameters:
listJobTemplatesRequest
-- Returns:
- A Java Future containing the result of the ListJobTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobTemplates
default CompletableFuture<ListJobTemplatesResponse> listJobTemplates(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) Lists job templates based on a set of parameters. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.
This is a convenience which creates an instance of the
ListJobTemplatesRequest.Builder
avoiding the need to create one manually viaListJobTemplatesRequest.builder()
- Parameters:
listJobTemplatesRequest
- AConsumer
that will call methods onListJobTemplatesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListJobTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobTemplatesPaginator
default ListJobTemplatesPublisher listJobTemplatesPaginator(ListJobTemplatesRequest listJobTemplatesRequest) This is a variant of
listJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesPublisher publisher = client.listJobTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesPublisher publisher = client.listJobTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesResponse 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
listJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)
operation.- Parameters:
listJobTemplatesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listJobTemplatesPaginator
default ListJobTemplatesPublisher listJobTemplatesPaginator(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) This is a variant of
listJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesPublisher publisher = client.listJobTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesPublisher publisher = client.listJobTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesResponse 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
listJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListJobTemplatesRequest.Builder
avoiding the need to create one manually viaListJobTemplatesRequest.builder()
- Parameters:
listJobTemplatesRequest
- AConsumer
that will call methods onListJobTemplatesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedEndpoints
default CompletableFuture<ListManagedEndpointsResponse> listManagedEndpoints(ListManagedEndpointsRequest listManagedEndpointsRequest) Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
- Parameters:
listManagedEndpointsRequest
-- Returns:
- A Java Future containing the result of the ListManagedEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedEndpoints
default CompletableFuture<ListManagedEndpointsResponse> listManagedEndpoints(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest) Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
This is a convenience which creates an instance of the
ListManagedEndpointsRequest.Builder
avoiding the need to create one manually viaListManagedEndpointsRequest.builder()
- Parameters:
listManagedEndpointsRequest
- AConsumer
that will call methods onListManagedEndpointsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListManagedEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedEndpointsPaginator
default ListManagedEndpointsPublisher listManagedEndpointsPaginator(ListManagedEndpointsRequest listManagedEndpointsRequest) This is a variant of
listManagedEndpoints(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsPublisher publisher = client.listManagedEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsPublisher publisher = client.listManagedEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsResponse 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
listManagedEndpoints(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsRequest)
operation.- Parameters:
listManagedEndpointsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listManagedEndpointsPaginator
default ListManagedEndpointsPublisher listManagedEndpointsPaginator(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest) This is a variant of
listManagedEndpoints(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsPublisher publisher = client.listManagedEndpointsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsPublisher publisher = client.listManagedEndpointsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsResponse 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
listManagedEndpoints(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsRequest)
operation.
This is a convenience which creates an instance of the
ListManagedEndpointsRequest.Builder
avoiding the need to create one manually viaListManagedEndpointsRequest.builder()
- Parameters:
listManagedEndpointsRequest
- AConsumer
that will call methods onListManagedEndpointsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException This is an internal server exception.
- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException This is an internal server exception.
- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualClusters
default CompletableFuture<ListVirtualClustersResponse> listVirtualClusters(ListVirtualClustersRequest listVirtualClustersRequest) Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
- Parameters:
listVirtualClustersRequest
-- Returns:
- A Java Future containing the result of the ListVirtualClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualClusters
default CompletableFuture<ListVirtualClustersResponse> listVirtualClusters(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest) Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.
This is a convenience which creates an instance of the
ListVirtualClustersRequest.Builder
avoiding the need to create one manually viaListVirtualClustersRequest.builder()
- Parameters:
listVirtualClustersRequest
- AConsumer
that will call methods onListVirtualClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListVirtualClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualClustersPaginator
default ListVirtualClustersPublisher listVirtualClustersPaginator(ListVirtualClustersRequest listVirtualClustersRequest) This is a variant of
listVirtualClusters(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersPublisher publisher = client.listVirtualClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersPublisher publisher = client.listVirtualClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersResponse 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
listVirtualClusters(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersRequest)
operation.- Parameters:
listVirtualClustersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listVirtualClustersPaginator
default ListVirtualClustersPublisher listVirtualClustersPaginator(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest) This is a variant of
listVirtualClusters(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersPublisher publisher = client.listVirtualClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersPublisher publisher = client.listVirtualClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersResponse 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
listVirtualClusters(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersRequest)
operation.
This is a convenience which creates an instance of the
ListVirtualClustersRequest.Builder
avoiding the need to create one manually viaListVirtualClustersRequest.builder()
- Parameters:
listVirtualClustersRequest
- AConsumer
that will call methods onListVirtualClustersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startJobRun
Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startJobRun
default CompletableFuture<StartJobRunResponse> startJobRun(Consumer<StartJobRunRequest.Builder> startJobRunRequest) Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.
This is a convenience which creates an instance of the
StartJobRunRequest.Builder
avoiding the need to create one manually viaStartJobRunRequest.builder()
- Parameters:
startJobRunRequest
- AConsumer
that will call methods onStartJobRunRequest.Builder
to 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- InternalServerException This is an internal server exception.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException This is an internal server exception.
- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException This is an internal server exception.
- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException This is an internal server exception.
- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from resources.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException This is an internal server exception.
- ValidationException There are invalid parameters in the client request.
- ResourceNotFoundException The specified resource was not found.
- 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.
- EmrContainersException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aEmrContainersAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEmrContainersAsyncClient
.
-