@Generated(value="software.amazon.awssdk:codegen") public interface EmrContainersClient extends SdkClient
builder()
method.
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 EKS Service Endpoints.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static EmrContainersClientBuilder |
builder()
Create a builder that can be used to configure and create a
EmrContainersClient . |
default CancelJobRunResponse |
cancelJobRun(CancelJobRunRequest cancelJobRunRequest)
Cancels a job run.
|
default CancelJobRunResponse |
cancelJobRun(Consumer<CancelJobRunRequest.Builder> cancelJobRunRequest)
Cancels a job run.
|
static EmrContainersClient |
create()
Create a
EmrContainersClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateManagedEndpointResponse |
createManagedEndpoint(Consumer<CreateManagedEndpointRequest.Builder> createManagedEndpointRequest)
Creates a managed endpoint.
|
default CreateManagedEndpointResponse |
createManagedEndpoint(CreateManagedEndpointRequest createManagedEndpointRequest)
Creates a managed endpoint.
|
default CreateVirtualClusterResponse |
createVirtualCluster(Consumer<CreateVirtualClusterRequest.Builder> createVirtualClusterRequest)
Creates a virtual cluster.
|
default CreateVirtualClusterResponse |
createVirtualCluster(CreateVirtualClusterRequest createVirtualClusterRequest)
Creates a virtual cluster.
|
default DeleteManagedEndpointResponse |
deleteManagedEndpoint(Consumer<DeleteManagedEndpointRequest.Builder> deleteManagedEndpointRequest)
Deletes a managed endpoint.
|
default DeleteManagedEndpointResponse |
deleteManagedEndpoint(DeleteManagedEndpointRequest deleteManagedEndpointRequest)
Deletes a managed endpoint.
|
default DeleteVirtualClusterResponse |
deleteVirtualCluster(Consumer<DeleteVirtualClusterRequest.Builder> deleteVirtualClusterRequest)
Deletes a virtual cluster.
|
default DeleteVirtualClusterResponse |
deleteVirtualCluster(DeleteVirtualClusterRequest deleteVirtualClusterRequest)
Deletes a virtual cluster.
|
default DescribeJobRunResponse |
describeJobRun(Consumer<DescribeJobRunRequest.Builder> describeJobRunRequest)
Displays detailed information about a job run.
|
default DescribeJobRunResponse |
describeJobRun(DescribeJobRunRequest describeJobRunRequest)
Displays detailed information about a job run.
|
default DescribeManagedEndpointResponse |
describeManagedEndpoint(Consumer<DescribeManagedEndpointRequest.Builder> describeManagedEndpointRequest)
Displays detailed information about a managed endpoint.
|
default DescribeManagedEndpointResponse |
describeManagedEndpoint(DescribeManagedEndpointRequest describeManagedEndpointRequest)
Displays detailed information about a managed endpoint.
|
default DescribeVirtualClusterResponse |
describeVirtualCluster(Consumer<DescribeVirtualClusterRequest.Builder> describeVirtualClusterRequest)
Displays detailed information about a specified virtual cluster.
|
default DescribeVirtualClusterResponse |
describeVirtualCluster(DescribeVirtualClusterRequest describeVirtualClusterRequest)
Displays detailed information about a specified virtual cluster.
|
default ListJobRunsResponse |
listJobRuns(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest)
Lists job runs based on a set of parameters.
|
default ListJobRunsResponse |
listJobRuns(ListJobRunsRequest listJobRunsRequest)
Lists job runs based on a set of parameters.
|
default ListJobRunsIterable |
listJobRunsPaginator(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest)
Lists job runs based on a set of parameters.
|
default ListJobRunsIterable |
listJobRunsPaginator(ListJobRunsRequest listJobRunsRequest)
Lists job runs based on a set of parameters.
|
default ListManagedEndpointsResponse |
listManagedEndpoints(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest)
Lists managed endpoints based on a set of parameters.
|
default ListManagedEndpointsResponse |
listManagedEndpoints(ListManagedEndpointsRequest listManagedEndpointsRequest)
Lists managed endpoints based on a set of parameters.
|
default ListManagedEndpointsIterable |
listManagedEndpointsPaginator(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest)
Lists managed endpoints based on a set of parameters.
|
default ListManagedEndpointsIterable |
listManagedEndpointsPaginator(ListManagedEndpointsRequest listManagedEndpointsRequest)
Lists managed endpoints based on a set of parameters.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags assigned to the resources.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags assigned to the resources.
|
default ListVirtualClustersResponse |
listVirtualClusters(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest)
Lists information about the specified virtual cluster.
|
default ListVirtualClustersResponse |
listVirtualClusters(ListVirtualClustersRequest listVirtualClustersRequest)
Lists information about the specified virtual cluster.
|
default ListVirtualClustersIterable |
listVirtualClustersPaginator(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest)
Lists information about the specified virtual cluster.
|
default ListVirtualClustersIterable |
listVirtualClustersPaginator(ListVirtualClustersRequest listVirtualClustersRequest)
Lists information about the specified virtual cluster.
|
static ServiceMetadata |
serviceMetadata() |
default StartJobRunResponse |
startJobRun(Consumer<StartJobRunRequest.Builder> startJobRunRequest)
Starts a job run.
|
default StartJobRunResponse |
startJobRun(StartJobRunRequest startJobRunRequest)
Starts a job run.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns tags to resources.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns tags to resources.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from resources.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from resources.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static EmrContainersClient create()
EmrContainersClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static EmrContainersClientBuilder builder()
EmrContainersClient
.default CancelJobRunResponse cancelJobRun(CancelJobRunRequest cancelJobRunRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.
cancelJobRunRequest
- 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.AwsServiceException
default CancelJobRunResponse cancelJobRun(Consumer<CancelJobRunRequest.Builder> cancelJobRunRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 via CancelJobRunRequest.builder()
cancelJobRunRequest
- A Consumer
that will call methods on CancelJobRunRequest.Builder
to create a request.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.AwsServiceException
default CreateManagedEndpointResponse createManagedEndpoint(CreateManagedEndpointRequest createManagedEndpointRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
createManagedEndpointRequest
- 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.AwsServiceException
default CreateManagedEndpointResponse createManagedEndpoint(Consumer<CreateManagedEndpointRequest.Builder> createManagedEndpointRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that 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 via CreateManagedEndpointRequest.builder()
createManagedEndpointRequest
- A Consumer
that will call methods on CreateManagedEndpointRequest.Builder
to create a
request.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.AwsServiceException
default CreateVirtualClusterResponse createVirtualCluster(CreateVirtualClusterRequest createVirtualClusterRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.
createVirtualClusterRequest
- 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.AwsServiceException
default CreateVirtualClusterResponse createVirtualCluster(Consumer<CreateVirtualClusterRequest.Builder> createVirtualClusterRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 via CreateVirtualClusterRequest.builder()
createVirtualClusterRequest
- A Consumer
that will call methods on CreateVirtualClusterRequest.Builder
to create a
request.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.AwsServiceException
default DeleteManagedEndpointResponse deleteManagedEndpoint(DeleteManagedEndpointRequest deleteManagedEndpointRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
deleteManagedEndpointRequest
- 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.AwsServiceException
default DeleteManagedEndpointResponse deleteManagedEndpoint(Consumer<DeleteManagedEndpointRequest.Builder> deleteManagedEndpointRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that 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 via DeleteManagedEndpointRequest.builder()
deleteManagedEndpointRequest
- A Consumer
that will call methods on DeleteManagedEndpointRequest.Builder
to create a
request.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.AwsServiceException
default DeleteVirtualClusterResponse deleteVirtualCluster(DeleteVirtualClusterRequest deleteVirtualClusterRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.
deleteVirtualClusterRequest
- 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.AwsServiceException
default DeleteVirtualClusterResponse deleteVirtualCluster(Consumer<DeleteVirtualClusterRequest.Builder> deleteVirtualClusterRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 via DeleteVirtualClusterRequest.builder()
deleteVirtualClusterRequest
- A Consumer
that will call methods on DeleteVirtualClusterRequest.Builder
to create a
request.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.AwsServiceException
default DescribeJobRunResponse describeJobRun(DescribeJobRunRequest describeJobRunRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.
describeJobRunRequest
- 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.AwsServiceException
default DescribeJobRunResponse describeJobRun(Consumer<DescribeJobRunRequest.Builder> describeJobRunRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 via DescribeJobRunRequest.builder()
describeJobRunRequest
- A Consumer
that will call methods on DescribeJobRunRequest.Builder
to create a request.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.AwsServiceException
default DescribeManagedEndpointResponse describeManagedEndpoint(DescribeManagedEndpointRequest describeManagedEndpointRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
describeManagedEndpointRequest
- 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.AwsServiceException
default DescribeManagedEndpointResponse describeManagedEndpoint(Consumer<DescribeManagedEndpointRequest.Builder> describeManagedEndpointRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that 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 via DescribeManagedEndpointRequest.builder()
describeManagedEndpointRequest
- A Consumer
that will call methods on DescribeManagedEndpointRequest.Builder
to create a
request.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.AwsServiceException
default DescribeVirtualClusterResponse describeVirtualCluster(DescribeVirtualClusterRequest describeVirtualClusterRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.
describeVirtualClusterRequest
- 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.AwsServiceException
default DescribeVirtualClusterResponse describeVirtualCluster(Consumer<DescribeVirtualClusterRequest.Builder> describeVirtualClusterRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 via DescribeVirtualClusterRequest.builder()
describeVirtualClusterRequest
- A Consumer
that will call methods on DescribeVirtualClusterRequest.Builder
to create a
request.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.AwsServiceException
default ListJobRunsResponse listJobRuns(ListJobRunsRequest listJobRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.
listJobRunsRequest
- 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.AwsServiceException
default ListJobRunsResponse listJobRuns(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 via ListJobRunsRequest.builder()
listJobRunsRequest
- A Consumer
that will call methods on ListJobRunsRequest.Builder
to create a request.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.AwsServiceException
default ListJobRunsIterable listJobRunsPaginator(ListJobRunsRequest listJobRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 variant of listJobRuns(software.amazon.awssdk.services.emrcontainers.model.ListJobRunsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsIterable responses = client.listJobRunsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsIterable responses = client.listJobRunsPaginator(request); for (software.amazon.awssdk.services.emrcontainers.model.ListJobRunsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsIterable responses = client.listJobRunsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listJobRunsRequest
- 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.AwsServiceException
default ListJobRunsIterable listJobRunsPaginator(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 variant of listJobRuns(software.amazon.awssdk.services.emrcontainers.model.ListJobRunsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsIterable responses = client.listJobRunsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsIterable responses = client.listJobRunsPaginator(request); for (software.amazon.awssdk.services.emrcontainers.model.ListJobRunsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsIterable responses = client.listJobRunsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListJobRunsRequest.builder()
listJobRunsRequest
- A Consumer
that will call methods on ListJobRunsRequest.Builder
to create a request.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.AwsServiceException
default ListManagedEndpointsResponse listManagedEndpoints(ListManagedEndpointsRequest listManagedEndpointsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
listManagedEndpointsRequest
- 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.AwsServiceException
default ListManagedEndpointsResponse listManagedEndpoints(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that 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 via ListManagedEndpointsRequest.builder()
listManagedEndpointsRequest
- A Consumer
that will call methods on ListManagedEndpointsRequest.Builder
to create a
request.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.AwsServiceException
default ListManagedEndpointsIterable listManagedEndpointsPaginator(ListManagedEndpointsRequest listManagedEndpointsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
This is a variant of
listManagedEndpoints(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsIterable responses = client.listManagedEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsIterable responses = client .listManagedEndpointsPaginator(request); for (software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsIterable responses = client.listManagedEndpointsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listManagedEndpointsRequest
- 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.AwsServiceException
default ListManagedEndpointsIterable listManagedEndpointsPaginator(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.
This is a variant of
listManagedEndpoints(software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsIterable responses = client.listManagedEndpointsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsIterable responses = client .listManagedEndpointsPaginator(request); for (software.amazon.awssdk.services.emrcontainers.model.ListManagedEndpointsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsIterable responses = client.listManagedEndpointsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListManagedEndpointsRequest.builder()
listManagedEndpointsRequest
- A Consumer
that will call methods on ListManagedEndpointsRequest.Builder
to create a
request.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.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, EmrContainersException
Lists the tags assigned to the resources.
listTagsForResourceRequest
- 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.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, EmrContainersException
Lists the tags assigned to the resources.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.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.AwsServiceException
default ListVirtualClustersResponse listVirtualClusters(ListVirtualClustersRequest listVirtualClustersRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.
listVirtualClustersRequest
- 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.AwsServiceException
default ListVirtualClustersResponse listVirtualClusters(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 via ListVirtualClustersRequest.builder()
listVirtualClustersRequest
- A Consumer
that will call methods on ListVirtualClustersRequest.Builder
to create a
request.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.AwsServiceException
default ListVirtualClustersIterable listVirtualClustersPaginator(ListVirtualClustersRequest listVirtualClustersRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 variant of
listVirtualClusters(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersIterable responses = client.listVirtualClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersIterable responses = client .listVirtualClustersPaginator(request); for (software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersIterable responses = client.listVirtualClustersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listVirtualClustersRequest
- 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.AwsServiceException
default ListVirtualClustersIterable listVirtualClustersPaginator(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 variant of
listVirtualClusters(software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersIterable responses = client.listVirtualClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersIterable responses = client .listVirtualClustersPaginator(request); for (software.amazon.awssdk.services.emrcontainers.model.ListVirtualClustersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersIterable responses = client.listVirtualClustersPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListVirtualClustersRequest.builder()
listVirtualClustersRequest
- A Consumer
that will call methods on ListVirtualClustersRequest.Builder
to create a
request.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.AwsServiceException
default StartJobRunResponse startJobRun(StartJobRunRequest startJobRunRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.
startJobRunRequest
- 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.AwsServiceException
default StartJobRunResponse startJobRun(Consumer<StartJobRunRequest.Builder> startJobRunRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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 via StartJobRunRequest.builder()
startJobRunRequest
- A Consumer
that will call methods on StartJobRunRequest.Builder
to create a request.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.AwsServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, EmrContainersException
Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS 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.
tagResourceRequest
- 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.AwsServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, EmrContainersException
Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS 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 via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.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.AwsServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, EmrContainersException
Removes tags from resources.
untagResourceRequest
- 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.AwsServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, EmrContainersException
Removes tags from resources.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.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.AwsServiceException
static ServiceMetadata serviceMetadata()