s3tables/aws.sdk.kotlin.services.s3tables

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createNamespace

inline suspend fun S3TablesClient.createNamespace(crossinline block: CreateNamespaceRequest.Builder.() -> Unit): CreateNamespaceResponse

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.

createTable

inline suspend fun S3TablesClient.createTable(crossinline block: CreateTableRequest.Builder.() -> Unit): CreateTableResponse

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.

createTableBucket

inline suspend fun S3TablesClient.createTableBucket(crossinline block: CreateTableBucketRequest.Builder.() -> Unit): CreateTableBucketResponse

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

deleteNamespace

inline suspend fun S3TablesClient.deleteNamespace(crossinline block: DeleteNamespaceRequest.Builder.() -> Unit): DeleteNamespaceResponse

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

deleteTable

inline suspend fun S3TablesClient.deleteTable(crossinline block: DeleteTableRequest.Builder.() -> Unit): DeleteTableResponse

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

deleteTableBucket

inline suspend fun S3TablesClient.deleteTableBucket(crossinline block: DeleteTableBucketRequest.Builder.() -> Unit): DeleteTableBucketResponse

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

deleteTableBucketEncryption

inline suspend fun S3TablesClient.deleteTableBucketEncryption(crossinline block: DeleteTableBucketEncryptionRequest.Builder.() -> Unit): DeleteTableBucketEncryptionResponse

Deletes the encryption configuration for a table bucket.

deleteTableBucketMetricsConfiguration

inline suspend fun S3TablesClient.deleteTableBucketMetricsConfiguration(crossinline block: DeleteTableBucketMetricsConfigurationRequest.Builder.() -> Unit): DeleteTableBucketMetricsConfigurationResponse

Deletes the metrics configuration for a table bucket.

deleteTableBucketPolicy

inline suspend fun S3TablesClient.deleteTableBucketPolicy(crossinline block: DeleteTableBucketPolicyRequest.Builder.() -> Unit): DeleteTableBucketPolicyResponse

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

deleteTableBucketReplication

inline suspend fun S3TablesClient.deleteTableBucketReplication(crossinline block: DeleteTableBucketReplicationRequest.Builder.() -> Unit): DeleteTableBucketReplicationResponse

Deletes the replication configuration for a table bucket. After deletion, new table updates will no longer be replicated to destination buckets, though existing replicated tables will remain in destination buckets.

deleteTablePolicy

inline suspend fun S3TablesClient.deleteTablePolicy(crossinline block: DeleteTablePolicyRequest.Builder.() -> Unit): DeleteTablePolicyResponse

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

deleteTableReplication

inline suspend fun S3TablesClient.deleteTableReplication(crossinline block: DeleteTableReplicationRequest.Builder.() -> Unit): DeleteTableReplicationResponse

Deletes the replication configuration for a specific table. After deletion, new updates to this table will no longer be replicated to destination tables, though existing replicated copies will remain in destination buckets.

getNamespace

inline suspend fun S3TablesClient.getNamespace(crossinline block: GetNamespaceRequest.Builder.() -> Unit): GetNamespaceResponse

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

getTable

inline suspend fun S3TablesClient.getTable(crossinline block: GetTableRequest.Builder.() -> Unit): GetTableResponse

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

getTableBucket

inline suspend fun S3TablesClient.getTableBucket(crossinline block: GetTableBucketRequest.Builder.() -> Unit): GetTableBucketResponse

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.

getTableBucketEncryption

inline suspend fun S3TablesClient.getTableBucketEncryption(crossinline block: GetTableBucketEncryptionRequest.Builder.() -> Unit): GetTableBucketEncryptionResponse

Gets the encryption configuration for a table bucket.

getTableBucketMaintenanceConfiguration

inline suspend fun S3TablesClient.getTableBucketMaintenanceConfiguration(crossinline block: GetTableBucketMaintenanceConfigurationRequest.Builder.() -> Unit): GetTableBucketMaintenanceConfigurationResponse

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.

getTableBucketMetricsConfiguration

