Class: Aws::KMS::Types::DecryptResponse

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:plaintext]

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext_for_recipient ⇒ String

The plaintext data encrypted with the public key in the attestation document.

This field is included in the response only when the ‘Recipient` parameter in the request includes a valid attestation document from an Amazon Web Services Nitro enclave. For information about the interaction between KMS and Amazon Web Services Nitro Enclaves, see

How Amazon Web Services Nitro Enclaves uses KMS][1

in the *Key

Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/services-nitro-enclaves.html

Returns:

  • (String) 


1687
1688
1689
1690
1691
1692
1693
1694
 
# File 'lib/aws-sdk-kms/types.rb', line 1687

class DecryptResponse < Struct.new(
  :key_id,
  :plaintext,
  :encryption_algorithm,
  :ciphertext_for_recipient)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#encryption_algorithm ⇒ String

The encryption algorithm that was used to decrypt the ciphertext.

Returns:

  • (String) 


1687
1688
1689
1690
1691
1692
1693
1694
 
# File 'lib/aws-sdk-kms/types.rb', line 1687

class DecryptResponse < Struct.new(
  :key_id,
  :plaintext,
  :encryption_algorithm,
  :ciphertext_for_recipient)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#key_id ⇒ String

The Amazon Resource Name ([key ARN]) of the KMS key that was used to decrypt the ciphertext.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN

Returns:

  • (String) 


1687
1688
1689
1690
1691
1692
1693
1694
 
# File 'lib/aws-sdk-kms/types.rb', line 1687

class DecryptResponse < Struct.new(
  :key_id,
  :plaintext,
  :encryption_algorithm,
  :ciphertext_for_recipient)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end

#plaintext ⇒ String

Decrypted plaintext data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.

If the response includes the ‘CiphertextForRecipient` field, the `Plaintext` field is null or empty.

Returns:

  • (String) 


1687
1688
1689
1690
1691
1692
1693
1694
 
# File 'lib/aws-sdk-kms/types.rb', line 1687

class DecryptResponse < Struct.new(
  :key_id,
  :plaintext,
  :encryption_algorithm,
  :ciphertext_for_recipient)
  SENSITIVE = [:plaintext]
  include Aws::Structure
end