Amazon S3 Tables

{'configuration': {'settings': {'icebergCompaction': {'strategy': 'auto | '
                                                                  'binpack | '
                                                                  'sort | '
                                                                  'z-order'}}}}

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

Permissions

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

• You must have the s3tables:GetTableData permission to use set the compaction strategy to sort or zorder.

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,
                    'strategy': 'auto'|'binpack'|'sort'|'z-order'
                },
                '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.

            • strategy (string) --

              The compaction strategy to use for the table. This determines how files are selected and combined during compaction operations.

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

{'value': {'settings': {'icebergCompaction': {'strategy': 'auto | binpack | '
                                                          'sort | z-order'}}}}

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

Permissions

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

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,
                'strategy': 'auto'|'binpack'|'sort'|'z-order'
            },
            '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.

    • strategy (string) --

      The compaction strategy to use for the table. This determines how files are selected and combined during compaction operations.

  • 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