Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.EMRcontainers

Inherits:
AWS.Service show all
Identifier:
emrcontainers
API Version:
2020-10-01
Defined in:
(unknown)

Overview

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

Service Description

Amazon EMR on EKS provides a deployment option for Amazon EMR that allows you to run open-source big data frameworks on Amazon Elastic Kubernetes Service (Amazon EKS). With this deployment option, you can focus on running analytics workloads while Amazon EMR on EKS builds, configures, and manages containers for open-source applications. For more information about Amazon EMR on EKS concepts and tasks, see What is Amazon EMR on EKS.

Amazon EMR containers is the API name for Amazon EMR on EKS. The emr-containers prefix is used in the following scenarios:

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

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

  • It is the prefix used in Amazon EMR on EKS service endpoints. For example, emr-containers.us-east-2.amazonaws.com. For more information, see Amazon EMR on EKS Service Endpoints.

Sending a Request Using EMRcontainers

var emrcontainers = new AWS.EMRcontainers();
emrcontainers.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 EMRcontainers object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var emrcontainers = new AWS.EMRcontainers({apiVersion: '2020-10-01'});

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

AWS.config.apiVersions = {
  emrcontainers: '2020-10-01',
  // other service API versions
};

var emrcontainers = new AWS.EMRcontainers();

Version:

  • 2020-10-01

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.EMRcontainers(options = {}) ⇒ Object

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

Examples:

Constructing a EMRcontainers object

var emrcontainers = new AWS.EMRcontainers({apiVersion: '2020-10-01'});

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.EMRcontainers.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.EMRcontainers.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'.

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. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

Service Reference:

Examples:

Calling the cancelJobRun operation

var params = {
  id: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE' /* required */
};
emrcontainers.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: {})
    • id — (String)

      The ID of the job run to cancel.

    • virtualClusterId — (String)

      The ID of the virtual cluster for which the job run will be canceled.

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:

      • id — (String)

        The output contains the ID of the cancelled job run.

      • virtualClusterId — (String)

        The output contains the virtual cluster ID for which the job run is cancelled.

Returns:

  • (AWS.Request)

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

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

Creates a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

Service Reference:

Examples:

Calling the createManagedEndpoint operation

