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

GetFieldLevelEncryptionProfile

Get the field-level encryption profile information.

Request Syntax


GET /2020-05-31/field-level-encryption-profile/Id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Id

Get the ID for the field-level encryption profile information.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
<?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 200 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.

AccessDenied

Access denied.

HTTP Status Code: 403

NoSuchFieldLevelEncryptionProfile

The specified profile for field-level encryption doesn't exist.

HTTP Status Code: 404