com.amazonaws.services.emrserverless

Class AWSEMRServerlessClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.emrserverless.AWSEMRServerlessClient

All Implemented Interfaces:

AWSEMRServerless

Direct Known Subclasses:

AWSEMRServerlessAsyncClient

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

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

Amazon EMR Serverless is a new deployment option for Amazon EMR. Amazon EMR Serverless provides a serverless runtime environment that simplifies running analytics applications using the latest open source frameworks such as Apache Spark and Apache Hive. With Amazon EMR Serverless, you don’t have to configure, optimize, secure, or operate clusters to run applications with these frameworks.

The API reference to Amazon EMR Serverless is emr-serverless. The emr-serverless prefix is used in the following scenarios:

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

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

• It is the prefix used in Amazon EMR Serverless service endpoints. For example, emr-serverless.us-east-2.amazonaws.com.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.emrserverless.AWSEMRServerless

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSEMRServerlessClientBuilder	builder()
CancelJobRunResult	cancelJobRun(CancelJobRunRequest request) Cancels a job run.
CreateApplicationResult	createApplication(CreateApplicationRequest request) Creates an application.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Deletes an application.
GetApplicationResult	getApplication(GetApplicationRequest request) Displays detailed information about a specified application.
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.
GetDashboardForJobRunResult	getDashboardForJobRun(GetDashboardForJobRunRequest request) Creates and returns a URL that you can use to access the application UIs for a job run.
GetJobRunResult	getJobRun(GetJobRunRequest request) Displays detailed information about a job run.
ListApplicationsResult	listApplications(ListApplicationsRequest request) Lists applications based on a set of parameters.
ListJobRunAttemptsResult	listJobRunAttempts(ListJobRunAttemptsRequest request) Lists all attempt of a job run.
ListJobRunsResult	listJobRuns(ListJobRunsRequest request) Lists job runs based on a set of parameters.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags assigned to the resources.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartApplicationResult	startApplication(StartApplicationRequest request) Starts a specified application and initializes initial capacity if configured.
StartJobRunResult	startJobRun(StartJobRunRequest request) Starts a job run.
StopApplicationResult	stopApplication(StopApplicationRequest request) Stops a specified application and releases initial capacity if configured.
TagResourceResult	tagResource(TagResourceRequest request) Assigns tags to resources.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from resources.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Updates a specified application.

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 AWSEMRServerlessClientBuilder builder()

cancelJobRun

public CancelJobRunResult cancelJobRun(CancelJobRunRequest request)

Cancels a job run.

Specified by:

cancelJobRun in interface AWSEMRServerless

Parameters:

cancelJobRunRequest -

Returns:

Result of the CancelJobRun operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

Creates an application.

Specified by:

createApplication in interface AWSEMRServerless

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

See Also:

AWS API Documentation

deleteApplication

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

Deletes an application. An application has to be in a stopped or created state in order to be deleted.

Specified by:

deleteApplication in interface AWSEMRServerless

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

getApplication

public GetApplicationResult getApplication(GetApplicationRequest request)

Displays detailed information about a specified application.

Specified by:

getApplication in interface AWSEMRServerless

Parameters:

getApplicationRequest -

Returns:

Result of the GetApplication operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

getDashboardForJobRun

public GetDashboardForJobRunResult getDashboardForJobRun(GetDashboardForJobRunRequest request)

Creates and returns a URL that you can use to access the application UIs for a job run.

For jobs in a running state, the application UI is a live user interface such as the Spark or Tez web UI. For completed jobs, the application UI is a persistent application user interface such as the Spark History Server or persistent Tez UI.

The URL is valid for one hour after you generate it. To access the application UI after that hour elapses, you must invoke the API again to generate a new URL.

Specified by:

getDashboardForJobRun in interface AWSEMRServerless

Parameters:

getDashboardForJobRunRequest -

Returns:

Result of the GetDashboardForJobRun operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

getJobRun

public GetJobRunResult getJobRun(GetJobRunRequest request)

Displays detailed information about a job run.

Specified by:

getJobRun in interface AWSEMRServerless

Parameters:

getJobRunRequest -

Returns:

Result of the GetJobRun operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest request)

Lists applications based on a set of parameters.

Specified by:

listApplications in interface AWSEMRServerless

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

listJobRunAttempts

public ListJobRunAttemptsResult listJobRunAttempts(ListJobRunAttemptsRequest request)

Lists all attempt of a job run.

Specified by:

listJobRunAttempts in interface AWSEMRServerless

Parameters:

listJobRunAttemptsRequest -

Returns:

Result of the ListJobRunAttempts operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

listJobRuns

public ListJobRunsResult listJobRuns(ListJobRunsRequest request)

Lists job runs based on a set of parameters.

Specified by:

listJobRuns in interface AWSEMRServerless

Parameters:

listJobRunsRequest -

Returns:

Result of the ListJobRuns operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags assigned to the resources.

Specified by:

listTagsForResource in interface AWSEMRServerless

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

startApplication

public StartApplicationResult startApplication(StartApplicationRequest request)

Starts a specified application and initializes initial capacity if configured.

Specified by:

startApplication in interface AWSEMRServerless

Parameters:

startApplicationRequest -

Returns:

Result of the StartApplication operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

ServiceQuotaExceededException - The maximum number of resources per account has been reached.

See Also:

AWS API Documentation

startJobRun

public StartJobRunResult startJobRun(StartJobRunRequest request)

Starts a job run.

Specified by:

startJobRun in interface AWSEMRServerless

Parameters:

startJobRunRequest -

Returns:

Result of the StartJobRun operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

ConflictException - The request could not be processed because of conflict in the current state of the resource.

See Also:

AWS API Documentation

stopApplication

public StopApplicationResult stopApplication(StopApplicationRequest request)

Stops a specified application and releases initial capacity if configured. All scheduled and running jobs must be completed or cancelled before stopping an application.

Specified by:

stopApplication in interface AWSEMRServerless

Parameters:

stopApplicationRequest -

Returns:

Result of the StopApplication operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

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.

Specified by:

tagResource in interface AWSEMRServerless

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from resources.

Specified by:

untagResource in interface AWSEMRServerless

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

See Also:

AWS API Documentation

updateApplication

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Updates a specified application. An application has to be in a stopped or created state in order to be updated.

Specified by:

updateApplication in interface AWSEMRServerless

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

ResourceNotFoundException - The specified resource was not found.

InternalServerException - Request processing failed because of an error or failure with the service.

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 AWSEMRServerless

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 AWSEMRServerless

Overrides:

shutdown in class AmazonWebServiceClient