You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::KMS::Types::DecryptRequest

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

Overview

Note:

When making an API call, you may pass DecryptRequest data as a hash:

{
  ciphertext_blob: "data", # required
  encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue",
  },
  grant_tokens: ["GrantTokenType"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext_blobString

Ciphertext to be decrypted. The blob includes metadata.

Returns:

  • (String)


446
447
448
449
450
451
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 446

class DecryptRequest < Struct.new(
  :ciphertext_blob,
  :encryption_context,
  :grant_tokens)
  include Aws::Structure
end

#encryption_contextHash<String,String>

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

Returns:

  • (Hash<String,String>)


446
447
448
449
450
451
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 446

class DecryptRequest < Struct.new(
  :ciphertext_blob,
  :encryption_context,
  :grant_tokens)
  include Aws::Structure
end

#grant_tokensArray<String>

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Returns:

  • (Array<String>)


446
447
448
449
450
451
# File 'gems/aws-sdk-kms/lib/aws-sdk-kms/types.rb', line 446

class DecryptRequest < Struct.new(
  :ciphertext_blob,
  :encryption_context,
  :grant_tokens)
  include Aws::Structure
end