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.
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":{ "name":"CreateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAliasRequest"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"AlreadyExistsException"}, {"shape":"NotFoundException"}, {"shape":"InvalidAliasNameException"}, {"shape":"KMSInternalException"}, {"shape":"LimitExceededException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Creates a display name for a customer master key. An alias can be used to identify a key and should be unique. The console enforces a one-to-one mapping between the alias and a key. 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/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
To map an alias to a different key, call UpdateAlias.
" }, "CreateGrant":{ "name":"CreateGrant", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateGrantRequest"}, "output":{"shape":"CreateGrantResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidArnException"}, {"shape":"KMSInternalException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"LimitExceededException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Adds a grant to a key to specify who can use the key and under what conditions. Grants are alternate permission mechanisms to key policies.
For more information about grants, see Grants in the AWS Key Management Service Developer Guide.
" }, "CreateKey":{ "name":"CreateKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyRequest"}, "output":{"shape":"CreateKeyResponse"}, "errors":[ {"shape":"MalformedPolicyDocumentException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidArnException"}, {"shape":"UnsupportedOperationException"}, {"shape":"KMSInternalException"}, {"shape":"LimitExceededException"}, {"shape":"TagException"} ], "documentation":"Creates a customer master key (CMK).
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
Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions:
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. To map an alias to a different key, call UpdateAlias.
" }, "DeleteImportedKeyMaterial":{ "name":"DeleteImportedKeyMaterial", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteImportedKeyMaterialRequest"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"UnsupportedOperationException"}, {"shape":"DependencyTimeoutException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Deletes key material that you previously imported and 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.
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":{ "name":"DescribeKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeKeyRequest"}, "output":{"shape":"DescribeKeyResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"} ], "documentation":"Provides detailed information about the specified customer master key.
" }, "DisableKey":{ "name":"DisableKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableKeyRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. 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":{ "name":"DisableKeyRotation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableKeyRotationRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"Disables rotation of the specified key.
" }, "EnableKey":{ "name":"EnableKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableKeyRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"LimitExceededException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Marks a key as enabled, thereby permitting its use.
" }, "EnableKeyRotation":{ "name":"EnableKeyRotation", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableKeyRotationRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"Enables rotation of the specified customer master key.
" }, "Encrypt":{ "name":"Encrypt", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EncryptRequest"}, "output":{"shape":"EncryptResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"KeyUnavailableException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidKeyUsageException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:
You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.
If you are moving encrypted data from one region to another, you can use this API 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.
Unless you are moving encrypted data from one region to another, you don't use this function to encrypt a generated data key within a region. You retrieve data keys already encrypted by calling the GenerateDataKey or GenerateDataKeyWithoutPlaintext function. Data keys don't need to be encrypted again by calling Encrypt.
If you want to encrypt data locally in your application, you can use the GenerateDataKey function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing.
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.
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 retrieve 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.
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":{ "name":"GetKeyPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetKeyPolicyRequest"}, "output":{"shape":"GetKeyPolicyResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Retrieves a policy attached to the specified key.
" }, "GetKeyRotationStatus":{ "name":"GetKeyRotationStatus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetKeyRotationStatusRequest"}, "output":{"shape":"GetKeyRotationStatusResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"}, {"shape":"UnsupportedOperationException"} ], "documentation":"Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.
" }, "GetParametersForImport":{ "name":"GetParametersForImport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParametersForImportRequest"}, "output":{"shape":"GetParametersForImportResponse"}, "errors":[ {"shape":"InvalidArnException"}, {"shape":"UnsupportedOperationException"}, {"shape":"DependencyTimeoutException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"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.
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, after which they cannot be used for a subsequent ImportKeyMaterial request. To retrieve new ones, send another GetParametersForImport request.
Imports key material into an AWS KMS customer master key (CMK) 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 CMK to import the key material into. This CMK's Origin must be EXTERNAL. You must also send an import token and the encrypted key material. Send the import token that you received in the same GetParametersForImport response that contained the public key that you used to encrypt the key material. You must also specify whether the key material expires and if so, when. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you can reimport the same key material. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date.
When this operation is successful, the specified CMK's key state changes 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.
" }, "ListAliases":{ "name":"ListAliases", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAliasesRequest"}, "output":{"shape":"ListAliasesResponse"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"InvalidMarkerException"}, {"shape":"KMSInternalException"} ], "documentation":"Lists all of the key aliases in the account.
" }, "ListGrants":{ "name":"ListGrants", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListGrantsRequest"}, "output":{"shape":"ListGrantsResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidMarkerException"}, {"shape":"InvalidArnException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"List the grants for a specified key.
" }, "ListKeyPolicies":{ "name":"ListKeyPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListKeyPoliciesRequest"}, "output":{"shape":"ListKeyPoliciesResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Retrieves a list of policies attached to a key.
" }, "ListKeys":{ "name":"ListKeys", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListKeysRequest"}, "output":{"shape":"ListKeysResponse"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"InvalidMarkerException"} ], "documentation":"Lists the customer master keys.
" }, "ListResourceTags":{ "name":"ListResourceTags", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListResourceTagsRequest"}, "output":{"shape":"ListResourceTagsResponse"}, "errors":[ {"shape":"KMSInternalException"}, {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidMarkerException"} ], "documentation":"Returns a list of all tags for the specified customer master key (CMK).
" }, "ListRetirableGrants":{ "name":"ListRetirableGrants", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRetirableGrantsRequest"}, "output":{"shape":"ListGrantsResponse"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"InvalidMarkerException"}, {"shape":"InvalidArnException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"} ], "documentation":"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":{ "name":"PutKeyPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutKeyPolicyRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"MalformedPolicyDocumentException"}, {"shape":"DependencyTimeoutException"}, {"shape":"UnsupportedOperationException"}, {"shape":"KMSInternalException"}, {"shape":"LimitExceededException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
" }, "ReEncrypt":{ "name":"ReEncrypt", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ReEncryptRequest"}, "output":{"shape":"ReEncryptResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DisabledException"}, {"shape":"InvalidCiphertextException"}, {"shape":"KeyUnavailableException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidKeyUsageException"}, {"shape":"InvalidGrantTokenException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"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.
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":{ "name":"RevokeGrant", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RevokeGrantRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"DependencyTimeoutException"}, {"shape":"InvalidArnException"}, {"shape":"InvalidGrantIdException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Revokes a grant. You can revoke a grant to actively deny operations that depend on it.
" }, "ScheduleKeyDeletion":{ "name":"ScheduleKeyDeletion", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ScheduleKeyDeletionRequest"}, "output":{"shape":"ScheduleKeyDeletionResponse"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"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.
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":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "errors":[ {"shape":"KMSInternalException"}, {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"KMSInvalidStateException"}, {"shape":"LimitExceededException"}, {"shape":"TagException"} ], "documentation":"Adds or overwrites one or more tags for the specified customer master key (CMK).
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.
Removes the specified tag or tags from the specified customer master key (CMK).
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":{ "name":"UpdateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAliasRequest"}, "errors":[ {"shape":"DependencyTimeoutException"}, {"shape":"NotFoundException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Updates an alias to map it to a different key.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
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/). An alias that begins with \"aws\" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
" }, "UpdateKeyDescription":{ "name":"UpdateKeyDescription", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateKeyDescriptionRequest"}, "errors":[ {"shape":"NotFoundException"}, {"shape":"InvalidArnException"}, {"shape":"DependencyTimeoutException"}, {"shape":"KMSInternalException"}, {"shape":"KMSInvalidStateException"} ], "documentation":"Updates the description of a customer master key (CMK).
" } }, "shapes":{ "AWSAccountIdType":{"type":"string"}, "AlgorithmSpec":{ "type":"string", "enum":[ "RSAES_PKCS1_V1_5", "RSAES_OAEP_SHA_1", "RSAES_OAEP_SHA_256" ] }, "AliasList":{ "type":"list", "member":{"shape":"AliasListEntry"} }, "AliasListEntry":{ "type":"structure", "members":{ "AliasName":{ "shape":"AliasNameType", "documentation":"String that contains the alias.
" }, "AliasArn":{ "shape":"ArnType", "documentation":"String that contains the key ARN.
" }, "TargetKeyId":{ "shape":"KeyIdType", "documentation":"String that contains the key identifier referred to by the alias.
" } }, "documentation":"Contains information about an alias.
" }, "AliasNameType":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9:/_-]+$" }, "AlreadyExistsException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because it attempted to create a resource that already exists.
", "exception":true }, "ArnType":{ "type":"string", "max":2048, "min":20 }, "BooleanType":{"type":"boolean"}, "CancelKeyDeletionRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The unique identifier for the customer master key (CMK) for which to cancel deletion.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
" } } }, "CancelKeyDeletionResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The unique identifier of the master key for which deletion is canceled.
" } } }, "CiphertextType":{ "type":"blob", "max":6144, "min":1 }, "CreateAliasRequest":{ "type":"structure", "required":[ "AliasName", "TargetKeyId" ], "members":{ "AliasName":{ "shape":"AliasNameType", "documentation":"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.
" }, "TargetKeyId":{ "shape":"KeyIdType", "documentation":"An identifier of the key for which you are creating the alias. This value cannot be another alias but can be a globally unique identifier or a fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
The unique identifier for the customer master key (CMK) that the grant applies to.
To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples:
Globally unique key ID: 12345678-1234-1234-1234-123456789012
Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012
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.
" }, "RetiringPrincipal":{ "shape":"PrincipalIdType", "documentation":"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.
" }, "Operations":{ "shape":"GrantOperationList", "documentation":"A list of operations that the grant permits.
" }, "Constraints":{ "shape":"GrantConstraints", "documentation":"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.
" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" }, "Name":{ "shape":"GrantNameType", "documentation":"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 grant token.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" }, "GrantId":{ "shape":"GrantIdType", "documentation":"The unique identifier for the grant.
You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
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 KiB (32768 bytes).
" }, "Description":{ "shape":"DescriptionType", "documentation":"A description of the CMK.
Use a description that helps you decide whether the CMK is appropriate for a task.
" }, "KeyUsage":{ "shape":"KeyUsageType", "documentation":"The intended use of the CMK.
You can use CMKs only for symmetric encryption and decryption.
" }, "Origin":{ "shape":"OriginType", "documentation":"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.
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.
" }, "Tags":{ "shape":"TagList", "documentation":"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.
" } } }, "CreateKeyResponse":{ "type":"structure", "members":{ "KeyMetadata":{ "shape":"KeyMetadata", "documentation":"Metadata associated with the CMK.
" } } }, "DataKeySpec":{ "type":"string", "enum":[ "AES_256", "AES_128" ] }, "DateType":{"type":"timestamp"}, "DecryptRequest":{ "type":"structure", "required":["CiphertextBlob"], "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"Ciphertext to be decrypted. The blob includes metadata.
" }, "EncryptionContext":{ "shape":"EncryptionContextType", "documentation":"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.
" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" } } }, "DecryptResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.
" }, "Plaintext":{ "shape":"PlaintextType", "documentation":"Decrypted plaintext data. This value may not be returned if the customer master key is not available or if you didn't have permission to use it.
" } } }, "DeleteAliasRequest":{ "type":"structure", "required":["AliasName"], "members":{ "AliasName":{ "shape":"AliasNameType", "documentation":"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.
" } } }, "DeleteImportedKeyMaterialRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The identifier of the CMK whose key material to delete. The CMK's Origin must be EXTERNAL.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
The system timed out while trying to fulfill the request. The request can be retried.
", "exception":true, "fault":true }, "DescribeKeyRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" } } }, "DescribeKeyResponse":{ "type":"structure", "members":{ "KeyMetadata":{ "shape":"KeyMetadata", "documentation":"Metadata associated with the key.
" } } }, "DescriptionType":{ "type":"string", "max":8192, "min":0 }, "DisableKeyRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
The request was rejected because the specified CMK is not enabled.
", "exception":true }, "EnableKeyRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A unique identifier for the customer master key. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
Data to be encrypted.
" }, "EncryptionContext":{ "shape":"EncryptionContextType", "documentation":"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 list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" } } }, "EncryptResponse":{ "type":"structure", "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.
" }, "KeyId":{ "shape":"KeyIdType", "documentation":"The ID of the key used during encryption.
" } } }, "EncryptionContextKey":{"type":"string"}, "EncryptionContextType":{ "type":"map", "key":{"shape":"EncryptionContextKey"}, "value":{"shape":"EncryptionContextValue"} }, "EncryptionContextValue":{"type":"string"}, "ErrorMessageType":{"type":"string"}, "ExpirationModelType":{ "type":"string", "enum":[ "KEY_MATERIAL_EXPIRES", "KEY_MATERIAL_DOES_NOT_EXPIRE" ] }, "ExpiredImportTokenException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because the provided import token is expired. Use GetParametersForImport to retrieve a new import token and public key, use the new public key to encrypt the key material, and then try the request again.
", "exception":true }, "GenerateDataKeyRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The identifier of the CMK under which to generate and encrypt the data encryption key.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
CMK 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
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.
" }, "NumberOfBytes":{ "shape":"NumberOfBytesType", "documentation":"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. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" } } }, "GenerateDataKeyResponse":{ "type":"structure", "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"The encrypted data encryption key.
" }, "Plaintext":{ "shape":"PlaintextType", "documentation":"The data encryption key. Use this data key for local encryption and decryption, then remove it from memory as soon as possible.
" }, "KeyId":{ "shape":"KeyIdType", "documentation":"The identifier of the CMK under which the data encryption key was generated and encrypted.
" } } }, "GenerateDataKeyWithoutPlaintextRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The identifier of the CMK under which to generate and encrypt the data encryption key.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK, or the alias name or ARN of an alias that refers to the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
CMK 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
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.
" }, "KeySpec":{ "shape":"DataKeySpec", "documentation":"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 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.
A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" } } }, "GenerateDataKeyWithoutPlaintextResponse":{ "type":"structure", "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"The encrypted data encryption key.
" }, "KeyId":{ "shape":"KeyIdType", "documentation":"The identifier of the CMK under which the data encryption key was generated and encrypted.
" } } }, "GenerateRandomRequest":{ "type":"structure", "members":{ "NumberOfBytes":{ "shape":"NumberOfBytesType", "documentation":"The length of the byte string.
" } } }, "GenerateRandomResponse":{ "type":"structure", "members":{ "Plaintext":{ "shape":"PlaintextType", "documentation":"The random byte string.
" } } }, "GetKeyPolicyRequest":{ "type":"structure", "required":[ "KeyId", "PolicyName" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
String that contains the name of the policy. Currently, this must be \"default\". Policy names can be discovered by calling ListKeyPolicies.
" } } }, "GetKeyPolicyResponse":{ "type":"structure", "members":{ "Policy":{ "shape":"PolicyType", "documentation":"A policy document in JSON format.
" } } }, "GetKeyRotationStatusRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A Boolean value that specifies whether key rotation is enabled.
" } } }, "GetParametersForImportRequest":{ "type":"structure", "required":[ "KeyId", "WrappingAlgorithm", "WrappingKeySpec" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
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.
" }, "WrappingKeySpec":{ "shape":"WrappingKeySpec", "documentation":"The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
" } } }, "GetParametersForImportResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport request.
The import token to send in a subsequent ImportKeyMaterial request.
" }, "PublicKey":{ "shape":"PlaintextType", "documentation":"The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
" }, "ParametersValidTo":{ "shape":"DateType", "documentation":"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 retrieve new ones.
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.
" }, "EncryptionContextEquals":{ "shape":"EncryptionContextType", "documentation":"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.
" } }, "documentation":"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.
The unique identifier for the customer master key (CMK) to which the grant applies.
" }, "GrantId":{ "shape":"GrantIdType", "documentation":"The unique identifier for the grant.
" }, "Name":{ "shape":"GrantNameType", "documentation":"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.
" }, "CreationDate":{ "shape":"DateType", "documentation":"The date and time when the grant was created.
" }, "GranteePrincipal":{ "shape":"PrincipalIdType", "documentation":"The principal that receives the grant's permissions.
" }, "RetiringPrincipal":{ "shape":"PrincipalIdType", "documentation":"The principal that can retire the grant.
" }, "IssuingAccount":{ "shape":"PrincipalIdType", "documentation":"The AWS account under which the grant was issued.
" }, "Operations":{ "shape":"GrantOperationList", "documentation":"The list of operations permitted by the grant.
" }, "Constraints":{ "shape":"GrantConstraints", "documentation":"A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.
" } }, "documentation":"Contains information about an entry in a list of grants.
" }, "GrantNameType":{ "type":"string", "max":256, "min":1, "pattern":"^[a-zA-Z0-9:/_-]+$" }, "GrantOperation":{ "type":"string", "enum":[ "Decrypt", "Encrypt", "GenerateDataKey", "GenerateDataKeyWithoutPlaintext", "ReEncryptFrom", "ReEncryptTo", "CreateGrant", "RetireGrant", "DescribeKey" ] }, "GrantOperationList":{ "type":"list", "member":{"shape":"GrantOperation"} }, "GrantTokenList":{ "type":"list", "member":{"shape":"GrantTokenType"}, "max":10, "min":0 }, "GrantTokenType":{ "type":"string", "max":8192, "min":1 }, "ImportKeyMaterialRequest":{ "type":"structure", "required":[ "KeyId", "ImportToken", "EncryptedKeyMaterial" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The identifier of the CMK to import the key material into. The CMK's Origin must be EXTERNAL.
A valid identifier is the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
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.
" }, "EncryptedKeyMaterial":{ "shape":"CiphertextType", "documentation":"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.
" }, "ValidTo":{ "shape":"DateType", "documentation":"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.
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.
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).
", "exception":true }, "InvalidAliasNameException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because the specified alias name is not valid.
", "exception":true }, "InvalidArnException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because a specified ARN was not valid.
", "exception":true }, "InvalidCiphertextException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.
", "exception":true }, "InvalidGrantIdException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because the specified GrantId is not valid.
The request was rejected because the specified grant token is not valid.
", "exception":true }, "InvalidImportTokenException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).
", "exception":true }, "InvalidKeyUsageException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"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.
", "exception":true }, "KMSInternalException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because an internal exception occurred. The request can be retried.
", "exception":true }, "KMSInvalidStateException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"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.
", "exception":true }, "KeyIdType":{ "type":"string", "max":2048, "min":1 }, "KeyList":{ "type":"list", "member":{"shape":"KeyListEntry"} }, "KeyListEntry":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"Unique identifier of the key.
" }, "KeyArn":{ "shape":"ArnType", "documentation":"ARN of the key.
" } }, "documentation":"Contains information about each entry in the key list.
" }, "KeyManagerType":{ "type":"string", "enum":[ "AWS", "CUSTOMER" ] }, "KeyMetadata":{ "type":"structure", "required":["KeyId"], "members":{ "AWSAccountId":{ "shape":"AWSAccountIdType", "documentation":"The twelve-digit account ID of the AWS account that owns the CMK.
" }, "KeyId":{ "shape":"KeyIdType", "documentation":"The globally unique identifier for the CMK.
" }, "Arn":{ "shape":"ArnType", "documentation":"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.
" }, "CreationDate":{ "shape":"DateType", "documentation":"The date and time when the CMK was created.
" }, "Enabled":{ "shape":"BooleanType", "documentation":"Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.
The description of the CMK.
" }, "KeyUsage":{ "shape":"KeyUsageType", "documentation":"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 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.
" }, "DeletionDate":{ "shape":"DateType", "documentation":"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 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.
Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.
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.
" } }, "documentation":"Contains metadata about a customer master key (CMK).
This data type is used as a response element for the CreateKey and DescribeKey operations.
" }, "KeyState":{ "type":"string", "enum":[ "Enabled", "Disabled", "PendingDeletion", "PendingImport" ] }, "KeyUnavailableException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because the specified CMK was not available. The request can be retried.
", "exception":true, "fault":true }, "KeyUsageType":{ "type":"string", "enum":["ENCRYPT_DECRYPT"] }, "LimitExceededException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.
", "exception":true }, "LimitType":{ "type":"integer", "max":1000, "min":1 }, "ListAliasesRequest":{ "type":"structure", "members":{ "Limit":{ "shape":"LimitType", "documentation":"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.
" }, "Marker":{ "shape":"MarkerType", "documentation":"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.
A list of key aliases in the user's account.
" }, "NextMarker":{ "shape":"MarkerType", "documentation":"When Truncated is true, this element is present and contains the value to use for 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 retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
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.
" }, "Marker":{ "shape":"MarkerType", "documentation":"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.
A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
A list of grants.
" }, "NextMarker":{ "shape":"MarkerType", "documentation":"When Truncated is true, this element is present and contains the value to use for 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 retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A unique identifier for the customer master key (CMK). You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
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.
" }, "Marker":{ "shape":"MarkerType", "documentation":"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.
A list of policy names. Currently, there is only one policy and it is named \"Default\".
" }, "NextMarker":{ "shape":"MarkerType", "documentation":"When Truncated is true, this element is present and contains the value to use for 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 retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
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.
" }, "Marker":{ "shape":"MarkerType", "documentation":"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.
A list of keys.
" }, "NextMarker":{ "shape":"MarkerType", "documentation":"When Truncated is true, this element is present and contains the value to use for 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 retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
A unique identifier for the CMK whose tags you are listing. You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
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.
" }, "Marker":{ "shape":"MarkerType", "documentation":"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.
A list of tags. Each tag consists of a tag key and a tag value.
" }, "NextMarker":{ "shape":"MarkerType", "documentation":"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.
" }, "Truncated":{ "shape":"BooleanType", "documentation":"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 retrieve more items, pass the value of the NextMarker element in this response to the Marker parameter in a subsequent request.
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.
" }, "Marker":{ "shape":"MarkerType", "documentation":"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 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.
" } } }, "MalformedPolicyDocumentException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because the specified policy is not syntactically or semantically correct.
", "exception":true }, "MarkerType":{ "type":"string", "max":320, "min":1, "pattern":"[\\u0020-\\u00FF]*" }, "NotFoundException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because the specified entity or resource could not be found.
", "exception":true }, "NumberOfBytesType":{ "type":"integer", "max":1024, "min":1 }, "OriginType":{ "type":"string", "enum":[ "AWS_KMS", "EXTERNAL" ] }, "PendingWindowInDaysType":{ "type":"integer", "max":365, "min":1 }, "PlaintextType":{ "type":"blob", "max":4096, "min":1, "sensitive":true }, "PolicyNameList":{ "type":"list", "member":{"shape":"PolicyNameType"} }, "PolicyNameType":{ "type":"string", "max":128, "min":1, "pattern":"[\\w]+" }, "PolicyType":{ "type":"string", "max":131072, "min":1, "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" }, "PrincipalIdType":{ "type":"string", "max":256, "min":1 }, "PutKeyPolicyRequest":{ "type":"structure", "required":[ "KeyId", "PolicyName", "Policy" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"A unique identifier for the CMK.
Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:
Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab
ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
The name of the key policy.
This value must be default.
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 KiB (32768 bytes).
" }, "BypassPolicyLockoutSafetyCheck":{ "shape":"BooleanType", "documentation":"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.
" } } }, "ReEncryptRequest":{ "type":"structure", "required":[ "CiphertextBlob", "DestinationKeyId" ], "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"Ciphertext of the data to reencrypt.
" }, "SourceEncryptionContext":{ "shape":"EncryptionContextType", "documentation":"Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.
A unique identifier for the CMK to use to reencrypt the data. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Alias Name Example - alias/MyAliasName
Encryption context to use when the data is reencrypted.
" }, "GrantTokens":{ "shape":"GrantTokenList", "documentation":"A list of grant tokens.
For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.
" } } }, "ReEncryptResponse":{ "type":"structure", "members":{ "CiphertextBlob":{ "shape":"CiphertextType", "documentation":"The reencrypted data.
" }, "SourceKeyId":{ "shape":"KeyIdType", "documentation":"Unique identifier of the CMK used to originally encrypt the data.
" }, "KeyId":{ "shape":"KeyIdType", "documentation":"Unique identifier of the CMK used to reencrypt the data.
" } } }, "RetireGrantRequest":{ "type":"structure", "members":{ "GrantToken":{ "shape":"GrantTokenType", "documentation":"Token that identifies the grant to be retired.
" }, "KeyId":{ "shape":"KeyIdType", "documentation":"The Amazon Resource Name of the CMK associated with the grant. Example:
arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
Identifier of the grant to be revoked.
" } } }, "ScheduleKeyDeletionRequest":{ "type":"structure", "required":["KeyId"], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The unique identifier for the customer master key (CMK) to delete.
To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
" }, "PendingWindowInDays":{ "shape":"PendingWindowInDaysType", "documentation":"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.
" } } }, "ScheduleKeyDeletionResponse":{ "type":"structure", "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"The unique identifier of the customer master key (CMK) for which deletion is scheduled.
" }, "DeletionDate":{ "shape":"DateType", "documentation":"The date and time after which AWS KMS deletes the customer master key (CMK).
" } } }, "Tag":{ "type":"structure", "required":[ "TagKey", "TagValue" ], "members":{ "TagKey":{ "shape":"TagKeyType", "documentation":"The key of the tag.
" }, "TagValue":{ "shape":"TagValueType", "documentation":"The value of the tag.
" } }, "documentation":"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.
" }, "TagException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because one or more tags are not valid.
", "exception":true }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKeyType"} }, "TagKeyType":{ "type":"string", "max":128, "min":1 }, "TagList":{ "type":"list", "member":{"shape":"Tag"} }, "TagResourceRequest":{ "type":"structure", "required":[ "KeyId", "Tags" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"A unique identifier for the CMK you are tagging. You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
One or more tags. Each tag consists of a tag key and a tag value.
" } } }, "TagValueType":{ "type":"string", "max":256, "min":0 }, "UnsupportedOperationException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessageType"} }, "documentation":"The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.
", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "KeyId", "TagKeys" ], "members":{ "KeyId":{ "shape":"KeyIdType", "documentation":"A unique identifier for the CMK from which you are removing tags. You can use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
One or more tag keys. Specify only the tag keys, not the tag values.
" } } }, "UpdateAliasRequest":{ "type":"structure", "required":[ "AliasName", "TargetKeyId" ], "members":{ "AliasName":{ "shape":"AliasNameType", "documentation":"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.
" }, "TargetKeyId":{ "shape":"KeyIdType", "documentation":"Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.
A unique identifier for the CMK. This value can be a globally unique identifier or the fully specified ARN to a key.
Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
New description for the CMK.
" } } }, "WrappingKeySpec":{ "type":"string", "enum":["RSA_2048"] } }, "documentation":"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.
" }