Class: AWS.EMRServerless

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'
  },
  imageConfiguration: {
    imageUri: 'STRING_VALUE'
  },
  initialCapacity: {
    '<WorkerTypeString>': {
      workerCount: 'NUMBER_VALUE', /* required */
      workerConfiguration: {
        cpu: 'STRING_VALUE', /* required */
        memory: 'STRING_VALUE', /* required */
        disk: 'STRING_VALUE',
        diskType: 'STRING_VALUE'
      }
    },
    /* '<WorkerTypeString>': ... */
  },
  interactiveConfiguration: {
    livyEndpointEnabled: true || false,
    studioEnabled: true || false
  },
  maximumCapacity: {
    cpu: 'STRING_VALUE', /* required */
    memory: 'STRING_VALUE', /* required */
    disk: 'STRING_VALUE'
  },
  monitoringConfiguration: {
    cloudWatchLoggingConfiguration: {
      enabled: true || false, /* required */
      encryptionKeyArn: 'STRING_VALUE',
      logGroupName: 'STRING_VALUE',
      logStreamNamePrefix: 'STRING_VALUE',
      logTypes: {
        '<WorkerTypeString>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<WorkerTypeString>': ... */
      }
    },
    managedPersistenceMonitoringConfiguration: {
      enabled: true || false,
      encryptionKeyArn: 'STRING_VALUE'
    },
    prometheusMonitoringConfiguration: {
      remoteWriteUrl: 'STRING_VALUE'
    },
    s3MonitoringConfiguration: {
      encryptionKeyArn: 'STRING_VALUE',
      logUri: 'STRING_VALUE'
    }
  },
  name: 'STRING_VALUE',
  networkConfiguration: {
    securityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  runtimeConfiguration: [ /* ConfigurationList */
    {
      classification: 'STRING_VALUE', /* required */
      configurations: /* recursive ConfigurationList */,
      properties: {
        '<ConfigurationPropertyKey>': 'STRING_VALUE',
        /* '<ConfigurationPropertyKey>': ... */
      }
    },
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  workerTypeSpecifications: {
    '<WorkerTypeString>': {
      imageConfiguration: {
        imageUri: 'STRING_VALUE'
      }
    },
    /* '<WorkerTypeString>': ... */
  }
};
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 Amazon EMR release 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.

    • workerCount — required — (Integer)

      The number of workers in the initial capacity configuration.

    • workerConfiguration — (map)

      The resource configuration of the initial capacity configuration.

      • cpu — required — (String)

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

      • memory — required — (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.

      • diskType — (String)

        The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD.

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

    • cpu — required — (String)

      The maximum allowed CPU for an application.

    • memory — required — (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"
  • imageConfiguration — (map)

    The image configuration for all worker types. You can either set this parameter or imageConfiguration for each worker type in workerTypeSpecifications.

    • imageUri — (String)

      The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.

  • workerTypeSpecifications — (map<map>)

    The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.

    • imageConfiguration — (map)

      The image configuration for a worker type.

      • imageUri — (String)

        The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.

  • runtimeConfiguration — (Array<map>)

    The Configuration specifications to use when creating an application. Each configuration consists of a classification and properties. This configuration is applied to all the job runs submitted under the application.

    • classification — required — (String)

      The classification within a configuration.

    • properties — (map<String>)

      A set of properties specified within a configuration classification.

    • configurations — (Array<map>)

      A list of additional configurations to apply within a configuration object.

  • monitoringConfiguration — (map)

    The configuration setting 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.

    • cloudWatchLoggingConfiguration — (map)

      The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

      • enabled — required — (Boolean)

        Enables CloudWatch logging.

      • logGroupName — (String)

        The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

      • logStreamNamePrefix — (String)

        Prefix for the CloudWatch log stream name.

      • encryptionKeyArn — (String)

        The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

      • logTypes — (map<Array<String>>)

        The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

        • Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK

        • Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

    • prometheusMonitoringConfiguration — (map)

      The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

      • remoteWriteUrl — (String)

        The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.

  • interactiveConfiguration — (map)

    The interactive configuration object that enables the interactive use cases to use when running an application.

    • studioEnabled — (Boolean)

      Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.

    • livyEndpointEnabled — (Boolean)

      Enables an Apache Livy endpoint that you can connect to and run interactive jobs.

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.

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.

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.

      • applicationId — required — (String)

        The ID of the application.

      • name — (String)

        The name of the application.

      • arn — required — (String)

        The ARN of the application.

      • releaseLabel — required — (String)

        The Amazon EMR release associated with the application.

      • type — required — (String)

        The type of application, such as Spark or Hive.

      • state — required — (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.

        • workerCount — required — (Integer)

          The number of workers in the initial capacity configuration.

        • workerConfiguration — (map)

          The resource configuration of the initial capacity configuration.

          • cpu — required — (String)

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

          • memory — required — (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.

          • diskType — (String)

            The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD.

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

        • cpu — required — (String)

          The maximum allowed CPU for an application.

        • memory — required — (String)

          The maximum allowed resources for an application.

        • disk — (String)

          The maximum allowed disk for an application.

      • createdAt — required — (Date)

        The date and time when the application run was created.

      • updatedAt — required — (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"
      • imageConfiguration — (map)

        The image configuration applied to all worker types.

        • imageUri — required — (String)

          The image URI.

        • resolvedImageDigest — (String)

          The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.

      • workerTypeSpecifications — (map<map>)

        The specification applied to each worker type.

        • imageConfiguration — (map)

          The image configuration for a worker type.

          • imageUri — required — (String)

            The image URI.

          • resolvedImageDigest — (String)

            The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.

      • runtimeConfiguration — (Array<map>)

        The Configuration specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the GetApplication API operation.

        • classification — required — (String)

          The classification within a configuration.

        • properties — (map<String>)

          A set of properties specified within a configuration classification.

      • monitoringConfiguration — (map)

        The configuration setting 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.

        • cloudWatchLoggingConfiguration — (map)

          The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

          • enabled — required — (Boolean)

            Enables CloudWatch logging.

          • logGroupName — (String)

            The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

          • logStreamNamePrefix — (String)

            Prefix for the CloudWatch log stream name.

          • encryptionKeyArn — (String)

            The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

          • logTypes — (map<Array<String>>)

            The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

            • Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK

            • Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

        • prometheusMonitoringConfiguration — (map)

          The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

          • remoteWriteUrl — (String)

            The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.

      • interactiveConfiguration — (map)

        The interactive configuration object that enables the interactive use cases for an application.

        • studioEnabled — (Boolean)

          Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.

        • livyEndpointEnabled — (Boolean)

          Enables an Apache Livy endpoint that you can connect to and run interactive jobs.

Returns:

• (AWS.Request) —

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

var params = {
  applicationId: 'STRING_VALUE', /* required */
  jobRunId: 'STRING_VALUE', /* required */
  attempt: 'NUMBER_VALUE'
};
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.

  • attempt — (Integer)

    An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.

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.

var params = {
  applicationId: 'STRING_VALUE', /* required */
  jobRunId: 'STRING_VALUE', /* required */
  attempt: 'NUMBER_VALUE'
};
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.

  • attempt — (Integer)

    An optimal parameter that indicates the amount of attempts for the job. If not specified, this value defaults to the attempt of the latest job.

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.

      • applicationId — required — (String)

        The ID of the application the job is running on.

      • jobRunId — required — (String)

        The ID of the job run.

      • name — (String)

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

      • arn — required — (String)

        The execution role ARN of the job run.

      • createdBy — required — (String)

        The user who created the job run.

      • createdAt — required — (Date)

        The date and time when the job run was created.

      • updatedAt — required — (Date)

        The date and time when the job run was updated.

      • executionRole — required — (String)

        The execution role ARN of the job run.

      • state — required — (String)

        The state of the job run.

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

        The state details of the job run.

      • releaseLabel — required — (String)

        The Amazon EMR release 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.

          • classification — required — (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.

          • cloudWatchLoggingConfiguration — (map)

            The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

            • enabled — required — (Boolean)

              Enables CloudWatch logging.

            • logGroupName — (String)

              The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

            • logStreamNamePrefix — (String)

              Prefix for the CloudWatch log stream name.

            • encryptionKeyArn — (String)

              The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

            • logTypes — (map<Array<String>>)

              The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

              • Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK

              • Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

          • prometheusMonitoringConfiguration — (map)

            The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

            • remoteWriteUrl — (String)

              The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.

      • jobDriver — required — (map)

        The job driver for the job run.

        • sparkSubmit — (map)

          The job driver parameters specified for Spark.

          • entryPoint — required — (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.

          • query — required — (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 the job starts to execute, until the time the job terminates, 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.

      • executionTimeoutMinutes — (Integer)

        Returns the job run timeout value from the StartJobRun call. If no timeout was specified, then it returns the default timeout of 720 minutes.

      • billedResourceUtilization — (map)

        The aggregate vCPU, memory, and storage that Amazon Web Services has billed for the job run. The billed resources include a 1-minute minimum usage for workers, plus additional storage over 20 GB per worker. Note that billed resources do not include usage for idle pre-initialized workers.

        • vCPUHour — (Float)

          The aggregated vCPU used per hour from the time the job starts executing until the job is terminated.

        • memoryGBHour — (Float)

          The aggregated memory used per hour from the time the job starts executing until the job is terminated.

        • storageGBHour — (Float)

          The aggregated storage used per hour from the time the job starts executing until the job is terminated.

      • mode — (String)

        The mode of the job run.

        Possible values include:
        • "BATCH"
        • "STREAMING"
      • retryPolicy — (map)

        The retry policy of the job run.

        • maxAttempts — (Integer)

          Maximum number of attempts for the job run. This parameter is only applicable for BATCH mode.

        • maxFailedAttemptsPerHour — (Integer)

          Maximum number of failed attempts per hour. This [arameter is only applicable for STREAMING mode.

      • attempt — (Integer)

        The attempt of the job run.

      • attemptCreatedAt — (Date)

        The date and time of when the job run attempt was created.

      • attemptUpdatedAt — (Date)

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

Returns:

• (AWS.Request) —

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

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.

      • id — required — (String)

        The ID of the application.

      • name — (String)

        The name of the application.

      • arn — required — (String)

        The ARN of the application.

      • releaseLabel — required — (String)

        The Amazon EMR release associated with the application.

      • type — required — (String)

        The type of application, such as Spark or Hive.

      • state — required — (String)

        The state of the application.

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

        The state details of the application.

      • createdAt — required — (Date)

        The date and time when the application was created.

      • updatedAt — required — (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.

var params = {
  applicationId: 'STRING_VALUE', /* required */
  jobRunId: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
emrserverless.listJobRunAttempts(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 job runs.

  • jobRunId — (String)

    The ID of the job run to list.

  • nextToken — (String)

    The token for the next set of job run attempt results.

  • maxResults — (Integer)

    The maximum number of job run attempts to list.

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:

    • jobRunAttempts — (Array<map>)

      The array of the listed job run attempt objects.

      • applicationId — required — (String)

        The ID of the application the job is running on.

      • id — required — (String)

        The ID of the job run attempt.

      • name — (String)

        The name of the job run attempt.

      • mode — (String)

        The mode of the job run attempt.

        Possible values include:
        • "BATCH"
        • "STREAMING"
      • arn — required — (String)

        The Amazon Resource Name (ARN) of the job run.

      • createdBy — required — (String)

        The user who created the job run.

      • jobCreatedAt — required — (Date)

        The date and time of when the job run was created.

      • createdAt — required — (Date)

        The date and time when the job run attempt was created.

      • updatedAt — required — (Date)

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

      • executionRole — required — (String)

        The Amazon Resource Name (ARN) of the execution role of the job run..

      • state — required — (String)

        The state of the job run attempt.

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

        The state details of the job run attempt.

      • releaseLabel — required — (String)

        The Amazon EMR release label of the job run attempt.

      • type — (String)

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

      • attempt — (Integer)

        The attempt number of the job run execution.

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

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',
  mode: BATCH | STREAMING,
  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.

  • mode — (String)

    The mode of the job runs to list.

    Possible values include:
    • "BATCH"
    • "STREAMING"

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.

      • applicationId — required — (String)

        The ID of the application the job is running on.

      • id — required — (String)

        The ID of the job run.

      • name — (String)

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

      • mode — (String)

        The mode of the job run.

        Possible values include:
        • "BATCH"
        • "STREAMING"
      • arn — required — (String)

        The ARN of the job run.

      • createdBy — required — (String)

        The user who created the job run.

      • createdAt — required — (Date)

        The date and time when the job run was created.

      • updatedAt — required — (Date)

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

      • executionRole — required — (String)

        The execution role ARN of the job run.

      • state — required — (String)

        The state of the job run.

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

        The state details of the job run.

      • releaseLabel — required — (String)

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

      • type — (String)

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

      • attempt — (Integer)

        The attempt number of the job run execution.

      • attemptCreatedAt — (Date)

        The date and time of when the job run attempt was created.

      • attemptUpdatedAt — (Date)

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

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

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.

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.

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: {
          '<ConfigurationPropertyKey>': 'STRING_VALUE',
          /* '<ConfigurationPropertyKey>': ... */
        }
      },
      /* more items */
    ],
    monitoringConfiguration: {
      cloudWatchLoggingConfiguration: {
        enabled: true || false, /* required */
        encryptionKeyArn: 'STRING_VALUE',
        logGroupName: 'STRING_VALUE',
        logStreamNamePrefix: 'STRING_VALUE',
        logTypes: {
          '<WorkerTypeString>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<WorkerTypeString>': ... */
        }
      },
      managedPersistenceMonitoringConfiguration: {
        enabled: true || false,
        encryptionKeyArn: 'STRING_VALUE'
      },
      prometheusMonitoringConfiguration: {
        remoteWriteUrl: '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'
    }
  },
  mode: BATCH | STREAMING,
  name: 'STRING_VALUE',
  retryPolicy: {
    maxAttempts: 'NUMBER_VALUE',
    maxFailedAttemptsPerHour: 'NUMBER_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.

      • entryPoint — required — (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.

      • query — required — (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.

      • classification — required — (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.

      • cloudWatchLoggingConfiguration — (map)

        The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

        • enabled — required — (Boolean)

          Enables CloudWatch logging.

        • logGroupName — (String)

          The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

        • logStreamNamePrefix — (String)

          Prefix for the CloudWatch log stream name.

        • encryptionKeyArn — (String)

          The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

        • logTypes — (map<Array<String>>)

          The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

          • Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK

          • Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

      • prometheusMonitoringConfiguration — (map)

        The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

        • remoteWriteUrl — (String)

          The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.

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

  • mode — (String)

    The mode of the job run when it starts.

    Possible values include:
    • "BATCH"
    • "STREAMING"
  • retryPolicy — (map)

    The retry policy when job run starts.

    • maxAttempts — (Integer)

      Maximum number of attempts for the job run. This parameter is only applicable for BATCH mode.

    • maxFailedAttemptsPerHour — (Integer)

      Maximum number of failed attempts per hour. This [arameter is only applicable for STREAMING mode.

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)

      This output displays the ARN of the job run..

Returns:

• (AWS.Request) —

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

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.

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.

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.

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'
  },
  imageConfiguration: {
    imageUri: 'STRING_VALUE'
  },
  initialCapacity: {
    '<WorkerTypeString>': {
      workerCount: 'NUMBER_VALUE', /* required */
      workerConfiguration: {
        cpu: 'STRING_VALUE', /* required */
        memory: 'STRING_VALUE', /* required */
        disk: 'STRING_VALUE',
        diskType: 'STRING_VALUE'
      }
    },
    /* '<WorkerTypeString>': ... */
  },
  interactiveConfiguration: {
    livyEndpointEnabled: true || false,
    studioEnabled: true || false
  },
  maximumCapacity: {
    cpu: 'STRING_VALUE', /* required */
    memory: 'STRING_VALUE', /* required */
    disk: 'STRING_VALUE'
  },
  monitoringConfiguration: {
    cloudWatchLoggingConfiguration: {
      enabled: true || false, /* required */
      encryptionKeyArn: 'STRING_VALUE',
      logGroupName: 'STRING_VALUE',
      logStreamNamePrefix: 'STRING_VALUE',
      logTypes: {
        '<WorkerTypeString>': [
          'STRING_VALUE',
          /* more items */
        ],
        /* '<WorkerTypeString>': ... */
      }
    },
    managedPersistenceMonitoringConfiguration: {
      enabled: true || false,
      encryptionKeyArn: 'STRING_VALUE'
    },
    prometheusMonitoringConfiguration: {
      remoteWriteUrl: 'STRING_VALUE'
    },
    s3MonitoringConfiguration: {
      encryptionKeyArn: 'STRING_VALUE',
      logUri: 'STRING_VALUE'
    }
  },
  networkConfiguration: {
    securityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    subnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  releaseLabel: 'STRING_VALUE',
  runtimeConfiguration: [ /* ConfigurationList */
    {
      classification: 'STRING_VALUE', /* required */
      configurations: /* recursive ConfigurationList */,
      properties: {
        '<ConfigurationPropertyKey>': 'STRING_VALUE',
        /* '<ConfigurationPropertyKey>': ... */
      }
    },
    /* more items */
  ],
  workerTypeSpecifications: {
    '<WorkerTypeString>': {
      imageConfiguration: {
        imageUri: 'STRING_VALUE'
      }
    },
    /* '<WorkerTypeString>': ... */
  }
};
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.

    • workerCount — required — (Integer)

      The number of workers in the initial capacity configuration.

    • workerConfiguration — (map)

      The resource configuration of the initial capacity configuration.

      • cpu — required — (String)

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

      • memory — required — (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.

      • diskType — (String)

        The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD.

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

    • cpu — required — (String)

      The maximum allowed CPU for an application.

    • memory — required — (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"
  • imageConfiguration — (map)

    The image configuration to be used for all worker types. You can either set this parameter or imageConfiguration for each worker type in WorkerTypeSpecificationInput.

    • imageUri — (String)

      The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.

  • workerTypeSpecifications — (map<map>)

    The key-value pairs that specify worker type to WorkerTypeSpecificationInput. This parameter must contain all valid worker types for a Spark or Hive application. Valid worker types include Driver and Executor for Spark applications and HiveDriver and TezTask for Hive applications. You can either set image details in this parameter for each worker type, or in imageConfiguration for all worker types.

    • imageConfiguration — (map)

      The image configuration for a worker type.

      • imageUri — (String)

        The URI of an image in the Amazon ECR registry. This field is required when you create a new application. If you leave this field blank in an update, Amazon EMR will remove the image configuration.

  • interactiveConfiguration — (map)

    The interactive configuration object that contains new interactive use cases when the application is updated.

    • studioEnabled — (Boolean)

      Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.

    • livyEndpointEnabled — (Boolean)

      Enables an Apache Livy endpoint that you can connect to and run interactive jobs.

  • releaseLabel — (String)

    The Amazon EMR release label for the application. You can change the release label to use a different release of Amazon EMR.

  • runtimeConfiguration — (Array<map>)

    The Configuration specifications to use when updating an application. Each configuration consists of a classification and properties. This configuration is applied across all the job runs submitted under the application.

    • classification — required — (String)

      The classification within a configuration.

    • properties — (map<String>)

      A set of properties specified within a configuration classification.

    • configurations — (Array<map>)

      A list of additional configurations to apply within a configuration object.

  • monitoringConfiguration — (map)

    The configuration setting 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.

    • cloudWatchLoggingConfiguration — (map)

      The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

      • enabled — required — (Boolean)

        Enables CloudWatch logging.

      • logGroupName — (String)

        The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

      • logStreamNamePrefix — (String)

        Prefix for the CloudWatch log stream name.

      • encryptionKeyArn — (String)

        The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

      • logTypes — (map<Array<String>>)

        The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

        • Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK

        • Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

    • prometheusMonitoringConfiguration — (map)

      The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

      • remoteWriteUrl — (String)

        The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.

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.

      • applicationId — required — (String)

        The ID of the application.

      • name — (String)

        The name of the application.

      • arn — required — (String)

        The ARN of the application.

      • releaseLabel — required — (String)

        The Amazon EMR release associated with the application.

      • type — required — (String)

        The type of application, such as Spark or Hive.

      • state — required — (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.

        • workerCount — required — (Integer)

          The number of workers in the initial capacity configuration.

        • workerConfiguration — (map)

          The resource configuration of the initial capacity configuration.

          • cpu — required — (String)

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

          • memory — required — (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.

          • diskType — (String)

            The disk type for every worker instance of the work type. Shuffle optimized disks have higher performance characteristics and are better for shuffle heavy workloads. Default is STANDARD.

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

        • cpu — required — (String)

          The maximum allowed CPU for an application.

        • memory — required — (String)

          The maximum allowed resources for an application.

        • disk — (String)

          The maximum allowed disk for an application.

      • createdAt — required — (Date)

        The date and time when the application run was created.

      • updatedAt — required — (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"
      • imageConfiguration — (map)

        The image configuration applied to all worker types.

        • imageUri — required — (String)

          The image URI.

        • resolvedImageDigest — (String)

          The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.

      • workerTypeSpecifications — (map<map>)

        The specification applied to each worker type.

        • imageConfiguration — (map)

          The image configuration for a worker type.

          • imageUri — required — (String)

            The image URI.

          • resolvedImageDigest — (String)

            The SHA256 digest of the image URI. This indicates which specific image the application is configured for. The image digest doesn't exist until an application has started.

      • runtimeConfiguration — (Array<map>)

        The Configuration specifications of an application. Each configuration consists of a classification and properties. You use this parameter when creating or updating an application. To see the runtimeConfiguration object of an application, run the GetApplication API operation.

        • classification — required — (String)

          The classification within a configuration.

        • properties — (map<String>)

          A set of properties specified within a configuration classification.

      • monitoringConfiguration — (map)

        The configuration setting 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.

        • cloudWatchLoggingConfiguration — (map)

          The Amazon CloudWatch configuration for monitoring logs. You can configure your jobs to send log information to CloudWatch.

          • enabled — required — (Boolean)

            Enables CloudWatch logging.

          • logGroupName — (String)

            The name of the log group in Amazon CloudWatch Logs where you want to publish your logs.

          • logStreamNamePrefix — (String)

            Prefix for the CloudWatch log stream name.

          • encryptionKeyArn — (String)

            The Key Management Service (KMS) key ARN to encrypt the logs that you store in CloudWatch Logs.

          • logTypes — (map<Array<String>>)

            The types of logs that you want to publish to CloudWatch. If you don't specify any log types, driver STDOUT and STDERR logs will be published to CloudWatch Logs by default. For more information including the supported worker types for Hive and Spark, see Logging for EMR Serverless with CloudWatch.

            • Key Valid Values: SPARK_DRIVER, SPARK_EXECUTOR, HIVE_DRIVER, TEZ_TASK

            • Array Members Valid Values: STDOUT, STDERR, HIVE_LOG, TEZ_AM, SYSTEM_LOGS

        • prometheusMonitoringConfiguration — (map)

          The monitoring configuration object you can configure to send metrics to Amazon Managed Service for Prometheus for a job run.

          • remoteWriteUrl — (String)

            The remote write URL in the Amazon Managed Service for Prometheus workspace to send metrics to.

      • interactiveConfiguration — (map)

        The interactive configuration object that enables the interactive use cases for an application.

        • studioEnabled — (Boolean)

          Enables you to connect an application to Amazon EMR Studio to run interactive workloads in a notebook.

        • livyEndpointEnabled — (Boolean)

          Enables an Apache Livy endpoint that you can connect to and run interactive jobs.

Returns:

• (AWS.Request) —

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