Amazon S3 Tables

2025/12/02 - Amazon S3 Tables - 13 new4 updated api methods

Changes  Add storage class, replication, and table record expiration features to S3 Tables.

PutTableReplication (new) Link ¶

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.

Permissions

  • You must have the s3tables:PutTableReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source table and write to all destination tables.

  • You must also have the following permissions:

    • s3tables:GetTable permission on the source table being replicated.

    • s3tables:CreateTable permission for the destination.

    • s3tables:CreateNamespace permission for the destination.

    • s3tables:GetTableMaintenanceConfig permission for the source table.

    • s3tables:PutTableMaintenanceConfig permission for the destination table.

  • You must have iam:PassRole permission with condition allowing roles to be passed to replication.s3tables.amazonaws.com.

See also: AWS API Documentation

Request Syntax

client.put_table_replication(
    tableArn='string',
    versionToken='string',
    configuration={
        'role': 'string',
        'rules': [
            {
                'destinations': [
                    {
                        'destinationTableBucketARN': 'string'
                    },
                ]
            },
        ]
    }
)
type tableArn:

string

param tableArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the source table.

type versionToken:

string

param versionToken:

A version token from a previous GetTableReplication call. Use this token to ensure you're updating the expected version of the configuration.

type configuration:

dict

param configuration:

[REQUIRED]