var params = {
  certificateArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE', /* required */
  executionRoleArn: 'STRING_VALUE', /* required */
  name: 'STRING_VALUE', /* required */
  releaseLabel: 'STRING_VALUE', /* required */
  type: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE', /* required */
  configurationOverrides: {
    applicationConfiguration: [ /* ConfigurationList */
      {
        classification: 'STRING_VALUE', /* required */
        configurations: /* recursive ConfigurationList */,
        properties: {
          '<String1024>': 'STRING_VALUE',
          /* '<String1024>': ... */
        }
      },
      /* more items */
    ],
    monitoringConfiguration: {
      cloudWatchMonitoringConfiguration: {
        logGroupName: 'STRING_VALUE', /* required */
        logStreamNamePrefix: 'STRING_VALUE'
      },
      persistentAppUI: ENABLED | DISABLED,
      s3MonitoringConfiguration: {
        logUri: 'STRING_VALUE' /* required */
      }
    }
  },
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.createManagedEndpoint(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 managed endpoint.

    • virtualClusterId — (String)

      The ID of the virtual cluster for which a managed endpoint is created.

    • type — (String)

      The type of the managed endpoint.

    • releaseLabel — (String)

      The Amazon EMR release version.

    • executionRoleArn — (String)

      The ARN of the execution role.

    • certificateArn — (String)

      The certificate ARN of the managed endpoint.

    • configurationOverrides — (map)

      The configuration settings that will be used to override existing configurations.

      • applicationConfiguration — (Array<map>)

        The configurations for the application running by the job run.

        • classificationrequired — (String)

          The classification within a configuration.

        • properties — (map<String>)

          A set of properties specified within a configuration classification.

      • monitoringConfiguration — (map)

        The configurations for monitoring.

        • persistentAppUI — (String)

          Monitoring configurations for the persistent application UI.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • cloudWatchMonitoringConfiguration — (map)

          Monitoring configurations for CloudWatch.

          • logGroupNamerequired — (String)

            The name of the log group for log publishing.

          • logStreamNamePrefix — (String)

            The specified name prefix for log streams.

        • s3MonitoringConfiguration — (map)

          Amazon S3 configuration for monitoring log publishing.

          • logUrirequired — (String)

            Amazon S3 destination URI for log publishing.

    • clientToken — (String)

      The client idempotency token for this create call.

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

      The tags of the managed endpoint.

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:

      • id — (String)

        The output contains the ID of the managed endpoint.

      • name — (String)

        The output contains the name of the managed endpoint.

      • arn — (String)

        The output contains the ARN of the managed endpoint.

      • virtualClusterId — (String)

        The output contains the ID of the virtual cluster.

Returns:

  • (AWS.Request)

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

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

Creates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Service Reference:

Examples:

Calling the createVirtualCluster operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  containerProvider: { /* required */
    id: 'STRING_VALUE', /* required */
    type: EKS, /* required */
    info: {
      eksInfo: {
        namespace: 'STRING_VALUE'
      }
    }
  },
  name: 'STRING_VALUE', /* required */
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.createVirtualCluster(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 specified name of the virtual cluster.

    • containerProvider — (map)

      The container provider of the virtual cluster.

      • typerequired — (String)

        The type of the container provider. EKS is the only supported type as of now.

        Possible values include:
        • "EKS"
      • idrequired — (String)

        The ID of the container cluster.

      • info — (map)

        The information about the container cluster.

        • eksInfo — (map)

          The information about the EKS cluster.

          • namespace — (String)

            The namespaces of the EKS cluster.

    • clientToken — (String)

      The client token of the virtual cluster.

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

      The tags assigned to the virtual cluster.

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:

      • id — (String)

        This output contains the virtual cluster ID.

      • name — (String)

        This output contains the name of the virtual cluster.

      • arn — (String)

        This output contains the ARN of virtual cluster.

Returns:

  • (AWS.Request)

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

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

Deletes a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

Service Reference:

Examples:

Calling the deleteManagedEndpoint operation

var params = {
  id: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE' /* required */
};
emrcontainers.deleteManagedEndpoint(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: {})
    • id — (String)

      The ID of the managed endpoint.

    • virtualClusterId — (String)

      The ID of the endpoint's virtual cluster.

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:

      • id — (String)

        The output displays the ID of the managed endpoint.

      • virtualClusterId — (String)

        The output displays the ID of the endpoint's virtual cluster.

Returns:

  • (AWS.Request)

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

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

Deletes a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Service Reference:

Examples:

Calling the deleteVirtualCluster operation

var params = {
  id: 'STRING_VALUE' /* required */
};
emrcontainers.deleteVirtualCluster(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: {})
    • id — (String)

      The ID of the virtual cluster 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. The data object has the following properties:

      • id — (String)

        This output contains the ID of the virtual cluster that will be deleted.

Returns:

  • (AWS.Request)

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

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

Displays detailed information about a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

Service Reference:

Examples:

Calling the describeJobRun operation

var params = {
  id: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE' /* required */
};
emrcontainers.describeJobRun(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: {})
    • id — (String)

      The ID of the job run request.

    • virtualClusterId — (String)

      The ID of the virtual cluster for which the job run is submitted.

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 a job run.

        • id — (String)

          The ID of the job run.

        • name — (String)

          The name of the job run.

        • virtualClusterId — (String)

          The ID of the job run's virtual cluster.

        • arn — (String)

          The ARN of job run.

        • state — (String)

          The state of the job run.

          Possible values include:
          • "PENDING"
          • "SUBMITTED"
          • "RUNNING"
          • "FAILED"
          • "CANCELLED"
          • "CANCEL_PENDING"
          • "COMPLETED"
        • clientToken — (String)

          The client token used to start a job run.

        • executionRoleArn — (String)

          The execution role ARN of the job run.

        • releaseLabel — (String)

          The release version of Amazon EMR.

        • configurationOverrides — (map)

          The configuration settings that are used to override default configuration.

          • applicationConfiguration — (Array<map>)

            The configurations for the application running by the job run.

            • classificationrequired — (String)

              The classification within a configuration.

            • properties — (map<String>)

              A set of properties specified within a configuration classification.

          • monitoringConfiguration — (map)

            The configurations for monitoring.

            • persistentAppUI — (String)

              Monitoring configurations for the persistent application UI.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
            • cloudWatchMonitoringConfiguration — (map)

              Monitoring configurations for CloudWatch.

              • logGroupNamerequired — (String)

                The name of the log group for log publishing.

              • logStreamNamePrefix — (String)

                The specified name prefix for log streams.

            • s3MonitoringConfiguration — (map)

              Amazon S3 configuration for monitoring log publishing.

              • logUrirequired — (String)

                Amazon S3 destination URI for log publishing.

        • jobDriver — (map)

          Parameters of job driver for the job run.

          • sparkSubmitJobDriver — (map)

            The job driver parameters specified for spark submit.

            • entryPointrequired — (String)

              The entry point of job application.

            • entryPointArguments — (Array<String>)

              The arguments for job application.

            • sparkSubmitParameters — (String)

              The Spark submit parameters that are used for job runs.

        • createdAt — (Date)

          The date and time when the job run was created.

        • createdBy — (String)

          The user who created the job run.

        • finishedAt — (Date)

          The date and time when the job run has finished.

        • stateDetails — (String)

          Additional details of the job run state.

        • failureReason — (String)

          The reasons why the job run has failed.

          Possible values include:
          • "INTERNAL_ERROR"
          • "USER_ERROR"
          • "VALIDATION_ERROR"
          • "CLUSTER_UNAVAILABLE"
        • tags — (map<String>)

          The assigned tags of the job run.

Returns:

  • (AWS.Request)

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

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

Displays detailed information about a managed endpoint. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

Service Reference:

Examples:

Calling the describeManagedEndpoint operation

var params = {
  id: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE' /* required */
};
emrcontainers.describeManagedEndpoint(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: {})
    • id — (String)

      This output displays ID of the managed endpoint.

    • virtualClusterId — (String)

      The ID of the endpoint's virtual cluster.

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:

      • endpoint — (map)

        This output displays information about a managed endpoint.

        • id — (String)

          The ID of the endpoint.

        • name — (String)

          The name of the endpoint.

        • arn — (String)

          The ARN of the endpoint.

        • virtualClusterId — (String)

          The ID of the endpoint's virtual cluster.

        • type — (String)

          The type of the endpoint.

        • state — (String)

          The state of the endpoint.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "TERMINATING"
          • "TERMINATED"
          • "TERMINATED_WITH_ERRORS"
        • releaseLabel — (String)

          The EMR release version to be used for the endpoint.

        • executionRoleArn — (String)

          The execution role ARN of the endpoint.

        • certificateArn — (String)

          The certificate ARN of the endpoint.

        • configurationOverrides — (map)

          The configuration settings that are used to override existing configurations for endpoints.

          • applicationConfiguration — (Array<map>)

            The configurations for the application running by the job run.

            • classificationrequired — (String)

              The classification within a configuration.

            • properties — (map<String>)

              A set of properties specified within a configuration classification.

          • monitoringConfiguration — (map)

            The configurations for monitoring.

            • persistentAppUI — (String)

              Monitoring configurations for the persistent application UI.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
            • cloudWatchMonitoringConfiguration — (map)

              Monitoring configurations for CloudWatch.

              • logGroupNamerequired — (String)

                The name of the log group for log publishing.

              • logStreamNamePrefix — (String)

                The specified name prefix for log streams.

            • s3MonitoringConfiguration — (map)

              Amazon S3 configuration for monitoring log publishing.

              • logUrirequired — (String)

                Amazon S3 destination URI for log publishing.

        • serverUrl — (String)

          The server URL of the endpoint.

        • createdAt — (Date)

          The date and time when the endpoint was created.

        • securityGroup — (String)

          The security group configuration of the endpoint.

        • subnetIds — (Array<String>)

          The subnet IDs of the endpoint.

        • tags — (map<String>)

          The tags of the endpoint.

Returns:

  • (AWS.Request)

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

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

Displays detailed information about a specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Service Reference:

Examples:

Calling the describeVirtualCluster operation

var params = {
  id: 'STRING_VALUE' /* required */
};
emrcontainers.describeVirtualCluster(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: {})
    • id — (String)

      The ID of the virtual cluster 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:

      • virtualCluster — (map)

        This output displays information about the specified virtual cluster.

        • id — (String)

          The ID of the virtual cluster.

        • name — (String)

          The name of the virtual cluster.

        • arn — (String)

          The ARN of the virtual cluster.

        • state — (String)

          The state of the virtual cluster.

          Possible values include:
          • "RUNNING"
          • "TERMINATING"
          • "TERMINATED"
          • "ARRESTED"
        • containerProvider — (map)

          The container provider of the virtual cluster.

          • typerequired — (String)

            The type of the container provider. EKS is the only supported type as of now.

            Possible values include:
            • "EKS"
          • idrequired — (String)

            The ID of the container cluster.

          • info — (map)

            The information about the container cluster.

            • eksInfo — (map)

              The information about the EKS cluster.

              • namespace — (String)

                The namespaces of the EKS cluster.

        • createdAt — (Date)

          The date and time when the virtual cluster is created.

        • tags — (map<String>)

          The assigned tags of the virtual cluster.

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. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

Service Reference:

Examples:

Calling the listJobRuns operation

var params = {
  virtualClusterId: 'STRING_VALUE', /* required */
  createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  name: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    PENDING | SUBMITTED | RUNNING | FAILED | CANCELLED | CANCEL_PENDING | COMPLETED,
    /* more items */
  ]
};
emrcontainers.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: {})
    • virtualClusterId — (String)

      The ID of the virtual cluster for which to list the job run.

    • createdBefore — (Date)

      The date and time before which the job runs were submitted.

    • createdAfter — (Date)

      The date and time after which the job runs were submitted.

    • name — (String)

      The name of the job run.

    • states — (Array<String>)

      The states of the job run.

    • maxResults — (Integer)

      The maximum number of job runs that can be listed.

    • nextToken — (String)

      The token for the next set of job runs to return.

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

        This output lists information about the specified job runs.

        • id — (String)

          The ID of the job run.

        • name — (String)

          The name of the job run.

        • virtualClusterId — (String)

          The ID of the job run's virtual cluster.

        • arn — (String)

          The ARN of job run.

        • state — (String)

          The state of the job run.

          Possible values include:
          • "PENDING"
          • "SUBMITTED"
          • "RUNNING"
          • "FAILED"
          • "CANCELLED"
          • "CANCEL_PENDING"
          • "COMPLETED"
        • clientToken — (String)

          The client token used to start a job run.

        • executionRoleArn — (String)

          The execution role ARN of the job run.

        • releaseLabel — (String)

          The release version of Amazon EMR.

        • configurationOverrides — (map)

          The configuration settings that are used to override default configuration.

          • applicationConfiguration — (Array<map>)

            The configurations for the application running by the job run.

            • classificationrequired — (String)

              The classification within a configuration.

            • properties — (map<String>)

              A set of properties specified within a configuration classification.

          • monitoringConfiguration — (map)

            The configurations for monitoring.

            • persistentAppUI — (String)

              Monitoring configurations for the persistent application UI.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
            • cloudWatchMonitoringConfiguration — (map)

              Monitoring configurations for CloudWatch.

              • logGroupNamerequired — (String)

                The name of the log group for log publishing.

              • logStreamNamePrefix — (String)

                The specified name prefix for log streams.

            • s3MonitoringConfiguration — (map)

              Amazon S3 configuration for monitoring log publishing.

              • logUrirequired — (String)

                Amazon S3 destination URI for log publishing.

        • jobDriver — (map)

          Parameters of job driver for the job run.

          • sparkSubmitJobDriver — (map)

            The job driver parameters specified for spark submit.

            • entryPointrequired — (String)

              The entry point of job application.

            • entryPointArguments — (Array<String>)

              The arguments for job application.

            • sparkSubmitParameters — (String)

              The Spark submit parameters that are used for job runs.

        • createdAt — (Date)

          The date and time when the job run was created.

        • createdBy — (String)

          The user who created the job run.

        • finishedAt — (Date)

          The date and time when the job run has finished.

        • stateDetails — (String)

          Additional details of the job run state.

        • failureReason — (String)

          The reasons why the job run has failed.

          Possible values include:
          • "INTERNAL_ERROR"
          • "USER_ERROR"
          • "VALIDATION_ERROR"
          • "CLUSTER_UNAVAILABLE"
        • tags — (map<String>)

          The assigned tags of the job run.

      • nextToken — (String)

        This output displays the token for the next set of job runs.

Returns:

  • (AWS.Request)

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

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

Lists managed endpoints based on a set of parameters. A managed endpoint is a gateway that connects EMR Studio to Amazon EMR on EKS so that EMR Studio can communicate with your virtual cluster.

Service Reference:

Examples:

Calling the listManagedEndpoints operation

var params = {
  virtualClusterId: 'STRING_VALUE', /* required */
  createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    CREATING | ACTIVE | TERMINATING | TERMINATED | TERMINATED_WITH_ERRORS,
    /* more items */
  ],
  types: [
    'STRING_VALUE',
    /* more items */
  ]
};
emrcontainers.listManagedEndpoints(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: {})
    • virtualClusterId — (String)

      The ID of the virtual cluster.

    • createdBefore — (Date)

      The date and time before which the endpoints are created.

    • createdAfter — (Date)

      The date and time after which the endpoints are created.

    • types — (Array<String>)

      The types of the managed endpoints.

    • states — (Array<String>)

      The states of the managed endpoints.

    • maxResults — (Integer)

      The maximum number of managed endpoints that can be listed.

    • nextToken — (String)

      The token for the next set of managed endpoints to return.

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:

      • endpoints — (Array<map>)

        The managed endpoints to be listed.

        • id — (String)

          The ID of the endpoint.

        • name — (String)

          The name of the endpoint.

        • arn — (String)

          The ARN of the endpoint.

        • virtualClusterId — (String)

          The ID of the endpoint's virtual cluster.

        • type — (String)

          The type of the endpoint.

        • state — (String)

          The state of the endpoint.

          Possible values include:
          • "CREATING"
          • "ACTIVE"
          • "TERMINATING"
          • "TERMINATED"
          • "TERMINATED_WITH_ERRORS"
        • releaseLabel — (String)

          The EMR release version to be used for the endpoint.

        • executionRoleArn — (String)

          The execution role ARN of the endpoint.

        • certificateArn — (String)

          The certificate ARN of the endpoint.

        • configurationOverrides — (map)

          The configuration settings that are used to override existing configurations for endpoints.

          • applicationConfiguration — (Array<map>)

            The configurations for the application running by the job run.

            • classificationrequired — (String)

              The classification within a configuration.

            • properties — (map<String>)

              A set of properties specified within a configuration classification.

          • monitoringConfiguration — (map)

            The configurations for monitoring.

            • persistentAppUI — (String)

              Monitoring configurations for the persistent application UI.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
            • cloudWatchMonitoringConfiguration — (map)

              Monitoring configurations for CloudWatch.

              • logGroupNamerequired — (String)

                The name of the log group for log publishing.

              • logStreamNamePrefix — (String)

                The specified name prefix for log streams.

            • s3MonitoringConfiguration — (map)

              Amazon S3 configuration for monitoring log publishing.

              • logUrirequired — (String)

                Amazon S3 destination URI for log publishing.

        • serverUrl — (String)

          The server URL of the endpoint.

        • createdAt — (Date)

          The date and time when the endpoint was created.

        • securityGroup — (String)

          The security group configuration of the endpoint.

        • subnetIds — (Array<String>)

          The subnet IDs of the endpoint.

        • tags — (map<String>)

          The tags of the endpoint.

      • nextToken — (String)

        The token for the next set of endpoints to return.

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 */
};
emrcontainers.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 ARN of tagged resources.

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 assigned to resources.

