AWS.EMRServerless — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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:

Sending a Request Using EMRServerless

var emrserverless = new AWS.EMRServerless();
emrserverless.cancelJobRun(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the EMRServerless object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var emrserverless = new AWS.EMRServerless({apiVersion: '2021-07-13'});

You can also set the API version globally in AWS.config.apiVersions using the emrserverless service identifier:

AWS.config.apiVersions = {
  emrserverless: '2021-07-13',
  // other service API versions
};

var emrserverless = new AWS.EMRServerless();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.EMRServerless(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createApplication(params = {}, callback) ⇒ AWS.Request

deleteApplication(params = {}, callback) ⇒ AWS.Request

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

getApplication(params = {}, callback) ⇒ AWS.Request

Displays detailed information about a specified application.

getDashboardForJobRun(params = {}, callback) ⇒ AWS.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.

Note: 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.

getJobRun(params = {}, callback) ⇒ AWS.Request

Displays detailed information about a job run.

listApplications(params = {}, callback) ⇒ AWS.Request

Lists applications based on a set of parameters.

listJobRunAttempts(params = {}, callback) ⇒ AWS.Request

Lists all attempt of a job run.

listJobRuns(params = {}, callback) ⇒ AWS.Request

Lists job runs based on a set of parameters.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags assigned to the resources.

startApplication(params = {}, callback) ⇒ AWS.Request

Starts a specified application and initializes initial capacity if configured.

stopApplication(params = {}, callback) ⇒ AWS.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.

tagResource(params = {}, callback) ⇒ AWS.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.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from resources.

updateApplication(params = {}, callback) ⇒ AWS.Request

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