Amazon S3 Tables
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
Endpoints 57
Table
- POSTComplete table migration
/complete-table-migration?tableARN=stringCompletes the migration of a table. The table's most recent migration must be in the succeeded , failed or cancelled state. After you complete the migration,… - PUTCreate table
/tables/:tableBucketARN/:namespaceCreates 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… - DELETEDelete table
/tables/:tableBucketARN/:namespace/:name?versionToken=stringDeletes a table. For more information, see Deleting an Amazon S3 table in the Amazon Simple Storage Service User Guide . Permissions You must have the… - GETGet table
/get-table?tableBucketARN=string&namespace=string&name=string&tableArn=stringGets details about a table. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide . Permissions You must have the… - GETGet table maintenance configuration
/tables/:tableBucketARN/:namespace/:name/maintenanceGets details about the maintenance configuration of a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide .… - GETGet table maintenance job status
/tables/:tableBucketARN/:namespace/:name/maintenance-job-statusGets the status of a maintenance job for a table. For more information, see S3 Tables maintenance in the Amazon Simple Storage Service User Guide .… - GETGet table metadata location
/tables/:tableBucketARN/:namespace/:name/metadata-locationGets the location of the table metadata. Permissions You must have the s3tables:GetTableMetadataLocation permission to use this operation. - PUTUpdate table metadata location
/tables/:tableBucketARN/:namespace/:name/metadata-locationUpdates 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… - GETGet table migration
/get-table-migration?migrationId=string&tableARN=stringGets the details of a migration, including its state, the reason it failed, its statistics and the location of its reports. Identify the migration by its… - GETGet table record expiration configuration
/table-record-expiration?tableArn=stringRetrieves the expiration configuration settings for records in a table, and the status of the configuration. If the status of the configuration is enabled ,… - PUTPut table record expiration configuration
/table-record-expiration?tableArn=stringCreates or updates the expiration configuration settings for records in a table, including the status of the configuration. If you enable record expiration… - GETGet table record expiration job status
/table-record-expiration-job-status?tableArn=stringRetrieves 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… - GETGet table storage class
/tables/:tableBucketARN/:namespace/:name/storage-classRetrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which… - GETList table migrations
/list-table-migrations?tableBucketARN=string&namespace=string&name=string&tableARN=string&state=string&hasValidPlan=true&maxResults=0&nextToken=stringLists the migrations whose destination is in a table bucket, a namespace or a table. Specify a tableBucketARN to list the migrations into a table bucket, and… - GETList tables
/tables/:tableBucketARN?namespace=string&prefix=string&continuationToken=string&maxTables=0List 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… - PUTPut table maintenance configuration
/tables/:tableBucketARN/:namespace/:name/maintenance/:typeCreates a new maintenance configuration or replaces an existing maintenance configuration for a table. For more information, see S3 Tables maintenance in the… - PUTRename table
/tables/:tableBucketARN/:namespace/:name/renameRenames a table or a namespace. For more information, see S3 Tables in the Amazon Simple Storage Service User Guide . Permissions You must have the… - POSTStart table migration
/start-table-migrationStarts migrating an Amazon Web Services Glue Data Catalog table into a new table in a table bucket. The migration runs asynchronously: this operation returns… - POSTSync table migration
/sync-table-migrationMigrates the changes in the source table since the previous start or sync, such as added and deleted source objects, into the destination table. The sync runs… - POSTUpdate table migration
/update-table-migration?tableARN=string&migrationId=stringRequests a state change for a migration. Identify the migration by its migrationId or by the tableARN of its destination table. Set requestedState to queued…
Namespace
- GETList namespaces
/namespaces/:tableBucketARN?prefix=string&continuationToken=string&maxNamespaces=0Lists the namespaces within a table bucket. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide . Permissions You must… - PUTCreate namespace
/namespaces/:tableBucketARNCreates 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… - GETGet namespace
/namespaces/:tableBucketARN/:namespaceGets details about a namespace. For more information, see Table namespaces in the Amazon Simple Storage Service User Guide . Permissions You must have the… - DELETEDelete namespace
/namespaces/:tableBucketARN/:namespaceDeletes a namespace. For more information, see Delete a namespace in the Amazon Simple Storage Service User Guide . Permissions You must have the…
Table bucket
- GETList table buckets
/buckets?prefix=string&continuationToken=string&maxBuckets=0&type=stringLists table buckets for your account. For more information, see S3 Table buckets in the Amazon Simple Storage Service User Guide . Permissions You must have… - PUTCreate table bucket
/bucketsCreates a table bucket. For more information, see Creating a table bucket in the Amazon Simple Storage Service User Guide . Permissions You must have the… - GETGet table bucket
/buckets/:tableBucketARNGets 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 .… - DELETEDelete table bucket
/buckets/:tableBucketARNDeletes a table bucket. For more information, see Deleting a table bucket in the Amazon Simple Storage Service User Guide . Permissions You must have the… - GETGet table bucket metrics configuration
/buckets/:tableBucketARN/metricsGets the metrics configuration for a table bucket. Permissions You must have the s3tables:GetTableBucketMetricsConfiguration permission to use this operation. - PUTPut table bucket metrics configuration
/buckets/:tableBucketARN/metricsSets the metrics configuration for a table bucket. Permissions You must have the s3tables:PutTableBucketMetricsConfiguration permission to use this operation. - DELETEDelete table bucket metrics configuration
/buckets/:tableBucketARN/metricsDeletes the metrics configuration for a table bucket. Permissions You must have the s3tables:DeleteTableBucketMetricsConfiguration permission to use this… - GETGet table bucket maintenance configuration
/buckets/:tableBucketARN/maintenanceGets details about a maintenance configuration for a given table bucket. For more information, see Amazon S3 table bucket maintenance in the Amazon Simple… - GETGet table bucket storage class
/buckets/:tableBucketARN/storage-classRetrieves the storage class configuration for a specific table. This allows you to view the storage class settings that apply to an individual table, which… - PUTPut table bucket storage class
/buckets/:tableBucketARN/storage-classSets 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… - PUTPut table bucket maintenance configuration
/buckets/:tableBucketARN/maintenance/:typeCreates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket. For more information, see Amazon S3 table bucket…
Table bucket encryption
- GETGet table bucket encryption
/buckets/:tableBucketARN/encryptionGets the encryption configuration for a table bucket. Permissions You must have the s3tables:GetTableBucketEncryption permission to use this operation. - PUTPut table bucket encryption
/buckets/:tableBucketARN/encryptionSets the encryption configuration for a table bucket. Permissions You must have the s3tables:PutTableBucketEncryption permission to use this operation. If you… - DELETEDelete table bucket encryption
/buckets/:tableBucketARN/encryptionDeletes the encryption configuration for a table bucket. Permissions You must have the s3tables:DeleteTableBucketEncryption permission to use this operation.
Table bucket policy
- GETGet table bucket policy
/buckets/:tableBucketARN/policyGets details about a table bucket policy. For more information, see Viewing a table bucket policy in the Amazon Simple Storage Service User Guide .… - PUTPut table bucket policy
/buckets/:tableBucketARN/policyCreates 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… - DELETEDelete table bucket policy
/buckets/:tableBucketARN/policyDeletes a table bucket policy. For more information, see Deleting a table bucket policy in the Amazon Simple Storage Service User Guide . Permissions You must…
Table bucket replication
- GETGet table bucket replication
/table-bucket-replication?tableBucketARN=stringRetrieves the replication configuration for a table bucket.This operation returns the IAM role, versionToken , and replication rules that define how tables in… - PUTPut table bucket replication
/table-bucket-replication?tableBucketARN=string&versionToken=stringCreates or updates the replication configuration for a table bucket. This operation defines how tables in the source bucket are replicated to destination… - DELETEDelete table bucket replication
/table-bucket-replication?tableBucketARN=string&versionToken=stringDeletes the replication configuration for a table bucket. After deletion, new table updates will no longer be replicated to destination buckets, though…
Table policy
- GETGet table policy
/tables/:tableBucketARN/:namespace/:name/policyGets details about a table policy. For more information, see Viewing a table policy in the Amazon Simple Storage Service User Guide . Permissions You must… - PUTPut table policy
/tables/:tableBucketARN/:namespace/:name/policyCreates 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… - DELETEDelete table policy
/tables/:tableBucketARN/:namespace/:name/policyDeletes a table policy. For more information, see Deleting a table policy in the Amazon Simple Storage Service User Guide . Permissions You must have the…
Table replication
- GETGet table replication
/table-replication?tableArn=stringRetrieves the replication configuration for a specific table. Permissions You must have the s3tables:GetTableReplication permission to use this operation. - PUTPut table replication
/table-replication?tableArn=string&versionToken=stringCreates or updates the replication configuration for a specific table. This operation allows you to define table-level replication independently of… - DELETEDelete table replication
/table-replication?tableArn=string&versionToken=stringDeletes the replication configuration for a specific table. After deletion, new updates to this table will no longer be replicated to destination tables,… - GETGet table replication status
/replication-status?tableArn=stringRetrieves the replication status for a table, including the status of replication to each destination. This operation provides visibility into replication…
Table bucket logging
- GETGet table bucket logging
/buckets/:tableBucketARN/loggingGets the server access logging configuration for a table bucket. For more information, see Server access logging for table buckets in the Amazon Simple… - PUTPut table bucket logging
/buckets/:tableBucketARN/loggingSets, updates, or removes the server access logging configuration for a table bucket. When logging is enabled, Amazon S3 delivers a record of the requests…
Table encryption
- GETGet table encryption
/tables/:tableBucketARN/:namespace/:name/encryptionGets the encryption configuration for a table. Permissions You must have the s3tables:GetTableEncryption permission to use this operation.
- GETList tags for resource
/tag/:resourceArnLists 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,… - POSTTag resource
/tag/:resourceArnApplies 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… - DELETEUntag resource
/tag/:resourceArn?tagKeys=Removes the specified user-defined tags from an Amazon S3 Tables resource. You can pass one or more tag keys. For a list of S3 resources that support tagging,…
API details
- Base URL
https://s3tables.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 57 operations on 35 pathsGET 26PUT 16DELETE 10POST 5
- Main resources
- Table 20Table bucket 11Namespace 4Table replication 4Table bucket encryption 3Table bucket policy 3Table bucket replication 3Table policy 3Table bucket logging 2Table encryption 1
- Description format
- AWS Smithy model, API version
2018-05-10 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon S3 Tables in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon S3 Tables collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Complete table migration” (POST /complete-table-migration?tableARN=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon S3 Tables?
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… It is listed under Developer tools and has 57 endpoints.
Who publishes the Amazon S3 Tables?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon S3 Tables?
Requests go to https://s3tables.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon S3 Tables?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon S3 Tables have?
57 operations on 35 paths (26 GET, 16 PUT, 10 DELETE, 5 POST). The largest groups are Table, Table bucket, Namespace, Table replication.
Is forking the Amazon S3 Tables free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.