Amazon S3 Tables

Creates a new maintenance configuration or replaces an existing table bucket policy for a table bucket.

See also: AWS API Documentation

Request Syntax

client.put_table_bucket_policy(
    tableBucketARN='string',
    resourcePolicy='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type resourcePolicy:

string

param resourcePolicy:

[REQUIRED]

The name of the resource policy.

returns:

None

Deletes a table bucket.

See also: AWS API Documentation

Request Syntax

client.delete_table_bucket(
    tableBucketARN='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

returns:

None

Gets the location of the table metadata.

See also: AWS API Documentation

Request Syntax

client.get_table_metadata_location(
    tableBucketARN='string',
    namespace='string',
    name='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

string

param namespace:

[REQUIRED]

The namespace of the table.

type name:

string

param name:

[REQUIRED]

The name of the table.

rtype:

dict

returns:

Response Syntax

{
    'versionToken': 'string',
    'metadataLocation': 'string',
    'warehouseLocation': 'string'
}

Response Structure

• (dict) --

  • versionToken (string) --

    The version token.

  • metadataLocation (string) --

    The metadata location.

  • warehouseLocation (string) --

    The warehouse location.

Gets details about a table policy.

See also: AWS API Documentation

Request Syntax

client.get_table_policy(
    tableBucketARN='string',
    namespace='string',
    name='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Number (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

{
    'resourcePolicy': 'string'
}

Response Structure

• (dict) --

  • resourcePolicy (string) --

    The name of the resource policy.

Updates the metadata location for a table.

See also: AWS API Documentation

Request Syntax

client.update_table_metadata_location(
    tableBucketARN='string',
    namespace='string',
    name='string',
    versionToken='string',
    metadataLocation='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

string

param namespace:

[REQUIRED]

The namespace of the table.

type name:

string

param name:

[REQUIRED]

The name of the table.

type versionToken:

string

param versionToken:

[REQUIRED]

The version token of the table.

type metadataLocation:

string

param metadataLocation:

[REQUIRED]

The new metadata location for the table.

rtype:

dict

returns:

Response Syntax

{
    'name': 'string',
    'tableARN': 'string',
    'namespace': [
        'string',
    ],
    'versionToken': 'string',
    'metadataLocation': 'string'
}

Response Structure

• (dict) --

  • name (string) --

    The name of the table.

  • tableARN (string) --

    The Amazon Resource Number (ARN) of the table.

  • namespace (list) --

    The namespace the table is associated with.

    • (string) --

  • versionToken (string) --

    The version token of the table.

  • metadataLocation (string) --

    The metadata location of the table.

Gets details about a maintenance configuration for a given table bucket.

See also: AWS API Documentation

Request Syntax

client.get_table_bucket_maintenance_configuration(
    tableBucketARN='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'tableBucketARN': 'string',
    'configuration': {
        'string': {
            'status': 'enabled'|'disabled',
            'settings': {
                'icebergUnreferencedFileRemoval': {
                    'unreferencedDays': 123,
                    'nonCurrentDays': 123
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • tableBucketARN (string) --

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

  • configuration (dict) --

    Details about the maintenance configuration for the table bucket.

    • (string) --

      • (dict) --

        Details about the values that define the maintenance configuration for a table bucket.

        • status (string) --

          The status of the maintenance configuration.

        • settings (dict) --

          Contains details about the settings of the maintenance configuration.

          • icebergUnreferencedFileRemoval (dict) --

            The unreferenced file removal settings for the table bucket.

            • unreferencedDays (integer) --

              The number of days an object has to be unreferenced before it is marked as non-current. </p>

            • nonCurrentDays (integer) --

              The number of days an object has to be non-current before it is deleted. </p>

Creates a new table associated with the given namespace in a table bucket.

See also: AWS API Documentation

Request Syntax

client.create_table(
    tableBucketARN='string',
    namespace='string',
    name='string',
    format='ICEBERG'
)

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.

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.

Gets the status of a maintenance job for a table.

See also: AWS API Documentation

Request Syntax

client.get_table_maintenance_job_status(
    tableBucketARN='string',
    namespace='string',
    name='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

string

param namespace:

[REQUIRED]

The name of the namespace the table is associated with. </p>

type name:

string

param name:

[REQUIRED]

The name of the maintenance job.

rtype:

dict

returns:

Response Syntax

{
    'tableARN': 'string',
    'status': {
        'string': {
            'status': 'Not_Yet_Run'|'Successful'|'Failed'|'Disabled',
            'lastRunTimestamp': datetime(2015, 1, 1),
            'failureMessage': 'string'
        }
    }
}

Response Structure

• (dict) --

  • tableARN (string) --

    The Amazon Resource Name (ARN) of the table.

  • status (dict) --

    The status of the maintenance job.

    • (string) --

      • (dict) --

        Details about the status of a maintenance job.

        • status (string) --

          The status of the job.

        • lastRunTimestamp (datetime) --

          The date and time that the maintenance job was last run.

        • failureMessage (string) --

          The failure message of a failed job.

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 Table namespaces.

See also: AWS API Documentation

Request Syntax

client.create_namespace(
    tableBucketARN='string',
    namespace=[
        'string',
    ]
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

list

param namespace:

[REQUIRED]

A name for the namespace.

• (string) --

rtype:

dict

returns:

Response Syntax

{
    'tableBucketARN': 'string',
    'namespace': [
        'string',
    ]
}

Response Structure

• (dict) --

  • tableBucketARN (string) --

    The Amazon Resource Name (ARN) of the table bucket the namespace was created in.

  • namespace (list) --

    The name of the namespace.

    • (string) --

Gets details about a table bucket policy.

See also: AWS API Documentation

Request Syntax

client.get_table_bucket_policy(
    tableBucketARN='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'resourcePolicy': 'string'
}

Response Structure

• (dict) --

  • resourcePolicy (string) --

    The name of the resource policy.

Creates a new maintenance configuration or replaces an existing table policy for a table.

See also: AWS API Documentation

Request Syntax

client.put_table_policy(
    tableBucketARN='string',
    namespace='string',
    name='string',
    resourcePolicy='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Number (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.

type resourcePolicy:

string

param resourcePolicy:

[REQUIRED]

The name of the resource policy.

returns:

None

Lists the namespaces within a table bucket.

See also: AWS API Documentation

Request Syntax

client.list_namespaces(
    tableBucketARN='string',
    prefix='string',
    continuationToken='string',
    maxNamespaces=123
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type prefix:

string

param prefix:

The prefix of the namespaces.

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 maxNamespaces:

integer

param maxNamespaces:

The maximum number of namespaces to return in the list.

rtype:

dict

returns:

Response Syntax

{
    'namespaces': [
        {
            'namespace': [
                'string',
            ],
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'ownerAccountId': 'string'
        },
    ],
    'continuationToken': 'string'
}

Response Structure

• (dict) --

  • namespaces (list) --

    A list of namespaces.

    • (dict) --

      Contains details about a namespace.

      • namespace (list) --

        The name of the namespace.

        • (string) --

      • createdAt (datetime) --

        The date and time the namespace was created at.

      • createdBy (string) --

        The ID of the account that created the namespace.

      • ownerAccountId (string) --

        The ID of the account that owns the namespace.

  • continuationToken (string) --

    The ContinuationToken for pagination of the list results.

Gets details about the maintenance configuration of a table.

See also: AWS API Documentation

Request Syntax

client.get_table_maintenance_configuration(
    tableBucketARN='string',
    namespace='string',
    name='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

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

{
    'tableARN': 'string',
    'configuration': {
        'string': {
            'status': 'enabled'|'disabled',
            'settings': {
                'icebergCompaction': {
                    'targetFileSizeMB': 123
                },
                'icebergSnapshotManagement': {
                    'minSnapshotsToKeep': 123,
                    'maxSnapshotAgeHours': 123
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • tableARN (string) --

    The Amazon Resource Name (ARN) of the table.

  • configuration (dict) --

    Details about the maintenance configuration for the table bucket.

    • (string) --

      • (dict) --

        Contains the values that define a maintenance configuration for a table.

        • status (string) --

          The status of the maintenance configuration.

        • settings (dict) --

          Contains details about the settings for the maintenance configuration.

          • icebergCompaction (dict) --

            Contains details about the Iceberg compaction settings for the table.

            • targetFileSizeMB (integer) --

              The target file size for the table in MB.

          • icebergSnapshotManagement (dict) --

            Contains details about the Iceberg snapshot management settings for the table.

            • minSnapshotsToKeep (integer) --

              The minimum number of snapshots to keep.

            • maxSnapshotAgeHours (integer) --

              The maximum age of a snapshot before it can be expired.

Deletes a namespace.

See also: AWS API Documentation

Request Syntax

client.delete_namespace(
    tableBucketARN='string',
    namespace='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

string

param namespace:

[REQUIRED]

The name of the namespace.

returns:

None

Creates a new maintenance configuration or replaces an existing maintenance configuration for a table.

See also: AWS API Documentation

Request Syntax

client.put_table_maintenance_configuration(
    tableBucketARN='string',
    namespace='string',
    name='string',
    type='icebergCompaction'|'icebergSnapshotManagement',
    value={
        'status': 'enabled'|'disabled',
        'settings': {
            'icebergCompaction': {
                'targetFileSizeMB': 123
            },
            'icebergSnapshotManagement': {
                'minSnapshotsToKeep': 123,
                'maxSnapshotAgeHours': 123
            }
        }
    }
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

string

param namespace:

[REQUIRED]

The namespace of the table.

type name:

string

param name:

[REQUIRED]

The name of the maintenance configuration.

type type:

string

param type:

[REQUIRED]

The type of the maintenance configuration.

type value:

dict

param value:

[REQUIRED]

Defines the values of the maintenance configuration for the table.

• status (string) --

  The status of the maintenance configuration.

• settings (dict) --

  Contains details about the settings for the maintenance configuration.

  • icebergCompaction (dict) --

    Contains details about the Iceberg compaction settings for the table.

    • targetFileSizeMB (integer) --

      The target file size for the table in MB.

  • icebergSnapshotManagement (dict) --

    Contains details about the Iceberg snapshot management settings for the table.

    • minSnapshotsToKeep (integer) --

      The minimum number of snapshots to keep.

    • maxSnapshotAgeHours (integer) --

      The maximum age of a snapshot before it can be expired.

returns:

None

Lists table buckets for your account.

See also: AWS API Documentation

Request Syntax

client.list_table_buckets(
    prefix='string',
    continuationToken='string',
    maxBuckets=123
)

type prefix:

string

param prefix:

The prefix of the table buckets.

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 maxBuckets:

integer

param maxBuckets:

The maximum number of table buckets to return in the list.

rtype:

dict

returns:

Response Syntax

{
    'tableBuckets': [
        {
            'arn': 'string',
            'name': 'string',
            'ownerAccountId': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'continuationToken': 'string'
}

Response Structure

• (dict) --

  • tableBuckets (list) --

    A list of table buckets.

    • (dict) --

      Contains details about a table bucket.

      • arn (string) --

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

      • name (string) --

        The name of the table bucket.

      • ownerAccountId (string) --

        The ID of the account that owns the table bucket.

      • createdAt (datetime) --

        The date and time the table bucket was created at.

  • continuationToken (string) --

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

Deletes a table policy.

See also: AWS API Documentation

Request Syntax

client.delete_table_policy(
    tableBucketARN='string',
    namespace='string',
    name='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

The Amazon Resource Number (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 table name.

returns:

None

Deletes a table.

See also: AWS API Documentation

Request Syntax

client.delete_table(
    tableBucketARN='string',
    namespace='string',
    name='string',
    versionToken='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.

type versionToken:

string

param versionToken:

The version token of the table.

returns:

None

List tables in the given table bucket.

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 Number (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)
        },
    ],
    '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 Number (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.

  • continuationToken (string) --

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

Creates a new maintenance configuration or replaces an existing maintenance configuration for a table bucket.

See also: AWS API Documentation

Request Syntax

client.put_table_bucket_maintenance_configuration(
    tableBucketARN='string',
    type='icebergUnreferencedFileRemoval',
    value={
        'status': 'enabled'|'disabled',
        'settings': {
            'icebergUnreferencedFileRemoval': {
                'unreferencedDays': 123,
                'nonCurrentDays': 123
            }
        }
    }
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type type:

string

param type:

[REQUIRED]

The type of the maintenance configuration.

type value:

dict

param value:

[REQUIRED]

Defines the values of the maintenance configuration for the table bucket.

• status (string) --

  The status of the maintenance configuration.

• settings (dict) --

  Contains details about the settings of the maintenance configuration.

  • icebergUnreferencedFileRemoval (dict) --

    The unreferenced file removal settings for the table bucket.

    • unreferencedDays (integer) --

      The number of days an object has to be unreferenced before it is marked as non-current. </p>

    • nonCurrentDays (integer) --

      The number of days an object has to be non-current before it is deleted. </p>

returns:

None

Deletes a table bucket policy.

See also: AWS API Documentation

Request Syntax

client.delete_table_bucket_policy(
    tableBucketARN='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

returns:

None

Gets details about a namespace.

See also: AWS API Documentation

Request Syntax

client.get_namespace(
    tableBucketARN='string',
    namespace='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

string

param namespace:

[REQUIRED]

The name of the namespace.

rtype:

dict

returns:

Response Syntax

{
    'namespace': [
        'string',
    ],
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'ownerAccountId': 'string'
}

Response Structure

• (dict) --

  • namespace (list) --

    The name of the namespace.

    • (string) --

  • createdAt (datetime) --

    The date and time the namespace was created at.

  • createdBy (string) --

    The ID of the account that created the namespace.

  • ownerAccountId (string) --

    The ID of the account that owns the namespcace.

Creates a table bucket.

See also: AWS API Documentation

Request Syntax

client.create_table_bucket(
    name='string'
)

type name:

string

param name:

[REQUIRED]

The name for the table bucket.

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string'
}

Response Structure

• (dict) --

  • arn (string) --

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

Gets details about a table.

See also: AWS API Documentation

Request Syntax

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

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

string

param namespace:

[REQUIRED]

The name of the namespace the table is associated with.

type name:

string

param name:

[REQUIRED]

The name of the table.

rtype:

dict

returns:

Response Syntax

{
    'name': 'string',
    'type': 'customer'|'aws',
    'tableARN': 'string',
    'namespace': [
        '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'
}

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) --

  • 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.

Renames a table or a namespace.

See also: AWS API Documentation

Request Syntax

client.rename_table(
    tableBucketARN='string',
    namespace='string',
    name='string',
    newNamespaceName='string',
    newName='string',
    versionToken='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

type namespace:

string

param namespace:

[REQUIRED]

The namespace associated with the table.

type name:

string

param name:

[REQUIRED]

The current name of the table.

type newNamespaceName:

string

param newNamespaceName:

The new name for the namespace.

type newName:

string

param newName:

The new name for the table.

type versionToken:

string

param versionToken:

The version token of the table.

returns:

None

Gets details on a table bucket.

See also: AWS API Documentation

Request Syntax

client.get_table_bucket(
    tableBucketARN='string'
)

type tableBucketARN:

string

param tableBucketARN:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'arn': 'string',
    'name': 'string',
    'ownerAccountId': 'string',
    'createdAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) --

  • arn (string) --

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

  • name (string) --

    The name of the table bucket

  • ownerAccountId (string) --

    The ID of the account that owns the table bucket.

  • createdAt (datetime) --

    The date and time the table bucket was created.