String aliasName
String that contains the alias. This value begins with alias/.
String aliasArn
String that contains the key ARN.
String targetKeyId
String that contains the key identifier of the KMS key associated with the alias.
Date creationDate
Date and time that the alias was most recently created in the account and Region. Formatted as Unix time.
Date lastUpdatedDate
Date and time that the alias was most recently associated with a KMS key in the account and Region. Formatted as Unix time.
String keyId
Identifies the KMS key whose deletion is being canceled.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String customKeyStoreId
Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
String aliasName
Specifies the alias name. This value must begin with alias/ followed by a name, such as
alias/ExampleAlias.
The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters,
forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/.
The alias/aws/ prefix is reserved for Amazon Web Services
managed keys.
String targetKeyId
Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.
A valid key ID is required. If you supply a null or empty string value, this operation returns an error.
For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String customKeyStoreName
Specifies a friendly name for the custom key store. The name must be unique in your Amazon Web Services account.
String cloudHsmClusterId
Identifies the CloudHSM cluster for the custom key store. Enter the cluster ID of any active CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.
String trustAnchorCertificate
Enter the content of the trust anchor certificate for the cluster. This is the content of the
customerCA.crt file that you created when you initialized the cluster.
String keyStorePassword
Enter the password of the
kmsuser crypto user (CU) account in the specified CloudHSM cluster. KMS logs into the cluster as
this user to manage key material on your behalf.
The password must be a string of 7 to 32 characters. Its value is case sensitive.
This parameter tells KMS the kmsuser account password; it does not change the password in the
CloudHSM cluster.
String customKeyStoreId
A unique identifier for the new custom key store.
String keyId
Identifies the KMS key for the grant. The grant gives principals permission to use this KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key 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
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String granteePrincipal
The identity that gets the permissions specified in the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
String retiringPrincipal
The principal that has permission to use the RetireGrant operation to retire the grant.
To specify the principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
The grant determines the retiring principal. Other principals might have permission to retire the grant or revoke the grant. For details, see RevokeGrant and Retiring and revoking grants in the Key Management Service Developer Guide.
SdkInternalList<T> operations
A list of operations that the grant permits.
The operation must be supported on the KMS key. For example, you cannot create a grant for a symmetric KMS key
that allows the Sign operation, or a grant for an asymmetric KMS key that allows the
GenerateDataKey operation. If you try, KMS returns a ValidationError exception. For details,
see Grant
operations in the Key Management Service Developer Guide.
GrantConstraints constraints
Specifies a grant constraint.
KMS supports the EncryptionContextEquals and EncryptionContextSubset grant constraints.
Each constraint value can include up to 8 encryption context pairs. The encryption context value in each
constraint cannot exceed 384 characters.
These grant constraints allow the permissions in the grant only when the encryption context in the request
matches (EncryptionContextEquals) or includes (EncryptionContextSubset) the encryption
context specified in this structure. For information about grant constraints, see Using
grant constraints in the Key Management Service Developer Guide. For more information about encryption
context, see Encryption Context
in the Key Management Service Developer Guide .
The encryption context grant constraints are supported only on operations that include an encryption context. You cannot use an encryption context grant constraint for cryptographic operations with asymmetric KMS keys or for management operations, such as DescribeKey or RetireGrant.
SdkInternalList<T> grantTokens
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.
String name
A friendly name for the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.
When this value is absent, all CreateGrant requests result in a new grant with a unique
GrantId even if all the supplied parameters are identical. This can result in unintended duplicates
when you retry the CreateGrant request.
When this value is present, you can retry a CreateGrant request with identical parameters; if the
grant already exists, the original GrantId is returned without creating a new grant. Note that the
returned grant token is unique with every CreateGrant request, even when a duplicate
GrantId is returned. All grant tokens for the same grant ID can be used interchangeably.
String grantToken
The grant token.
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.
String grantId
The unique identifier for the grant.
You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.
String policy
The key policy to attach to the KMS key.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal
that is making the CreateKey request to make a subsequent PutKeyPolicy request on the KMS
key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in
the Default Key Policy section of the Key Management Service Developer Guide .
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see Default Key Policy in the Key Management Service Developer Guide.
The key policy size quota is 32 kilobytes (32768 bytes).
For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
String description
A description of the KMS key.
Use a description that helps you decide whether the KMS key is appropriate for a task. The default value is an empty string (no description).
To set or change the description after the key is created, use UpdateKeyDescription.
String keyUsage
Determines the cryptographic
operations for which you can use the KMS key. The default value is ENCRYPT_DECRYPT. This
parameter is required only for asymmetric KMS keys. You can't change the KeyUsage value after the
KMS key is created.
Select only one valid value.
For symmetric KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.
For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.
String customerMasterKeySpec
Instead, use the KeySpec parameter.
The KeySpec and CustomerMasterKeySpec parameters work the same way. Only the names
differ. We recommend that you use KeySpec parameter in your code. However, to avoid breaking
changes, KMS will support both parameters.
String keySpec
Specifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT, creates a KMS key
with a 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your KMS key, see How to Choose Your KMS key
Configuration in the Key Management Service Developer Guide .
The KeySpec determines whether the KMS key contains a symmetric key or an asymmetric key pair. It
also determines the encryption algorithms or signing algorithms that the KMS key supports. You can't change the
KeySpec after the KMS key is created. To further restrict the algorithms that can be used with the
KMS key, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the Key Management Service Developer Guide .
Amazon Web Services services that are integrated with KMS use symmetric KMS keys to protect your data. These services do not support asymmetric KMS keys. For help determining whether a KMS key is symmetric or asymmetric, see Identifying Symmetric and Asymmetric KMS keys in the Key Management Service Developer Guide.
KMS supports the following key specs for KMS keys:
Symmetric key (default)
SYMMETRIC_DEFAULT (AES-256-GCM)
Asymmetric RSA key pairs
RSA_2048
RSA_3072
RSA_4096
Asymmetric NIST-recommended elliptic curve key pairs
ECC_NIST_P256 (secp256r1)
ECC_NIST_P384 (secp384r1)
ECC_NIST_P521 (secp521r1)
Other asymmetric elliptic curve key pairs
ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
String origin
The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The
default is AWS_KMS, which means that KMS creates the key material.
To create a KMS key with no key material (for imported key material), set the value to EXTERNAL. For
more information about importing key material into KMS, see Importing Key Material in
the Key Management Service Developer Guide. This value is valid only for symmetric KMS keys.
To create a KMS key in an KMS custom key store
and create its key material in the associated CloudHSM cluster, set this value to AWS_CLOUDHSM. You
must also use the CustomKeyStoreId parameter to identify the custom key store. This value is valid
only for symmetric KMS keys.
String customKeyStoreId
Creates the KMS key in the specified custom key store
and the key material in its associated CloudHSM cluster. To create a KMS key in a custom key store, you must also
specify the Origin parameter with a value of AWS_CLOUDHSM. The CloudHSM cluster that is
associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in
the Region.
This parameter is valid only for symmetric KMS keys and regional KMS keys. You cannot create an asymmetric KMS key or a multi-Region key in a custom key store.
To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
The response includes the custom key store ID and the ID of the CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in KMS, which combines the convenience and extensive integration of KMS with the isolation and control of a single-tenant key store.
Boolean bypassPolicyLockoutSafetyCheck
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide .
Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
SdkInternalList<T> tags
Assigns one or more tags to the KMS key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
Boolean multiRegion
Creates a multi-Region primary key that you can replicate into other Amazon Web Services Regions. You cannot change this value after you create the KMS key.
For a multi-Region key, set this parameter to True. For a single-Region KMS key, omit this parameter
or set it to False. The default value is False.
This operation supports multi-Region keys, an KMS feature that lets you create multiple interoperable KMS keys in different Amazon Web Services Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them interchangeably to encrypt data in one Amazon Web Services Region and decrypt it in a different Amazon Web Services Region without re-encrypting the data or making a cross-Region call. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
This value creates a primary key, not a replica. To create a replica key, use the ReplicateKey operation.
You can create a symmetric or asymmetric multi-Region key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store.
KeyMetadata keyMetadata
Metadata associated with the KMS key.
String customKeyStoreId
A unique identifier for the custom key store.
String customKeyStoreName
The user-specified friendly name for the custom key store.
String cloudHsmClusterId
A unique identifier for the CloudHSM cluster that is associated with the custom key store.
String trustAnchorCertificate
The trust anchor certificate of the associated CloudHSM cluster. When you initialize the
cluster, you create this certificate and save it in the customerCA.crt file.
String connectionState
Indicates whether the custom key store is connected to its CloudHSM cluster.
You can create and use KMS keys in your custom key stores only when its connection state is
CONNECTED.
The value is DISCONNECTED if the key store has never been connected or you use the
DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are
having trouble using the custom key store, make sure that its associated CloudHSM cluster is active and contains
at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. The
ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a
connection failure, see Troubleshooting a Custom Key
Store in the Key Management Service Developer Guide.
String connectionErrorCode
Describes the connection error. This field appears in the response only when the ConnectionState is
FAILED. For help resolving these errors, see How to Fix a
Connection Failure in Key Management Service Developer Guide.
Valid values are:
CLUSTER_NOT_FOUND - KMS cannot find the CloudHSM cluster with the specified cluster ID.
INSUFFICIENT_CLOUDHSM_HSMS - The associated CloudHSM cluster does not contain any active HSMs. To
connect a custom key store to its CloudHSM cluster, the cluster must contain at least one active HSM.
INTERNAL_ERROR - KMS could not complete the request due to an internal error. Retry the request. For
ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
INVALID_CREDENTIALS - KMS does not have the correct password for the kmsuser crypto
user in the CloudHSM cluster. Before you can connect your custom key store to its CloudHSM cluster, you must
change the kmsuser account password and update the key store password value for the custom key
store.
NETWORK_ERRORS - Network errors are preventing KMS from connecting to the custom key store.
SUBNET_NOT_FOUND - A subnet in the CloudHSM cluster configuration was deleted. If KMS cannot find
all of the subnets in the cluster configuration, attempts to connect the custom key store to the CloudHSM cluster
fail. To fix this error, create a cluster from a recent backup and associate it with your custom key store. (This
process creates a new cluster configuration with a VPC and private subnets.) For details, see How to Fix a
Connection Failure in the Key Management Service Developer Guide.
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated CloudHSM
cluster due to too many failed password attempts. Before you can connect your custom key store to its CloudHSM
cluster, you must change the kmsuser account password and update the key store password value for
the custom key store.
USER_LOGGED_IN - The kmsuser CU account is logged into the the associated CloudHSM
cluster. This prevents KMS from rotating the kmsuser account password and logging into the cluster.
Before you can connect your custom key store to its CloudHSM cluster, you must log the kmsuser CU
out of the cluster. If you changed the kmsuser password to log into the cluster, you must also and
update the key store password value for the custom key store. For help, see How to Log Out and
Reconnect in the Key Management Service Developer Guide.
USER_NOT_FOUND - KMS cannot find a kmsuser CU account in the associated CloudHSM
cluster. Before you can connect your custom key store to its CloudHSM cluster, you must create a
kmsuser CU account in the cluster, and then update the key store password value for the custom key
store.
Date creationDate
The date and time when the custom key store was created.
ByteBuffer ciphertextBlob
Ciphertext to be decrypted. The blob includes metadata.
SdkInternalMap<K,V> encryptionContext
Specifies the encryption context to use when decrypting the data. An encryption context is valid only for cryptographic operations 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 in the Key Management Service Developer Guide.
SdkInternalList<T> grantTokens
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.
String keyId
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.
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 KMS key. The default value,
SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric KMS keys.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that was used to decrypt the ciphertext.
ByteBuffer plaintext
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.
String encryptionAlgorithm
The encryption algorithm that was used to decrypt the ciphertext.
String aliasName
The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as
alias/ExampleAlias.
String customKeyStoreId
Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
String keyId
Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key
must be EXTERNAL.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String customKeyStoreId
Gets only information about the specified custom key store. Enter the key store ID.
By default, this operation gets information about all custom key stores in the account and Region. To limit the
output to a particular custom key store, you can use either the CustomKeyStoreId or
CustomKeyStoreName parameter, but not both.
String customKeyStoreName
Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
By default, this operation gets information about all custom key stores in the account and Region. To limit the
output to a particular custom key store, you can use either the CustomKeyStoreId or
CustomKeyStoreName parameter, but not both.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
String marker
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker from the truncated response you just received.
SdkInternalList<T> customKeyStores
Contains metadata about each custom key store.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
A flag that indicates whether there are more items in the list. When this value is true, the list in this
response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
to the Marker parameter in a subsequent request.
String keyId
Describes the specified KMS key.
If you specify a predefined Amazon Web Services alias (an Amazon Web Services alias with no key ID), KMS
associates the alias with an Amazon Web Services
managed key and returns its KeyId and Arn in the response.
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.
SdkInternalList<T> grantTokens
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.
KeyMetadata keyMetadata
Metadata associated with the key.
String keyId
Identifies the KMS key to disable.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String keyId
Identifies a symmetric KMS key. You cannot enable or disable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String customKeyStoreId
Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
String keyId
Identifies the KMS key to enable.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String keyId
Identifies a symmetric KMS key. You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String keyId
Identifies the KMS key to use in the encryption operation.
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.
ByteBuffer plaintext
Data to be encrypted.
SdkInternalMap<K,V> encryptionContext
Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for cryptographic operations 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 in the Key Management Service Developer Guide.
SdkInternalList<T> grantTokens
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.
String encryptionAlgorithm
Specifies the encryption algorithm that KMS will use to encrypt the plaintext message. The algorithm must be compatible with the KMS key that you specify.
This parameter is required only for asymmetric KMS keys. The default value, SYMMETRIC_DEFAULT, is
the algorithm used for symmetric KMS keys. If you are using an asymmetric KMS key, we recommend
RSAES_OAEP_SHA_256.
ByteBuffer ciphertextBlob
The encrypted plaintext. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that was used to encrypt the plaintext.
String encryptionAlgorithm
The encryption algorithm that was used to encrypt the plaintext.
SdkInternalMap<K,V> encryptionContext
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
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 in the Key Management Service Developer Guide.
String keyId
Specifies the symmetric KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
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.
String keyPairSpec
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.
SdkInternalList<T> grantTokens
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.
ByteBuffer privateKeyCiphertextBlob
The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
ByteBuffer privateKeyPlaintext
The plaintext copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
ByteBuffer publicKey
The public key (in plaintext).
String keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
String keyPairSpec
The type of data key pair that was generated.
SdkInternalMap<K,V> encryptionContext
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
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 in the Key Management Service Developer Guide.
String keyId
Specifies the KMS key that encrypts the private key in the data key pair. You must specify a symmetric KMS key. You cannot use an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.
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.
String keyPairSpec
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.
SdkInternalList<T> grantTokens
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.
ByteBuffer privateKeyCiphertextBlob
The encrypted copy of the private key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
ByteBuffer publicKey
The public key (in plaintext).
String keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the private key.
String keyPairSpec
The type of data key pair that was generated.
String keyId
Identifies the symmetric KMS key that encrypts the data key.
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.
SdkInternalMap<K,V> encryptionContext
Specifies the encryption context that will be used when encrypting the data key.
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 in the Key Management Service Developer Guide.
Integer numberOfBytes
Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64
bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec
parameter.
You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in
every GenerateDataKey request.
String keySpec
Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or
AES_256 to generate a 256-bit symmetric key.
You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in
every GenerateDataKey request.
SdkInternalList<T> grantTokens
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.
ByteBuffer ciphertextBlob
The encrypted copy of the data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
ByteBuffer plaintext
The plaintext data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
String keyId
The identifier of the symmetric KMS key that encrypts the data key.
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.
SdkInternalMap<K,V> encryptionContext
Specifies the encryption context that will be used when encrypting the data key.
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 in the Key Management Service Developer Guide.
String keySpec
The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256
to generate a 256-bit symmetric key.
Integer numberOfBytes
The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is
512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the
KeySpec field instead of this one.
SdkInternalList<T> grantTokens
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.
ByteBuffer ciphertextBlob
The encrypted data key. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that encrypted the data key.
Integer numberOfBytes
The length of the byte string.
String customKeyStoreId
Generates the random byte string in the CloudHSM cluster that is associated with the specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
ByteBuffer plaintext
The random byte string. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String keyId
Gets the key policy for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String policyName
Specifies the name of the key policy. The only valid name is default. To get the names of key
policies, use ListKeyPolicies.
String policy
A key policy document in JSON format.
String keyId
Gets the rotation status for the specified KMS key.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key 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
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Boolean keyRotationEnabled
A Boolean value that specifies whether key rotation is enabled.
String keyId
The identifier of the symmetric KMS key into which you will import key material. The Origin of the
KMS key must be EXTERNAL.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String wrappingAlgorithm
The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the Key Management Service Developer Guide.
String wrappingKeySpec
The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
String keyId
The Amazon Resource Name (key ARN) of the KMS
key to use in a subsequent ImportKeyMaterial request. This is the same KMS key specified in the
GetParametersForImport request.
ByteBuffer importToken
The import token to send in a subsequent ImportKeyMaterial request.
ByteBuffer publicKey
The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
Date parametersValidTo
The time at which the import token and public key are no longer valid. After this time, you cannot use them to
make an ImportKeyMaterial request and you must send another GetParametersForImport request to
get new ones.
String keyId
Identifies the asymmetric KMS key that includes the public key.
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.
SdkInternalList<T> grantTokens
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.
String keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key from which the public key was downloaded.
ByteBuffer publicKey
The exported public key.
The value is a DER-encoded X.509 public key, also known as SubjectPublicKeyInfo (SPKI), as defined
in RFC 5280. When you use the HTTP API or the Amazon Web
Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String customerMasterKeySpec
Instead, use the KeySpec field in the GetPublicKey response.
The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you
use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both
fields.
String keySpec
The type of the of the public key that was downloaded.
String keyUsage
The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.
This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of
KMS, the ciphertext cannot be decrypted.
SdkInternalList<T> encryptionAlgorithms
The encryption algorithms that KMS supports for this key.
This information is critical. If a public key encrypts data outside of KMS by using an unsupported encryption algorithm, the ciphertext cannot be decrypted.
This field appears in the response only when the KeyUsage of the public key is
ENCRYPT_DECRYPT.
SdkInternalList<T> signingAlgorithms
The signing algorithms that KMS supports for this key.
This field appears in the response only when the KeyUsage of the public key is
SIGN_VERIFY.
SdkInternalMap<K,V> encryptionContextSubset
A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.
SdkInternalMap<K,V> encryptionContextEquals
A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.
String keyId
The unique identifier for the KMS key to which the grant applies.
String grantId
The unique identifier for the grant.
String name
The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.
Date creationDate
The date and time when the grant was created.
String granteePrincipal
The identity that gets the permissions in the grant.
The GranteePrincipal field in the ListGrants response usually contains the user or role
designated as the grantee principal in the grant. However, when the grantee principal in the grant is an Amazon
Web Services service, the GranteePrincipal field contains the service principal, which might represent several different grantee principals.
String retiringPrincipal
The principal that can retire the grant.
String issuingAccount
The Amazon Web Services account under which the grant was issued.
SdkInternalList<T> operations
The list of operations permitted by the grant.
GrantConstraints constraints
A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
String keyId
The identifier of the symmetric KMS key that receives the imported key material. The KMS key's
Origin must be EXTERNAL. This must be the same KMS key specified in the
KeyID parameter of the corresponding GetParametersForImport request.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
ByteBuffer importToken
The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.
ByteBuffer encryptedKeyMaterial
The encrypted key material to import. The key material must be encrypted with the public wrapping key that
GetParametersForImport returned, using the wrapping algorithm that you specified in the same
GetParametersForImport request.
Date validTo
The time at which the imported key material expires. When the key material expires, KMS deletes the key material
and the KMS key becomes unusable. You must omit this parameter when the ExpirationModel parameter is
set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.
String expirationModel
Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you
must include the ValidTo parameter. When this parameter is set to
KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.
String aWSAccountId
The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
String keyId
The globally unique identifier for the KMS key.
String arn
The Amazon Resource Name (ARN) of the KMS key. For examples, see Key Management Service (KMS) in the Example ARNs section of the Amazon Web Services General Reference.
Date creationDate
The date and time when the KMS key was created.
Boolean enabled
Specifies whether the KMS key is enabled. When KeyState is Enabled this value is true,
otherwise it is false.
String description
The description of the KMS key.
String keyUsage
The cryptographic operations for which you can use the KMS key.
String keyState
The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.
Date deletionDate
The date and time after which KMS deletes this KMS key. This value is present only when the KMS key is scheduled
for deletion, that is, when its KeyState is PendingDeletion.
When the primary key in a multi-Region key is scheduled for deletion but still has replica keys, its key state is
PendingReplicaDeletion and the length of its waiting period is displayed in the
PendingDeletionWindowInDays field.
Date validTo
The time at which the imported key material expires. When the key material expires, KMS deletes the key material
and the KMS key becomes unusable. This value is present only for KMS keys whose Origin is
EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this
value is omitted.
String origin
The source of the key material for the KMS key. When this value is AWS_KMS, KMS created the key
material. When this value is EXTERNAL, the key material was imported or the KMS key doesn't have any
key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster
associated with a custom key store.
String customKeyStoreId
A unique identifier for the custom key store that contains the KMS key. This value is present only when the KMS key is created in a custom key store.
String cloudHsmClusterId
The cluster ID of the CloudHSM cluster that contains the key material for the KMS key. When you create a KMS key in a custom key store, KMS creates the key material for the KMS key in the associated CloudHSM cluster. This value is present only when the KMS key is created in a custom key store.
String expirationModel
Specifies whether the KMS key's key material expires. This value is present only when Origin is
EXTERNAL, otherwise this value is omitted.
String keyManager
The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed. For more information about the difference, see KMS keys in the Key Management Service Developer Guide.
String customerMasterKeySpec
Instead, use the KeySpec field.
The KeySpec and CustomerMasterKeySpec fields have the same value. We recommend that you
use the KeySpec field in your code. However, to avoid breaking changes, KMS will support both
fields.
String keySpec
Describes the type of key material in the KMS key.
SdkInternalList<T> encryptionAlgorithms
The encryption algorithms that the KMS key supports. You cannot use the KMS key with other encryption algorithms within KMS.
This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.
SdkInternalList<T> signingAlgorithms
The signing algorithms that the KMS key supports. You cannot use the KMS key with other signing algorithms within KMS.
This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.
Boolean multiRegion
Indicates whether the KMS key is a multi-Region (True) or regional (False) key. This
value is True for multi-Region primary and replica keys and False for regional KMS
keys.
For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.
MultiRegionConfiguration multiRegionConfiguration
Lists the primary and replica keys in same multi-Region key. This field is present only when the value of the
MultiRegion field is True.
For more information about any listed KMS key, use the DescribeKey operation.
MultiRegionKeyType indicates whether the KMS key is a PRIMARY or REPLICA
key.
PrimaryKey displays the key ARN and Region of the primary key. This field displays the current KMS
key if it is the primary key.
ReplicaKeys displays the key ARNs and Regions of all replica keys. This field includes the current
KMS key if it is a replica key.
Integer pendingDeletionWindowInDays
The waiting period before the primary key in a multi-Region key is deleted. This waiting period begins when the
last of its replica keys is deleted. This value is present only when the KeyState of the KMS key is
PendingReplicaDeletion. That indicates that the KMS key is the primary key in a multi-Region key, it
is scheduled for deletion, and it still has existing replica keys.
When a single-Region KMS key or a multi-Region replica key is scheduled for deletion, its deletion date is
displayed in the DeletionDate field. However, when the primary key in a multi-Region key is
scheduled for deletion, its waiting period doesn't begin until all of its replica keys are deleted. This value
displays that waiting period. When the last replica key in the multi-Region key is deleted, the
KeyState of the scheduled primary key changes from PendingReplicaDeletion to
PendingDeletion and the deletion date appears in the DeletionDate field.
String keyId
Lists only aliases that are associated with the specified KMS key. Enter a KMS key in your Amazon Web Services account.
This parameter is optional. If you omit it, ListAliases returns all aliases in the account and
Region.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
String marker
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker from the truncated response you just received.
SdkInternalList<T> aliases
A list of aliases.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
A flag that indicates whether there are more items in the list. When this value is true, the list in this
response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
to the Marker parameter in a subsequent request.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
String marker
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker from the truncated response you just received.
String keyId
Returns only grants for the specified KMS key. This parameter is required.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key 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
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String grantId
Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
String granteePrincipal
Returns only grants where the specified principal is the grantee principal for the grant.
SdkInternalList<T> grants
A list of grants.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
A flag that indicates whether there are more items in the list. When this value is true, the list in this
response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
to the Marker parameter in a subsequent request.
String keyId
Gets the names of key policies for the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
Only one policy can be attached to a key.
String marker
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker from the truncated response you just received.
SdkInternalList<T> policyNames
A list of key policy names. The only valid value is default.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
A flag that indicates whether there are more items in the list. When this value is true, the list in this
response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
to the Marker parameter in a subsequent request.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.
String marker
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker from the truncated response you just received.
SdkInternalList<T> keys
A list of KMS keys.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
A flag that indicates whether there are more items in the list. When this value is true, the list in this
response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
to the Marker parameter in a subsequent request.
String keyId
Gets tags on the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.
String marker
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker from the truncated response you just received.
Do not attempt to construct this value. Use only the value of NextMarker from the truncated response
you just received.
SdkInternalList<T> tags
A list of tags. Each tag consists of a tag key and a tag value.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Do not assume or infer any information from this value.
Boolean truncated
A flag that indicates whether there are more items in the list. When this value is true, the list in this
response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
to the Marker parameter in a subsequent request.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.
This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.
String marker
Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
value of NextMarker from the truncated response you just received.
String retiringPrincipal
The retiring principal for which to list grants. Enter a principal in your Amazon Web Services account.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an Amazon Web Services principal. Valid Amazon Web Services principals include Amazon Web Services accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see Amazon Web Services Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.
SdkInternalList<T> grants
A list of grants.
String nextMarker
When Truncated is true, this element is present and contains the value to use for the
Marker parameter in a subsequent request.
Boolean truncated
A flag that indicates whether there are more items in the list. When this value is true, the list in this
response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
to the Marker parameter in a subsequent request.
String multiRegionKeyType
Indicates whether the KMS key is a PRIMARY or REPLICA key.
MultiRegionKey primaryKey
Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.
SdkInternalList<T> replicaKeys
displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.
String keyId
Sets the key policy on the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String policyName
The name of the key policy. The only valid value is default.
String policy
The key policy to attach to the KMS key.
The key policy must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal
that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on
the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the
scenario in the Default Key Policy section of the Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the Key Management Service Developer Guide.
Boolean bypassPolicyLockoutSafetyCheck
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a
subsequent PutKeyPolicy request on the KMS key.
The default value is false.
ByteBuffer ciphertextBlob
Ciphertext of the data to reencrypt.
SdkInternalMap<K,V> sourceEncryptionContext
Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was used to encrypt the ciphertext.
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 in the Key Management Service Developer Guide.
String sourceKeyId
Specifies the KMS key that KMS will use to decrypt the ciphertext before it is re-encrypted. 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.
String destinationKeyId
A unique identifier for the KMS key that is used to reencrypt the data. Specify a symmetric or asymmetric KMS key
with a KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a
KMS key, use the DescribeKey operation.
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.
SdkInternalMap<K,V> destinationEncryptionContext
Specifies that encryption context to use when the reencrypting the data.
A destination encryption context is valid only when the destination KMS key is a symmetric KMS key. The standard ciphertext format for asymmetric KMS keys does not include fields for metadata.
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 in the Key Management Service Developer Guide.
String sourceEncryptionAlgorithm
Specifies the encryption algorithm that KMS will use to decrypt the ciphertext before it is reencrypted. The
default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric KMS keys.
Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the decrypt attempt fails.
This parameter is required only when the ciphertext was encrypted under an asymmetric KMS key.
String destinationEncryptionAlgorithm
Specifies the encryption algorithm that KMS will use to reecrypt the data after it has decrypted it. The default
value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric KMS keys.
This parameter is required only when the destination KMS key is an asymmetric KMS key.
SdkInternalList<T> grantTokens
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.
ByteBuffer ciphertextBlob
The reencrypted data. When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String sourceKeyId
Unique identifier of the KMS key used to originally encrypt the data.
String keyId
The Amazon Resource Name (key ARN) of the KMS key that was used to reencrypt the data.
String sourceEncryptionAlgorithm
The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.
String destinationEncryptionAlgorithm
The encryption algorithm that was used to reencrypt the data.
String keyId
Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a
multi-Region primary key, use the DescribeKey operation to check the value of the
MultiRegionKeyType property.
Specify the key ID or key ARN of a multi-Region primary key.
For example:
Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String replicaRegion
The Region ID of the Amazon Web Services Region for this replica key.
Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web
Services Regions in which KMS is supported, see KMS service endpoints in the
Amazon Web Services General Reference.
The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region.
For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.
String policy
The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
If you provide a key policy, it must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller
kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes
unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
The key policy size quota is 32 kilobytes (32768 bytes).
Boolean bypassPolicyLockoutSafetyCheck
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a
subsequent PutKeyPolicy request on the KMS key.
The default value is false.
String description
A description of the KMS key. The default value is an empty string (no description).
The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.
SdkInternalList<T> tags
Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
To use this parameter, you must have kms:TagResource permission in an IAM policy.
Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
KeyMetadata replicaKeyMetadata
String replicaPolicy
The key policy of the new replica key. The value is a key policy document in JSON format.
SdkInternalList<T> replicaTags
The tags on the new replica key. The value is a list of tag key and tag value pairs.
String grantToken
Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved eventual consistency.
Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual consistency in the Key Management Service Developer Guide.
String keyId
The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.
For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
String grantId
Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
String keyId
A unique identifier for the KMS key associated with the grant. To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services account, you must use the key 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
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String grantId
Identifies the grant to revoke. To get the grant ID, use CreateGrant, ListGrants, or ListRetirableGrants.
String keyId
The unique identifier of the KMS key to delete.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
Integer pendingWindowInDays
The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
String keyId
The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.
Date deletionDate
The date and time after which KMS deletes the KMS key.
If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.
String keyState
The current status of the KMS key.
For more information about how key state affects the use of a KMS key, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.
Integer pendingWindowInDays
The waiting period before the KMS key is deleted.
If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.
String keyId
Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The
KeyUsage type of the KMS key must be SIGN_VERIFY. To find the KeyUsage of
a KMS key, use the DescribeKey operation.
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.
ByteBuffer message
Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide the message digest.
If you provide a message, KMS generates a hash digest of the message and then signs it.
String messageType
Tells KMS whether the value of the Message parameter is a message or message digest. The default
value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
SdkInternalList<T> grantTokens
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.
String signingAlgorithm
Specifies the signing algorithm to use when signing the message.
Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
String keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to sign the message.
ByteBuffer signature
The cryptographic signature that was generated for the message.
When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing
algorithms, this value is a DER-encoded object as defined by ANS X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly
used signature format and is appropriate for most uses.
When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not Base64-encoded.
String signingAlgorithm
The signing algorithm that was used to sign the message.
String keyId
Identifies a customer managed key in the account and Region.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
SdkInternalList<T> tags
One or more tags.
Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.
You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
String keyId
Identifies the KMS key from which you are removing tags.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
SdkInternalList<T> tagKeys
One or more tag keys. Specify only the tag keys, not the tag values.
String aliasName
Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the
alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.
String targetKeyId
Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.
The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric) and they must have the same key usage.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct KMS key, use ListAliases.
String customKeyStoreId
Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
String newCustomKeyStoreName
Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the Amazon Web Services account.
String keyStorePassword
Enter the current password of the kmsuser crypto user (CU) in the CloudHSM cluster that is
associated with the custom key store.
This parameter tells KMS the current password of the kmsuser crypto user (CU). It does not set or
change the password of any users in the CloudHSM cluster.
String cloudHsmClusterId
Associates the custom key store with a related CloudHSM cluster.
Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.
String keyId
Updates the description of the specified KMS key.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String description
New description for the KMS key.
String keyId
Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
Specify the key ID or key ARN of a multi-Region primary key.
For example:
Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
String primaryRegion
The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or
ap-southeast-2. There must be an existing replica key in this Region.
When the operation completes, the multi-Region key in this Region will be the primary key.
String keyId
Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.
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.
ByteBuffer message
Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the
message. If you submit a digest, use the MessageType parameter with a value of DIGEST.
If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.
String messageType
Tells KMS whether the value of the Message parameter is a message or message digest. The default
value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
Use the DIGEST value only when the value of the Message parameter is a message digest.
If you use the DIGEST value with a raw message, the security of the verification operation can be
compromised.
ByteBuffer signature
The signature that the Sign operation generated.
String signingAlgorithm
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
SdkInternalList<T> grantTokens
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.
String keyId
The Amazon Resource Name (key ARN) of the asymmetric KMS key that was used to verify the signature.
Boolean signatureValid
A Boolean value that indicates whether the signature was verified. A value of True indicates that
the Signature was produced by signing the Message with the specified KeyID
and SigningAlgorithm. If the signature is not verified, the Verify operation fails with
a KMSInvalidSignatureException exception.
String signingAlgorithm
The signing algorithm that was used to verify the signature.
Copyright © 2021. All rights reserved.