Request Syntax Request Parameters Response Elements Errors See Also

PutDataCatalogEncryptionSettings

Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.

Request Syntax


{
   "CatalogId": "string",
   "DataCatalogEncryptionSettings": { 
      "ConnectionPasswordEncryption": { 
         "AwsKmsKeyId": "string",
         "ReturnConnectionPasswordEncrypted": boolean
      },
      "EncryptionAtRest": { 
         "CatalogEncryptionMode": "string",
         "CatalogEncryptionServiceRole": "string",
         "SseAwsKmsKeyId": "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 set 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

DataCatalogEncryptionSettings

The security configuration to set.

Type: DataCatalogEncryptionSettings object

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

An internal service error occurred.

Message: A message describing the problem.

HTTP Status Code: 500

InvalidInputException

The input provided was not valid.

FromFederationSource: Indicates whether or not the exception relates to a federated source.
Message: A message describing the problem.

HTTP Status Code: 400

OperationTimeoutException

The operation timed out.

Message: A message describing the problem.

HTTP Status Code: 400