DecryptRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.DecryptRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class DecryptRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Decrypts ciphertext that was encrypted by a AWS KMS customer master key (CMK) using any of the following operations:
You can use this operation to decrypt ciphertext that was encrypted under a symmetric or asymmetric CMK. When the CMK is asymmetric, you must specify the CMK and the encryption algorithm that was used to encrypt the ciphertext. For information about symmetric and asymmetric CMKs, see Using Symmetric and Asymmetric CMKs in the AWS Key Management Service Developer Guide.

The Decrypt operation also decrypts ciphertext that was encrypted outside of AWS KMS by the public key in an AWS KMS asymmetric CMK. However, it cannot decrypt ciphertext produced by other libraries, such as the AWS Encryption SDK or Amazon S3 client-side encryption. These libraries return a ciphertext format that is incompatible with AWS KMS.

If the ciphertext was encrypted under a symmetric CMK, the KeyId parameter is optional. AWS 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 CMK ID. However, specifying the CMK is always recommended as a best practice. When you use the KeyId parameter to specify a CMK, AWS KMS only uses the CMK you specify. If the ciphertext was encrypted under a different CMK, the Decrypt operation fails. This practice ensures that you use the CMK that you intend.

Whenever possible, use key policies to give users permission to call the Decrypt operation on a particular CMK, instead of using IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts. For details, see Best practices for IAM policies in the AWS Key Management Service Developer Guide.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Cross-account use: Yes. You can decrypt a ciphertext using a CMK in a different AWS account.

Required permissions: kms:Decrypt (key policy)

Related operations:
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DecryptRequest()

Constructors
Constructor and Description
`DecryptRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DecryptRequest`	`addEncryptionContextEntry(java.lang.String key, java.lang.String value)` Specifies the encryption context to use when decrypting the data.
`DecryptRequest`	`clearEncryptionContextEntries()` Removes all the entries added into EncryptionContext.
`boolean`	`equals(java.lang.Object obj)`
`java.nio.ByteBuffer`	`getCiphertextBlob()` Ciphertext to be decrypted.
`java.lang.String`	`getEncryptionAlgorithm()` Specifies the encryption algorithm that will be used to decrypt the ciphertext.
`java.util.Map<java.lang.String,java.lang.String>`	`getEncryptionContext()` Specifies the encryption context to use when decrypting the data.
`java.util.List<java.lang.String>`	`getGrantTokens()` A list of grant tokens.
`java.lang.String`	`getKeyId()` Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext.
`int`	`hashCode()`
`void`	`setCiphertextBlob(java.nio.ByteBuffer ciphertextBlob)` Ciphertext to be decrypted.
`void`	`setEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)` Specifies the encryption algorithm that will be used to decrypt the ciphertext.
`void`	`setEncryptionAlgorithm(java.lang.String encryptionAlgorithm)` Specifies the encryption algorithm that will be used to decrypt the ciphertext.
`void`	`setEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)` Specifies the encryption context to use when decrypting the data.
`void`	`setGrantTokens(java.util.Collection<java.lang.String> grantTokens)` A list of grant tokens.
`void`	`setKeyId(java.lang.String keyId)` Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DecryptRequest`	`withCiphertextBlob(java.nio.ByteBuffer ciphertextBlob)` Ciphertext to be decrypted.
`DecryptRequest`	`withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)` Specifies the encryption algorithm that will be used to decrypt the ciphertext.
`DecryptRequest`	`withEncryptionAlgorithm(java.lang.String encryptionAlgorithm)` Specifies the encryption algorithm that will be used to decrypt the ciphertext.
`DecryptRequest`	`withEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)` Specifies the encryption context to use when decrypting the data.
`DecryptRequest`	`withGrantTokens(java.util.Collection<java.lang.String> grantTokens)` A list of grant tokens.
`DecryptRequest`	`withGrantTokens(java.lang.String... grantTokens)` A list of grant tokens.
`DecryptRequest`	`withKeyId(java.lang.String keyId)` Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DecryptRequest
```
public DecryptRequest()
```
- Method Detail
  - getCiphertextBlob
```
public java.nio.ByteBuffer getCiphertextBlob()
```
    Ciphertext to be decrypted. The blob includes metadata.
    
    Constraints:
    Length: 1 - 6144
    
    Returns:
    
    Ciphertext to be decrypted. The blob includes metadata.
  - setCiphertextBlob
```
public void setCiphertextBlob(java.nio.ByteBuffer ciphertextBlob)
```
    Ciphertext to be decrypted. The blob includes metadata.
    
    Constraints:
    Length: 1 - 6144
    
    Parameters:
    
    ciphertextBlob -
    Ciphertext to be decrypted. The blob includes metadata.
  - withCiphertextBlob
```
public DecryptRequest withCiphertextBlob(java.nio.ByteBuffer ciphertextBlob)
```
    Ciphertext to be decrypted. The blob includes metadata.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 6144
    
    Parameters:
    
    ciphertextBlob -
    Ciphertext to be decrypted. The blob includes metadata.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEncryptionContext
```
public java.util.Map<java.lang.String,java.lang.String> getEncryptionContext()
```
    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS 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 CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS 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 CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
  - setEncryptionContext
```
public void setEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)
```
    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS 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 CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    encryptionContext -
    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS 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 CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
  - withEncryptionContext
```
public DecryptRequest withEncryptionContext(java.util.Map<java.lang.String,java.lang.String> encryptionContext)
```
    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS 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 CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    encryptionContext -
    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS 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 CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addEncryptionContextEntry
```
public DecryptRequest addEncryptionContextEntry(java.lang.String key,
                                                java.lang.String value)