Returns:

  • (AWS.Request)

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

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

Lists information about the specified virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list and delete virtual clusters. They do not consume any additional resource in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

Service Reference:

Examples:

Calling the listVirtualClusters operation

var params = {
  containerProviderId: 'STRING_VALUE',
  containerProviderType: EKS,
  createdAfter: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  createdBefore: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  states: [
    RUNNING | TERMINATING | TERMINATED | ARRESTED,
    /* more items */
  ]
};
emrcontainers.listVirtualClusters(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: {})
    • containerProviderId — (String)

      The container provider ID of the virtual cluster.

    • containerProviderType — (String)

      The container provider type of the virtual cluster. EKS is the only supported type as of now.

      Possible values include:
      • "EKS"
    • createdAfter — (Date)

      The date and time after which the virtual clusters are created.

    • createdBefore — (Date)

      The date and time before which the virtual clusters are created.

    • states — (Array<String>)

      The states of the requested virtual clusters.

    • maxResults — (Integer)

      The maximum number of virtual clusters that can be listed.

    • nextToken — (String)

      The token for the next set of virtual clusters to return.

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:

      • virtualClusters — (Array<map>)

        This output lists the specified virtual clusters.

        • id — (String)

          The ID of the virtual cluster.

        • name — (String)

          The name of the virtual cluster.

        • arn — (String)

          The ARN of the virtual cluster.

        • state — (String)

          The state of the virtual cluster.

          Possible values include:
          • "RUNNING"
          • "TERMINATING"
          • "TERMINATED"
          • "ARRESTED"
        • containerProvider — (map)

          The container provider of the virtual cluster.

          • typerequired — (String)

            The type of the container provider. EKS is the only supported type as of now.

            Possible values include:
            • "EKS"
          • idrequired — (String)

            The ID of the container cluster.

          • info — (map)

            The information about the container cluster.

            • eksInfo — (map)

              The information about the EKS cluster.

              • namespace — (String)

                The namespaces of the EKS cluster.

        • createdAt — (Date)

          The date and time when the virtual cluster is created.

        • tags — (map<String>)

          The assigned tags of the virtual cluster.

      • nextToken — (String)

        This output displays the token for the next set of virtual clusters.