inline suspend fun S3TablesClient.getTableBucketMetricsConfiguration(crossinline block: GetTableBucketMetricsConfigurationRequest.Builder.() -> Unit): GetTableBucketMetricsConfigurationResponse

Gets the metrics configuration for a table bucket.

getTableBucketPolicy

inline suspend fun S3TablesClient.getTableBucketPolicy(crossinline block: GetTableBucketPolicyRequest.Builder.() -> Unit): GetTableBucketPolicyResponse

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

getTableBucketReplication

inline suspend fun S3TablesClient.getTableBucketReplication(crossinline block: GetTableBucketReplicationRequest.Builder.() -> Unit): GetTableBucketReplicationResponse

Retrieves the replication configuration for a table bucket.This operation returns the IAM role, versionToken, and replication rules that define how tables in this bucket are replicated to other buckets.

getTableBucketStorageClass

inline suspend fun S3TablesClient.getTableBucketStorageClass(crossinline block: GetTableBucketStorageClassRequest.Builder.() -> Unit): GetTableBucketStorageClassResponse

Retrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which may differ from the table bucket's default configuration.

getTableEncryption

inline suspend fun S3TablesClient.getTableEncryption(crossinline block: GetTableEncryptionRequest.Builder.() -> Unit): GetTableEncryptionResponse

Gets the encryption configuration for a table.

getTableMaintenanceConfiguration

inline suspend fun S3TablesClient.getTableMaintenanceConfiguration(crossinline block: GetTableMaintenanceConfigurationRequest.Builder.() -> Unit): GetTableMaintenanceConfigurationResponse

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

getTableMaintenanceJobStatus

inline suspend fun S3TablesClient.getTableMaintenanceJobStatus(crossinline block: GetTableMaintenanceJobStatusRequest.Builder.() -> Unit): GetTableMaintenanceJobStatusResponse

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.

getTableMetadataLocation

inline suspend fun S3TablesClient.getTableMetadataLocation(crossinline block: GetTableMetadataLocationRequest.Builder.() -> Unit): GetTableMetadataLocationResponse

Gets the location of the table metadata.

getTablePolicy

inline suspend fun S3TablesClient.getTablePolicy(crossinline block: GetTablePolicyRequest.Builder.() -> Unit): GetTablePolicyResponse

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

getTableRecordExpirationConfiguration

inline suspend fun S3TablesClient.getTableRecordExpirationConfiguration(crossinline block: GetTableRecordExpirationConfigurationRequest.Builder.() -> Unit): GetTableRecordExpirationConfigurationResponse

Retrieves the expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is enabled, records expire and are automatically removed from the table after the specified number of days.

getTableRecordExpirationJobStatus

inline suspend fun S3TablesClient.getTableRecordExpirationJobStatus(crossinline block: GetTableRecordExpirationJobStatusRequest.Builder.() -> Unit): GetTableRecordExpirationJobStatusResponse

Retrieves the status, metrics, and details of the latest record expiration job for a table. This includes when the job ran, and whether it succeeded or failed. If the job ran successfully, this also includes statistics about the records that were removed.

getTableReplication

inline suspend fun S3TablesClient.getTableReplication(crossinline block: GetTableReplicationRequest.Builder.() -> Unit): GetTableReplicationResponse

Retrieves the replication configuration for a specific table.

getTableReplicationStatus

inline suspend fun S3TablesClient.getTableReplicationStatus(crossinline block: GetTableReplicationStatusRequest.Builder.() -> Unit): GetTableReplicationStatusResponse

Retrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication health and progress.

getTableStorageClass

inline suspend fun S3TablesClient.getTableStorageClass(crossinline block: GetTableStorageClassRequest.Builder.() -> Unit): GetTableStorageClassResponse

listNamespaces

inline suspend fun S3TablesClient.listNamespaces(crossinline block: ListNamespacesRequest.Builder.() -> Unit): ListNamespacesResponse

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

listTableBuckets

inline suspend fun S3TablesClient.listTableBuckets(crossinline block: ListTableBucketsRequest.Builder.() -> Unit): ListTableBucketsResponse

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

listTables

inline suspend fun S3TablesClient.listTables(crossinline block: ListTablesRequest.Builder.() -> Unit): ListTablesResponse

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

