Interface EmrContainersClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EmrContainersClient extends AwsClient
Service client for accessing Amazon EMR Containers. This can be created using the staticbuilder()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 shared id="EMR-EKS"/>.
Amazon EMR containers is the API name for Amazon EMR on EKS. The
emr-containersprefix 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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
cancelJobRun
default 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.
- Parameters:
cancelJobRunRequest-- Returns:
- Result of the CancelJobRun operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
cancelJobRun
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.Builderavoiding the need to create one manually viaCancelJobRunRequest.builder()- Parameters:
cancelJobRunRequest- AConsumerthat will call methods onCancelJobRunRequest.Builderto create a request.- Returns:
- Result of the CancelJobRun operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
createJobTemplate
default CreateJobTemplateResponse createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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:
- Result of the CreateJobTemplate operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
createJobTemplate
default CreateJobTemplateResponse createJobTemplate(Consumer<CreateJobTemplateRequest.Builder> createJobTemplateRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.Builderavoiding the need to create one manually viaCreateJobTemplateRequest.builder()- Parameters:
createJobTemplateRequest- AConsumerthat will call methods onCreateJobTemplateRequest.Builderto create a request.- Returns:
- Result of the CreateJobTemplate operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
createManagedEndpoint
default CreateManagedEndpointResponse createManagedEndpoint(CreateManagedEndpointRequest createManagedEndpointRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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:
- Result of the CreateManagedEndpoint operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
createManagedEndpoint
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 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.Builderavoiding the need to create one manually viaCreateManagedEndpointRequest.builder()- Parameters:
createManagedEndpointRequest- AConsumerthat will call methods onCreateManagedEndpointRequest.Builderto create a request.- Returns:
- Result of the CreateManagedEndpoint operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
createVirtualCluster
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.
- Parameters:
createVirtualClusterRequest-- Returns:
- Result of the CreateVirtualCluster operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
createVirtualCluster
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.Builderavoiding the need to create one manually viaCreateVirtualClusterRequest.builder()- Parameters:
createVirtualClusterRequest- AConsumerthat will call methods onCreateVirtualClusterRequest.Builderto create a request.- Returns:
- Result of the CreateVirtualCluster operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteJobTemplate
default DeleteJobTemplateResponse deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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:
- Result of the DeleteJobTemplate operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteJobTemplate
default DeleteJobTemplateResponse deleteJobTemplate(Consumer<DeleteJobTemplateRequest.Builder> deleteJobTemplateRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.Builderavoiding the need to create one manually viaDeleteJobTemplateRequest.builder()- Parameters:
deleteJobTemplateRequest- AConsumerthat will call methods onDeleteJobTemplateRequest.Builderto create a request.- Returns:
- Result of the DeleteJobTemplate operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteManagedEndpoint
default DeleteManagedEndpointResponse deleteManagedEndpoint(DeleteManagedEndpointRequest deleteManagedEndpointRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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:
- Result of the DeleteManagedEndpoint operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteManagedEndpoint
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 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.Builderavoiding the need to create one manually viaDeleteManagedEndpointRequest.builder()- Parameters:
deleteManagedEndpointRequest- AConsumerthat will call methods onDeleteManagedEndpointRequest.Builderto create a request.- Returns:
- Result of the DeleteManagedEndpoint operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteVirtualCluster
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.
- Parameters:
deleteVirtualClusterRequest-- Returns:
- Result of the DeleteVirtualCluster operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
deleteVirtualCluster
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.Builderavoiding the need to create one manually viaDeleteVirtualClusterRequest.builder()- Parameters:
deleteVirtualClusterRequest- AConsumerthat will call methods onDeleteVirtualClusterRequest.Builderto create a request.- Returns:
- Result of the DeleteVirtualCluster operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
describeJobRun
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.
- Parameters:
describeJobRunRequest-- Returns:
- Result of the DescribeJobRun operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
describeJobRun
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.Builderavoiding the need to create one manually viaDescribeJobRunRequest.builder()- Parameters:
describeJobRunRequest- AConsumerthat will call methods onDescribeJobRunRequest.Builderto create a request.- Returns:
- Result of the DescribeJobRun operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
describeJobTemplate
default DescribeJobTemplateResponse describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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:
- Result of the DescribeJobTemplate operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
describeJobTemplate
default DescribeJobTemplateResponse describeJobTemplate(Consumer<DescribeJobTemplateRequest.Builder> describeJobTemplateRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.Builderavoiding the need to create one manually viaDescribeJobTemplateRequest.builder()- Parameters:
describeJobTemplateRequest- AConsumerthat will call methods onDescribeJobTemplateRequest.Builderto create a request.- Returns:
- Result of the DescribeJobTemplate operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
describeManagedEndpoint
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 Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
- Parameters:
describeManagedEndpointRequest-- Returns:
- Result of the DescribeManagedEndpoint operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
describeManagedEndpoint
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 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.Builderavoiding the need to create one manually viaDescribeManagedEndpointRequest.builder()- Parameters:
describeManagedEndpointRequest- AConsumerthat will call methods onDescribeManagedEndpointRequest.Builderto create a request.- Returns:
- Result of the DescribeManagedEndpoint operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
describeVirtualCluster
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.
- Parameters:
describeVirtualClusterRequest-- Returns:
- Result of the DescribeVirtualCluster operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
describeVirtualCluster
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.Builderavoiding the need to create one manually viaDescribeVirtualClusterRequest.builder()- Parameters:
describeVirtualClusterRequest- AConsumerthat will call methods onDescribeVirtualClusterRequest.Builderto create a request.- Returns:
- Result of the DescribeVirtualCluster operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
getManagedEndpointSessionCredentials
default GetManagedEndpointSessionCredentialsResponse getManagedEndpointSessionCredentials(GetManagedEndpointSessionCredentialsRequest getManagedEndpointSessionCredentialsRequest) throws ValidationException, RequestThrottledException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Generate a session token to connect to a managed endpoint.
- Parameters:
getManagedEndpointSessionCredentialsRequest-- Returns:
- Result of the GetManagedEndpointSessionCredentials operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getManagedEndpointSessionCredentials
default GetManagedEndpointSessionCredentialsResponse getManagedEndpointSessionCredentials(Consumer<GetManagedEndpointSessionCredentialsRequest.Builder> getManagedEndpointSessionCredentialsRequest) throws ValidationException, RequestThrottledException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
Generate a session token to connect to a managed endpoint.
This is a convenience which creates an instance of the
GetManagedEndpointSessionCredentialsRequest.Builderavoiding the need to create one manually viaGetManagedEndpointSessionCredentialsRequest.builder()- Parameters:
getManagedEndpointSessionCredentialsRequest- AConsumerthat will call methods onGetManagedEndpointSessionCredentialsRequest.Builderto create a request.- Returns:
- Result of the GetManagedEndpointSessionCredentials operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listJobRuns
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.
- Parameters:
listJobRunsRequest-- Returns:
- Result of the ListJobRuns operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listJobRuns
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.Builderavoiding the need to create one manually viaListJobRunsRequest.builder()- Parameters:
listJobRunsRequest- AConsumerthat will call methods onListJobRunsRequest.Builderto create a request.- Returns:
- Result of the ListJobRuns operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listJobRunsPaginator
default ListJobRunsIterable listJobRunsPaginator(ListJobRunsRequest listJobRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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
2) Using For loopsoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsIterable responses = client.listJobRunsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listJobRunsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listJobRunsPaginator
default ListJobRunsIterable listJobRunsPaginator(Consumer<ListJobRunsRequest.Builder> listJobRunsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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
2) Using For loopsoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobRunsIterable responses = client.listJobRunsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListJobRunsRequest.builder()- Parameters:
listJobRunsRequest- AConsumerthat will call methods onListJobRunsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listJobTemplates
default ListJobTemplatesResponse listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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:
- Result of the ListJobTemplates operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listJobTemplates
default ListJobTemplatesResponse listJobTemplates(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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.Builderavoiding the need to create one manually viaListJobTemplatesRequest.builder()- Parameters:
listJobTemplatesRequest- AConsumerthat will call methods onListJobTemplatesRequest.Builderto create a request.- Returns:
- Result of the ListJobTemplates operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listJobTemplatesPaginator
default ListJobTemplatesIterable listJobTemplatesPaginator(ListJobTemplatesRequest listJobTemplatesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
This is a variant of
listJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesIterable responses = client .listJobTemplatesPaginator(request); for (software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(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
listJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)operation.- Parameters:
listJobTemplatesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listJobTemplatesPaginator
default ListJobTemplatesIterable listJobTemplatesPaginator(Consumer<ListJobTemplatesRequest.Builder> listJobTemplatesRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
This is a variant of
listJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)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
2) Using For loopsoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesIterable responses = client .listJobTemplatesPaginator(request); for (software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.emrcontainers.paginators.ListJobTemplatesIterable responses = client.listJobTemplatesPaginator(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
listJobTemplates(software.amazon.awssdk.services.emrcontainers.model.ListJobTemplatesRequest)operation.
This is a convenience which creates an instance of the
ListJobTemplatesRequest.Builderavoiding the need to create one manually viaListJobTemplatesRequest.builder()- Parameters:
listJobTemplatesRequest- AConsumerthat will call methods onListJobTemplatesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listManagedEndpoints
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 Amazon EMR Studio to Amazon EMR on EKS so that Amazon EMR Studio can communicate with your virtual cluster.
- Parameters:
listManagedEndpointsRequest-- Returns:
- Result of the ListManagedEndpoints operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listManagedEndpoints
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 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.Builderavoiding the need to create one manually viaListManagedEndpointsRequest.builder()- Parameters:
listManagedEndpointsRequest- AConsumerthat will call methods onListManagedEndpointsRequest.Builderto create a request.- Returns:
- Result of the ListManagedEndpoints operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listManagedEndpointsPaginator
default ListManagedEndpointsIterable listManagedEndpointsPaginator(ListManagedEndpointsRequest listManagedEndpointsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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
2) Using For loopsoftware.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsIterable responses = client.listManagedEndpointsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listManagedEndpointsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listManagedEndpointsPaginator
default ListManagedEndpointsIterable listManagedEndpointsPaginator(Consumer<ListManagedEndpointsRequest.Builder> listManagedEndpointsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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
2) Using For loopsoftware.amazon.awssdk.services.emrcontainers.paginators.ListManagedEndpointsIterable responses = client.listManagedEndpointsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListManagedEndpointsRequest.builder()- Parameters:
listManagedEndpointsRequest- AConsumerthat will call methods onListManagedEndpointsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, EmrContainersException
Lists the tags assigned to the resources.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listTagsForResource
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listVirtualClusters
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.
- Parameters:
listVirtualClustersRequest-- Returns:
- Result of the ListVirtualClusters operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listVirtualClusters
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.Builderavoiding the need to create one manually viaListVirtualClustersRequest.builder()- Parameters:
listVirtualClustersRequest- AConsumerthat will call methods onListVirtualClustersRequest.Builderto create a request.- Returns:
- Result of the ListVirtualClusters operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
listVirtualClustersPaginator
default ListVirtualClustersIterable listVirtualClustersPaginator(ListVirtualClustersRequest listVirtualClustersRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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
2) Using For loopsoftware.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersIterable responses = client.listVirtualClustersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listVirtualClustersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
listVirtualClustersPaginator
default ListVirtualClustersIterable listVirtualClustersPaginator(Consumer<ListVirtualClustersRequest.Builder> listVirtualClustersRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, EmrContainersException
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
2) Using For loopsoftware.amazon.awssdk.services.emrcontainers.paginators.ListVirtualClustersIterable responses = client.listVirtualClustersPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListVirtualClustersRequest.builder()- Parameters:
listVirtualClustersRequest- AConsumerthat will call methods onListVirtualClustersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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- See Also:
- AWS API Documentation
-
startJobRun
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.
- Parameters:
startJobRunRequest-- Returns:
- Result of the StartJobRun operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
startJobRun
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.Builderavoiding the need to create one manually viaStartJobRunRequest.builder()- Parameters:
startJobRunRequest- AConsumerthat will call methods onStartJobRunRequest.Builderto create a request.- Returns:
- Result of the StartJobRun operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
tagResource
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 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:
- Result of the TagResource operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
tagResource
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 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, EmrContainersException
Removes tags from resources.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
untagResource
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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- See Also:
- AWS API Documentation
-
create
static EmrContainersClient create()
Create aEmrContainersClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static EmrContainersClientBuilder builder()
Create a builder that can be used to configure and create aEmrContainersClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default EmrContainersServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-