Returns:

  • (AWS.Request)

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

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

Starts a job run. A job run is a unit of work, such as a Spark jar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on EKS.

Service Reference:

Examples:

Calling the startJobRun operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  executionRoleArn: 'STRING_VALUE', /* required */
  jobDriver: { /* required */
    sparkSubmitJobDriver: {
      entryPoint: 'STRING_VALUE', /* required */
      entryPointArguments: [
        'STRING_VALUE',
        /* more items */
      ],
      sparkSubmitParameters: 'STRING_VALUE'
    }
  },
  releaseLabel: 'STRING_VALUE', /* required */
  virtualClusterId: 'STRING_VALUE', /* required */
  configurationOverrides: {
    applicationConfiguration: [ /* ConfigurationList */
      {
        classification: 'STRING_VALUE', /* required */
        configurations: /* recursive ConfigurationList */,
        properties: {
          '<String1024>': 'STRING_VALUE',
          /* '<String1024>': ... */
        }
      },
      /* more items */
    ],
    monitoringConfiguration: {
      cloudWatchMonitoringConfiguration: {
        logGroupName: 'STRING_VALUE', /* required */
        logStreamNamePrefix: 'STRING_VALUE'
      },
      persistentAppUI: ENABLED | DISABLED,
      s3MonitoringConfiguration: {
        logUri: 'STRING_VALUE' /* required */
      }
    }
  },
  name: 'STRING_VALUE',
  tags: {
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.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: {})
    • name — (String)

      The name of the job run.

    • virtualClusterId — (String)

      The virtual cluster ID for which the job run request is submitted.

    • clientToken — (String)

      The client idempotency token of the job run 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.

    • releaseLabel — (String)

      The Amazon EMR release version to use for the job run.

    • jobDriver — (map)

      The job driver for the job run.

      • sparkSubmitJobDriver — (map)

        The job driver parameters specified for spark submit.

        • entryPointrequired — (String)

          The entry point of job application.

        • entryPointArguments — (Array<String>)

          The arguments for job application.

        • sparkSubmitParameters — (String)

          The Spark submit parameters that are used for job runs.

    • configurationOverrides — (map)

      The configuration overrides for the job run.

      • applicationConfiguration — (Array<map>)

        The configurations for the application running by the job run.

        • classificationrequired — (String)

          The classification within a configuration.

        • properties — (map<String>)

          A set of properties specified within a configuration classification.

      • monitoringConfiguration — (map)

        The configurations for monitoring.

        • persistentAppUI — (String)

          Monitoring configurations for the persistent application UI.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • cloudWatchMonitoringConfiguration — (map)

          Monitoring configurations for CloudWatch.

          • logGroupNamerequired — (String)

            The name of the log group for log publishing.

          • logStreamNamePrefix — (String)

            The specified name prefix for log streams.

        • s3MonitoringConfiguration — (map)

          Amazon S3 configuration for monitoring log publishing.

          • logUrirequired — (String)

            Amazon S3 destination URI for log publishing.

    • tags — (map<String>)

      The tags assigned to 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:

      • id — (String)

        This output displays the started job run ID.

      • name — (String)

        This output displays the name of the started job run.

      • arn — (String)

        This output lists the ARN of job run.

      • virtualClusterId — (String)

        This output displays the virtual cluster ID for which the job run was submitted.

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. For example, you can define a set of tags for your Amazon EMR on EKS clusters to help you track each cluster's owner and stack level. We recommend that you devise a consistent set of tag keys for each resource type. You can then search and filter the resources based on the tags that you add.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<String128>': 'STRING_VALUE',
    /* '<String128>': ... */
  }
};
emrcontainers.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 ARN of resources.

    • tags — (map<String>)

      The tags assigned to resources.

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 */
  ]
};
emrcontainers.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 ARN of resources.

    • tagKeys — (Array<String>)

      The tag keys of the resources.

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.