Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.KMS.ReEncrypt

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this operation to change the KMS key under which data is encrypted, such as when you manually rotate a KMS key or change the KMS key that protects a ciphertext. You can also use it to reencrypt ciphertext under the same KMS key, such as to change the encryption context of a ciphertext.

The ReEncrypt operation can decrypt ciphertext that was encrypted by using an KMS KMS key in an KMS operation, such as Encrypt or GenerateDataKey. It can also decrypt ciphertext that was encrypted by using the public key of an asymmetric KMS key outside of KMS. However, it cannot decrypt ciphertext produced by other libraries, such as the Amazon Web Services Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with KMS.

When you use the ReEncrypt operation, you need to provide information for the decrypt operation and the subsequent encrypt operation.

If your ciphertext was encrypted under an asymmetric KMS key, you must use the SourceKeyId parameter to identify the KMS key that encrypted the ciphertext. You must also supply the encryption algorithm that was used. This information is required to decrypt the data.
If your ciphertext was encrypted under a symmetric KMS key, the SourceKeyId parameter is optional. KMS can get this information from metadata that it adds to the symmetric ciphertext blob. This feature adds durability to your implementation by ensuring that authorized users can decrypt ciphertext decades after it was encrypted, even if they've lost track of the key ID. However, specifying the source KMS key is always recommended as a best practice. When you use the SourceKeyId parameter to specify a KMS key, KMS uses only the KMS key you specify. If the ciphertext was encrypted under a different KMS key, the ReEncrypt operation fails. This practice ensures that you use the KMS key that you intend.
To reencrypt the data, you must use the DestinationKeyId parameter specify the KMS key that re-encrypts the data after it is decrypted. You can select a symmetric or asymmetric KMS key. If the destination KMS key is an asymmetric KMS key, you must also provide the encryption algorithm. The algorithm that you choose must be compatible with the KMS key.
When you use an asymmetric KMS key to encrypt or reencrypt data, be sure to record the KMS key and encryption algorithm that you choose. You will be required to provide the same KMS key and encryption algorithm when you decrypt the data. If the KMS key and algorithm do not match the values used to encrypt the data, the decrypt operation fails.
You are not required to supply the key ID and encryption algorithm when you decrypt with symmetric KMS keys because KMS stores this information in the ciphertext blob. KMS cannot store metadata in ciphertext generated with asymmetric keys. The standard format for asymmetric key ciphertext does not include configurable fields.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

Cross-account use: Yes. The source KMS key and destination KMS key can be in different Amazon Web Services accounts. Either or both KMS keys can be in a different account than the caller. To specify a KMS key in a different account, you must use its key ARN or alias ARN.

Required permissions:

kms:ReEncryptFrom permission on the source KMS key (key policy)
kms:ReEncryptTo permission on the destination KMS key (key policy)

To permit reencryption from or to a KMS key, include the "kms:ReEncrypt*" permission in your key policy. This permission is automatically included in the key policy when you use the console to create a KMS key. But you must include it manually when you create a KMS key programmatically or when you use the PutKeyPolicy operation to set a key policy.

Related operations:

Decrypt
Encrypt
GenerateDataKey
GenerateDataKeyPair

Synopsis

