com.amazonaws.services.emrserverless

Interface AWSEMRServerless

All Known Subinterfaces:

AWSEMRServerlessAsync

All Known Implementing Classes:

AbstractAWSEMRServerless, AbstractAWSEMRServerlessAsync, AWSEMRServerlessAsyncClient, AWSEMRServerlessClient

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

Interface for accessing EMR Serverless.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSEMRServerless instead.

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

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.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates an application.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an application.
GetApplicationResult	getApplication(GetApplicationRequest getApplicationRequest) 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 getDashboardForJobRunRequest) Creates and returns a URL that you can use to access the application UIs for a job run.
GetJobRunResult	getJobRun(GetJobRunRequest getJobRunRequest) Displays detailed information about a job run.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Lists applications based on a set of parameters.
ListJobRunAttemptsResult	listJobRunAttempts(ListJobRunAttemptsRequest listJobRunAttemptsRequest) Lists all attempt of a job run.
ListJobRunsResult	listJobRuns(ListJobRunsRequest listJobRunsRequest) Lists job runs based on a set of parameters.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 startApplicationRequest) Starts a specified application and initializes initial capacity if configured.
StartJobRunResult	startJobRun(StartJobRunRequest startJobRunRequest) Starts a job run.
StopApplicationResult	stopApplication(StopApplicationRequest stopApplicationRequest) Stops a specified application and releases initial capacity if configured.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns tags to resources.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from resources.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates a specified application.

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.

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

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

Creates an application.

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

DeleteApplicationResult deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

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

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

GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)

Displays detailed information about a specified application.

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

GetDashboardForJobRunResult getDashboardForJobRun(GetDashboardForJobRunRequest getDashboardForJobRunRequest)

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.

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

GetJobRunResult getJobRun(GetJobRunRequest getJobRunRequest)

Displays detailed information about a job run.

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

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

Lists applications based on a set of parameters.

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

ListJobRunAttemptsResult listJobRunAttempts(ListJobRunAttemptsRequest listJobRunAttemptsRequest)

Lists all attempt of a job run.

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

ListJobRunsResult listJobRuns(ListJobRunsRequest listJobRunsRequest)

Lists job runs based on a set of parameters.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags assigned to the resources.

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

StartApplicationResult startApplication(StartApplicationRequest startApplicationRequest)

Starts a specified application and initializes initial capacity if configured.

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

StartJobRunResult startJobRun(StartJobRunRequest startJobRunRequest)

Starts a job run.

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

StopApplicationResult stopApplication(StopApplicationRequest stopApplicationRequest)

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

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from resources.

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

UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

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

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

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.