get_data_catalog_encryption_settings
(**kwargs)¶Retrieves the security configuration for a specified catalog.
See also: AWS API Documentation
Request Syntax
response = client.get_data_catalog_encryption_settings(
CatalogId='string'
)
{
'DataCatalogEncryptionSettings': {
'EncryptionAtRest': {
'CatalogEncryptionMode': 'DISABLED'|'SSE-KMS',
'SseAwsKmsKeyId': 'string'
},
'ConnectionPasswordEncryption': {
'ReturnConnectionPasswordEncrypted': True|False,
'AwsKmsKeyId': 'string'
}
}
}
Response Structure
The requested security configuration.
Specifies the encryption-at-rest configuration for the Data Catalog.
The encryption-at-rest mode for encrypting Data Catalog data.
The ID of the KMS key to use for encryption at rest.
When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection
or UpdateConnection
and store it in the ENCRYPTED_PASSWORD
field in the connection properties. You can enable catalog encryption or only password encryption.
When the ReturnConnectionPasswordEncrypted
flag is set to "true", passwords remain encrypted in the responses of GetConnection
and GetConnections
. This encryption takes effect independently from catalog encryption.
An KMS key that is used to encrypt the connection password.
If connection password protection is enabled, the caller of CreateConnection
and UpdateConnection
needs at least kms:Encrypt
permission on the specified KMS key, to encrypt passwords before storing them in the Data Catalog.
You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.
Exceptions
Glue.Client.exceptions.InternalServiceException
Glue.Client.exceptions.InvalidInputException
Glue.Client.exceptions.OperationTimeoutException