You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.EMRServerless

Inherits:
AWS.Service show all
Identifier:
emrserverless
API Version:
2021-07-13
Defined in:
(unknown)

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

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();

Version:

  • 2021-07-13

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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.

Examples:

Constructing a EMRServerless object

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

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.EMRServerless.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.EMRServerless.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.EMRServerless.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Cancels a job run.

Service Reference:

Examples:

Calling the cancelJobRun operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  jobRunId: 'STRING_VALUE' /* required */
};
emrserverless.cancelJobRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application on which the job run will be canceled.

    • jobRunId — (String)

      The ID of the job run to cancel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationId — (String)

        The output contains the application ID on which the job run is cancelled.

      • jobRunId — (String)

        The output contains the ID of the cancelled job run.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Creates an application.

Service Reference:

Examples:

Calling the createApplication operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  releaseLabel: 'STRING_VALUE', /* required */
  type: 'STRING_VALUE', /* required */
  architecture: ARM64 | X86_64,
  autoStartConfiguration: {
    enabled: true || false
  },
  autoStopConfiguration: {
    enabled: true || false,
    idleTimeoutMinutes: 'NUMBER_VALUE'
  },
  initialCapacity: {
    '<WorkerTypeString>': {
      workerCount: 'NUMBER_VALUE', /* required */
      workerConfiguration: {
        cpu: 'STRING_VALUE', /* required */
        memory: 'STRING_VALUE', /* required */
        disk: 'STRING_VALUE'
      }
    },
    /* '<WorkerTypeString>': ... */
  },
  maximumCapacity: {
    cpu: 'STRING_VALUE', /* required */
    memory: 'STRING_VALUE', /* required */
    disk: 'STRING_VALUE'
  },
  name: 'STRING_VALUE',
  networkConfiguration: {
    securityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
emrserverless.createApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the application.

    • releaseLabel — (String)

      The EMR release version associated with the application.

    • type — (String)

      The type of application you want to start, such as Spark or Hive.

    • clientToken — (String)

      The client idempotency token of the application to create. Its value must be unique for each request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • initialCapacity — (map<map>)

      The capacity to initialize when the application is created.

      • workerCountrequired — (Integer)

        The number of workers in the initial capacity configuration.

      • workerConfiguration — (map)

        The resource configuration of the initial capacity configuration.

        • cpurequired — (String)

          The CPU requirements for every worker instance of the worker type.

        • memoryrequired — (String)

          The memory requirements for every worker instance of the worker type.

        • disk — (String)

          The disk requirements for every worker instance of the worker type.

    • maximumCapacity — (map)

      The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit.

      • cpurequired — (String)

        The maximum allowed CPU for an application.

      • memoryrequired — (String)

        The maximum allowed resources for an application.

      • disk — (String)

        The maximum allowed disk for an application.

    • tags — (map<String>)

      The tags assigned to the application.

    • autoStartConfiguration — (map)

      The configuration for an application to automatically start on job submission.

      • enabled — (Boolean)

        Enables the application to automatically start on job submission. Defaults to true.

    • autoStopConfiguration — (map)

      The configuration for an application to automatically stop after a certain amount of time being idle.

      • enabled — (Boolean)

        Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.

      • idleTimeoutMinutes — (Integer)

        The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.

    • networkConfiguration — (map)

      The network configuration for customer VPC connectivity.

      • subnetIds — (Array<String>)

        The array of subnet Ids for customer VPC connectivity.

      • securityGroupIds — (Array<String>)

        The array of security group Ids for customer VPC connectivity.

    • architecture — (String)

      The CPU architecture of an application.

      Possible values include:
      • "ARM64"
      • "X86_64"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationId — (String)

        The output contains the application ID.

      • name — (String)

        The output contains the name of the application.

      • arn — (String)

        The output contains the ARN of the application.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

Examples:

Calling the deleteApplication operation

var params = {
  applicationId: 'STRING_VALUE' /* required */
};
emrserverless.deleteApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application that will be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Displays detailed information about a specified application.

Service Reference:

Examples:

Calling the getApplication operation

var params = {
  applicationId: 'STRING_VALUE' /* required */
};
emrserverless.getApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application that will be described.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • application — (map)

        The output displays information about the specified application.

        • applicationIdrequired — (String)

          The ID of the application.

        • name — (String)

          The name of the application.

        • arnrequired — (String)

          The ARN of the application.

        • releaseLabelrequired — (String)

          The EMR release version associated with the application.

        • typerequired — (String)

          The type of application, such as Spark or Hive.

        • staterequired — (String)

          The state of the application.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "STARTING"
          • "STARTED"
          • "STOPPING"
          • "STOPPED"
          • "TERMINATED"
        • stateDetails — (String)

          The state details of the application.

        • initialCapacity — (map<map>)

          The initial capacity of the application.

          • workerCountrequired — (Integer)

            The number of workers in the initial capacity configuration.

          • workerConfiguration — (map)

            The resource configuration of the initial capacity configuration.

            • cpurequired — (String)

              The CPU requirements for every worker instance of the worker type.

            • memoryrequired — (String)

              The memory requirements for every worker instance of the worker type.

            • disk — (String)

              The disk requirements for every worker instance of the worker type.

        • maximumCapacity — (map)

          The maximum capacity of the application. This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.

          • cpurequired — (String)

            The maximum allowed CPU for an application.

          • memoryrequired — (String)

            The maximum allowed resources for an application.

          • disk — (String)

            The maximum allowed disk for an application.

        • createdAtrequired — (Date)

          The date and time when the application run was created.

        • updatedAtrequired — (Date)

          The date and time when the application run was last updated.

        • tags — (map<String>)

          The tags assigned to the application.

        • autoStartConfiguration — (map)

          The configuration for an application to automatically start on job submission.

          • enabled — (Boolean)

            Enables the application to automatically start on job submission. Defaults to true.

        • autoStopConfiguration — (map)

          The configuration for an application to automatically stop after a certain amount of time being idle.

          • enabled — (Boolean)

            Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.

          • idleTimeoutMinutes — (Integer)

            The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.

        • networkConfiguration — (map)

          The network configuration for customer VPC connectivity for the application.

          • subnetIds — (Array<String>)

            The array of subnet Ids for customer VPC connectivity.

          • securityGroupIds — (Array<String>)

            The array of security group Ids for customer VPC connectivity.

        • architecture — (String)

          The CPU architecture of an application.

          Possible values include:
          • "ARM64"
          • "X86_64"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Returns a URL to access the job run dashboard.

Service Reference:

Examples:

Calling the getDashboardForJobRun operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  jobRunId: 'STRING_VALUE' /* required */
};
emrserverless.getDashboardForJobRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application.

    • jobRunId — (String)

      The ID of the job run.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • url — (String)

        The URL to view job run's dashboard.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Displays detailed information about a job run.

