AWS SDK for JavaScript S3tables Client for Node.js, Browser and React Native
npm install @aws-sdk/client-s3tablesAWS SDK for JavaScript S3Tables Client for Node.js, Browser and React Native.
An Amazon S3 table represents a structured dataset consisting of tabular data in Apache Parquet format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the Apache Iceberg table format. Through integration with the Amazon Web Services Glue Data Catalog you can interact with your tables using Amazon Web Services analytics services, such as Amazon Athena and Amazon Redshift. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see Amazon S3 table buckets.
npm install @aws-sdk/client-s3tablesyarn add @aws-sdk/client-s3tablespnpm add @aws-sdk/client-s3tablesThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the S3TablesClient and
the commands you need, for example ListTableBucketsCommand:
``js`
// ES5 example
const { S3TablesClient, ListTableBucketsCommand } = require("@aws-sdk/client-s3tables");
`ts`
// ES6+ example
import { S3TablesClient, ListTableBucketsCommand } from "@aws-sdk/client-s3tables";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new S3TablesClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListTableBucketsCommand(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-s3tables";
const client = new AWS.S3Tables({ region: "REGION" });
// async/await.
try {
const data = await client.listTableBuckets(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listTableBuckets(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listTableBuckets(params, (err, data) => {
// process err and data.
});
`
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;
* }
*/
}
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.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-s3tables` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
CreateNamespace
Command API Reference / Input / Output
CreateTable
Command API Reference / Input / Output
CreateTableBucket
Command API Reference / Input / Output
DeleteNamespace
Command API Reference / Input / Output
DeleteTable
Command API Reference / Input / Output
DeleteTableBucket
Command API Reference / Input / Output
DeleteTableBucketEncryption
Command API Reference / Input / Output
DeleteTableBucketMetricsConfiguration
Command API Reference / Input / Output
DeleteTableBucketPolicy
Command API Reference / Input / Output
DeleteTableBucketReplication
Command API Reference / Input / Output
DeleteTablePolicy
Command API Reference / Input / Output
DeleteTableReplication
Command API Reference / Input / Output
GetNamespace
Command API Reference / Input / Output
GetTable
Command API Reference / Input / Output
GetTableBucket
Command API Reference / Input / Output
GetTableBucketEncryption
Command API Reference / Input / Output
GetTableBucketMaintenanceConfiguration
Command API Reference / Input / Output
GetTableBucketMetricsConfiguration
Command API Reference / Input / Output
GetTableBucketPolicy
Command API Reference / Input / Output
GetTableBucketReplication
Command API Reference / Input / Output
GetTableBucketStorageClass
Command API Reference / Input / Output
GetTableEncryption
Command API Reference / Input / Output
GetTableMaintenanceConfiguration
Command API Reference / Input / Output
GetTableMaintenanceJobStatus
Command API Reference / Input / Output
GetTableMetadataLocation
Command API Reference / Input / Output
GetTablePolicy
Command API Reference / Input / Output
GetTableRecordExpirationConfiguration
Command API Reference / Input / Output
GetTableRecordExpirationJobStatus
Command API Reference / Input / Output
GetTableReplication
Command API Reference / Input / Output
GetTableReplicationStatus
Command API Reference / Input / Output
GetTableStorageClass
Command API Reference / Input / Output
ListNamespaces
Command API Reference / Input / Output
ListTableBuckets
Command API Reference / Input / Output
ListTables
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
PutTableBucketEncryption
Command API Reference / Input / Output
PutTableBucketMaintenanceConfiguration
Command API Reference / Input / Output
PutTableBucketMetricsConfiguration
Command API Reference / Input / Output
PutTableBucketPolicy
Command API Reference / Input / Output
PutTableBucketReplication
Command API Reference / Input / Output
PutTableBucketStorageClass
Command API Reference / Input / Output
PutTableMaintenanceConfiguration
Command API Reference / Input / Output
PutTablePolicy
Command API Reference / Input / Output
PutTableRecordExpirationConfiguration
Command API Reference / Input / Output
PutTableReplication
Command API Reference / Input / Output
RenameTable
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateTableMetadataLocation