@aws-sdk/client-athena

Description

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

Amazon Athena is an interactive query service that lets you use standard SQL
to analyze data directly in Amazon S3. You can point Athena at your
data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay
only for the queries you run. Athena scales automatically—executing queries
in parallel—so results are fast, even with large datasets and complex queries. For more
information, see What is Amazon Athena in the Amazon Athena User
Guide.

If you connect to Athena using the JDBC driver, use version 1.1.0 of the
driver or later with the Amazon Athena API. Earlier version drivers do not
support the API. For more information and to download the driver, see Accessing
Amazon Athena with JDBC.

Installing

To install this package, simply type add or install @aws-sdk/client-athena
using your favorite package manager:
- npm install @aws-sdk/client-athena
- yarn add @aws-sdk/client-athena
- pnpm add @aws-sdk/client-athena

Getting Started

$3

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

``js
// ES5 example
const { AthenaClient, ListDataCatalogsCommand } = require("@aws-sdk/client-athena");
`

`ts
// ES6+ example
import { AthenaClient, ListDataCatalogsCommand } from "@aws-sdk/client-athena";
`

$3

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.

`js
// a client can be shared by different commands.
const client = new AthenaClient({ region: "REGION" });

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

#### Async/await

We recommend using 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.
}
`

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.

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

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

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

`js
// 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

`ts
import * as AWS from "@aws-sdk/client-athena";
const client = new AWS.Athena({ region: "REGION" });

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

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

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

$3

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

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.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

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

BatchGetNamedQuery

Command API Reference / Input / Output

BatchGetPreparedStatement

Command API Reference / Input / Output

BatchGetQueryExecution

Command API Reference / Input / Output

CancelCapacityReservation

Command API Reference / Input / Output

CreateCapacityReservation

Command API Reference / Input / Output

CreateDataCatalog

Command API Reference / Input / Output

CreateNamedQuery

Command API Reference / Input / Output

CreateNotebook

Command API Reference / Input / Output

CreatePreparedStatement

Command API Reference / Input / Output

CreatePresignedNotebookUrl

Command API Reference / Input / Output

CreateWorkGroup

Command API Reference / Input / Output

DeleteCapacityReservation

Command API Reference / Input / Output

DeleteDataCatalog

Command API Reference / Input / Output

DeleteNamedQuery

Command API Reference / Input / Output

DeleteNotebook

Command API Reference / Input / Output

DeletePreparedStatement

Command API Reference / Input / Output

DeleteWorkGroup

Command API Reference / Input / Output

ExportNotebook

Command API Reference / Input / Output

GetCalculationExecution

Command API Reference / Input / Output

GetCalculationExecutionCode

Command API Reference / Input / Output

GetCalculationExecutionStatus

Command API Reference / Input / Output

GetCapacityAssignmentConfiguration

Command API Reference / Input / Output

GetCapacityReservation

Command API Reference / Input / Output

GetDatabase

Command API Reference / Input / Output

GetDataCatalog

Command API Reference / Input / Output

GetNamedQuery

Command API Reference / Input / Output

GetNotebookMetadata

Command API Reference / Input / Output

GetPreparedStatement

Command API Reference / Input / Output

GetQueryExecution

Command API Reference / Input / Output

GetQueryResults

Command API Reference / Input / Output

GetQueryRuntimeStatistics

Command API Reference / Input / Output

GetResourceDashboard

Command API Reference / Input / Output

GetSession

Command API Reference / Input / Output

GetSessionEndpoint

Command API Reference / Input / Output

GetSessionStatus

Command API Reference / Input / Output

GetTableMetadata

Command API Reference / Input / Output

GetWorkGroup

Command API Reference / Input / Output

ImportNotebook

Command API Reference / Input / Output

ListApplicationDPUSizes

Command API Reference / Input / Output

ListCalculationExecutions

Command API Reference / Input / Output

ListCapacityReservations

Command API Reference / Input / Output

ListDatabases

Command API Reference / Input / Output

ListDataCatalogs

Command API Reference / Input / Output

ListEngineVersions

Command API Reference / Input / Output

ListExecutors

Command API Reference / Input / Output

ListNamedQueries

Command API Reference / Input / Output

ListNotebookMetadata

Command API Reference / Input / Output

ListNotebookSessions

Command API Reference / Input / Output

ListPreparedStatements

Command API Reference / Input / Output

ListQueryExecutions

Command API Reference / Input / Output

ListSessions

Command API Reference / Input / Output

ListTableMetadata

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListWorkGroups

Command API Reference / Input / Output

PutCapacityAssignmentConfiguration

Command API Reference / Input / Output

StartCalculationExecution

Command API Reference / Input / Output

StartQueryExecution

Command API Reference / Input / Output

StartSession

Command API Reference / Input / Output

StopCalculationExecution

Command API Reference / Input / Output

StopQueryExecution

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

TerminateSession

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateCapacityReservation

Command API Reference / Input / Output

UpdateDataCatalog

Command API Reference / Input / Output

UpdateNamedQuery

Command API Reference / Input / Output

UpdateNotebook

Command API Reference / Input / Output

UpdateNotebookMetadata

Command API Reference / Input / Output

UpdatePreparedStatement

Command API Reference / Input / Output

UpdateWorkGroup

Command API Reference / Input / Output