com.amazonaws.services.emrcontainers

Interface AmazonEMRContainers

All Known Subinterfaces:

AmazonEMRContainersAsync

All Known Implementing Classes:

AbstractAmazonEMRContainers, AbstractAmazonEMRContainersAsync, AmazonEMRContainersAsyncClient, AmazonEMRContainersClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonEMRContainers

Interface for accessing Amazon EMR Containers.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from 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 Amazon EMR on EKS.

Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following scenarios:

• It is the prefix in the CLI commands for Amazon EMR on EKS. For example, aws emr-containers start-job-run.

• It is the prefix before IAM policy actions for Amazon EMR on EKS. For example, "Action": [ "emr-containers:StartJobRun"]. For more information, see Policy actions for Amazon EMR on EKS.

• It is the prefix used in Amazon EMR on EKS service endpoints. For example, emr-containers.us-east-2.amazonaws.com. For more information, see Amazon EMR on EKS Service Endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelJobRunResult	cancelJobRun(CancelJobRunRequest cancelJobRunRequest) Cancels a job run.
CreateJobTemplateResult	createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest) Creates a job template.
CreateManagedEndpointResult	createManagedEndpoint(CreateManagedEndpointRequest createManagedEndpointRequest) Creates a managed endpoint.
CreateVirtualClusterResult	createVirtualCluster(CreateVirtualClusterRequest createVirtualClusterRequest) Creates a virtual cluster.
DeleteJobTemplateResult	deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest) Deletes a job template.
DeleteManagedEndpointResult	deleteManagedEndpoint(DeleteManagedEndpointRequest deleteManagedEndpointRequest) Deletes a managed endpoint.
DeleteVirtualClusterResult	deleteVirtualCluster(DeleteVirtualClusterRequest deleteVirtualClusterRequest) Deletes a virtual cluster.
DescribeJobRunResult	describeJobRun(DescribeJobRunRequest describeJobRunRequest) Displays detailed information about a job run.
DescribeJobTemplateResult	describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest) Displays detailed information about a specified job template.
DescribeManagedEndpointResult	describeManagedEndpoint(DescribeManagedEndpointRequest describeManagedEndpointRequest) Displays detailed information about a managed endpoint.
DescribeVirtualClusterResult	describeVirtualCluster(DescribeVirtualClusterRequest describeVirtualClusterRequest) Displays detailed information about a specified virtual cluster.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListJobRunsResult	listJobRuns(ListJobRunsRequest listJobRunsRequest) Lists job runs based on a set of parameters.
ListJobTemplatesResult	listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest) Lists job templates based on a set of parameters.
ListManagedEndpointsResult	listManagedEndpoints(ListManagedEndpointsRequest listManagedEndpointsRequest) Lists managed endpoints based on a set of parameters.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags assigned to the resources.
ListVirtualClustersResult	listVirtualClusters(ListVirtualClustersRequest listVirtualClustersRequest) Lists information about the specified virtual cluster.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartJobRunResult	startJobRun(StartJobRunRequest startJobRunRequest) Starts a job run.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns tags to resources.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from resources.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelJobRun

CancelJobRunResult cancelJobRun(CancelJobRunRequest cancelJobRunRequest)

Cancels a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

Parameters:

cancelJobRunRequest -

Returns:

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.

See Also:

AWS API Documentation

createJobTemplate

CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest createJobTemplateRequest)

Creates a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

Parameters:

createJobTemplateRequest -

Returns:

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.

See Also:

AWS API Documentation

createManagedEndpoint

CreateManagedEndpointResult createManagedEndpoint(CreateManagedEndpointRequest createManagedEndpointRequest)

Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

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.

See Also:

AWS API Documentation

createVirtualCluster

CreateVirtualClusterResult createVirtualCluster(CreateVirtualClusterRequest createVirtualClusterRequest)

Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Parameters:

createVirtualClusterRequest -

Returns:

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.

See Also:

AWS API Documentation

deleteJobTemplate

DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest deleteJobTemplateRequest)

Deletes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

Parameters:

deleteJobTemplateRequest -

Returns:

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.

See Also:

AWS API Documentation

deleteManagedEndpoint

DeleteManagedEndpointResult deleteManagedEndpoint(DeleteManagedEndpointRequest deleteManagedEndpointRequest)

Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

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.

See Also:

AWS API Documentation

deleteVirtualCluster

DeleteVirtualClusterResult deleteVirtualCluster(DeleteVirtualClusterRequest deleteVirtualClusterRequest)

Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Parameters:

deleteVirtualClusterRequest -

Returns:

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.

See Also:

AWS API Documentation

describeJobRun

DescribeJobRunResult describeJobRun(DescribeJobRunRequest describeJobRunRequest)

Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

Parameters:

describeJobRunRequest -

Returns:

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.

See Also:

AWS API Documentation

describeJobTemplate

DescribeJobTemplateResult describeJobTemplate(DescribeJobTemplateRequest describeJobTemplateRequest)

Displays detailed information about a specified job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

Parameters:

describeJobTemplateRequest -

Returns:

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.

See Also:

AWS API Documentation

describeManagedEndpoint

DescribeManagedEndpointResult describeManagedEndpoint(DescribeManagedEndpointRequest describeManagedEndpointRequest)

Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

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.

See Also:

AWS API Documentation

describeVirtualCluster

DescribeVirtualClusterResult describeVirtualCluster(DescribeVirtualClusterRequest describeVirtualClusterRequest)

Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Parameters:

describeVirtualClusterRequest -

Returns:

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.

See Also:

AWS API Documentation

listJobRuns

ListJobRunsResult listJobRuns(ListJobRunsRequest listJobRunsRequest)

Lists job runs based on a set of parameters. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

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.

See Also:

AWS API Documentation

listJobTemplates

ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest listJobTemplatesRequest)

Lists job templates based on a set of parameters. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

Parameters:

listJobTemplatesRequest -

Returns:

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.

See Also:

AWS API Documentation

listManagedEndpoints

ListManagedEndpointsResult listManagedEndpoints(ListManagedEndpointsRequest listManagedEndpointsRequest)

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

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.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

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.

See Also:

AWS API Documentation

listVirtualClusters

ListVirtualClustersResult listVirtualClusters(ListVirtualClustersRequest listVirtualClustersRequest)

Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Parameters:

listVirtualClustersRequest -

Returns:

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.

See Also:

AWS API Documentation

startJobRun

StartJobRunResult startJobRun(StartJobRunRequest startJobRunRequest)

Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Assigns tags to resources. A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize your AWS resources by attributes such as purpose, owner, or environment. When you have many resources of the same type, you can quickly identify a specific resource based on the tags you've assigned to it. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.

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.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.