String keyId
The unique identifier for the customer master key (CMK) for which to cancel deletion.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
String keyId
The unique identifier of the master key for which deletion is canceled.
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
String that contains the display name. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
String targetKeyId
Identifies the CMK for which you are creating the alias. This value cannot be an alias.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
String customKeyStoreName
Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
String cloudHsmClusterId
Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS 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 AWS CloudHSM cluster. AWS KMS logs into the
cluster as this user to manage key material on your behalf.
This parameter tells AWS KMS the kmsuser account password; it does not change the password in the
AWS CloudHSM cluster.
String customKeyStoreId
A unique identifier for the new custom key store.
String keyId
The unique identifier for the customer master key (CMK) that the grant applies to.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey.
String granteePrincipal
The principal that is given permission to perform the operations that the grant permits.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS 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 AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
String retiringPrincipal
The principal that is given permission to retire the grant by using RetireGrant operation.
To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.
SdkInternalList<T> operations
A list of operations that the grant permits.
GrantConstraints constraints
A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.
SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
String name
A friendly name for identifying the grant. Use this value to prevent 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 obtained in this way can be used interchangeably.
String grantToken
The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
String grantId
The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
String policy
The key policy to attach to the CMK.
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 CMK.
This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS 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 AWS KMS. When you create a new AWS 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.
The key policy size limit is 32 kilobytes (32768 bytes).
String description
A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
String keyUsage
The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
String origin
The source of the CMK's key material. You cannot change the origin after you create the CMK.
The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.
When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can
import key material from your existing key management infrastructure. For more information about importing key
material into AWS KMS, see Importing Key Material in the
AWS Key Management Service Developer Guide.
When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in a AWS KMS custom key store and
creates its key material in the associated AWS CloudHSM cluster. You must also use the
CustomKeyStoreId parameter to identify the custom key store.
String customKeyStoreId
Creates the CMK in the specified custom key store and the
key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify
the Origin parameter with a value of AWS_CLOUDHSM. The AWS 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.
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 AWS CloudHSM cluster.
This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS 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 CMK 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 AWS 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 CMK.
The default value is false.
SdkInternalList<T> tags
One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.
KeyMetadata keyMetadata
Metadata associated with the CMK.
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 AWS CloudHSM cluster that is associated with the custom key store.
String trustAnchorCertificate
The trust anchor certificate of the associated AWS 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 AWS CloudHSM cluster.
You can create and use CMKs 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 AWS CloudHSM cluster is active and
contains at least one active HSM.
A value of FAILED indicates that an attempt to connect was unsuccessful. For help resolving a
connection failure, see Troubleshooting a Custom Key
Store in the AWS Key Management Service Developer Guide.
String connectionErrorCode
Describes the connection error. Valid values are:
CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs.
To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto
user in the AWS CloudHSM cluster.
NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM
cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS
CloudHSM cluster, you must change the kmsuser account password and update the password value for the
custom key store.
For help with connection failures, see Troubleshooting Custom Key Stores in the AWS Key Management Service Developer Guide.
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
The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.
SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
String keyId
ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
ByteBuffer plaintext
Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encdoded. Otherwise, it is not encoded.
String aliasName
The alias to be deleted. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
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
The identifier of the CMK whose key material to delete. The CMK's Origin must be
EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, 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, AWS 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 this response
to the Marker parameter in a subsequent request.
String keyId
Describes the specified customer master key (CMK).
If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and
returns its KeyId and Arn in the response.
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.
SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
KeyMetadata keyMetadata
Metadata associated with the key.
String keyId
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
String keyId
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, 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
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
String keyId
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
String keyId
A unique identifier for the customer master key (CMK).
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.
ByteBuffer plaintext
Data to be encrypted.
SdkInternalMap<K,V> encryptionContext
Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the
same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.
SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
ByteBuffer ciphertextBlob
The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encdoded. Otherwise, it is not encoded.
String keyId
The ID of the key used during encryption.
String keyId
The identifier of the CMK under which to generate and encrypt the data encryption key.
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.
SdkInternalMap<K,V> encryptionContext
A set of key-value pairs that represents additional authenticated data.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
Integer numberOfBytes
The length of the data encryption 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.
String keySpec
The length of the data encryption key. Use AES_128 to generate a 128-bit symmetric key, or
AES_256 to generate a 256-bit symmetric key.
SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
ByteBuffer ciphertextBlob
The encrypted data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encdoded. Otherwise, it is not encoded.
ByteBuffer plaintext
The data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encdoded. Otherwise, it is not encoded. Use this data key for local encryption and decryption, then remove it from memory as soon as possible.
String keyId
The identifier of the CMK under which the data encryption key was generated and encrypted.
String keyId
The identifier of the customer master key (CMK) under which to generate and encrypt the data encryption key.
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.
SdkInternalMap<K,V> encryptionContext
A set of key-value pairs that represents additional authenticated data.
For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
String keySpec
The length of the data encryption 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 encryption 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.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
ByteBuffer ciphertextBlob
The encrypted data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encdoded. Otherwise, it is not encoded.
String keyId
The identifier of the CMK under which the data encryption key was generated and encrypted.
Integer numberOfBytes
The length of the byte string.
String customKeyStoreId
Generates the random byte string in the AWS 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 AWS CLI, the value is Base64-encdoded. Otherwise, it is not encoded.
String keyId
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, 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
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey.
Boolean keyRotationEnabled
A Boolean value that specifies whether key rotation is enabled.
String keyId
The identifier of the CMK into which you will import key material. The CMK's Origin must be
EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, 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 AWS 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 identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK 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.
SdkInternalMap<K,V> encryptionContextSubset
A list of key-value pairs, all of which must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list or is a superset of this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
SdkInternalMap<K,V> encryptionContextEquals
A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows. When certain subsequent operations allowed by the grant include encryption context that matches this list, the grant allows the operation. Otherwise, the grant does not allow the operation.
String keyId
The unique identifier for the customer master key (CMK) 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 principal that receives the grant's permissions.
String retiringPrincipal
The principal that can retire the grant.
String issuingAccount
The AWS 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 CMK to import the key material into. The CMK's Origin must be
EXTERNAL.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, 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. It must be encrypted with the public key that you received in the response to a previous GetParametersForImport request, using the wrapping algorithm that you specified in that request.
Date validTo
The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key
material and the CMK 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 AWS account that owns the CMK.
String keyId
The globally unique identifier for the CMK.
String arn
The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
Date creationDate
The date and time when the CMK was created.
Boolean enabled
Specifies whether the CMK is enabled. When KeyState is Enabled this value is true,
otherwise it is false.
String description
The description of the CMK.
String keyUsage
String keyState
The state of the CMK.
For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
Date deletionDate
The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is
PendingDeletion.
Date validTo
The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key
material and the CMK becomes unusable. This value is present only for CMKs whose Origin is
EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this
value is omitted.
String origin
The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material.
When this value is EXTERNAL, the key material was imported from your existing key management
infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was
created in the AWS CloudHSM cluster associated with a custom key store.
String customKeyStoreId
A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.
String cloudHsmClusterId
The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.
String expirationModel
Specifies whether the CMK's key material expires. This value is present only when Origin is
EXTERNAL, otherwise this value is omitted.
String keyManager
The CMK's manager. CMKs are either customer-managed or AWS-managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.
String keyId
Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.
This parameter is optional. If you omit it, ListAliases returns all aliases in the account and
region.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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 this response
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, AWS 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
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey.
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 this response
to the Marker parameter in a subsequent request.
String keyId
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.
Currently only 1 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. Currently, there is only one key policy per CMK and it is always named
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 this response
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, AWS 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 customer master keys (CMKs).
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 this response
to the Marker parameter in a subsequent request.
String keyId
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
Integer limit
Use this parameter to specify the maximum number of items to return. When this value is present, AWS 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.
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 this response
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, AWS 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.
To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS 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 this response
to the Marker parameter in a subsequent request.
String keyId
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, 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 CMK.
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 CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in
the Default Key Policy section of the AWS 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 AWS KMS. When you create a new AWS 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 AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
The key policy size limit 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 CMK 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 AWS 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 CMK.
The default value is false.
ByteBuffer ciphertextBlob
Ciphertext of the data to reencrypt.
SdkInternalMap<K,V> sourceEncryptionContext
Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.
String destinationKeyId
A unique identifier for the CMK that is used to reencrypt the data.
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.
SdkInternalMap<K,V> destinationEncryptionContext
Encryption context to use when the data is reencrypted.
SdkInternalList<T> grantTokens
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
ByteBuffer ciphertextBlob
The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encdoded. Otherwise, it is not encoded.
String sourceKeyId
Unique identifier of the CMK used to originally encrypt the data.
String keyId
Unique identifier of the CMK used to reencrypt the data.
String grantToken
Token that identifies the grant to be retired.
String keyId
The Amazon Resource Name (ARN) of the CMK associated with the grant.
For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
String grantId
Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant
operation.
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
String keyId
A unique identifier for the customer master key associated with the grant.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS 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 CMK, use ListKeys or DescribeKey.
String grantId
Identifier of the grant to be revoked.
String keyId
The unique identifier of the customer master key (CMK) to delete.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
Integer pendingWindowInDays
The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
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
A unique identifier for the CMK you are tagging.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
SdkInternalList<T> tags
One or more tags. Each tag consists of a tag key and a tag value.
String keyId
A unique identifier for the CMK from which you are removing tags.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
SdkInternalList<T> tagKeys
One or more tag keys. Specify only the tag keys, not the tag values.
String aliasName
String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
String targetKeyId
Unique identifier of the customer master key to be mapped to the alias.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct CMK, 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 AWS account.
String keyStorePassword
Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is
associated with the custom key store.
This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set
or change the password of any users in the AWS CloudHSM cluster.
String cloudHsmClusterId
Associates the custom key store with a related AWS 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 with the original cluster. You cannot use this parameter to associate a custom key store with a different cluster.
Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.
String keyId
A unique identifier for the customer master key (CMK).
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
String description
New description for the CMK.
Copyright © 2018. All rights reserved.