* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.emrcontainers.AbstractAmazonEMRContainers} instead. *
**
* 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-containers prefix is used in
* the following scenarios:
*
* It is the prefix in the CLI commands for Amazon EMR on EKS. For example,
* aws emr-containers start-job-run.
*
* It is the prefix before IAM policy actions for Amazon EMR on EKS. For example,
* "Action": [ "emr-containers:StartJobRun"]. For more information, see Policy actions for Amazon EMR on EKS.
*
* It is the prefix used in Amazon EMR on EKS service endpoints. For example,
* emr-containers.us-east-2.amazonaws.com. For more information, see Amazon EMR on EKSService Endpoints.
*
* 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. *
* * @param cancelJobRunRequest * @return Result of the CancelJobRun operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.CancelJobRun * @see AWS * API Documentation */ CancelJobRunResult cancelJobRun(CancelJobRunRequest cancelJobRunRequest); /** ** 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. *
* * @param createJobTemplateRequest * @return Result of the CreateJobTemplate operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.CreateJobTemplate * @see AWS API Documentation */ CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest); /** ** 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. *
* * @param createManagedEndpointRequest * @return Result of the CreateManagedEndpoint operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.CreateManagedEndpoint * @see AWS API Documentation */ CreateManagedEndpointResult createManagedEndpoint(CreateManagedEndpointRequest createManagedEndpointRequest); /** ** 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. *
* * @param createVirtualClusterRequest * @return Result of the CreateVirtualCluster operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.CreateVirtualCluster * @see AWS API Documentation */ CreateVirtualClusterResult createVirtualCluster(CreateVirtualClusterRequest createVirtualClusterRequest); /** ** 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. *
* * @param deleteJobTemplateRequest * @return Result of the DeleteJobTemplate operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.DeleteJobTemplate * @see AWS API Documentation */ DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest); /** ** 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. *
* * @param deleteManagedEndpointRequest * @return Result of the DeleteManagedEndpoint operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.DeleteManagedEndpoint * @see AWS API Documentation */ DeleteManagedEndpointResult deleteManagedEndpoint(DeleteManagedEndpointRequest deleteManagedEndpointRequest); /** ** 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. *
* * @param deleteVirtualClusterRequest * @return Result of the DeleteVirtualCluster operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.DeleteVirtualCluster * @see AWS API Documentation */ DeleteVirtualClusterResult deleteVirtualCluster(DeleteVirtualClusterRequest deleteVirtualClusterRequest); /** ** 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. *
* * @param describeJobRunRequest * @return Result of the DescribeJobRun operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.DescribeJobRun * @see AWS * API Documentation */ DescribeJobRunResult describeJobRun(DescribeJobRunRequest describeJobRunRequest); /** ** 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. *
* * @param describeJobTemplateRequest * @return Result of the DescribeJobTemplate operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.DescribeJobTemplate * @see AWS API Documentation */ DescribeJobTemplateResult describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest); /** ** 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. *
* * @param describeManagedEndpointRequest * @return Result of the DescribeManagedEndpoint operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.DescribeManagedEndpoint * @see AWS API Documentation */ DescribeManagedEndpointResult describeManagedEndpoint(DescribeManagedEndpointRequest describeManagedEndpointRequest); /** ** 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. *
* * @param describeVirtualClusterRequest * @return Result of the DescribeVirtualCluster operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.DescribeVirtualCluster * @see AWS API Documentation */ DescribeVirtualClusterResult describeVirtualCluster(DescribeVirtualClusterRequest describeVirtualClusterRequest); /** ** Generate a session token to connect to a managed endpoint. *
* * @param getManagedEndpointSessionCredentialsRequest * @return Result of the GetManagedEndpointSessionCredentials operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws RequestThrottledException * The request throttled. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.GetManagedEndpointSessionCredentials * @see AWS API Documentation */ GetManagedEndpointSessionCredentialsResult getManagedEndpointSessionCredentials( GetManagedEndpointSessionCredentialsRequest getManagedEndpointSessionCredentialsRequest); /** ** 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. *
* * @param listJobRunsRequest * @return Result of the ListJobRuns operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.ListJobRuns * @see AWS API * Documentation */ ListJobRunsResult listJobRuns(ListJobRunsRequest listJobRunsRequest); /** ** 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. *
* * @param listJobTemplatesRequest * @return Result of the ListJobTemplates operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.ListJobTemplates * @see AWS API Documentation */ ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest); /** ** 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. *
* * @param listManagedEndpointsRequest * @return Result of the ListManagedEndpoints operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.ListManagedEndpoints * @see AWS API Documentation */ ListManagedEndpointsResult listManagedEndpoints(ListManagedEndpointsRequest listManagedEndpointsRequest); /** ** Lists the tags assigned to the resources. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InternalServerException * This is an internal server exception. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @sample AmazonEMRContainers.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** ** 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. *
* * @param listVirtualClustersRequest * @return Result of the ListVirtualClusters operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.ListVirtualClusters * @see AWS API Documentation */ ListVirtualClustersResult listVirtualClusters(ListVirtualClustersRequest listVirtualClustersRequest); /** ** 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. *
* * @param startJobRunRequest * @return Result of the StartJobRun operation returned by the service. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * This is an internal server exception. * @sample AmazonEMRContainers.StartJobRun * @see AWS API * Documentation */ StartJobRunResult startJobRun(StartJobRunRequest startJobRunRequest); /** ** 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. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws InternalServerException * This is an internal server exception. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @sample AmazonEMRContainers.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** ** Removes tags from resources. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InternalServerException * This is an internal server exception. * @throws ValidationException * There are invalid parameters in the client request. * @throws ResourceNotFoundException * The specified resource was not found. * @sample AmazonEMRContainers.UntagResource * @see AWS * API Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. ** Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }