Back to Aws Sdk Js V3

@aws-sdk/client-emr-serverless

clients/client-emr-serverless/README.md

3.1043.017.0 KB
Original Source
<!-- generated file, do not edit directly -->

@aws-sdk/client-emr-serverless

Description

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

<p>Amazon EMR Serverless is a new deployment option for Amazon EMR. Amazon EMR Serverless provides a serverless runtime environment that simplifies running analytics applications using the latest open source frameworks such as Apache Spark and Apache Hive. With Amazon EMR Serverless, you don’t have to configure, optimize, secure, or operate clusters to run applications with these frameworks.</p> <p>The API reference to Amazon EMR Serverless is <code>emr-serverless</code>. The <code>emr-serverless</code> prefix is used in the following scenarios: </p> <ul> <li> <p>It is the prefix in the CLI commands for Amazon EMR Serverless. For example, <code>aws emr-serverless start-job-run</code>.</p> </li> <li> <p>It is the prefix before IAM policy actions for Amazon EMR Serverless. For example, <code>"Action": ["emr-serverless:StartJobRun"]</code>. For more information, see <a href="https://docs.aws.amazon.com/emr/latest/EMR-Serverless-UserGuide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-actions">Policy actions for Amazon EMR Serverless</a>.</p> </li> <li> <p>It is the prefix used in Amazon EMR Serverless service endpoints. For example, <code>emr-serverless.us-east-2.amazonaws.com</code>.</p> </li> </ul>

Installing

To install this package, use the CLI of your favorite package manager:

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

Getting Started

Import

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

js
// ES5 example
const { EMRServerlessClient, ListApplicationsCommand } = require("@aws-sdk/client-emr-serverless");
ts
// ES6+ example
import { EMRServerlessClient, ListApplicationsCommand } from "@aws-sdk/client-emr-serverless";

Usage

To send a request:

  • Instantiate a client with configuration (e.g. credentials, region).
  • Instantiate a command with input parameters.
  • Call the send operation on the client, providing the command object as input.
js
const client = new EMRServerlessClient({ region: "REGION" });

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

Async/await

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

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

Promises

You can also use Promise chaining.

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

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

EMRServerless extends EMRServerlessClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (EMRServerlessClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

ts
import { EMRServerless } from "@aws-sdk/client-emr-serverless";

const client = new EMRServerless({ region: "REGION" });

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

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

// callbacks (not recommended).
client.listApplications(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).

js
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;
   * }
   */
}

See also docs/ERROR_HANDLING.

Getting Help

Please use these community resources for getting help. We use 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-serverless 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)

<details> <summary> CancelJobRun </summary>

Command API Reference / Input / Output

</details> <details> <summary> CreateApplication </summary>

Command API Reference / Input / Output

</details> <details> <summary> DeleteApplication </summary>

Command API Reference / Input / Output

</details> <details> <summary> GetApplication </summary>

Command API Reference / Input / Output

</details> <details> <summary> GetDashboardForJobRun </summary>

Command API Reference / Input / Output

</details> <details> <summary> GetJobRun </summary>

Command API Reference / Input / Output

</details> <details> <summary> GetResourceDashboard </summary>

Command API Reference / Input / Output

</details> <details> <summary> GetSession </summary>

Command API Reference / Input / Output

</details> <details> <summary> GetSessionEndpoint </summary>

Command API Reference / Input / Output

</details> <details> <summary> ListApplications </summary>

Command API Reference / Input / Output

</details> <details> <summary> ListJobRunAttempts </summary>

Command API Reference / Input / Output

</details> <details> <summary> ListJobRuns </summary>

Command API Reference / Input / Output

</details> <details> <summary> ListSessions </summary>

Command API Reference / Input / Output

</details> <details> <summary> ListTagsForResource </summary>

Command API Reference / Input / Output

</details> <details> <summary> StartApplication </summary>

Command API Reference / Input / Output

</details> <details> <summary> StartJobRun </summary>

Command API Reference / Input / Output

</details> <details> <summary> StartSession </summary>

Command API Reference / Input / Output

</details> <details> <summary> StopApplication </summary>

Command API Reference / Input / Output

</details> <details> <summary> TagResource </summary>

Command API Reference / Input / Output

</details> <details> <summary> TerminateSession </summary>

Command API Reference / Input / Output

</details> <details> <summary> UntagResource </summary>

Command API Reference / Input / Output

</details> <details> <summary> UpdateApplication </summary>

Command API Reference / Input / Output

</details>