{
"version": "2.0",
"service": "
AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide.
AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.
We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.
Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.
Signing Requests
Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.
All AWS KMS operations require Signature Version 4.
Logging API Requests
AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Additional Resources
For more information about credentials and request signing, see the following:
AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS.
Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials.
Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key.
Commonly Used APIs
Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console.
", "operations": { "CancelKeyDeletion": "Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled
state. To enable a CMK, use EnableKey. You cannot perform this operation on a CMK in a different AWS account.
For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
", "CreateAlias": "Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey.
Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
An alias must start with the word alias
followed by a forward slash (alias/
). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.
To map an existing alias to a different CMK, call UpdateAlias.
", "CreateGrant": "Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
", "CreateKey": "Creates a customer master key (CMK) in the caller's AWS account.
You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data encryption keys (DEKs), which are used to encrypt raw data. For more information about DEKs and the difference between CMKs and DEKs, see the following:
The GenerateDataKey operation
AWS Key Management Service Concepts in the AWS Key Management Service Developer Guide
You cannot use this operation to create a CMK in a different AWS account.
", "Decrypt": "Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:
Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant Decrypt
permission on all resources), then ciphertext encrypted by using keys in other accounts where the key grants access to the caller can be decrypted. To remedy this, we recommend that you do not grant Decrypt
access in an IAM user policy. Instead grant Decrypt
access only in key policies. If you must grant Decrypt
access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts.
Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.
Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.
Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.
", "DeleteImportedKeyMaterial": "Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.
When the specified CMK is in the PendingDeletion
state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport
.
After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.
", "DescribeKey": "Provides detailed information about the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
", "DisableKey": "Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
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.
", "DisableKeyRotation": "Disables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
", "EnableKey": "Sets the state of a customer master key (CMK) to enabled, thereby permitting its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.
", "EnableKeyRotation": "Enables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
", "Encrypt": "Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt
operation has two primary use cases:
You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.
To move encrypted data from one AWS region to another, you can use this operation to encrypt in the new region the plaintext data key that was used to encrypt the data in the original region. This provides you with an encrypted copy of the data key that can be decrypted in the new region and used there to decrypt the encrypted data.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
Unless you are moving encrypted data from one region to another, you don't use this operation to encrypt a generated data key within a region. To get data keys that are already encrypted, call the GenerateDataKey or GenerateDataKeyWithoutPlaintext operation. Data keys don't need to be encrypted again by calling Encrypt
.
To encrypt data locally in your application, use the GenerateDataKey operation to return a plaintext data encryption key and a copy of the key encrypted under the CMK of your choosing.
", "GenerateDataKey": "Returns a data encryption key that you can use in your application to encrypt data locally.
You must specify the customer master key (CMK) under which to generate the data key. You must also specify the length of the data key using either the KeySpec
or NumberOfBytes
field. You must specify one field or the other, but not both. For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec
. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation returns a plaintext copy of the data key in the Plaintext
field of the response, and an encrypted copy of the data key in the CiphertextBlob
field. The data key is encrypted under the CMK specified in the KeyId
field of the request.
We recommend that you use the following pattern to encrypt data locally in your application:
Use this operation (GenerateDataKey
) to get a data encryption key.
Use the plaintext data encryption key (returned in the Plaintext
field of the response) to encrypt data locally, then erase the plaintext data key from memory.
Store the encrypted data key (returned in the CiphertextBlob
field of the response) alongside the locally encrypted data.
To decrypt data locally:
Use the Decrypt operation to decrypt the encrypted data key into a plaintext copy of the data key.
Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.
To return only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To return a random byte string that is cryptographically secure, use GenerateRandom.
If you use the optional EncryptionContext
field, you must store at least enough information to be able to reconstruct the full encryption context when you later send the ciphertext to the Decrypt operation. It is a good practice to choose an encryption context that you can reconstruct on the fly to better secure the ciphertext. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.
Returns a data encryption key encrypted under a customer master key (CMK). This operation is identical to GenerateDataKey but returns only the encrypted copy of the data key.
To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.
This operation is useful in a system that has multiple components with different degrees of trust. For example, consider a system that stores encrypted data in containers. Each container stores the encrypted data and an encrypted copy of the data key. One component of the system, called the control plane, creates new containers. When it creates a new container, it uses this operation (GenerateDataKeyWithoutPlaintext
) to get an encrypted data key and then stores it in the container. Later, a different component of the system, called the data plane, puts encrypted data into the containers. To do this, it passes the encrypted data key to the Decrypt operation, then uses the returned plaintext data key to encrypt data, and finally stores the encrypted data in the container. In this system, the control plane never sees the plaintext data key.
Returns a random byte string that is cryptographically secure.
For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.
", "GetKeyPolicy": "Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
", "GetKeyRotationStatus": "Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
", "GetParametersForImport": "Returns the items you need in order to import key material into AWS KMS 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.
You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin
must be EXTERNAL
. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on a CMK in a different AWS account.
This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be used for a subsequent ImportKeyMaterial request. To get new ones, send another GetParametersForImport
request.
Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.
Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport
response.
When calling this operation, you must specify the following values:
The key ID or key ARN of a CMK with no key material. Its Origin
must be EXTERNAL
.
To create a CMK with no key material, call CreateKey and set the value of its Origin
parameter to EXTERNAL
. To get the Origin
of a CMK, call DescribeKey.)
The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.
The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response.
Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.
When this operation is successful, the CMK's key state changes from PendingImport
to Enabled
, and you can use the CMK. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.
Gets a list of all aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.
The response might include several aliases that do not have a TargetKeyId
field because they are not associated with a CMK. These are predefined aliases that are reserved for CMKs managed by AWS services. If an alias is not associated with a CMK, the alias does not count against the alias limit for your account.
Gets a list of all grants for the specified customer master key (CMK).
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
", "ListKeyPolicies": "Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default
. You cannot perform this operation on a CMK in a different AWS account.
Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.
", "ListResourceTags": "Returns a list of all tags for the specified customer master key (CMK).
You cannot perform this operation on a CMK in a different AWS account.
", "ListRetirableGrants": "Returns a list of all grants for which the grant's RetiringPrincipal
matches the one specified.
A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.
", "PutKeyPolicy": "Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
", "ReEncrypt": "Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.
You can reencrypt data using CMKs in different AWS accounts.
Unlike other operations, ReEncrypt
is authorized twice, once as ReEncryptFrom
on the source CMK and once as ReEncryptTo
on the destination CMK. We recommend that you include the \"kms:ReEncrypt*\"
permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console, but you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.
Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:
The AWS account (root user) under which the grant was created
The RetiringPrincipal
, if present in the grant
The GranteePrincipal
, if RetireGrant
is an operation specified in the grant
You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.
", "RevokeGrant": "Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.
To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.
", "ScheduleKeyDeletion": "Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion
. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.
You cannot perform this operation on a CMK in a different AWS account.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
", "TagResource": "Adds or overwrites one or more tags for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
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.
You cannot use the same tag key more than once per CMK. For example, consider a CMK with one tag whose tag key is Purpose
and tag value is Test
. If you send a TagResource
request for this CMK with a tag key of Purpose
and a tag value of Prod
, it does not create a second tag. Instead, the original tag is overwritten with the new tag value.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
", "UntagResource": "Removes the specified tag or tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.
To remove a tag, you specify the tag key for each tag to remove. You do not specify the tag value. To overwrite the tag value for an existing tag, use TagResource.
", "UpdateAlias": "Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.
This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias.
Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word alias
followed by a forward slash (alias/
). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with aws
; that alias name prefix is reserved by Amazon Web Services (AWS).
Updates the description of a customer master key (CMK). To see the decription of a CMK, use DescribeKey.
You cannot perform this operation on a CMK in a different AWS account.
" }, "shapes": { "AWSAccountIdType": { "base": null, "refs": { "KeyMetadata$AWSAccountId": "The twelve-digit account ID of the AWS account that owns the CMK.
" } }, "AlgorithmSpec": { "base": null, "refs": { "GetParametersForImportRequest$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.
" } }, "AliasList": { "base": null, "refs": { "ListAliasesResponse$Aliases": "A list of aliases.
" } }, "AliasListEntry": { "base": "Contains information about an alias.
", "refs": { "AliasList$member": null } }, "AliasNameType": { "base": null, "refs": { "AliasListEntry$AliasName": "String that contains the alias.
", "CreateAliasRequest$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.
", "DeleteAliasRequest$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.
", "UpdateAliasRequest$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.
" } }, "AlreadyExistsException": { "base": "The request was rejected because it attempted to create a resource that already exists.
", "refs": { } }, "ArnType": { "base": null, "refs": { "AliasListEntry$AliasArn": "String that contains the key ARN.
", "KeyListEntry$KeyArn": "ARN of the key.
", "KeyMetadata$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.
" } }, "BooleanType": { "base": null, "refs": { "CreateKeyRequest$BypassPolicyLockoutSafetyCheck": "A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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.
", "GetKeyRotationStatusResponse$KeyRotationEnabled": "A Boolean value that specifies whether key rotation is enabled.
", "KeyMetadata$Enabled": "Specifies whether the CMK is enabled. When KeyState
is Enabled
this value is true, otherwise it is false.
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.
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.
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.
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.
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.
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the likelihood 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.
" } }, "CancelKeyDeletionRequest": { "base": null, "refs": { } }, "CancelKeyDeletionResponse": { "base": null, "refs": { } }, "CiphertextType": { "base": null, "refs": { "DecryptRequest$CiphertextBlob": "Ciphertext to be decrypted. The blob includes metadata.
", "EncryptResponse$CiphertextBlob": "The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
", "GenerateDataKeyResponse$CiphertextBlob": "The encrypted data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
", "GenerateDataKeyWithoutPlaintextResponse$CiphertextBlob": "The encrypted data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
", "GetParametersForImportResponse$ImportToken": "The import token to send in a subsequent ImportKeyMaterial request.
", "ImportKeyMaterialRequest$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.
", "ImportKeyMaterialRequest$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.
", "ReEncryptRequest$CiphertextBlob": "Ciphertext of the data to reencrypt.
", "ReEncryptResponse$CiphertextBlob": "The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
" } }, "CreateAliasRequest": { "base": null, "refs": { } }, "CreateGrantRequest": { "base": null, "refs": { } }, "CreateGrantResponse": { "base": null, "refs": { } }, "CreateKeyRequest": { "base": null, "refs": { } }, "CreateKeyResponse": { "base": null, "refs": { } }, "DataKeySpec": { "base": null, "refs": { "GenerateDataKeyRequest$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.
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.
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.
The date and time when the grant was created.
", "ImportKeyMaterialRequest$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.
The date and time when the CMK was created.
", "KeyMetadata$DeletionDate": "The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState
is PendingDeletion
, otherwise this value is omitted.
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.
The date and time after which AWS KMS deletes the customer master key (CMK).
" } }, "DecryptRequest": { "base": null, "refs": { } }, "DecryptResponse": { "base": null, "refs": { } }, "DeleteAliasRequest": { "base": null, "refs": { } }, "DeleteImportedKeyMaterialRequest": { "base": null, "refs": { } }, "DependencyTimeoutException": { "base": "The system timed out while trying to fulfill the request. The request can be retried.
", "refs": { } }, "DescribeKeyRequest": { "base": null, "refs": { } }, "DescribeKeyResponse": { "base": null, "refs": { } }, "DescriptionType": { "base": null, "refs": { "CreateKeyRequest$Description": "A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
", "KeyMetadata$Description": "The description of the CMK.
", "UpdateKeyDescriptionRequest$Description": "New description for the CMK.
" } }, "DisableKeyRequest": { "base": null, "refs": { } }, "DisableKeyRotationRequest": { "base": null, "refs": { } }, "DisabledException": { "base": "The request was rejected because the specified CMK is not enabled.
", "refs": { } }, "EnableKeyRequest": { "base": null, "refs": { } }, "EnableKeyRotationRequest": { "base": null, "refs": { } }, "EncryptRequest": { "base": null, "refs": { } }, "EncryptResponse": { "base": null, "refs": { } }, "EncryptionContextKey": { "base": null, "refs": { "EncryptionContextType$key": null } }, "EncryptionContextType": { "base": null, "refs": { "DecryptRequest$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.
", "EncryptRequest$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.
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.
", "GenerateDataKeyWithoutPlaintextRequest$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.
", "GrantConstraints$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.
", "GrantConstraints$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.
", "ReEncryptRequest$SourceEncryptionContext": "Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob
parameter.
Encryption context to use when the data is reencrypted.
" } }, "EncryptionContextValue": { "base": null, "refs": { "EncryptionContextType$value": null } }, "ErrorMessageType": { "base": null, "refs": { "AlreadyExistsException$message": null, "DependencyTimeoutException$message": null, "DisabledException$message": null, "ExpiredImportTokenException$message": null, "IncorrectKeyMaterialException$message": null, "InvalidAliasNameException$message": null, "InvalidArnException$message": null, "InvalidCiphertextException$message": null, "InvalidGrantIdException$message": null, "InvalidGrantTokenException$message": null, "InvalidImportTokenException$message": null, "InvalidKeyUsageException$message": null, "InvalidMarkerException$message": null, "KMSInternalException$message": null, "KMSInvalidStateException$message": null, "KeyUnavailableException$message": null, "LimitExceededException$message": null, "MalformedPolicyDocumentException$message": null, "NotFoundException$message": null, "TagException$message": null, "UnsupportedOperationException$message": null } }, "ExpirationModelType": { "base": null, "refs": { "ImportKeyMaterialRequest$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.
Specifies whether the CMK's key material expires. This value is present only when Origin
is EXTERNAL
, otherwise this value is omitted.
The request was rejected because the provided import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
", "refs": { } }, "GenerateDataKeyRequest": { "base": null, "refs": { } }, "GenerateDataKeyResponse": { "base": null, "refs": { } }, "GenerateDataKeyWithoutPlaintextRequest": { "base": null, "refs": { } }, "GenerateDataKeyWithoutPlaintextResponse": { "base": null, "refs": { } }, "GenerateRandomRequest": { "base": null, "refs": { } }, "GenerateRandomResponse": { "base": null, "refs": { } }, "GetKeyPolicyRequest": { "base": null, "refs": { } }, "GetKeyPolicyResponse": { "base": null, "refs": { } }, "GetKeyRotationStatusRequest": { "base": null, "refs": { } }, "GetKeyRotationStatusResponse": { "base": null, "refs": { } }, "GetParametersForImportRequest": { "base": null, "refs": { } }, "GetParametersForImportResponse": { "base": null, "refs": { } }, "GrantConstraints": { "base": "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.
Grant constraints apply only to operations that accept encryption context as input. For example, the DescribeKey
operation does not accept encryption context as input. A grant that allows the DescribeKey
operation does so regardless of the grant constraints. In constrast, the Encrypt
operation accepts encryption context as input. A grant that allows the Encrypt
operation does so only when the encryption context of the Encrypt
operation satisfies the grant 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.
", "GrantListEntry$Constraints": "A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
" } }, "GrantIdType": { "base": null, "refs": { "CreateGrantResponse$GrantId": "The unique identifier for the grant.
You can use the GrantId
in a subsequent RetireGrant or RevokeGrant operation.
The unique identifier for the grant.
", "RetireGrantRequest$GrantId": "Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant
operation.
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
Identifier of the grant to be revoked.
" } }, "GrantList": { "base": null, "refs": { "ListGrantsResponse$Grants": "A list of grants.
" } }, "GrantListEntry": { "base": "Contains information about an entry in a list of grants.
", "refs": { "GrantList$member": null } }, "GrantNameType": { "base": null, "refs": { "CreateGrantRequest$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.
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.
" } }, "GrantOperation": { "base": null, "refs": { "GrantOperationList$member": null } }, "GrantOperationList": { "base": null, "refs": { "CreateGrantRequest$Operations": "A list of operations that the grant permits.
", "GrantListEntry$Operations": "The list of operations permitted by the grant.
" } }, "GrantTokenList": { "base": null, "refs": { "CreateGrantRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", "DecryptRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", "DescribeKeyRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", "EncryptRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", "GenerateDataKeyRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", "GenerateDataKeyWithoutPlaintextRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", "ReEncryptRequest$GrantTokens": "A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" } }, "GrantTokenType": { "base": null, "refs": { "CreateGrantResponse$GrantToken": "The grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
", "GrantTokenList$member": null, "RetireGrantRequest$GrantToken": "Token that identifies the grant to be retired.
" } }, "ImportKeyMaterialRequest": { "base": null, "refs": { } }, "ImportKeyMaterialResponse": { "base": null, "refs": { } }, "IncorrectKeyMaterialException": { "base": "The request was rejected because the provided key material is invalid or is not the same key material that was previously imported into this customer master key (CMK).
", "refs": { } }, "InvalidAliasNameException": { "base": "The request was rejected because the specified alias name is not valid.
", "refs": { } }, "InvalidArnException": { "base": "The request was rejected because a specified ARN was not valid.
", "refs": { } }, "InvalidCiphertextException": { "base": "The request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.
", "refs": { } }, "InvalidGrantIdException": { "base": "The request was rejected because the specified GrantId
is not valid.
The request was rejected because the specified grant token is not valid.
", "refs": { } }, "InvalidImportTokenException": { "base": "The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).
", "refs": { } }, "InvalidKeyUsageException": { "base": "The request was rejected because the specified KeySpec
value is not valid.
The request was rejected because the marker that specifies where pagination should next begin is not valid.
", "refs": { } }, "KMSInternalException": { "base": "The request was rejected because an internal exception occurred. The request can be retried.
", "refs": { } }, "KMSInvalidStateException": { "base": "The request was rejected because the state of the specified resource is not valid for this request.
For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
", "refs": { } }, "KeyIdType": { "base": null, "refs": { "AliasListEntry$TargetKeyId": "String that contains the key identifier referred to by the alias.
", "CancelKeyDeletionRequest$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.
", "CancelKeyDeletionResponse$KeyId": "The unique identifier of the master key for which deletion is canceled.
", "CreateAliasRequest$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.
", "CreateGrantRequest$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.
", "DecryptResponse$KeyId": "ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
", "DeleteImportedKeyMaterialRequest$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.
", "DescribeKeyRequest$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.
", "DisableKeyRequest$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.
", "DisableKeyRotationRequest$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.
", "EnableKeyRequest$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.
", "EnableKeyRotationRequest$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.
", "EncryptRequest$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.
", "EncryptResponse$KeyId": "The ID of the key used during encryption.
", "GenerateDataKeyRequest$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.
", "GenerateDataKeyResponse$KeyId": "The identifier of the CMK under which the data encryption key was generated and encrypted.
", "GenerateDataKeyWithoutPlaintextRequest$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.
", "GenerateDataKeyWithoutPlaintextResponse$KeyId": "The identifier of the CMK under which the data encryption key was generated and encrypted.
", "GetKeyPolicyRequest$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.
", "GetKeyRotationStatusRequest$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.
", "GetParametersForImportRequest$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.
", "GetParametersForImportResponse$KeyId": "The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport
request.
The unique identifier for the customer master key (CMK) to which the grant applies.
", "ImportKeyMaterialRequest$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.
", "KeyListEntry$KeyId": "Unique identifier of the key.
", "KeyMetadata$KeyId": "The globally unique identifier for the CMK.
", "ListGrantsRequest$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.
", "ListKeyPoliciesRequest$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.
", "ListResourceTagsRequest$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.
", "PutKeyPolicyRequest$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.
", "ReEncryptRequest$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.
", "ReEncryptResponse$SourceKeyId": "Unique identifier of the CMK used to originally encrypt the data.
", "ReEncryptResponse$KeyId": "Unique identifier of the CMK used to reencrypt the data.
", "RetireGrantRequest$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
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.
", "ScheduleKeyDeletionRequest$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.
", "ScheduleKeyDeletionResponse$KeyId": "The unique identifier of the customer master key (CMK) for which deletion is scheduled.
", "TagResourceRequest$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.
", "UntagResourceRequest$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.
", "UpdateAliasRequest$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.
", "UpdateKeyDescriptionRequest$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.
" } }, "KeyList": { "base": null, "refs": { "ListKeysResponse$Keys": "A list of customer master keys (CMKs).
" } }, "KeyListEntry": { "base": "Contains information about each entry in the key list.
", "refs": { "KeyList$member": null } }, "KeyManagerType": { "base": null, "refs": { "KeyMetadata$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.
" } }, "KeyMetadata": { "base": "Contains metadata about a customer master key (CMK).
This data type is used as a response element for the CreateKey and DescribeKey operations.
", "refs": { "CreateKeyResponse$KeyMetadata": "Metadata associated with the CMK.
", "DescribeKeyResponse$KeyMetadata": "Metadata associated with the key.
" } }, "KeyState": { "base": null, "refs": { "KeyMetadata$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.
" } }, "KeyUnavailableException": { "base": "The request was rejected because the specified CMK was not available. The request can be retried.
", "refs": { } }, "KeyUsageType": { "base": null, "refs": { "CreateKeyRequest$KeyUsage": "The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
", "KeyMetadata$KeyUsage": "The cryptographic operations for which you can use the CMK. Currently the only allowed value is ENCRYPT_DECRYPT
, which means you can use the CMK for the Encrypt and Decrypt operations.
The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
", "refs": { } }, "LimitType": { "base": null, "refs": { "ListAliasesRequest$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.
", "ListGrantsRequest$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.
", "ListKeyPoliciesRequest$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.
", "ListKeysRequest$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.
", "ListResourceTagsRequest$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.
", "ListRetirableGrantsRequest$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.
" } }, "ListAliasesRequest": { "base": null, "refs": { } }, "ListAliasesResponse": { "base": null, "refs": { } }, "ListGrantsRequest": { "base": null, "refs": { } }, "ListGrantsResponse": { "base": null, "refs": { } }, "ListKeyPoliciesRequest": { "base": null, "refs": { } }, "ListKeyPoliciesResponse": { "base": null, "refs": { } }, "ListKeysRequest": { "base": null, "refs": { } }, "ListKeysResponse": { "base": null, "refs": { } }, "ListResourceTagsRequest": { "base": null, "refs": { } }, "ListResourceTagsResponse": { "base": null, "refs": { } }, "ListRetirableGrantsRequest": { "base": null, "refs": { } }, "MalformedPolicyDocumentException": { "base": "The request was rejected because the specified policy is not syntactically or semantically correct.
", "refs": { } }, "MarkerType": { "base": null, "refs": { "ListAliasesRequest$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.
When Truncated
is true, this element is present and contains the value to use for the Marker
parameter in a subsequent request.
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.
When Truncated
is true, this element is present and contains the value to use for the Marker
parameter in a subsequent request.
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.
When Truncated
is true, this element is present and contains the value to use for the Marker
parameter in a subsequent request.
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.
When Truncated
is true, this element is present and contains the value to use for the Marker
parameter in a subsequent request.
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.
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.
", "ListRetirableGrantsRequest$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.
The request was rejected because the specified entity or resource could not be found.
", "refs": { } }, "NumberOfBytesType": { "base": null, "refs": { "GenerateDataKeyRequest$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.
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.
The length of the byte string.
" } }, "OriginType": { "base": null, "refs": { "CreateKeyRequest$Origin": "The source of the CMK's key material.
The default is AWS_KMS
, which means AWS KMS creates the key material. When this parameter is set to EXTERNAL
, the request 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.
The CMK's Origin
is immutable and is set when the CMK is created.
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.
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.
" } }, "PlaintextType": { "base": null, "refs": { "DecryptResponse$Plaintext": "Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
", "EncryptRequest$Plaintext": "Data to be encrypted.
", "GenerateDataKeyResponse$Plaintext": "The data encryption key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. Use this data key for local encryption and decryption, then remove it from memory as soon as possible.
", "GenerateRandomResponse$Plaintext": "The random byte string. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.
", "GetParametersForImportResponse$PublicKey": "The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
" } }, "PolicyNameList": { "base": null, "refs": { "ListKeyPoliciesResponse$PolicyNames": "A list of policy names. Currently, there is only one policy and it is named \"Default\".
" } }, "PolicyNameType": { "base": null, "refs": { "GetKeyPolicyRequest$PolicyName": "Specifies the name of the policy. The only valid name is default
. To get the names of key policies, use ListKeyPolicies.
The name of the key policy. The only valid value is default
.
The key policy to attach to the CMK.
If you specify a policy and do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
It must allow the principal that is making the CreateKey
request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
The principals that are specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
If you do not specify a 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 policy size limit is 32 kilobytes (32768 bytes).
", "GetKeyPolicyResponse$Policy": "A policy document in JSON format.
", "PutKeyPolicyRequest$Policy": "The key policy to attach to the CMK.
If you do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following criteria:
It must allow the principal that is making the PutKeyPolicy
request to make a subsequent PutKeyPolicy
request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
The principals that are specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
The policy size limit is 32 kilobytes (32768 bytes).
" } }, "PrincipalIdType": { "base": null, "refs": { "CreateGrantRequest$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.
", "CreateGrantRequest$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.
", "GrantListEntry$GranteePrincipal": "The principal that receives the grant's permissions.
", "GrantListEntry$RetiringPrincipal": "The principal that can retire the grant.
", "GrantListEntry$IssuingAccount": "The AWS account under which the grant was issued.
", "ListRetirableGrantsRequest$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.
" } }, "PutKeyPolicyRequest": { "base": null, "refs": { } }, "ReEncryptRequest": { "base": null, "refs": { } }, "ReEncryptResponse": { "base": null, "refs": { } }, "RetireGrantRequest": { "base": null, "refs": { } }, "RevokeGrantRequest": { "base": null, "refs": { } }, "ScheduleKeyDeletionRequest": { "base": null, "refs": { } }, "ScheduleKeyDeletionResponse": { "base": null, "refs": { } }, "Tag": { "base": "A key-value pair. A 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.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
", "refs": { "TagList$member": null } }, "TagException": { "base": "The request was rejected because one or more tags are not valid.
", "refs": { } }, "TagKeyList": { "base": null, "refs": { "UntagResourceRequest$TagKeys": "One or more tag keys. Specify only the tag keys, not the tag values.
" } }, "TagKeyType": { "base": null, "refs": { "Tag$TagKey": "The key of the tag.
", "TagKeyList$member": null } }, "TagList": { "base": null, "refs": { "CreateKeyRequest$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.
", "ListResourceTagsResponse$Tags": "A list of tags. Each tag consists of a tag key and a tag value.
", "TagResourceRequest$Tags": "One or more tags. Each tag consists of a tag key and a tag value.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagValueType": { "base": null, "refs": { "Tag$TagValue": "The value of the tag.
" } }, "UnsupportedOperationException": { "base": "The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UpdateAliasRequest": { "base": null, "refs": { } }, "UpdateKeyDescriptionRequest": { "base": null, "refs": { } }, "WrappingKeySpec": { "base": null, "refs": { "GetParametersForImportRequest$WrappingKeySpec": "The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
" } } } }