Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

@aws-sdk/client-emr-containers

@aws-sdk/client-emr-containers

Description

AWS SDK for JavaScript EMRContainers Client for Node.js, Browser and React Native.

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 shared id="EMR-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 EKSService Endpoints.

Installing

To install the this package, simply type add or install @aws-sdk/client-emr-containers using your favorite package manager:

  • npm install @aws-sdk/client-emr-containers
  • yarn add @aws-sdk/client-emr-containers
  • pnpm add @aws-sdk/client-emr-containers

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the EMRContainersClient and the commands you need, for example ListJobRunsCommand:

// ES5 example
const { EMRContainersClient, ListJobRunsCommand } = require("@aws-sdk/client-emr-containers");
// ES6+ example
import { EMRContainersClient, ListJobRunsCommand } from "@aws-sdk/client-emr-containers";

Usage

To send a request, you:

  • Initiate client with configuration (e.g. credentials, region).
  • Initiate command with input parameters.
  • Call send operation on client with command object as input.
  • If you are using a custom http handler, you may call destroy() to close open connections.
// a client can be shared by different commands.
const client = new EMRContainersClient({ region: "REGION" });

const params = {
/** input parameters */
};
const command = new ListJobRunsCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);

Promises can also be called using .catch() and .finally() as follows:

client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
// process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-emr-containers";
const client = new AWS.EMRContainers({ region: "REGION" });

// async/await.
try {
const data = await client.listJobRuns(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listJobRuns(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listJobRuns(params, (err, data) => {
// process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-emr-containers package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

CancelJobRun

Command API Reference / Input / Output

CreateJobTemplate

Command API Reference / Input / Output

CreateManagedEndpoint

Command API Reference / Input / Output

CreateVirtualCluster

Command API Reference / Input / Output

DeleteJobTemplate

Command API Reference / Input / Output

DeleteManagedEndpoint

Command API Reference / Input / Output

DeleteVirtualCluster

Command API Reference / Input / Output

DescribeJobRun

Command API Reference / Input / Output

DescribeJobTemplate

Command API Reference / Input / Output

DescribeManagedEndpoint

Command API Reference / Input / Output

DescribeVirtualCluster

Command API Reference / Input / Output

GetManagedEndpointSessionCredentials

Command API Reference / Input / Output

ListJobRuns

Command API Reference / Input / Output

ListJobTemplates

Command API Reference / Input / Output

ListManagedEndpoints

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListVirtualClusters

Command API Reference / Input / Output

StartJobRun

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output