GetFieldLevelEncryptionProfileConfig
Get the field-level encryption profile configuration information.
Request Syntax
GET /2020-05-31/field-level-encryption-profile/Id/config HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- Id
-
Get the ID for the field-level encryption profile configuration 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"?>
<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>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.
- 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
- Comment
-
An optional comment for the field-level encryption profile. The comment cannot be longer than 128 characters.
Type: String
- 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
- Name
-
Profile name for the field-level encryption profile.
Type: String
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
