S3Tables / Client / get_table_encryption

get_table_encryption

S3Tables.Client.get_table_encryption(**kwargs)

Gets the encryption configuration for a table.

Permissions

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

See also: AWS API Documentation

Request Syntax

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

  • tableBucketARN (string) –

    [REQUIRED]

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

  • namespace (string) –

    [REQUIRED]

    The namespace associated with the table.

  • name (string) –

    [REQUIRED]

    The name of the table.

Return type:

dict

Returns:

Response Syntax

{
    'encryptionConfiguration': {
        'sseAlgorithm': 'AES256'|'aws:kms',
        'kmsKeyArn': 'string'
    }
}

Response Structure

  • (dict) –

    • encryptionConfiguration (dict) –

      The encryption configuration for the table.

      • sseAlgorithm (string) –

        The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

      • kmsKeyArn (string) –

        The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when sseAlgorithm is set to aws:kms.

Exceptions