Service Reference:

Examples:

Calling the getJobRun operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  jobRunId: 'STRING_VALUE' /* required */
};
emrserverless.getJobRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application on which the job run is submitted.

    • jobRunId — (String)

      The ID of the job run.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobRun — (map)

        The output displays information about the job run.

        • applicationIdrequired — (String)

          The ID of the application the job is running on.

        • jobRunIdrequired — (String)

          The ID of the job run.

        • name — (String)

          The optional job run name. This doesn't have to be unique.

        • arnrequired — (String)

          The execution role ARN of the job run.

        • createdByrequired — (String)

          The user who created the job run.

        • createdAtrequired — (Date)

          The date and time when the job run was created.

        • updatedAtrequired — (Date)

          The date and time when the job run was updated.

        • executionRolerequired — (String)

          The execution role ARN of the job run.

        • staterequired — (String)

          The state of the job run.

          Possible values include:
          • "SUBMITTED"
          • "PENDING"
          • "SCHEDULED"
          • "RUNNING"
          • "SUCCESS"
          • "FAILED"
          • "CANCELLING"
          • "CANCELLED"
        • stateDetailsrequired — (String)

          The state details of the job run.

        • releaseLabelrequired — (String)

          The EMR release version associated with the application your job is running on.

        • configurationOverrides — (map)

          The configuration settings that are used to override default configuration.

          • applicationConfiguration — (Array<map>)

            The override configurations for the application.

            • classificationrequired — (String)

              The classification within a configuration.

            • properties — (map<String>)

              A set of properties specified within a configuration classification.

          • monitoringConfiguration — (map)

            The override configurations for monitoring.

            • s3MonitoringConfiguration — (map)

              The Amazon S3 configuration for monitoring log publishing.

              • logUri — (String)

                The Amazon S3 destination URI for log publishing.

              • encryptionKeyArn — (String)

                The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

            • managedPersistenceMonitoringConfiguration — (map)

              The managed log persistence configuration for a job run.

              • enabled — (Boolean)

                Enables managed logging and defaults to true. If set to false, managed logging will be turned off.

              • encryptionKeyArn — (String)

                The KMS key ARN to encrypt the logs stored in managed log persistence.

        • jobDriverrequired — (map)

          The job driver for the job run.

          • sparkSubmit — (map)

            The job driver parameters specified for Spark.

            • entryPointrequired — (String)

              The entry point for the Spark submit job run.

            • entryPointArguments — (Array<String>)

              The arguments for the Spark submit job run.

            • sparkSubmitParameters — (String)

              The parameters for the Spark submit job run.

          • hive — (map)

            The job driver parameters specified for Hive.

            • queryrequired — (String)

              The query for the Hive job run.

            • initQueryFile — (String)

              The query file for the Hive job run.

            • parameters — (String)

              The parameters for the Hive job run.

        • tags — (map<String>)

          The tags assigned to the job run.

        • totalResourceUtilization — (map)

          The aggregate vCPU, memory, and storage resources used from the time job start executing till the time job is terminated, rounded up to the nearest second.

          • vCPUHour — (Float)

            The aggregated vCPU used per hour from the time job start executing till the time job is terminated.

          • memoryGBHour — (Float)

            The aggregated memory used per hour from the time job start executing till the time job is terminated.

          • storageGBHour — (Float)

            The aggregated storage used per hour from the time job start executing till the time job is terminated.

        • networkConfiguration — (map)

          The network configuration for customer VPC connectivity.

          • subnetIds — (Array<String>)

            The array of subnet Ids for customer VPC connectivity.

          • securityGroupIds — (Array<String>)

            The array of security group Ids for customer VPC connectivity.

        • totalExecutionDurationSeconds — (Integer)

          The job run total execution duration in seconds. This field is only available for job runs in a COMPLETED, FAILED, or CANCELLED state.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists applications based on a set of parameters.

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    CREATING | CREATED | STARTING | STARTED | STOPPING | STOPPED | TERMINATED,
    /* more items */
  ]
};
emrserverless.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • nextToken — (String)

      The token for the next set of application results.

    • maxResults — (Integer)

      The maximum number of applications that can be listed.

    • states — (Array<String>)

      An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applications — (Array<map>)

        The output lists the specified applications.

        • idrequired — (String)

          The ID of the application.

        • name — (String)

          The name of the application.

        • arnrequired — (String)

          The ARN of the application.

        • releaseLabelrequired — (String)

          The EMR release version associated with the application.

        • typerequired — (String)

          The type of application, such as Spark or Hive.

        • staterequired — (String)

          The state of the application.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "STARTING"
          • "STARTED"
          • "STOPPING"
          • "STOPPED"
          • "TERMINATED"
        • stateDetails — (String)

          The state details of the application.

        • createdAtrequired — (Date)

          The date and time when the application was created.

        • updatedAtrequired — (Date)

          The date and time when the application was last updated.

        • architecture — (String)

          The CPU architecture of an application.

          Possible values include:
          • "ARM64"
          • "X86_64"
      • nextToken — (String)

        The output displays the token for the next set of application results. This is required for pagination and is available as a response of the previous request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists job runs based on a set of parameters.

