class Aws::KMS::Types::DecryptRequest

@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
    }

@!attribute [rw] ciphertext_blob

Ciphertext to be decrypted. The blob includes metadata.
@return [String]

@!attribute [rw] encryption_context

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

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][2] in the *Key
Management Service Developer Guide*.

[1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations
[2]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context
@return [Hash<String,String>]

@!attribute [rw] grant_tokens

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][1] and [Using a grant
token][2] in the *Key Management Service Developer Guide*.

[1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token
[2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token
@return [Array<String>]

@!attribute [rw] key_id

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.

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.
@return [String]

@!attribute [rw] encryption_algorithm

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
KMS keys.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/DecryptRequest AWS API Documentation

Constants

SENSITIVE