```
    Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS 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 CMK, but it is highly recommended.
    
    For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
    
    The method adds a new key-value pair into EncryptionContext parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into EncryptionContext.
    
    value - The corresponding value of the entry to be added into EncryptionContext.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearEncryptionContextEntries
```
public DecryptRequest clearEncryptionContextEntries()
```
    Removes all the entries added into EncryptionContext.
    Returns a reference to this object so that method calls can be chained together.
  - getGrantTokens
```
public java.util.List<java.lang.String> getGrantTokens()
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
  - setGrantTokens
```
public void setGrantTokens(java.util.Collection<java.lang.String> grantTokens)
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
  - withGrantTokens
```
public DecryptRequest withGrantTokens(java.lang.String... grantTokens)
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withGrantTokens
```
public DecryptRequest withGrantTokens(java.util.Collection<java.lang.String> grantTokens)
```
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    grantTokens -
    A list of grant tokens.
    
    For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getKeyId
```
public java.lang.String getKeyId()
```
    Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK 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 CMK that you intend.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    
    Constraints:
    Length: 1 - 2048
    Returns:
    Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK 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 CMK that you intend.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
  - setKeyId
```
public void setKeyId(java.lang.String keyId)
```
    Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK 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 CMK that you intend.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    
    Constraints:
    Length: 1 - 2048
    Parameters:
    keyId -
    Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK 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 CMK that you intend.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
  - withKeyId
```
public DecryptRequest withKeyId(java.lang.String keyId)
```
    Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK 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 CMK that you intend.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Parameters:
    keyId -
    Specifies the customer master key (CMK) that AWS KMS uses to decrypt the ciphertext. Enter a key ID of the CMK that was used to encrypt the ciphertext.
    
    This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. If you used a symmetric CMK, AWS KMS can get the CMK 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 CMK that you intend.
    
    To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEncryptionAlgorithm
```
public java.lang.String getEncryptionAlgorithm()
```
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    Constraints:
    Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
    
    Returns:
    
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - setEncryptionAlgorithm
```
public void setEncryptionAlgorithm(java.lang.String encryptionAlgorithm)
```
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    Constraints:
    Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
    
    Parameters:
    
    encryptionAlgorithm -
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - withEncryptionAlgorithm
```
public DecryptRequest withEncryptionAlgorithm(java.lang.String encryptionAlgorithm)
```
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
    
    Parameters:
    
    encryptionAlgorithm -
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - setEncryptionAlgorithm
```
public void setEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)
```
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    Constraints:
    Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
    
    Parameters:
    
    encryptionAlgorithm -
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - withEncryptionAlgorithm
```
public DecryptRequest withEncryptionAlgorithm(EncryptionAlgorithmSpec encryptionAlgorithm)
```
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SYMMETRIC_DEFAULT, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256
    
    Parameters:
    
    encryptionAlgorithm -
    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 CMK. The default value, SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    EncryptionAlgorithmSpec
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DecryptRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DecryptRequest

Method Detail

getCiphertextBlob

setCiphertextBlob

withCiphertextBlob

getEncryptionContext

setEncryptionContext

withEncryptionContext

addEncryptionContextEntry

clearEncryptionContextEntries

getGrantTokens

setGrantTokens

withGrantTokens

withGrantTokens

getKeyId

setKeyId

withKeyId

getEncryptionAlgorithm

setEncryptionAlgorithm

withEncryptionAlgorithm

setEncryptionAlgorithm

withEncryptionAlgorithm

toString

hashCode

equals