data ReEncrypt = ReEncrypt' {
- destinationEncryptionContext :: Maybe (HashMap Text Text)
- sourceKeyId :: Maybe Text
- sourceEncryptionContext :: Maybe (HashMap Text Text)
- grantTokens :: Maybe [Text]
- destinationEncryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
- sourceEncryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
- ciphertextBlob :: Base64
- destinationKeyId :: Text
}
newReEncrypt :: ByteString -> Text -> ReEncrypt
reEncrypt_destinationEncryptionContext :: Lens' ReEncrypt (Maybe (HashMap Text Text))
reEncrypt_sourceKeyId :: Lens' ReEncrypt (Maybe Text)
reEncrypt_sourceEncryptionContext :: Lens' ReEncrypt (Maybe (HashMap Text Text))
reEncrypt_grantTokens :: Lens' ReEncrypt (Maybe [Text])
reEncrypt_destinationEncryptionAlgorithm :: Lens' ReEncrypt (Maybe EncryptionAlgorithmSpec)
reEncrypt_sourceEncryptionAlgorithm :: Lens' ReEncrypt (Maybe EncryptionAlgorithmSpec)
reEncrypt_ciphertextBlob :: Lens' ReEncrypt ByteString
reEncrypt_destinationKeyId :: Lens' ReEncrypt Text
data ReEncryptResponse = ReEncryptResponse' {
- sourceKeyId :: Maybe Text
- keyId :: Maybe Text
- destinationEncryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
- sourceEncryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
- ciphertextBlob :: Maybe Base64
- httpStatus :: Int
}
newReEncryptResponse :: Int -> ReEncryptResponse
reEncryptResponse_sourceKeyId :: Lens' ReEncryptResponse (Maybe Text)
reEncryptResponse_keyId :: Lens' ReEncryptResponse (Maybe Text)
reEncryptResponse_destinationEncryptionAlgorithm :: Lens' ReEncryptResponse (Maybe EncryptionAlgorithmSpec)
reEncryptResponse_sourceEncryptionAlgorithm :: Lens' ReEncryptResponse (Maybe EncryptionAlgorithmSpec)
reEncryptResponse_ciphertextBlob :: Lens' ReEncryptResponse (Maybe ByteString)
reEncryptResponse_httpStatus :: Lens' ReEncryptResponse Int

Creating a Request

data ReEncrypt Source #

See: newReEncrypt smart constructor.

Constructors

ReEncrypt'

Fields

destinationEncryptionContext :: Maybe (HashMap Text Text)
Specifies that encryption context to use when the reencrypting the data.
A destination encryption context is valid only when the destination KMS key is a symmetric KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
sourceKeyId :: Maybe Text
Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the KMS key that was used to encrypt the ciphertext.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
- Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name: alias/ExampleAlias
- Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
sourceEncryptionContext :: Maybe (HashMap Text Text)
Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.
An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.
For more information, see Encryption Context in the Key Management Service Developer Guide.
grantTokens :: Maybe [Text]
A list of grant tokens.
Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.
destinationEncryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric KMS keys.
This parameter is required only when the destination KMS key is an asymmetric KMS key.
sourceEncryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric KMS keys.
Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
ciphertextBlob :: Base64
Ciphertext of the data to reencrypt.
destinationKeyId :: Text
A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.
To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.
For example:
- Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
- Alias name: alias/ExampleAlias
- Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Instances

Instances details

