com.amazonaws.services.emrcontainers

Class AmazonEMRContainersClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.emrcontainers.AmazonEMRContainersClient

All Implemented Interfaces:

AmazonEMRContainers

Direct Known Subclasses:

AmazonEMRContainersAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonEMRContainersClient
extends AmazonWebServiceClient
implements AmazonEMRContainers

Client for accessing Amazon EMR Containers. All service calls made using this client are blocking, and will not return until the service call completes.

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. For more information about Amazon EMR on EKS concepts and tasks, see What is Amazon EMR on EKS.

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

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

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

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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.emrcontainers.AmazonEMRContainers

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonEMRContainersClientBuilder	builder()
CancelJobRunResult	cancelJobRun(CancelJobRunRequest request) Cancels a job run.
CreateJobTemplateResult	createJobTemplate(CreateJobTemplateRequest request) Creates a job template.
CreateManagedEndpointResult	createManagedEndpoint(CreateManagedEndpointRequest request) Creates a managed endpoint.
CreateSecurityConfigurationResult	createSecurityConfiguration(CreateSecurityConfigurationRequest request) Creates a security configuration.
CreateVirtualClusterResult	createVirtualCluster(CreateVirtualClusterRequest request) Creates a virtual cluster.
DeleteJobTemplateResult	deleteJobTemplate(DeleteJobTemplateRequest request) Deletes a job template.
DeleteManagedEndpointResult	deleteManagedEndpoint(DeleteManagedEndpointRequest request) Deletes a managed endpoint.
DeleteVirtualClusterResult	deleteVirtualCluster(DeleteVirtualClusterRequest request) Deletes a virtual cluster.
DescribeJobRunResult	describeJobRun(DescribeJobRunRequest request) Displays detailed information about a job run.
DescribeJobTemplateResult	describeJobTemplate(DescribeJobTemplateRequest request) Displays detailed information about a specified job template.
DescribeManagedEndpointResult	describeManagedEndpoint(DescribeManagedEndpointRequest request) Displays detailed information about a managed endpoint.
DescribeSecurityConfigurationResult	describeSecurityConfiguration(DescribeSecurityConfigurationRequest request) Displays detailed information about a specified security configuration.
DescribeVirtualClusterResult	describeVirtualCluster(DescribeVirtualClusterRequest request) 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.
GetManagedEndpointSessionCredentialsResult	getManagedEndpointSessionCredentials(GetManagedEndpointSessionCredentialsRequest request) Generate a session token to connect to a managed endpoint.
ListJobRunsResult	listJobRuns(ListJobRunsRequest request) Lists job runs based on a set of parameters.
ListJobTemplatesResult	listJobTemplates(ListJobTemplatesRequest request) Lists job templates based on a set of parameters.
ListManagedEndpointsResult	listManagedEndpoints(ListManagedEndpointsRequest request) Lists managed endpoints based on a set of parameters.
ListSecurityConfigurationsResult	listSecurityConfigurations(ListSecurityConfigurationsRequest request) Lists security configurations based on a set of parameters.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags assigned to the resources.
ListVirtualClustersResult	listVirtualClusters(ListVirtualClustersRequest request) 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 request) Starts a job run.
TagResourceResult	tagResource(TagResourceRequest request) Assigns tags to resources.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from resources.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonEMRContainersClientBuilder builder()

cancelJobRun

public CancelJobRunResult cancelJobRun(CancelJobRunRequest request)

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.

Specified by:

cancelJobRun in interface AmazonEMRContainers

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

public CreateJobTemplateResult createJobTemplate(CreateJobTemplateRequest request)

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.

Specified by:

createJobTemplate in interface AmazonEMRContainers

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

public CreateManagedEndpointResult createManagedEndpoint(CreateManagedEndpointRequest request)

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.

Specified by:

createManagedEndpoint in interface AmazonEMRContainers

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

createSecurityConfiguration

public CreateSecurityConfigurationResult createSecurityConfiguration(CreateSecurityConfigurationRequest request)

Creates a security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

Specified by:

createSecurityConfiguration in interface AmazonEMRContainers

Parameters:

createSecurityConfigurationRequest -

Returns:

