S3Tables / Client / get_table_maintenance_configuration

get_table_maintenance_configuration#

S3Tables.Client.get_table_maintenance_configuration(**kwargs)#

Gets details about the maintenance configuration of a table.

See also: AWS API Documentation

Request Syntax

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

  • tableBucketARN (string) –

    [REQUIRED]

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

  • namespace (string) –

    [REQUIRED]

    The namespace associated with the table.

  • name (string) –

    [REQUIRED]

    The name of the table.

Return type:

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.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: icebergCompaction, icebergSnapshotManagement. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

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

Exceptions