Eq ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods (==) :: ReEncrypt -> ReEncrypt -> Bool # (/=) :: ReEncrypt -> ReEncrypt -> Bool #
Read ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods readsPrec :: Int -> ReadS ReEncrypt # readList :: ReadS [ReEncrypt] # readPrec :: ReadPrec ReEncrypt # readListPrec :: ReadPrec [ReEncrypt] #
Show ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods showsPrec :: Int -> ReEncrypt -> ShowS # show :: ReEncrypt -> String # showList :: [ReEncrypt] -> ShowS #
Generic ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Associated Types type Rep ReEncrypt :: Type -> Type # Methods from :: ReEncrypt -> Rep ReEncrypt x # to :: Rep ReEncrypt x -> ReEncrypt #
NFData ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods rnf :: ReEncrypt -> () #
Hashable ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods hashWithSalt :: Int -> ReEncrypt -> Int # hash :: ReEncrypt -> Int #
ToJSON ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods toJSON :: ReEncrypt -> Value # toEncoding :: ReEncrypt -> Encoding # toJSONList :: [ReEncrypt] -> Value # toEncodingList :: [ReEncrypt] -> Encoding #
AWSRequest ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Associated Types type AWSResponse ReEncrypt # Methods request :: ReEncrypt -> Request ReEncrypt # response :: MonadResource m => Logger -> Service -> Proxy ReEncrypt -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ReEncrypt))) #
ToHeaders ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods toHeaders :: ReEncrypt -> [Header] #
ToPath ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods toPath :: ReEncrypt -> ByteString #
ToQuery ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods toQuery :: ReEncrypt -> QueryString #
type Rep ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt type Rep ReEncrypt = D1 ('MetaData "ReEncrypt" "Amazonka.KMS.ReEncrypt" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "ReEncrypt'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "destinationEncryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "sourceKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sourceEncryptionContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "grantTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "destinationEncryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :: S1 ('MetaSel ('Just "sourceEncryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec))) :: (S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Base64) :*: S1 ('MetaSel ('Just "destinationKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ReEncrypt Source #
Instance details Defined in Amazonka.KMS.ReEncrypt type AWSResponse ReEncrypt = ReEncryptResponse

newReEncrypt Source #

Arguments

:: ByteString	`$sel:ciphertextBlob:ReEncrypt'`
-> Text	`$sel:destinationKeyId:ReEncrypt'`
-> ReEncrypt

Create a value of ReEncrypt with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:destinationEncryptionContext:ReEncrypt', reEncrypt_destinationEncryptionContext - Specifies that encryption context to use when the reencrypting the data.

A destination encryption context is valid only when the destination KMS key is a symmetric KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

For more information, see Encryption Context in the Key Management Service Developer Guide.

$sel:sourceKeyId:ReEncrypt', reEncrypt_sourceKeyId - Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the KMS key that was used to encrypt the ciphertext.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

$sel:sourceEncryptionContext:ReEncrypt', reEncrypt_sourceEncryptionContext - Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

For more information, see Encryption Context in the Key Management Service Developer Guide.

$sel:grantTokens:ReEncrypt', reEncrypt_grantTokens - A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

$sel:destinationEncryptionAlgorithm:ReEncrypt', reEncrypt_destinationEncryptionAlgorithm - Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric KMS keys.

This parameter is required only when the destination KMS key is an asymmetric KMS key.

$sel:sourceEncryptionAlgorithm:ReEncrypt', reEncrypt_sourceEncryptionAlgorithm - Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric KMS keys.

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.

$sel:ciphertextBlob:ReEncrypt', reEncrypt_ciphertextBlob - Ciphertext of the data to reencrypt.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:destinationKeyId:ReEncrypt', reEncrypt_destinationKeyId - A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Request Lenses

reEncrypt_destinationEncryptionContext :: Lens' ReEncrypt (Maybe (HashMap Text Text)) Source #

Specifies that encryption context to use when the reencrypting the data.

A destination encryption context is valid only when the destination KMS key is a symmetric KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

For more information, see Encryption Context in the Key Management Service Developer Guide.

reEncrypt_sourceKeyId :: Lens' ReEncrypt (Maybe Text) Source #

Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted. Enter a key ID of the KMS key that was used to encrypt the ciphertext.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric KMS key, KMS can get the KMS key from metadata that it adds to the symmetric ciphertext blob. However, it is always recommended as a best practice. This practice ensures that you use the KMS key that you intend.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

reEncrypt_sourceEncryptionContext :: Lens' ReEncrypt (Maybe (HashMap Text Text)) Source #

Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.

An encryption context is a collection of non-secret key-value pairs that represents additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting with a symmetric KMS key, but it is highly recommended.

For more information, see Encryption Context in the Key Management Service Developer Guide.

reEncrypt_grantTokens :: Lens' ReEncrypt (Maybe [Text]) Source #

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

reEncrypt_destinationEncryptionAlgorithm :: Lens' ReEncrypt (Maybe EncryptionAlgorithmSpec) Source #

Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric KMS keys.

This parameter is required only when the destination KMS key is an asymmetric KMS key.

reEncrypt_sourceEncryptionAlgorithm :: Lens' ReEncrypt (Maybe EncryptionAlgorithmSpec) Source #

Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric KMS keys.

Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.

reEncrypt_ciphertextBlob :: Lens' ReEncrypt ByteString Source #

Ciphertext of the data to reencrypt.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

reEncrypt_destinationKeyId :: Lens' ReEncrypt Text Source #

A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or asymmetric KMS key with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Destructuring the Response

data ReEncryptResponse Source #

See: newReEncryptResponse smart constructor.

Constructors

ReEncryptResponse'

Fields

sourceKeyId :: Maybe Text
Unique identifier of the KMS key used to originally encrypt the data.
keyId :: Maybe Text
The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.
destinationEncryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
The encryption algorithm that was used to reencrypt the data.
sourceEncryptionAlgorithm :: Maybe EncryptionAlgorithmSpec
The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.
ciphertextBlob :: Maybe Base64
The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ReEncryptResponse Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods (==) :: ReEncryptResponse -> ReEncryptResponse -> Bool # (/=) :: ReEncryptResponse -> ReEncryptResponse -> Bool #
Read ReEncryptResponse Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods readsPrec :: Int -> ReadS ReEncryptResponse # readList :: ReadS [ReEncryptResponse] # readPrec :: ReadPrec ReEncryptResponse # readListPrec :: ReadPrec [ReEncryptResponse] #
Show ReEncryptResponse Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods showsPrec :: Int -> ReEncryptResponse -> ShowS # show :: ReEncryptResponse -> String # showList :: [ReEncryptResponse] -> ShowS #
Generic ReEncryptResponse Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Associated Types type Rep ReEncryptResponse :: Type -> Type # Methods from :: ReEncryptResponse -> Rep ReEncryptResponse x # to :: Rep ReEncryptResponse x -> ReEncryptResponse #
NFData ReEncryptResponse Source #
Instance details Defined in Amazonka.KMS.ReEncrypt Methods rnf :: ReEncryptResponse -> () #
type Rep ReEncryptResponse Source #
Instance details Defined in Amazonka.KMS.ReEncrypt type Rep ReEncryptResponse = D1 ('MetaData "ReEncryptResponse" "Amazonka.KMS.ReEncrypt" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "ReEncryptResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "destinationEncryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)))) :: (S1 ('MetaSel ('Just "sourceEncryptionAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionAlgorithmSpec)) :: (S1 ('MetaSel ('Just "ciphertextBlob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newReEncryptResponse Source #

Arguments

:: Int	`$sel:httpStatus:ReEncryptResponse'`
-> ReEncryptResponse

Create a value of ReEncryptResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:sourceKeyId:ReEncrypt', reEncryptResponse_sourceKeyId - Unique identifier of the KMS key used to originally encrypt the data.

$sel:keyId:ReEncryptResponse', reEncryptResponse_keyId - The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.

$sel:destinationEncryptionAlgorithm:ReEncrypt', reEncryptResponse_destinationEncryptionAlgorithm - The encryption algorithm that was used to reencrypt the data.

$sel:sourceEncryptionAlgorithm:ReEncrypt', reEncryptResponse_sourceEncryptionAlgorithm - The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.

$sel:ciphertextBlob:ReEncrypt', reEncryptResponse_ciphertextBlob - The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:httpStatus:ReEncryptResponse', reEncryptResponse_httpStatus - The response's http status code.

Response Lenses

reEncryptResponse_sourceKeyId :: Lens' ReEncryptResponse (Maybe Text) Source #

Unique identifier of the KMS key used to originally encrypt the data.

reEncryptResponse_keyId :: Lens' ReEncryptResponse (Maybe Text) Source #

The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.

reEncryptResponse_destinationEncryptionAlgorithm :: Lens' ReEncryptResponse (Maybe EncryptionAlgorithmSpec) Source #

The encryption algorithm that was used to reencrypt the data.

reEncryptResponse_sourceEncryptionAlgorithm :: Lens' ReEncryptResponse (Maybe EncryptionAlgorithmSpec) Source #

The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.

reEncryptResponse_ciphertextBlob :: Lens' ReEncryptResponse (Maybe ByteString) Source #

The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

reEncryptResponse_httpStatus :: Lens' ReEncryptResponse Int Source #

The response's http status code.