listTagsForResource

inline suspend fun S3TablesClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all of the tags applied to a specified Amazon S3 Tables resource. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to resources.

putTableBucketEncryption

inline suspend fun S3TablesClient.putTableBucketEncryption(crossinline block: PutTableBucketEncryptionRequest.Builder.() -> Unit): PutTableBucketEncryptionResponse

Sets the encryption configuration for a table bucket.

putTableBucketMaintenanceConfiguration

inline suspend fun S3TablesClient.putTableBucketMaintenanceConfiguration(crossinline block: PutTableBucketMaintenanceConfigurationRequest.Builder.() -> Unit): PutTableBucketMaintenanceConfigurationResponse

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.

putTableBucketMetricsConfiguration

inline suspend fun S3TablesClient.putTableBucketMetricsConfiguration(crossinline block: PutTableBucketMetricsConfigurationRequest.Builder.() -> Unit): PutTableBucketMetricsConfigurationResponse

Sets the metrics configuration for a table bucket.

putTableBucketPolicy

inline suspend fun S3TablesClient.putTableBucketPolicy(crossinline block: PutTableBucketPolicyRequest.Builder.() -> Unit): PutTableBucketPolicyResponse

Creates a new table bucket policy 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.

putTableBucketReplication

inline suspend fun S3TablesClient.putTableBucketReplication(crossinline block: PutTableBucketReplicationRequest.Builder.() -> Unit): PutTableBucketReplicationResponse

Creates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination buckets. Replication helps ensure data availability and disaster recovery across regions or accounts.

putTableBucketStorageClass

inline suspend fun S3TablesClient.putTableBucketStorageClass(crossinline block: PutTableBucketStorageClassRequest.Builder.() -> Unit): PutTableBucketStorageClassResponse

Sets or updates the storage class configuration for a table bucket. This configuration serves as the default storage class for all new tables created in the bucket, allowing you to optimize storage costs at the bucket level.

putTableMaintenanceConfiguration

inline suspend fun S3TablesClient.putTableMaintenanceConfiguration(crossinline block: PutTableMaintenanceConfigurationRequest.Builder.() -> Unit): PutTableMaintenanceConfigurationResponse

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.

putTablePolicy

inline suspend fun S3TablesClient.putTablePolicy(crossinline block: PutTablePolicyRequest.Builder.() -> Unit): PutTablePolicyResponse

Creates a new table policy 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.

putTableRecordExpirationConfiguration

inline suspend fun S3TablesClient.putTableRecordExpirationConfiguration(crossinline block: PutTableRecordExpirationConfigurationRequest.Builder.() -> Unit): PutTableRecordExpirationConfigurationResponse

Creates or updates the expiration configuration settings for records in a table, including the status of the configuration. If you enable record expiration for a table, records expire and are automatically removed from the table after the number of days that you specify.

putTableReplication

inline suspend fun S3TablesClient.putTableReplication(crossinline block: PutTableReplicationRequest.Builder.() -> Unit): PutTableReplicationResponse

Creates or updates the replication configuration for a specific table. This operation allows you to define table-level replication independently of bucket-level replication, providing granular control over which tables are replicated and where.

renameTable

inline suspend fun S3TablesClient.renameTable(crossinline block: RenameTableRequest.Builder.() -> Unit): RenameTableResponse

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

tagResource

inline suspend fun S3TablesClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Applies one or more user-defined tags to an Amazon S3 Tables resource or updates existing tags. Each tag is a label consisting of a key and value pair. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 tags for each S3 resource.

untagResource

inline suspend fun S3TablesClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the specified user-defined tags from an Amazon S3 Tables resource. You can pass one or more tag keys.

updateTableMetadataLocation

inline suspend fun S3TablesClient.updateTableMetadataLocation(crossinline block: UpdateTableMetadataLocationRequest.Builder.() -> Unit): UpdateTableMetadataLocationResponse

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.

withConfig

fun S3TablesClient.withConfig(block: S3TablesClient.Config.Builder.() -> Unit): S3TablesClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.