GetDataCatalogEncryptionSettings
Retrieves the security configuration for a specified catalog.
Request Syntax
{
"CatalogId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- CatalogId
-
The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the AWS account ID is used by default.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
Response Syntax
{
"DataCatalogEncryptionSettings": {
"ConnectionPasswordEncryption": {
"AwsKmsKeyId": "string",
"ReturnConnectionPasswordEncrypted": boolean
},
"EncryptionAtRest": {
"CatalogEncryptionMode": "string",
"CatalogEncryptionServiceRole": "string",
"SseAwsKmsKeyId": "string"
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DataCatalogEncryptionSettings
-
The requested security configuration.
Type: DataCatalogEncryptionSettings object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
