Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateFieldLevelEncryptionProfile

Create a field-level encryption profile.

Request Syntax


POST /2020-05-31/field-level-encryption-profile HTTP/1.1
<?xml version="1.0" encoding="UTF-8"?>
<FieldLevelEncryptionProfileConfig xmlns="http://cloudfront.amazonaws.com/doc/2020-05-31/">
   <CallerReference>string</CallerReference>
   <Comment>string</Comment>
   <EncryptionEntities>
      <Items>
         <EncryptionEntity>
            <FieldPatterns>
               <Items>
                  <FieldPattern>string</FieldPattern>
               </Items>
               <Quantity>integer</Quantity>
            </FieldPatterns>
            <ProviderId>string</ProviderId>
            <PublicKeyId>string</PublicKeyId>
         </EncryptionEntity>
      </Items>
      <Quantity>integer</Quantity>
   </EncryptionEntities>
   <Name>string</Name>
</FieldLevelEncryptionProfileConfig>

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in XML format.

FieldLevelEncryptionProfileConfig

Root level tag for the FieldLevelEncryptionProfileConfig parameters.

Required: Yes

CallerReference

A unique number that ensures that the request can't be replayed.

Type: String

Required: Yes

Comment

An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.

Type: String

Required: No

EncryptionEntities

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

Type: EncryptionEntities object

Required: Yes

Name

Profile name for the field-level encryption profile.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 201
<?xml version="1.0" encoding="UTF-8"?>
<FieldLevelEncryptionProfile>
   <FieldLevelEncryptionProfileConfig>
      <CallerReference>string</CallerReference>
      <Comment>string</Comment>
      <EncryptionEntities>
         <Items>
            <EncryptionEntity>
               <FieldPatterns>
                  <Items>
                     <FieldPattern>string</FieldPattern>
                  </Items>
                  <Quantity>integer</Quantity>
               </FieldPatterns>
               <ProviderId>string</ProviderId>
               <PublicKeyId>string</PublicKeyId>
            </EncryptionEntity>
         </Items>
         <Quantity>integer</Quantity>
      </EncryptionEntities>
      <Name>string</Name>
   </FieldLevelEncryptionProfileConfig>
   <Id>string</Id>
   <LastModifiedTime>timestamp</LastModifiedTime>
</FieldLevelEncryptionProfile>

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in XML format by the service.

FieldLevelEncryptionProfile

Root level tag for the FieldLevelEncryptionProfile parameters.

Required: Yes

FieldLevelEncryptionProfileConfig

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

Type: FieldLevelEncryptionProfileConfig object

Id

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

Type: String

LastModifiedTime

The last time the field-level encryption profile was updated.

Type: Timestamp

Errors

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

FieldLevelEncryptionProfileAlreadyExists

The specified profile for field-level encryption already exists.

HTTP Status Code: 409

FieldLevelEncryptionProfileSizeExceeded

The maximum size of a profile for field-level encryption was exceeded.

HTTP Status Code: 400

InconsistentQuantities

The value of Quantity and the size of Items don't match.

HTTP Status Code: 400

InvalidArgument

An argument is invalid.

HTTP Status Code: 400

NoSuchPublicKey

The specified public key doesn't exist.

HTTP Status Code: 404

TooManyFieldLevelEncryptionEncryptionEntities

The maximum number of encryption entities for field-level encryption have been created.

HTTP Status Code: 400

TooManyFieldLevelEncryptionFieldPatterns

The maximum number of field patterns for field-level encryption have been created.

HTTP Status Code: 400

TooManyFieldLevelEncryptionProfiles

The maximum number of profiles for field-level encryption have been created.

HTTP Status Code: 400