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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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"],
  key_id: "KeyIdType",
  encryption_algorithm: "SYMMETRIC_DEFAULT", # accepts SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256, SM2PKE
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ciphertext_blobString

Ciphertext to be decrypted. The blob includes metadata.

Returns:

  • (String)

1304
1305
1306
1307
1308
1309
1310
1311
1312
# File 'lib/aws-sdk-kms/types.rb', line 1304

class DecryptRequest < Struct.new(
  :ciphertext_blob,
  :encryption_context,
  :grant_tokens,
  :key_id,
  :encryption_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_algorithmString

Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that was used to encrypt the data. If you specify a different algorithm, the `Decrypt` operation fails.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. The default value, `SYMMETRIC_DEFAULT`, represents the only supported algorithm that is valid for symmetric encryption KMS keys.

Returns:

  • (String)

1304
1305
1306
1307
1308
1309
1310
1311
1312
# File 'lib/aws-sdk-kms/types.rb', line 1304

class DecryptRequest < Struct.new(
  :ciphertext_blob,
  :encryption_context,
  :grant_tokens,
  :key_id,
  :encryption_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_contextHash<String,String>

Specifies the encryption context to use when decrypting the data. An encryption context is valid only for [cryptographic operations] with a symmetric encryption KMS key. The standard asymmetric encryption algorithms and HMAC algorithms that KMS uses do not support an encryption context.

An *encryption context* is a collection of non-secret key-value pairs that represent 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 supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see [Encryption context] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations [2]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context

Returns:

  • (Hash<String,String>)

1304
1305
1306
1307
1308
1309
1310
1311
1312
# File 'lib/aws-sdk-kms/types.rb', line 1304

class DecryptRequest < Struct.new(
  :ciphertext_blob,
  :encryption_context,
  :grant_tokens,
  :key_id,
  :encryption_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#grant_tokensArray<String>

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*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token

Returns:

  • (Array<String>)

1304
1305
1306
1307
1308
1309
1310
1311
1312
# File 'lib/aws-sdk-kms/types.rb', line 1304

class DecryptRequest < Struct.new(
  :ciphertext_blob,
  :encryption_context,
  :grant_tokens,
  :key_id,
  :encryption_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#key_idString

Specifies the KMS key that KMS uses to decrypt the ciphertext.

Enter a key ID of the KMS key that was used to encrypt the ciphertext. If you identify a different KMS key, the `Decrypt` operation throws an `IncorrectKeyException`.

This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key. If you used a symmetric encryption 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.

Returns:

  • (String)

1304
1305
1306
1307
1308
1309
1310
1311
1312
# File 'lib/aws-sdk-kms/types.rb', line 1304

class DecryptRequest < Struct.new(
  :ciphertext_blob,
  :encryption_context,
  :grant_tokens,
  :key_id,
  :encryption_algorithm)
  SENSITIVE = []
  include Aws::Structure
end