S3Tables / Client / get_table_bucket_maintenance_configuration

get_table_bucket_maintenance_configuration#

S3Tables.Client.get_table_bucket_maintenance_configuration(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.get_table_bucket_maintenance_configuration(
    tableBucketARN='string'
)
Parameters:

tableBucketARN (string) –

[REQUIRED]

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

Return type:

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.

            Note

            This is a Tagged Union structure. Only one of the following top level keys will be set: icebergUnreferencedFileRemoval. 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'}

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

Exceptions

  • S3Tables.Client.exceptions.InternalServerErrorException

  • S3Tables.Client.exceptions.ForbiddenException

  • S3Tables.Client.exceptions.NotFoundException

  • S3Tables.Client.exceptions.TooManyRequestsException

  • S3Tables.Client.exceptions.ConflictException

  • S3Tables.Client.exceptions.BadRequestException