The replication configuration to apply to the table, including the IAM role and replication rules.

  • role (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate the table on your behalf.

  • rules (list) -- [REQUIRED]

    An array of replication rules that define where this table should be replicated.

    • (dict) --

      Defines a rule for replicating a table to one or more destination tables.

      • destinations (list) -- [REQUIRED]

        An array of destination table buckets where this table should be replicated.

        • (dict) --

          Specifies a destination table bucket for replication.

          • destinationTableBucketARN (string) -- [REQUIRED]

            The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.

rtype:

dict

returns:

Response Syntax

{
    'versionToken': 'string',
    'status': 'string'
}

Response Structure

  • (dict) --

    • versionToken (string) --

      A new version token representing the updated replication configuration.

    • status (string) --

      The status of the replication configuration operation.

GetTableBucketStorageClass (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.get_table_bucket_storage_class(
    tableBucketARN='string'
)
type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the table bucket.

rtype:

dict

returns:

Response Syntax

{
    'storageClassConfiguration': {
        'storageClass': 'STANDARD'|'INTELLIGENT_TIERING'
    }
}

Response Structure

  • (dict) --

    • storageClassConfiguration (dict) --

      The storage class configuration for the table bucket.

      • storageClass (string) --

        The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.

GetTableStorageClass (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.get_table_storage_class(
    tableBucketARN='string',
    namespace='string',
    name='string'
)
type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the table bucket that contains the table.

type namespace:

string

param namespace:

[REQUIRED]

The namespace associated with the table.

type name:

string

param name:

[REQUIRED]

The name of the table.

rtype:

dict

returns:

Response Syntax

{
    'storageClassConfiguration': {
        'storageClass': 'STANDARD'|'INTELLIGENT_TIERING'
    }
}

Response Structure

  • (dict) --

    • storageClassConfiguration (dict) --

      The storage class configuration for the table.

      • storageClass (string) --

        The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.

GetTableRecordExpirationConfiguration (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.get_table_record_expiration_configuration(
    tableArn='string'
)
type tableArn:

string

param tableArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the table.

rtype:

dict

returns:

Response Syntax

{
    'configuration': {
        'status': 'enabled'|'disabled',
        'settings': {
            'days': 123
        }
    }
}

Response Structure

  • (dict) --

    • configuration (dict) --

      The record expiration configuration for the table, including the status and retention settings.

      • status (string) --

        The status of the expiration settings for records in the table.

      • settings (dict) --

        The expiration settings for records in the table.

        • days (integer) --

          If you enable record expiration for a table, you can specify the number of days to retain your table records. For example, to retain your table records for one year, set this value to 365.

PutTableBucketReplication (new) Link ¶

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.

Permissions

  • You must have the s3tables:PutTableBucketReplication permission to use this operation. The IAM role specified in the configuration must have permissions to read from the source bucket and write permissions to all destination buckets.

  • You must also have the following permissions:

    • s3tables:GetTable permission on the source table.

    • s3tables:ListTables permission on the bucket containing the table.

    • s3tables:CreateTable permission for the destination.

    • s3tables:CreateNamespace permission for the destination.

    • s3tables:GetTableMaintenanceConfig permission for the source bucket.

    • s3tables:PutTableMaintenanceConfig permission for the destination bucket.

  • You must have iam:PassRole permission with condition allowing roles to be passed to replication.s3tables.amazonaws.com.

See also: AWS API Documentation

Request Syntax

client.put_table_bucket_replication(
    tableBucketARN='string',
    versionToken='string',
    configuration={
        'role': 'string',
        'rules': [
            {
                'destinations': [
                    {
                        'destinationTableBucketARN': 'string'
                    },
                ]
            },
        ]
    }
)
type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the source table bucket.

type versionToken:

string

param versionToken:

A version token from a previous GetTableBucketReplication call. Use this token to ensure you're updating the expected version of the configuration.

type configuration:

dict

param configuration:

[REQUIRED]

The replication configuration to apply, including the IAM role and replication rules.

  • role (string) -- [REQUIRED]

    The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate tables on your behalf.

  • rules (list) -- [REQUIRED]

    An array of replication rules that define which tables to replicate and where to replicate them.

    • (dict) --

      Defines a rule for replicating tables from a source table bucket to one or more destination table buckets.

      • destinations (list) -- [REQUIRED]

        An array of destination table buckets where tables should be replicated.

        • (dict) --

          Specifies a destination table bucket for replication.

          • destinationTableBucketARN (string) -- [REQUIRED]

            The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.

rtype:

dict

returns:

Response Syntax

{
    'versionToken': 'string',
    'status': 'string'
}

Response Structure

  • (dict) --

    • versionToken (string) --

      A new version token representing the updated replication configuration.

    • status (string) --

      The status of the replication configuration operation.

PutTableRecordExpirationConfiguration (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.put_table_record_expiration_configuration(
    tableArn='string',
    value={
        'status': 'enabled'|'disabled',
        'settings': {
            'days': 123
        }
    }
)
type tableArn:

string

param tableArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the table.

type value:

dict

param value:

[REQUIRED]

The record expiration configuration to apply to the table, including the status ( enabled or disabled) and retention period in days.

  • status (string) --

    The status of the expiration settings for records in the table.

  • settings (dict) --

    The expiration settings for records in the table.

    • days (integer) --

      If you enable record expiration for a table, you can specify the number of days to retain your table records. For example, to retain your table records for one year, set this value to 365.

returns:

None

GetTableReplicationStatus (new) Link ¶

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

Permissions

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

See also: AWS API Documentation

Request Syntax

client.get_table_replication_status(
    tableArn='string'
)
type tableArn:

string

param tableArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the table.

rtype:

dict

returns:

Response Syntax

{
    'sourceTableArn': 'string',
    'destinations': [
        {
            'replicationStatus': 'pending'|'completed'|'failed',
            'destinationTableBucketArn': 'string',
            'destinationTableArn': 'string',
            'lastSuccessfulReplicatedUpdate': {
                'metadataLocation': 'string',
                'timestamp': datetime(2015, 1, 1)
            },
            'failureMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • sourceTableArn (string) --

      The Amazon Resource Name (ARN) of the source table being replicated.

    • destinations (list) --

      An array of status information for each replication destination, including the current state, last successful update, and any error messages.

      • (dict) --

        Contains status information for a replication destination, including the current replication state, last successful update, and any error messages.

        • replicationStatus (string) --

          The current status of replication to this destination.

        • destinationTableBucketArn (string) --

          The Amazon Resource Name (ARN) of the destination table bucket.

        • destinationTableArn (string) --

          The Amazon Resource Name (ARN) of the destination table.

        • lastSuccessfulReplicatedUpdate (dict) --

          Information about the most recent successful replication update to this destination.

          • metadataLocation (string) --

            The S3 location of the metadata that was successfully replicated.

          • timestamp (datetime) --

            The timestamp when the replication update completed successfully.

        • failureMessage (string) --

          If replication has failed, this field contains an error message describing the failure reason.

GetTableReplication (new) Link ¶

Retrieves the replication configuration for a specific table.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.get_table_replication(
    tableArn='string'
)
type tableArn:

string

param tableArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the table.

rtype:

dict

returns:

Response Syntax

{
    'versionToken': 'string',
    'configuration': {
        'role': 'string',
        'rules': [
            {
                'destinations': [
                    {
                        'destinationTableBucketARN': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • versionToken (string) --

      A version token that represents the current state of the table's replication configuration. Use this token when updating the configuration to ensure consistency.

    • configuration (dict) --

      The replication configuration for the table, including the IAM role and replication rules.

      • role (string) --

        The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate the table on your behalf.

      • rules (list) --

        An array of replication rules that define where this table should be replicated.

        • (dict) --

          Defines a rule for replicating a table to one or more destination tables.

          • destinations (list) --

            An array of destination table buckets where this table should be replicated.

            • (dict) --

              Specifies a destination table bucket for replication.

              • destinationTableBucketARN (string) --

                The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.

DeleteTableBucketReplication (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.delete_table_bucket_replication(
    tableBucketARN='string',
    versionToken='string'
)
type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the table bucket.

type versionToken:

string

param versionToken:

A version token from a previous GetTableBucketReplication call. Use this token to ensure you're deleting the expected version of the configuration.

returns:

None

GetTableRecordExpirationJobStatus (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.get_table_record_expiration_job_status(
    tableArn='string'
)
type tableArn:

string

param tableArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the table.

rtype:

dict

returns:

Response Syntax

{
    'status': 'NotYetRun'|'Successful'|'Failed'|'Disabled',
    'lastRunTimestamp': datetime(2015, 1, 1),
    'failureMessage': 'string',
    'metrics': {
        'deletedDataFiles': 123,
        'deletedRecords': 123,
        'removedFilesSize': 123
    }
}

Response Structure

  • (dict) --

    • status (string) --

      The current status of the most recent expiration job.

    • lastRunTimestamp (datetime) --

      The timestamp when the expiration job was last executed.

    • failureMessage (string) --

      If the job failed, this field contains an error message describing the failure reason.

    • metrics (dict) --

      Metrics about the most recent expiration job execution, including the number of records and files deleted.

      • deletedDataFiles (integer) --

        The total number of data files that were removed when the job ran.

      • deletedRecords (integer) --

        The total number of records that were removed when the job ran.

      • removedFilesSize (integer) --

        The total size (in bytes) of the data files that were removed when the job ran.

PutTableBucketStorageClass (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.put_table_bucket_storage_class(
    tableBucketARN='string',
    storageClassConfiguration={
        'storageClass': 'STANDARD'|'INTELLIGENT_TIERING'
    }
)
type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the table bucket.

type storageClassConfiguration:

dict

param storageClassConfiguration:

[REQUIRED]

The storage class configuration to apply to the table bucket. This configuration will serve as the default for new tables created in this bucket.

  • storageClass (string) -- [REQUIRED]

    The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.

returns:

None

DeleteTableReplication (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.delete_table_replication(
    tableArn='string',
    versionToken='string'
)
type tableArn:

string

param tableArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the table.

type versionToken:

string

param versionToken:

[REQUIRED]

A version token from a previous GetTableReplication call. Use this token to ensure you're deleting the expected version of the configuration.

returns:

None

GetTableBucketReplication (new) Link ¶

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.

Permissions

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

See also: AWS API Documentation

Request Syntax

client.get_table_bucket_replication(
    tableBucketARN='string'
)
type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the table bucket.

rtype:

dict

returns:

Response Syntax

{
    'versionToken': 'string',
    'configuration': {
        'role': 'string',
        'rules': [
            {
                'destinations': [
                    {
                        'destinationTableBucketARN': 'string'
                    },
                ]
            },
        ]
    }
}

Response Structure

  • (dict) --

    • versionToken (string) --

      A version token that represents the current state of the replication configuration. Use this token when updating the configuration to ensure consistency.

    • configuration (dict) --

      The replication configuration for the table bucket, including the IAM role and replication rules.

      • role (string) --

        The Amazon Resource Name (ARN) of the IAM role that S3 Tables assumes to replicate tables on your behalf.

      • rules (list) --

        An array of replication rules that define which tables to replicate and where to replicate them.

        • (dict) --

          Defines a rule for replicating tables from a source table bucket to one or more destination table buckets.

          • destinations (list) --

            An array of destination table buckets where tables should be replicated.

            • (dict) --

              Specifies a destination table bucket for replication.

              • destinationTableBucketARN (string) --

                The Amazon Resource Name (ARN) of the destination table bucket where tables will be replicated.

CreateTable (updated) Link ¶
Changes (request)
{'metadata': {'iceberg': {'properties': {'string': 'string'}}},
 'storageClassConfiguration': {'storageClass': 'STANDARD | '
                                               'INTELLIGENT_TIERING'}}

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.

  • If you use this operation with the storageClassConfiguration request parameter, you must have the s3tables:PutTableStorageClass permission.

  • To create a table with tags, you must have the s3tables:TagResource permission in addition to s3tables:CreateTable permission.

See also: AWS API Documentation

Request Syntax

client.create_table(
    tableBucketARN='string',
    namespace='string',
    name='string',
    format='ICEBERG',
    metadata={
        'iceberg': {
            'schema': {
                'fields': [
                    {
                        'name': 'string',
                        'type': 'string',
                        'required': True|False
                    },
                ]
            },
            'properties': {
                'string': 'string'
            }
        }
    },
    encryptionConfiguration={
        'sseAlgorithm': 'AES256'|'aws:kms',
        'kmsKeyArn': 'string'
    },
    storageClassConfiguration={
        'storageClass': 'STANDARD'|'INTELLIGENT_TIERING'
    },
    tags={
        'string': 'string'
    }
)
type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Name (ARN) of the table bucket to create the table in.

type namespace:

string

param namespace:

[REQUIRED]

The namespace to associated with the table.

type name:

string

param name:

[REQUIRED]

The name for the table.

type format:

string

param format:

[REQUIRED]

The format for the table.

type metadata:

dict

param metadata:

The metadata for the table.

  • iceberg (dict) --

    Contains details about the metadata of an Iceberg table.

    • schema (dict) -- [REQUIRED]

      The schema for an Iceberg table.

      • fields (list) -- [REQUIRED]

        The schema fields for the table

        • (dict) --

          Contains details about a schema field.

          • name (string) -- [REQUIRED]

            The name of the field.

          • type (string) -- [REQUIRED]

            The field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the Apache Iceberg documentation.

          • required (boolean) --

            A Boolean value that specifies whether values are required for each row in this field. By default, this is false and null values are allowed in the field. If this is true the field does not allow null values.

    • properties (dict) --

      Contains configuration properties for an Iceberg table.

      • (string) --

        • (string) --

type encryptionConfiguration:

dict

param encryptionConfiguration:

The encryption configuration to use for the table. This configuration specifies the encryption algorithm and, if using SSE-KMS, the KMS key to use for encrypting the table.

  • sseAlgorithm (string) -- [REQUIRED]

    The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. 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.

  • kmsKeyArn (string) --

    The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.

type storageClassConfiguration:

dict

param storageClassConfiguration:

The storage class configuration for the table. If not specified, the table inherits the storage class configuration from its table bucket. Specify this parameter to override the bucket's default storage class for this table.

  • storageClass (string) -- [REQUIRED]

    The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.

type tags:

dict

param tags:

A map of user-defined tags that you would like to apply to the table that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs for, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'tableARN': 'string',
    'versionToken': 'string'
}

Response Structure

  • (dict) --

    • tableARN (string) --

      The Amazon Resource Name (ARN) of the table.

    • versionToken (string) --

      The version token of the table.

CreateTableBucket (updated) Link ¶
Changes (request)
{'storageClassConfiguration': {'storageClass': 'STANDARD | '
                                               'INTELLIGENT_TIERING'}}

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.

  • If you use this operation with the storageClassConfiguration request parameter, you must have the s3tables:PutTableBucketStorageClass permission.

  • To create a table bucket with tags, you must have the s3tables:TagResource permission in addition to s3tables:CreateTableBucket permission.

See also: AWS API Documentation

Request Syntax

client.create_table_bucket(
    name='string',
    encryptionConfiguration={
        'sseAlgorithm': 'AES256'|'aws:kms',
        'kmsKeyArn': 'string'
    },
    storageClassConfiguration={
        'storageClass': 'STANDARD'|'INTELLIGENT_TIERING'
    },
    tags={
        'string': 'string'
    }
)
type name:

string

param name:

[REQUIRED]

The name for the table bucket.

type encryptionConfiguration:

dict

param encryptionConfiguration:

The encryption configuration to use for the table bucket. This configuration specifies the default encryption settings that will be applied to all tables created in this bucket unless overridden at the table level. The configuration includes the encryption algorithm and, if using SSE-KMS, the KMS key to use.

  • sseAlgorithm (string) -- [REQUIRED]

    The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. 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.

  • kmsKeyArn (string) --

    The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.

type storageClassConfiguration:

dict

param storageClassConfiguration:

The default storage class configuration for the table bucket. This configuration will be applied to all new tables created in this bucket unless overridden at the table level. If not specified, the service default storage class will be used.

  • storageClass (string) -- [REQUIRED]

    The storage class for the table or table bucket. Valid values include storage classes optimized for different access patterns and cost profiles.

type tags:

dict

param tags:

A map of user-defined tags that you would like to apply to the table bucket that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string'
}

Response Structure

  • (dict) --

    • arn (string) --

      The Amazon Resource Name (ARN) of the table bucket.

GetTable (updated) Link ¶
Changes (response)
{'managedTableInformation': {'replicationInformation': {'sourceTableARN': 'string'}}}

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.

See also: AWS API Documentation

Request Syntax

client.get_table(
    tableBucketARN='string',
    namespace='string',
    name='string',
    tableArn='string'
)
type tableBucketARN:

string

param tableBucketARN:

The Amazon Resource Name (ARN) of the table bucket associated with the table.

type namespace:

string

param namespace:

The name of the namespace the table is associated with.

type name:

string

param name:

The name of the table.

type tableArn:

string

param tableArn:

The Amazon Resource Name (ARN) of the table.

rtype:

dict

returns:

Response Syntax

{
    'name': 'string',
    'type': 'customer'|'aws',
    'tableARN': 'string',
    'namespace': [
        'string',
    ],
    'namespaceId': 'string',
    'versionToken': 'string',
    'metadataLocation': 'string',
    'warehouseLocation': 'string',
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'managedByService': 'string',
    'modifiedAt': datetime(2015, 1, 1),
    'modifiedBy': 'string',
    'ownerAccountId': 'string',
    'format': 'ICEBERG',
    'tableBucketId': 'string',
    'managedTableInformation': {
        'replicationInformation': {
            'sourceTableARN': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • name (string) --

      The name of the table.

    • type (string) --

      The type of the table.

    • tableARN (string) --

      The Amazon Resource Name (ARN) of the table.

    • namespace (list) --

      The namespace associated with the table.

      • (string) --

    • namespaceId (string) --

      The unique identifier of the namespace containing this table.

    • versionToken (string) --

      The version token of the table.

    • metadataLocation (string) --

      The metadata location of the table.

    • warehouseLocation (string) --

      The warehouse location of the table.

    • createdAt (datetime) --

      The date and time the table bucket was created at.

    • createdBy (string) --

      The ID of the account that created the table.

    • managedByService (string) --

      The service that manages the table.

    • modifiedAt (datetime) --

      The date and time the table was last modified on.

    • modifiedBy (string) --

      The ID of the account that last modified the table.

    • ownerAccountId (string) --

      The ID of the account that owns the table.

    • format (string) --

      The format of the table.

    • tableBucketId (string) --

      The unique identifier of the table bucket containing this table.

    • managedTableInformation (dict) --

      If this table is managed by S3 Tables, contains additional information such as replication details.

      • replicationInformation (dict) --

        If this table is a replica, contains information about the source table from which it is replicated.

        • sourceTableARN (string) --

          The Amazon Resource Name (ARN) of the source table from which this table is replicated.

ListTables (updated) Link ¶
Changes (response)
{'tables': {'managedByService': 'string'}}

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.

See also: AWS API Documentation

Request Syntax

client.list_tables(
    tableBucketARN='string',
    namespace='string',
    prefix='string',
    continuationToken='string',
    maxTables=123
)
type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon resource Name (ARN) of the table bucket.

type namespace:

string

param namespace:

The namespace of the tables.

type prefix:

string

param prefix:

The prefix of the tables.

type continuationToken:

string

param continuationToken:

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

type maxTables:

integer

param maxTables:

The maximum number of tables to return.

rtype:

dict

returns:

Response Syntax

{
    'tables': [
        {
            'namespace': [
                'string',
            ],
            'name': 'string',
            'type': 'customer'|'aws',
            'tableARN': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1),
            'managedByService': 'string',
            'namespaceId': 'string',
            'tableBucketId': 'string'
        },
    ],
    'continuationToken': 'string'
}

Response Structure

  • (dict) --

    • tables (list) --

      A list of tables.

      • (dict) --

        Contains details about a table.

        • namespace (list) --

          The name of the namespace.

          • (string) --

        • name (string) --

          The name of the table.

        • type (string) --

          The type of the table.

        • tableARN (string) --

          The Amazon Resource Name (ARN) of the table.

        • createdAt (datetime) --

          The date and time the table was created at.

        • modifiedAt (datetime) --

          The date and time the table was last modified at.

        • managedByService (string) --

          The Amazon Web Services service managing this table, if applicable. For example, a replicated table is managed by the S3 Tables replication service.

        • namespaceId (string) --

          The unique identifier for the namespace that contains this table.

        • tableBucketId (string) --

          The unique identifier for the table bucket that contains this table.

    • continuationToken (string) --

      You can use this ContinuationToken for pagination of the list results.