Service Reference:

Examples:

Calling the listJobRuns operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  createdAtAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdAtBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    SUBMITTED | PENDING | SCHEDULED | RUNNING | SUCCESS | FAILED | CANCELLING | CANCELLED,
    /* more items */
  ]
};
emrserverless.listJobRuns(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application for which to list the job run.

    • nextToken — (String)

      The token for the next set of job run results.

    • maxResults — (Integer)

      The maximum number of job runs that can be listed.

    • createdAtAfter — (Date)

      The lower bound of the option to filter by creation date and time.

    • createdAtBefore — (Date)

      The upper bound of the option to filter by creation date and time.

    • states — (Array<String>)

      An optional filter for job run states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • jobRuns — (Array<map>)

        The output lists information about the specified job runs.

        • applicationIdrequired — (String)

          The ID of the application the job is running on.

        • idrequired — (String)

          The ID of the job run.

        • name — (String)

          The optional job run name. This doesn't have to be unique.

        • arnrequired — (String)

          The ARN of the job run.

        • createdByrequired — (String)

          The user who created the job run.

        • createdAtrequired — (Date)

          The date and time when the job run was created.

        • updatedAtrequired — (Date)

          The date and time when the job run was last updated.

        • executionRolerequired — (String)

          The execution role ARN of the job run.

        • staterequired — (String)

          The state of the job run.

          Possible values include:
          • "SUBMITTED"
          • "PENDING"
          • "SCHEDULED"
          • "RUNNING"
          • "SUCCESS"
          • "FAILED"
          • "CANCELLING"
          • "CANCELLED"
        • stateDetailsrequired — (String)

          The state details of the job run.

        • releaseLabelrequired — (String)

          The EMR release version associated with the application your job is running on.

        • type — (String)

          The type of job run, such as Spark or Hive.

      • nextToken — (String)

        The output displays the token for the next set of job run results. This is required for pagination and is available as a response of the previous request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Lists the tags assigned to the resources.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
emrserverless.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

        The tags for the resource.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Starts a specified application and initializes initial capacity if configured.

Service Reference:

Examples:

Calling the startApplication operation

var params = {
  applicationId: 'STRING_VALUE' /* required */
};
emrserverless.startApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application to start.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Starts a job run.

Service Reference:

Examples:

Calling the startJobRun operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE', /* required */
  executionRoleArn: 'STRING_VALUE', /* required */
  configurationOverrides: {
    applicationConfiguration: [ /* ConfigurationList */
      {
        classification: 'STRING_VALUE', /* required */
        configurations: /* recursive ConfigurationList */,
        properties: {
          '<String1024>': 'STRING_VALUE',
          /* '<String1024>': ... */
        }
      },
      /* more items */
    ],
    monitoringConfiguration: {
      managedPersistenceMonitoringConfiguration: {
        enabled: true || false,
        encryptionKeyArn: 'STRING_VALUE'
      },
      s3MonitoringConfiguration: {
        encryptionKeyArn: 'STRING_VALUE',
        logUri: 'STRING_VALUE'
      }
    }
  },
  executionTimeoutMinutes: 'NUMBER_VALUE',
  jobDriver: {
    hive: {
      query: 'STRING_VALUE', /* required */
      initQueryFile: 'STRING_VALUE',
      parameters: 'STRING_VALUE'
    },
    sparkSubmit: {
      entryPoint: 'STRING_VALUE', /* required */
      entryPointArguments: [
        'STRING_VALUE',
        /* more items */
      ],
      sparkSubmitParameters: 'STRING_VALUE'
    }
  },
  name: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
emrserverless.startJobRun(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application on which to run the job.

    • clientToken — (String)

      The client idempotency token of the job run to start. Its value must be unique for each request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • executionRoleArn — (String)

      The execution role ARN for the job run.

    • jobDriver — (map)

      The job driver for the job run.

      • sparkSubmit — (map)

        The job driver parameters specified for Spark.

        • entryPointrequired — (String)

          The entry point for the Spark submit job run.

        • entryPointArguments — (Array<String>)

          The arguments for the Spark submit job run.

        • sparkSubmitParameters — (String)

          The parameters for the Spark submit job run.

      • hive — (map)

        The job driver parameters specified for Hive.

        • queryrequired — (String)

          The query for the Hive job run.

        • initQueryFile — (String)

          The query file for the Hive job run.

        • parameters — (String)

          The parameters for the Hive job run.

    • configurationOverrides — (map)

      The configuration overrides for the job run.

      • applicationConfiguration — (Array<map>)

        The override configurations for the application.

        • classificationrequired — (String)

          The classification within a configuration.

        • properties — (map<String>)

          A set of properties specified within a configuration classification.

      • monitoringConfiguration — (map)

        The override configurations for monitoring.

        • s3MonitoringConfiguration — (map)

          The Amazon S3 configuration for monitoring log publishing.

          • logUri — (String)

            The Amazon S3 destination URI for log publishing.

          • encryptionKeyArn — (String)

            The KMS key ARN to encrypt the logs published to the given Amazon S3 destination.

        • managedPersistenceMonitoringConfiguration — (map)

          The managed log persistence configuration for a job run.

          • enabled — (Boolean)

            Enables managed logging and defaults to true. If set to false, managed logging will be turned off.

          • encryptionKeyArn — (String)

            The KMS key ARN to encrypt the logs stored in managed log persistence.

    • tags — (map<String>)

      The tags assigned to the job run.

    • executionTimeoutMinutes — (Integer)

      The maximum duration for the job run to run. If the job run runs beyond this duration, it will be automatically cancelled.

    • name — (String)

      The optional job run name. This doesn't have to be unique.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • applicationId — (String)

        This output displays the application ID on which the job run was submitted.

      • jobRunId — (String)

        The output contains the ID of the started job run.

      • arn — (String)

        The output lists the execution role ARN of the job run.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the stopApplication operation

var params = {
  applicationId: 'STRING_VALUE' /* required */
};
emrserverless.stopApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application to stop.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
emrserverless.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

    • tags — (map<String>)

      The tags to add to the resource. A tag is an array of key-value pairs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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

Removes tags from resources.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
emrserverless.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource to list the tags for. Currently, the supported resources are Amazon EMR Serverless applications and job runs.

    • tagKeys — (Array<String>)

      The keys of the tags to be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

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.

Service Reference:

Examples:

Calling the updateApplication operation

var params = {
  applicationId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE', /* required */
  architecture: ARM64 | X86_64,
  autoStartConfiguration: {
    enabled: true || false
  },
  autoStopConfiguration: {
    enabled: true || false,
    idleTimeoutMinutes: 'NUMBER_VALUE'
  },
  initialCapacity: {
    '<WorkerTypeString>': {
      workerCount: 'NUMBER_VALUE', /* required */
      workerConfiguration: {
        cpu: 'STRING_VALUE', /* required */
        memory: 'STRING_VALUE', /* required */
        disk: 'STRING_VALUE'
      }
    },
    /* '<WorkerTypeString>': ... */
  },
  maximumCapacity: {
    cpu: 'STRING_VALUE', /* required */
    memory: 'STRING_VALUE', /* required */
    disk: 'STRING_VALUE'
  },
  networkConfiguration: {
    securityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
emrserverless.updateApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • applicationId — (String)

      The ID of the application to update.

    • clientToken — (String)

      The client idempotency token of the application to update. Its value must be unique for each request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • initialCapacity — (map<map>)

      The capacity to initialize when the application is updated.

      • workerCountrequired — (Integer)

        The number of workers in the initial capacity configuration.

      • workerConfiguration — (map)

        The resource configuration of the initial capacity configuration.

        • cpurequired — (String)

          The CPU requirements for every worker instance of the worker type.

        • memoryrequired — (String)

          The memory requirements for every worker instance of the worker type.

        • disk — (String)

          The disk requirements for every worker instance of the worker type.

    • maximumCapacity — (map)

      The maximum capacity to allocate when the application is updated. This is cumulative across all workers at any given point in time during the lifespan of the application. No new resources will be created once any one of the defined limits is hit.

      • cpurequired — (String)

        The maximum allowed CPU for an application.

      • memoryrequired — (String)

        The maximum allowed resources for an application.

      • disk — (String)

        The maximum allowed disk for an application.

    • autoStartConfiguration — (map)

      The configuration for an application to automatically start on job submission.

      • enabled — (Boolean)

        Enables the application to automatically start on job submission. Defaults to true.

    • autoStopConfiguration — (map)

      The configuration for an application to automatically stop after a certain amount of time being idle.

      • enabled — (Boolean)

        Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.

      • idleTimeoutMinutes — (Integer)

        The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.

    • networkConfiguration — (map)

      The network configuration for customer VPC connectivity.

      • subnetIds — (Array<String>)

        The array of subnet Ids for customer VPC connectivity.

      • securityGroupIds — (Array<String>)

        The array of security group Ids for customer VPC connectivity.

    • architecture — (String)

      The CPU architecture of an application.

      Possible values include:
      • "ARM64"
      • "X86_64"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • application — (map)

        Information about the updated application.

        • applicationIdrequired — (String)

          The ID of the application.

        • name — (String)

          The name of the application.

        • arnrequired — (String)

          The ARN of the application.

        • releaseLabelrequired — (String)

          The EMR release version associated with the application.

        • typerequired — (String)

          The type of application, such as Spark or Hive.

        • staterequired — (String)

          The state of the application.

          Possible values include:
          • "CREATING"
          • "CREATED"
          • "STARTING"
          • "STARTED"
          • "STOPPING"
          • "STOPPED"
          • "TERMINATED"
        • stateDetails — (String)

          The state details of the application.

        • initialCapacity — (map<map>)

          The initial capacity of the application.

          • workerCountrequired — (Integer)

            The number of workers in the initial capacity configuration.

          • workerConfiguration — (map)

            The resource configuration of the initial capacity configuration.

            • cpurequired — (String)

              The CPU requirements for every worker instance of the worker type.

            • memoryrequired — (String)

              The memory requirements for every worker instance of the worker type.

            • disk — (String)

              The disk requirements for every worker instance of the worker type.

        • maximumCapacity — (map)

          The maximum capacity of the application. This is cumulative across all workers at any given point in time during the lifespan of the application is created. No new resources will be created once any one of the defined limits is hit.

          • cpurequired — (String)

            The maximum allowed CPU for an application.

          • memoryrequired — (String)

            The maximum allowed resources for an application.

          • disk — (String)

            The maximum allowed disk for an application.

        • createdAtrequired — (Date)

          The date and time when the application run was created.

        • updatedAtrequired — (Date)

          The date and time when the application run was last updated.

        • tags — (map<String>)

          The tags assigned to the application.

        • autoStartConfiguration — (map)

          The configuration for an application to automatically start on job submission.

          • enabled — (Boolean)

            Enables the application to automatically start on job submission. Defaults to true.

        • autoStopConfiguration — (map)

          The configuration for an application to automatically stop after a certain amount of time being idle.

          • enabled — (Boolean)

            Enables the application to automatically stop after a certain amount of time being idle. Defaults to true.

          • idleTimeoutMinutes — (Integer)

            The amount of idle time in minutes after which your application will automatically stop. Defaults to 15 minutes.

        • networkConfiguration — (map)

          The network configuration for customer VPC connectivity for the application.

          • subnetIds — (Array<String>)

            The array of subnet Ids for customer VPC connectivity.

          • securityGroupIds — (Array<String>)

            The array of security group Ids for customer VPC connectivity.

        • architecture — (String)

          The CPU architecture of an application.

          Possible values include:
          • "ARM64"
          • "X86_64"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.