S3TablesClient

Suggest an Edit

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 .

Installation

NPM
npm install @aws-sdk/client-s3tables
Yarn
yarn add @aws-sdk/client-s3tables
pnpm
pnpm add @aws-sdk/client-s3tables

S3TablesClient Operations

Command
Summary
CreateNamespaceCommand

Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see Create a namespace  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:CreateNamespace permission to use this operation.

CreateTableBucketCommand

Creates a table bucket. For more information, see Creating a table bucket  in the Amazon Simple Storage Service User Guide.

Permissions

  • You must have the s3tables:CreateTableBucket permission to use this operation.

  • If you use this operation with the optional encryptionConfiguration parameter you must have the s3tables:PutTableBucketEncryption permission.

CreateTableCommand

Creates a new table associated with the given namespace in a table bucket. For more information, see Creating an Amazon S3 table  in the Amazon Simple Storage Service User Guide.

Permissions

  • You must have the s3tables:CreateTable permission to use this operation.

  • If you use this operation with the optional metadata request parameter you must have the s3tables:PutTableData permission.

  • If you use this operation with the optional encryptionConfiguration request parameter you must have the s3tables:PutTableEncryption permission.

Additionally,

DeleteNamespaceCommand

Deletes a namespace. For more information, see Delete a namespace  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:DeleteNamespace permission to use this operation.

DeleteTableBucketCommand

Deletes a table bucket. For more information, see Deleting a table bucket  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:DeleteTableBucket permission to use this operation.

DeleteTableBucketEncryptionCommand

Deletes the encryption configuration for a table bucket.

Permissions

You must have the s3tables:DeleteTableBucketEncryption permission to use this operation.

DeleteTableBucketPolicyCommand

Deletes a table bucket policy. For more information, see Deleting a table bucket policy  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:DeleteTableBucketPolicy permission to use this operation.

DeleteTableCommand

Deletes a table. For more information, see Deleting an Amazon S3 table  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:DeleteTable permission to use this operation.

DeleteTablePolicyCommand

Deletes a table policy. For more information, see Deleting a table policy  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:DeleteTablePolicy permission to use this operation.

GetNamespaceCommand

Gets details about a namespace. For more information, see Table namespaces  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetNamespace permission to use this operation.

GetTableBucketCommand

Gets details on a table bucket. For more information, see Viewing details about an Amazon S3 table bucket  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetTableBucket permission to use this operation.

GetTableBucketEncryptionCommand

Gets the encryption configuration for a table bucket.

Permissions

You must have the s3tables:GetTableBucketEncryption permission to use this operation.

GetTableBucketMaintenanceConfigurationCommand

Gets details about a maintenance configuration for a given table bucket. For more information, see Amazon S3 table bucket maintenance  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetTableBucketMaintenanceConfiguration permission to use this operation.

GetTableBucketPolicyCommand

Gets details about a table bucket policy. For more information, see Viewing a table bucket policy  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetTableBucketPolicy permission to use this operation.

GetTableCommand

Gets details about a table. For more information, see S3 Tables  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetTable permission to use this operation.

GetTableEncryptionCommand

Gets the encryption configuration for a table.

Permissions

You must have the s3tables:GetTableEncryption permission to use this operation.

GetTableMaintenanceConfigurationCommand

Gets details about the maintenance configuration of a table. For more information, see S3 Tables maintenance  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetTableMaintenanceConfiguration permission to use this operation.

GetTableMaintenanceJobStatusCommand

Gets the status of a maintenance job for a table. For more information, see S3 Tables maintenance  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetTableMaintenanceJobStatus permission to use this operation.

GetTableMetadataLocationCommand

Gets the location of the table metadata.

Permissions

You must have the s3tables:GetTableMetadataLocation permission to use this operation.

GetTablePolicyCommand

Gets details about a table policy. For more information, see Viewing a table policy  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetTablePolicy permission to use this operation.

ListNamespacesCommand

Lists the namespaces within a table bucket. For more information, see Table namespaces  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:ListNamespaces permission to use this operation.

ListTableBucketsCommand

Lists table buckets for your account. For more information, see S3 Table buckets  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:ListTableBuckets permission to use this operation.

ListTablesCommand

List tables in the given table bucket. For more information, see S3 Tables  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:ListTables permission to use this operation.

PutTableBucketEncryptionCommand

Sets the encryption configuration for a table bucket.

Permissions

You must have the s3tables:PutTableBucketEncryption permission to use this operation.

If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption 

PutTableBucketMaintenanceConfigurationCommand

Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket. For more information, see Amazon S3 table bucket maintenance  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:PutTableBucketMaintenanceConfiguration permission to use this operation.

PutTableBucketPolicyCommand

Creates a new maintenance configuration or replaces an existing table bucket policy for a table bucket. For more information, see Adding a table bucket policy  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:PutTableBucketPolicy permission to use this operation.

PutTableMaintenanceConfigurationCommand

Creates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see S3 Tables maintenance  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:PutTableMaintenanceConfiguration permission to use this operation.

PutTablePolicyCommand

Creates a new maintenance configuration or replaces an existing table policy for a table. For more information, see Adding a table policy  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:PutTablePolicy permission to use this operation.

RenameTableCommand

Renames a table or a namespace. For more information, see S3 Tables  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:RenameTable permission to use this operation.

UpdateTableMetadataLocationCommand

Updates the metadata location for a table. The metadata location of a table must be an S3 URI that begins with the table's warehouse location. The metadata location for an Apache Iceberg table must end with .metadata.json, or if the metadata file is Gzip-compressed, .metadata.json.gz.

Permissions

You must have the s3tables:UpdateTableMetadataLocation permission to use this operation.

S3TablesClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: S3TablesClientConfig