S3 / Client / update_bucket_metadata_journal_table_configuration

update_bucket_metadata_journal_table_configuration

S3.Client.update_bucket_metadata_journal_table_configuration(**kwargs)

Enables or disables journal table record expiration for an S3 Metadata configuration on a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.

Permissions

To use this operation, you must have the s3:UpdateBucketMetadataJournalTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.

The following operations are related to UpdateBucketMetadataJournalTableConfiguration:

See also: AWS API Documentation

Request Syntax

response = client.update_bucket_metadata_journal_table_configuration(
    Bucket='string',
    ContentMD5='string',
    ChecksumAlgorithm='CRC32'|'CRC32C'|'SHA1'|'SHA256'|'CRC64NVME',
    JournalTableConfiguration={
        'RecordExpiration': {
            'Expiration': 'ENABLED'|'DISABLED',
            'Days': 123
        }
    },
    ExpectedBucketOwner='string'
)
Parameters:

  • Bucket (string) –

    [REQUIRED]

    The general purpose bucket that corresponds to the metadata configuration that you want to enable or disable journal table record expiration for.

  • ContentMD5 (string) – The Content-MD5 header for the journal table configuration.

  • ChecksumAlgorithm (string) – The checksum algorithm to use with your journal table configuration.

  • JournalTableConfiguration (dict) –

    [REQUIRED]

    The contents of your journal table configuration.

    • RecordExpiration (dict) – [REQUIRED]

      The journal table record expiration settings for the journal table.

      • Expiration (string) – [REQUIRED]

        Specifies whether journal table record expiration is enabled or disabled.

      • Days (integer) –

        If you enable journal table record expiration, you can set the number of days to retain your journal table records. Journal table records must be retained for a minimum of 7 days. To set this value, specify any whole number from 7 to 2147483647. For example, to retain your journal table records for one year, set this value to 365.

  • ExpectedBucketOwner (string) – The expected owner of the general purpose bucket that corresponds to the metadata table configuration that you want to enable or disable journal table record expiration for.

Returns:

None