Result of the CreateSecurityConfiguration 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

createVirtualCluster

public CreateVirtualClusterResult createVirtualCluster(CreateVirtualClusterRequest request)

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.

Specified by:

createVirtualCluster in interface AmazonEMRContainers

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.

EKSRequestThrottledException - The request exceeded the Amazon EKS API operation limits.

See Also:

AWS API Documentation

deleteJobTemplate

public DeleteJobTemplateResult deleteJobTemplate(DeleteJobTemplateRequest request)

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.

Specified by:

deleteJobTemplate in interface AmazonEMRContainers

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

public DeleteManagedEndpointResult deleteManagedEndpoint(DeleteManagedEndpointRequest request)

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.

Specified by:

deleteManagedEndpoint in interface AmazonEMRContainers

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

public DeleteVirtualClusterResult deleteVirtualCluster(DeleteVirtualClusterRequest request)

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.

Specified by:

deleteVirtualCluster in interface AmazonEMRContainers

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

public DescribeJobRunResult describeJobRun(DescribeJobRunRequest request)

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.

Specified by:

describeJobRun in interface AmazonEMRContainers

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

public DescribeJobTemplateResult describeJobTemplate(DescribeJobTemplateRequest request)

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.

Specified by:

describeJobTemplate in interface AmazonEMRContainers

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

public DescribeManagedEndpointResult describeManagedEndpoint(DescribeManagedEndpointRequest request)

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.

Specified by:

describeManagedEndpoint in interface AmazonEMRContainers

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

describeSecurityConfiguration

public DescribeSecurityConfigurationResult describeSecurityConfiguration(DescribeSecurityConfigurationRequest request)

Displays detailed information about a specified security configuration. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

Specified by:

describeSecurityConfiguration in interface AmazonEMRContainers

Parameters:

describeSecurityConfigurationRequest -

Returns:

Result of the DescribeSecurityConfiguration 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

public DescribeVirtualClusterResult describeVirtualCluster(DescribeVirtualClusterRequest request)

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.

Specified by:

describeVirtualCluster in interface AmazonEMRContainers

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

getManagedEndpointSessionCredentials

public GetManagedEndpointSessionCredentialsResult getManagedEndpointSessionCredentials(GetManagedEndpointSessionCredentialsRequest request)

Generate a session token to connect to a managed endpoint.

Specified by:

getManagedEndpointSessionCredentials in interface AmazonEMRContainers

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.

See Also:

AWS API Documentation

listJobRuns

public ListJobRunsResult listJobRuns(ListJobRunsRequest request)

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.

Specified by:

listJobRuns in interface AmazonEMRContainers

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

public ListJobTemplatesResult listJobTemplates(ListJobTemplatesRequest request)

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.

Specified by:

listJobTemplates in interface AmazonEMRContainers

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

public ListManagedEndpointsResult listManagedEndpoints(ListManagedEndpointsRequest request)

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.

Specified by:

listManagedEndpoints in interface AmazonEMRContainers

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

listSecurityConfigurations

public ListSecurityConfigurationsResult listSecurityConfigurations(ListSecurityConfigurationsRequest request)

Lists security configurations based on a set of parameters. Security configurations in Amazon EMR on EKS are templates for different security setups. You can use security configurations to configure the Lake Formation integration setup. You can also create a security configuration to re-use a security setup each time you create a virtual cluster.

Specified by:

listSecurityConfigurations in interface AmazonEMRContainers

Parameters:

listSecurityConfigurationsRequest -

Returns:

Result of the ListSecurityConfigurations 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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags assigned to the resources.

Specified by:

listTagsForResource in interface AmazonEMRContainers

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

public ListVirtualClustersResult listVirtualClusters(ListVirtualClustersRequest request)

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.

Specified by:

listVirtualClusters in interface AmazonEMRContainers

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

public StartJobRunResult startJobRun(StartJobRunRequest request)

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.

Specified by:

startJobRun in interface AmazonEMRContainers

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

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AmazonEMRContainers

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from resources.

Specified by:

untagResource in interface AmazonEMRContainers

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonEMRContainers

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonEMRContainers

Overrides:

shutdown in class AmazonWebServiceClient