AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
This is the response object from the Encrypt operation.
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public class EncryptResponse : AmazonWebServiceResponse
The EncryptResponse type exposes the following members
| Name | Description | |
|---|---|---|
|
EncryptResponse() |
| Name | Type | Description | |
|---|---|---|---|
|
CiphertextBlob | System.IO.MemoryStream |
Gets and sets the property CiphertextBlob. The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. |
|
ContentLength | System.Int64 | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
EncryptionAlgorithm | Amazon.KeyManagementService.EncryptionAlgorithmSpec |
Gets and sets the property EncryptionAlgorithm. The encryption algorithm that was used to encrypt the plaintext. |
|
HttpStatusCode | System.Net.HttpStatusCode | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
|
KeyId | System.String |
Gets and sets the property KeyId. The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext. |
|
ResponseMetadata | Amazon.Runtime.ResponseMetadata | Inherited from Amazon.Runtime.AmazonWebServiceResponse. |
The following example encrypts data with the specified symmetric encryption KMS key.
var client = new AmazonKeyManagementServiceClient();
var response = client.Encrypt(new EncryptRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab",
Plaintext = new MemoryStream(<binary data>)
});
MemoryStream ciphertextBlob = response.CiphertextBlob;
EncryptionAlgorithmSpec encryptionAlgorithm = response.EncryptionAlgorithm;
string keyId = response.KeyId;
The following example encrypts data with the specified RSA asymmetric KMS key. When you encrypt with an asymmetric key, you must specify the encryption algorithm.
var client = new AmazonKeyManagementServiceClient();
var response = client.Encrypt(new EncryptRequest
{
EncryptionAlgorithm = "RSAES_OAEP_SHA_256",
KeyId = "0987dcba-09fe-87dc-65ba-ab0987654321",
Plaintext = new MemoryStream(<binary data>)
});
MemoryStream ciphertextBlob = response.CiphertextBlob;
EncryptionAlgorithmSpec encryptionAlgorithm = response.EncryptionAlgorithm;
string keyId = response.KeyId;
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.7.2 and newer