From f7f14e71e410440cca335715d4ea2eeab4518320 Mon Sep 17 00:00:00 2001 From: Alex Wood Date: Thu, 15 Oct 2015 12:22:39 -0700 Subject: [PATCH] API Update for Aws::KMS This release of AWS Key Management Service introduces the ability to delete customer master keys (CMKs), including two new APIs for scheduling and canceling key deletion. --- CHANGELOG.md | 7 +- aws-sdk-core/apis/kms/2014-11-01/api-2.json | 481 ++++++++++++++++++- aws-sdk-core/apis/kms/2014-11-01/docs-2.json | 211 +++++--- 3 files changed, 622 insertions(+), 77 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e0446f2c3a5..50717a79cb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,12 @@ Unreleased Changes ------------------ -* Feature - Aws::S3 - Adds support for Service Side Encryption (AES256) to `Aws::S3::Client#upload_part`. +* Feature - Aws::KMS - This release of AWS Key Management Service introduces the + ability to delete customer master keys (CMKs), including two new APIs for + scheduling and canceling key deletion. + +* Feature - Aws::S3 - Adds support for Service Side Encryption (AES256) to + `Aws::S3::Client#upload_part`. * Issue - Aws::EC2 - Resolved an issue where `Aws::EC2::Client#copy_snapshot` would not compute the required presigned url when the `:destination_region` diff --git a/aws-sdk-core/apis/kms/2014-11-01/api-2.json b/aws-sdk-core/apis/kms/2014-11-01/api-2.json index deb77d3aa61..827bdd18691 100644 --- a/aws-sdk-core/apis/kms/2014-11-01/api-2.json +++ b/aws-sdk-core/apis/kms/2014-11-01/api-2.json @@ -11,6 +11,61 @@ "protocol":"json" }, "operations":{ + "CancelKeyDeletion":{ + "name":"CancelKeyDeletion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelKeyDeletionRequest"}, + "output":{"shape":"CancelKeyDeletionResponse"}, + "errors":[ + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidArnException", + "error":{ + "code":"InvalidArn", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DependencyTimeoutException", + "error":{ + "code":"DependencyTimeout", + "httpStatusCode":503 + }, + "exception":true, + "fault":true + }, + { + "shape":"KMSInternalException", + "error":{ + "code":"KMSInternal", + "httpStatusCode":500 + }, + "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + } + ] + }, "CreateAlias":{ "name":"CreateAlias", "http":{ @@ -71,6 +126,15 @@ "senderFault":true }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -144,6 +208,15 @@ "senderFault":true }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -281,6 +354,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -317,6 +399,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -408,6 +499,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -462,6 +562,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -516,6 +625,15 @@ "senderFault":true }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -570,6 +688,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -643,6 +770,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -716,6 +852,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -789,6 +934,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -863,6 +1017,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -909,6 +1072,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -958,6 +1130,15 @@ "input":{"shape":"ListGrantsRequest"}, "output":{"shape":"ListGrantsResponse"}, "errors":[ + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, { "shape":"DependencyTimeoutException", "error":{ @@ -992,6 +1173,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -1038,6 +1228,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -1069,6 +1268,61 @@ } ] }, + "ListRetirableGrants":{ + "name":"ListRetirableGrants", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRetirableGrantsRequest"}, + "output":{"shape":"ListGrantsResponse"}, + "errors":[ + { + "shape":"DependencyTimeoutException", + "error":{ + "code":"DependencyTimeout", + "httpStatusCode":503 + }, + "exception":true, + "fault":true + }, + { + "shape":"InvalidMarkerException", + "error":{ + "code":"InvalidMarker", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidArnException", + "error":{ + "code":"InvalidArn", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"KMSInternalException", + "error":{ + "code":"KMSInternal", + "httpStatusCode":500 + }, + "exception":true + } + ] + }, "PutKeyPolicy":{ "name":"PutKeyPolicy", "http":{ @@ -1147,6 +1401,15 @@ "senderFault":true }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -1229,6 +1492,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -1249,6 +1521,15 @@ }, "exception":true }, + { + "shape":"InvalidGrantIdException", + "error":{ + "code":"InvalidGrantId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, { "shape":"NotFoundException", "error":{ @@ -1274,6 +1555,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -1312,6 +1602,70 @@ }, "exception":true }, + { + "shape":"InvalidGrantIdException", + "error":{ + "code":"InvalidGrantId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"KMSInternalException", + "error":{ + "code":"KMSInternal", + "httpStatusCode":500 + }, + "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + } + ] + }, + "ScheduleKeyDeletion":{ + "name":"ScheduleKeyDeletion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScheduleKeyDeletionRequest"}, + "output":{"shape":"ScheduleKeyDeletionResponse"}, + "errors":[ + { + "shape":"NotFoundException", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + { + "shape":"InvalidArnException", + "error":{ + "code":"InvalidArn", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"DependencyTimeoutException", + "error":{ + "code":"DependencyTimeout", + "httpStatusCode":503 + }, + "exception":true, + "fault":true + }, { "shape":"KMSInternalException", "error":{ @@ -1319,6 +1673,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -1355,6 +1718,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] }, @@ -1400,6 +1772,15 @@ "httpStatusCode":500 }, "exception":true + }, + { + "shape":"KMSInvalidStateException", + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true } ] } @@ -1442,6 +1823,19 @@ "max":2048 }, "BooleanType":{"type":"boolean"}, + "CancelKeyDeletionRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{"shape":"KeyIdType"} + } + }, + "CancelKeyDeletionResponse":{ + "type":"structure", + "members":{ + "KeyId":{"shape":"KeyIdType"} + } + }, "CiphertextType":{ "type":"blob", "min":1, @@ -1470,7 +1864,8 @@ "RetiringPrincipal":{"shape":"PrincipalIdType"}, "Operations":{"shape":"GrantOperationList"}, "Constraints":{"shape":"GrantConstraints"}, - "GrantTokens":{"shape":"GrantTokenList"} + "GrantTokens":{"shape":"GrantTokenList"}, + "Name":{"shape":"GrantNameType"} } }, "CreateGrantResponse":{ @@ -1541,7 +1936,8 @@ "type":"structure", "required":["KeyId"], "members":{ - "KeyId":{"shape":"KeyIdType"} + "KeyId":{"shape":"KeyIdType"}, + "GrantTokens":{"shape":"GrantTokenList"} } }, "DescribeKeyResponse":{ @@ -1721,7 +2117,10 @@ "GrantListEntry":{ "type":"structure", "members":{ + "KeyId":{"shape":"KeyIdType"}, "GrantId":{"shape":"GrantIdType"}, + "Name":{"shape":"GrantNameType"}, + "CreationDate":{"shape":"DateType"}, "GranteePrincipal":{"shape":"PrincipalIdType"}, "RetiringPrincipal":{"shape":"PrincipalIdType"}, "IssuingAccount":{"shape":"PrincipalIdType"}, @@ -1729,6 +2128,12 @@ "Constraints":{"shape":"GrantConstraints"} } }, + "GrantNameType":{ + "type":"string", + "min":1, + "max":256, + "pattern":"^[a-zA-Z0-9:/_-]+$" + }, "GrantOperation":{ "type":"string", "enum":[ @@ -1739,7 +2144,8 @@ "ReEncryptFrom", "ReEncryptTo", "CreateGrant", - "RetireGrant" + "RetireGrant", + "DescribeKey" ] }, "GrantOperationList":{ @@ -1793,6 +2199,18 @@ }, "exception":true }, + "InvalidGrantIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "error":{ + "code":"InvalidGrantId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "InvalidGrantTokenException":{ "type":"structure", "members":{ @@ -1840,6 +2258,18 @@ }, "exception":true }, + "KMSInvalidStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "error":{ + "code":"KMSInvalidStateException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, "KeyIdType":{ "type":"string", "min":1, @@ -1866,9 +2296,19 @@ "CreationDate":{"shape":"DateType"}, "Enabled":{"shape":"BooleanType"}, "Description":{"shape":"DescriptionType"}, - "KeyUsage":{"shape":"KeyUsageType"} + "KeyUsage":{"shape":"KeyUsageType"}, + "KeyState":{"shape":"KeyState"}, + "DeletionDate":{"shape":"DateType"} } }, + "KeyState":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled", + "PendingDeletion" + ] + }, "KeyUnavailableException":{ "type":"structure", "members":{ @@ -1921,9 +2361,9 @@ "type":"structure", "required":["KeyId"], "members":{ - "KeyId":{"shape":"KeyIdType"}, "Limit":{"shape":"LimitType"}, - "Marker":{"shape":"MarkerType"} + "Marker":{"shape":"MarkerType"}, + "KeyId":{"shape":"KeyIdType"} } }, "ListGrantsResponse":{ @@ -1966,6 +2406,15 @@ "Truncated":{"shape":"BooleanType"} } }, + "ListRetirableGrantsRequest":{ + "type":"structure", + "required":["RetiringPrincipal"], + "members":{ + "Limit":{"shape":"LimitType"}, + "Marker":{"shape":"MarkerType"}, + "RetiringPrincipal":{"shape":"PrincipalIdType"} + } + }, "MalformedPolicyDocumentException":{ "type":"structure", "members":{ @@ -2001,6 +2450,11 @@ "min":1, "max":1024 }, + "PendingWindowInDaysType":{ + "type":"integer", + "min":1, + "max":365 + }, "PlaintextType":{ "type":"blob", "min":1, @@ -2082,6 +2536,21 @@ "GrantId":{"shape":"GrantIdType"} } }, + "ScheduleKeyDeletionRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{"shape":"KeyIdType"}, + "PendingWindowInDays":{"shape":"PendingWindowInDaysType"} + } + }, + "ScheduleKeyDeletionResponse":{ + "type":"structure", + "members":{ + "KeyId":{"shape":"KeyIdType"}, + "DeletionDate":{"shape":"DateType"} + } + }, "UnsupportedOperationException":{ "type":"structure", "members":{ diff --git a/aws-sdk-core/apis/kms/2014-11-01/docs-2.json b/aws-sdk-core/apis/kms/2014-11-01/docs-2.json index 591d0ee4506..348b2e51b0e 100644 --- a/aws-sdk-core/apis/kms/2014-11-01/docs-2.json +++ b/aws-sdk-core/apis/kms/2014-11-01/docs-2.json @@ -1,39 +1,42 @@ { "version": "2.0", "operations": { - "CreateAlias": "

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).

To associate an alias with a different key, call UpdateAlias.

Note that you cannot create or update an alias that represents a key in another account.

", - "CreateGrant": "

Adds a grant to a key to specify who can access the key and under what conditions. Grants are alternate permission mechanisms to key policies. For more information about grants, see Grants in the developer guide. If a grant is absent, access to the key is evaluated based on IAM policies attached to the user.

  1. ListGrants
  2. RetireGrant
  3. RevokeGrant

", + "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.

For more information about scheduling and canceling deletion of a CMK, go to Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

", + "CreateAlias": "

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": "

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": "

Creates a customer master key. Customer master keys can be used to encrypt small amounts of data (less than 4K) directly, but they are most commonly used to encrypt or envelope data keys that are then used to encrypt customer data. For more information about data keys, see GenerateDataKey and GenerateDataKeyWithoutPlaintext.

", "Decrypt": "

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.

", - "DeleteAlias": "

Deletes the specified alias. To associate an alias with a different key, call UpdateAlias.

", + "DeleteAlias": "

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

", "DescribeKey": "

Provides detailed information about the specified customer master key.

", - "DisableKey": "

Marks a key as disabled, thereby preventing its use.

", - "DisableKeyRotation": "Disables rotation of the specified key.", - "EnableKey": "Marks a key as enabled, thereby permitting its use. You can have up to 25 enabled keys at one time.", - "EnableKeyRotation": "Enables rotation of the specified customer master key.", + "DisableKey": "

Sets the state of a master key to disabled, thereby preventing its use for cryptographic operations. For more information about how key state affects the use of a master key, go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

", + "DisableKeyRotation": "

Disables rotation of the specified key.

", + "EnableKey": "

Marks a key as enabled, thereby permitting its use.

", + "EnableKeyRotation": "

Enables rotation of the specified customer master key.

", "Encrypt": "

Encrypts plaintext into ciphertext by using a customer master key. The Encrypt function has two primary use cases:

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.

", "GenerateDataKey": "

Generates a data key that you can use in your application to locally encrypt data. This call returns a plaintext version of the key in the Plaintext field of the response object and an encrypted copy of the key in the CiphertextBlob field. The key is encrypted by using the master key specified by the KeyId field. To decrypt the encrypted key, pass it to the Decrypt API.

We recommend that you use the following pattern to locally encrypt data: call the GenerateDataKey API, use the key returned in the Plaintext response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the CiphertextBlob field) alongside of the locally encrypted data.

You should not call the Encrypt function to re-encrypt your data keys within a region. GenerateDataKey always returns the data key encrypted and tied to the customer master key that will be used to decrypt it. There is no need to decrypt it twice.

If you decide to use the optional EncryptionContext parameter, you must also store the context in full or at least store enough information along with the encrypted data to be able to reconstruct the context when submitting the ciphertext to the Decrypt API. It is a good practice to choose a context that you can reconstruct on the fly to better secure the ciphertext. For more information about how this parameter is used, see Encryption Context.

To decrypt data, pass the encrypted data key to the Decrypt API. Decrypt uses the associated master key to decrypt the encrypted data key and returns it as plaintext. Use the plaintext data key to locally decrypt your data and then erase the key from memory. You must specify the encryption context, if any, that you specified when you generated the key. The encryption context is logged by CloudTrail, and you can use this log to help track the use of particular data.

", "GenerateDataKeyWithoutPlaintext": "

Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like GenerateDataKey. You can use this API to, for example, satisfy an audit requirement that an encrypted key be made available without exposing the plaintext copy of that key.

", "GenerateRandom": "

Generates an unpredictable byte string.

", "GetKeyPolicy": "

Retrieves a policy attached to the specified key.

", - "GetKeyRotationStatus": "Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.", + "GetKeyRotationStatus": "

Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.

", "ListAliases": "

Lists all of the key aliases in the account.

", "ListGrants": "

List the grants for a specified key.

", "ListKeyPolicies": "

Retrieves a list of policies attached to a key.

", "ListKeys": "

Lists the customer master keys.

", + "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 policy to the specified key.

", "ReEncrypt": "

Encrypts data on the server side with a new customer master key without exposing the plaintext of the data on the client side. The data is first decrypted and then encrypted. This operation can also be used to change the encryption context of a ciphertext.

Unlike other actions, ReEncrypt is authorized twice - once as ReEncryptFrom on the source key and once as ReEncryptTo on the destination key. We therefore recommend that you include the \"action\":\"kms:ReEncrypt*\" statement in your key policies to permit re-encryption from or to the key. The statement is included automatically when you authorize use of the key through the console but must be included manually when you set a policy by using the PutKeyPolicy function.

", "RetireGrant": "

Retires a grant. You can retire a grant when you're done using it to clean up. 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 grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant function.

", - "RevokeGrant": "Revokes a grant. You can revoke a grant to actively deny operations that depend on it.", - "UpdateAlias": "

Updates an alias to associate it with a different 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).

An alias is not a property of a key. Therefore, an alias can be associated with and disassociated from an existing key without changing the properties of the key.

Note that you cannot create or update an alias that represents a key in another account.

", + "RevokeGrant": "

Revokes a grant. You can revoke a grant to actively deny operations that depend on it.

", + "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 point 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, go to Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

", + "UpdateAlias": "

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": "

Updates the description of a key.

" }, - "service": "AWS Key Management Service

AWS Key Management Service (KMS) is an encryption and key management web service. This guide describes the KMS actions that you can call programmatically. For general information about 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 KMS and AWS. 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 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 access key ID and secret key for everyday work with 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 KMS operations require Signature Version 4.

Recording API Requests

KMS supports AWS CloudTrail, a service that records 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 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:

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.

", + "service": "AWS Key Management 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 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:

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.

", "shapes": { "AWSAccountIdType": { "base": null, "refs": { - "KeyMetadata$AWSAccountId": "

Account ID number.

" + "KeyMetadata$AWSAccountId": "

The twelve-digit account ID of the AWS account that owns the key.

" } }, "AliasList": { @@ -43,7 +46,7 @@ } }, "AliasListEntry": { - "base": "Contains information about an alias.", + "base": "

Contains information about an alias.

", "refs": { "AliasList$member": null } @@ -54,7 +57,7 @@ "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 modifed. 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": { @@ -67,18 +70,28 @@ "refs": { "AliasListEntry$AliasArn": "

String that contains the key ARN.

", "KeyListEntry$KeyArn": "

ARN of the key.

", - "KeyMetadata$Arn": "

Key ARN (Amazon Resource Name).

" + "KeyMetadata$Arn": "

The Amazon Resource Name (ARN) of the key. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

" } }, "BooleanType": { "base": null, "refs": { - "GetKeyRotationStatusResponse$KeyRotationEnabled": "A Boolean value that specifies whether key rotation is enabled.", - "KeyMetadata$Enabled": "

Value that specifies whether the key is enabled.

", - "ListAliasesResponse$Truncated": "

A flag that indicates whether there are more items in the list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more aliases in the list.

", - "ListGrantsResponse$Truncated": "

A flag that indicates whether there are more items in the list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more grants in the list.

", - "ListKeyPoliciesResponse$Truncated": "

A flag that indicates whether there are more items in the list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more policies in the list.

", - "ListKeysResponse$Truncated": "

A flag that indicates whether there are more items in the list. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more keys in the list.

" + "GetKeyRotationStatusResponse$KeyRotationEnabled": "

A Boolean value that specifies whether key rotation is enabled.

", + "KeyMetadata$Enabled": "

Specifies whether the key is enabled. When KeyState is Enabled this value is true, otherwise it is false.

", + "ListAliasesResponse$Truncated": "

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

", + "ListGrantsResponse$Truncated": "

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

", + "ListKeyPoliciesResponse$Truncated": "

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

", + "ListKeysResponse$Truncated": "

A flag that indicates whether there are more items in the list. If your results were truncated, you can use the Marker parameter to make a subsequent pagination request to retrieve more items in the list.

" + } + }, + "CancelKeyDeletionRequest": { + "base": null, + "refs": { + } + }, + "CancelKeyDeletionResponse": { + "base": null, + "refs": { } }, "CiphertextType": { @@ -127,7 +140,10 @@ "DateType": { "base": null, "refs": { - "KeyMetadata$CreationDate": "

Date the key was created.

" + "GrantListEntry$CreationDate": "

The date and time when the grant was created.

", + "KeyMetadata$CreationDate": "

The date and time when the key was created.

", + "KeyMetadata$DeletionDate": "

The date and time after which AWS KMS deletes the customer master key (CMK). This value is present only when KeyState is PendingDeletion, otherwise this value is null.

", + "ScheduleKeyDeletionResponse$DeletionDate": "

The date and time after which AWS KMS deletes the customer master key (CMK).

" } }, "DecryptRequest": { @@ -146,7 +162,7 @@ } }, "DependencyTimeoutException": { - "base": "

The system timed out while trying to fulfill the request.

", + "base": "

The system timed out while trying to fulfill the request. The request can be retried.

", "refs": { } }, @@ -164,7 +180,7 @@ "base": null, "refs": { "CreateKeyRequest$Description": "

Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task.

", - "KeyMetadata$Description": "

The description of the key.

", + "KeyMetadata$Description": "

The friendly description of the key.

", "UpdateKeyDescriptionRequest$Description": "

New description for the key.

" } }, @@ -179,7 +195,7 @@ } }, "DisabledException": { - "base": "

A request was rejected because the specified key was marked as disabled.

", + "base": "

The request was rejected because the specified key was marked as disabled.

", "refs": { } }, @@ -216,8 +232,8 @@ "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.

", "GenerateDataKeyRequest$EncryptionContext": "

Name/value pair that contains additional data to be authenticated during the encryption and decryption processes that use the key. This value is logged by AWS CloudTrail to provide context around the data encrypted by the key.

", "GenerateDataKeyWithoutPlaintextRequest$EncryptionContext": "

Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

", - "GrantConstraints$EncryptionContextSubset": "The constraint equals the full encryption context.", - "GrantConstraints$EncryptionContextEquals": "The constraint contains additional key/value pairs that serve to further limit the grant.", + "GrantConstraints$EncryptionContextSubset": "

Contains a list of key-value pairs, a subset of which must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list or is a subset of this list, the grant allows the operation. Otherwise, the operation is not allowed.

", + "GrantConstraints$EncryptionContextEquals": "

Contains a list of key-value pairs that must be present in the encryption context of a subsequent operation permitted by the grant. When a subsequent operation permitted by the grant includes an encryption context that matches this list, the grant allows the operation. Otherwise, the operation is not allowed.

", "ReEncryptRequest$SourceEncryptionContext": "

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

", "ReEncryptRequest$DestinationEncryptionContext": "

Encryption context to be used when the data is re-encrypted.

" } @@ -237,10 +253,12 @@ "InvalidAliasNameException$message": null, "InvalidArnException$message": null, "InvalidCiphertextException$message": null, + "InvalidGrantIdException$message": null, "InvalidGrantTokenException$message": null, "InvalidKeyUsageException$message": null, "InvalidMarkerException$message": null, "KMSInternalException$message": null, + "KMSInvalidStateException$message": null, "KeyUnavailableException$message": null, "LimitExceededException$message": null, "MalformedPolicyDocumentException$message": null, @@ -299,17 +317,17 @@ } }, "GrantConstraints": { - "base": "Contains constraints on the grant.", + "base": "

A structure for specifying the conditions under which the operations permitted by the grant are allowed.

You can use this structure to allow the operations permitted by the grant only when a specified encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide.

", "refs": { - "CreateGrantRequest$Constraints": "

Specifies the conditions under which the actions specified by the Operations parameter are allowed.

", - "GrantListEntry$Constraints": "

Specifies the conditions under which the actions specified by the Operations parameter are allowed.

" + "CreateGrantRequest$Constraints": "

The conditions under which the operations permitted by the grant are allowed.

You can use this value to allow the operations permitted by the grant only when a specified encryption context is present. For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

", + "GrantListEntry$Constraints": "

The conditions under which the grant's operations are allowed.

" } }, "GrantIdType": { "base": null, "refs": { - "CreateGrantResponse$GrantId": "

Unique grant identifier. You can use the GrantId value to revoke a grant.

", - "GrantListEntry$GrantId": "

Unique grant identifier.

", + "CreateGrantResponse$GrantId": "

The unique identifier for the grant.

You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.

", + "GrantListEntry$GrantId": "

The unique identifier for the grant.

", "RetireGrantRequest$GrantId": "

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

", "RevokeGrantRequest$GrantId": "

Identifier of the grant to be revoked.

" } @@ -321,11 +339,18 @@ } }, "GrantListEntry": { - "base": "

Contains information about each entry in the grant list.

", + "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.

", + "GrantListEntry$Name": "

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

" + } + }, "GrantOperation": { "base": null, "refs": { @@ -335,25 +360,26 @@ "GrantOperationList": { "base": null, "refs": { - "CreateGrantRequest$Operations": "

List of operations permitted by the grant. This can be any combination of one or more of the following values:

  1. Decrypt
  2. Encrypt
  3. GenerateDataKey
  4. GenerateDataKeyWithoutPlaintext
  5. ReEncryptFrom
  6. ReEncryptTo
  7. CreateGrant
  8. RetireGrant

", - "GrantListEntry$Operations": "

List of operations permitted by the grant. This can be any combination of one or more of the following values:

  1. Decrypt
  2. Encrypt
  3. GenerateDataKey
  4. GenerateDataKeyWithoutPlaintext
  5. ReEncryptFrom
  6. ReEncryptTo
  7. CreateGrant

" + "CreateGrantRequest$Operations": "

A list of operations that the grant permits. The list can contain any combination of one or more of the following values:

", + "GrantListEntry$Operations": "

The list of operations permitted by the grant.

" } }, "GrantTokenList": { "base": null, "refs": { - "CreateGrantRequest$GrantTokens": "

For more information, see Grant Tokens.

", - "DecryptRequest$GrantTokens": "

For more information, see Grant Tokens.

", - "EncryptRequest$GrantTokens": "

For more information, see Grant Tokens.

", - "GenerateDataKeyRequest$GrantTokens": "

For more information, see Grant Tokens.

", - "GenerateDataKeyWithoutPlaintextRequest$GrantTokens": "

For more information, see Grant Tokens.

", - "ReEncryptRequest$GrantTokens": "

For more information, see Grant Tokens.

" + "CreateGrantRequest$GrantTokens": "

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

", + "DecryptRequest$GrantTokens": "

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

", + "DescribeKeyRequest$GrantTokens": "

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

", + "EncryptRequest$GrantTokens": "

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

", + "GenerateDataKeyRequest$GrantTokens": "

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

", + "GenerateDataKeyWithoutPlaintextRequest$GrantTokens": "

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

", + "ReEncryptRequest$GrantTokens": "

A list of grant tokens.

For more information, go to Grant Tokens in the AWS Key Management Service Developer Guide.

" } }, "GrantTokenType": { "base": null, "refs": { - "CreateGrantResponse$GrantToken": "

For more information, see Grant Tokens.

", + "CreateGrantResponse$GrantToken": "

The grant token.

For more information about using grant tokens, see Grant Tokens in the AWS Key Management Service Developer Guide.

", "GrantTokenList$member": null, "RetireGrantRequest$GrantToken": "

Token that identifies the grant to be retired.

" } @@ -373,8 +399,13 @@ "refs": { } }, + "InvalidGrantIdException": { + "base": "

The request was rejected because the specified GrantId is not valid.

", + "refs": { + } + }, "InvalidGrantTokenException": { - "base": "

A grant token provided as part of the request is invalid.

", + "base": "

The request was rejected because a grant token provided as part of the request is invalid.

", "refs": { } }, @@ -389,7 +420,12 @@ } }, "KMSInternalException": { - "base": "

The request was rejected because an internal exception occurred. This error can be retried.

", + "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 customer master key (CMK), go to How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

", "refs": { } }, @@ -397,8 +433,10 @@ "base": null, "refs": { "AliasListEntry$TargetKeyId": "

String that contains the key identifier pointed to by the alias.

", + "CancelKeyDeletionRequest$KeyId": "

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:

To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

", + "CancelKeyDeletionResponse$KeyId": "

The unique identifier of the master key for which deletion is canceled.

", "CreateAliasRequest$TargetKeyId": "

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.

", - "CreateGrantRequest$KeyId": "

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

", + "CreateGrantRequest$KeyId": "

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:

", "DecryptResponse$KeyId": "

ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.

", "DescribeKeyRequest$KeyId": "

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/\".

", "DisableKeyRequest$KeyId": "

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

", @@ -413,8 +451,9 @@ "GenerateDataKeyWithoutPlaintextResponse$KeyId": "

System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.

", "GetKeyPolicyRequest$KeyId": "

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

", "GetKeyRotationStatusRequest$KeyId": "

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

", + "GrantListEntry$KeyId": "

The unique identifier for the customer master key (CMK) to which the grant applies.

", "KeyListEntry$KeyId": "

Unique identifier of the key.

", - "KeyMetadata$KeyId": "

Unique identifier for the key.

", + "KeyMetadata$KeyId": "

The globally unique identifier for the key.

", "ListGrantsRequest$KeyId": "

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

", "ListKeyPoliciesRequest$KeyId": "

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/\".

", "PutKeyPolicyRequest$KeyId": "

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

", @@ -423,7 +462,9 @@ "ReEncryptResponse$KeyId": "

Unique identifier of the key used to re-encrypt the data.

", "RetireGrantRequest$KeyId": "

A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the key.

", "RevokeGrantRequest$KeyId": "

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.

", - "UpdateAliasRequest$TargetKeyId": "

Unique identifier of the customer master key to be associated with the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

", + "ScheduleKeyDeletionRequest$KeyId": "

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:

To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

", + "ScheduleKeyDeletionResponse$KeyId": "

The unique identifier of the customer master key (CMK) for which deletion is scheduled.

", + "UpdateAliasRequest$TargetKeyId": "

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.

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

", "UpdateKeyDescriptionRequest$KeyId": "

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

" } }, @@ -440,14 +481,20 @@ } }, "KeyMetadata": { - "base": "Contains metadata associated with a specific key.", + "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 key.

", "DescribeKeyResponse$KeyMetadata": "

Metadata associated with the key.

" } }, + "KeyState": { + "base": null, + "refs": { + "KeyMetadata$KeyState": "

The state of the customer master key (CMK).

For more information about how key state affects the use of a CMK, go to 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 key was disabled, not found, or otherwise not available.

", + "base": "

The request was rejected because the key was not available. The request can be retried.

", "refs": { } }, @@ -455,21 +502,22 @@ "base": null, "refs": { "CreateKeyRequest$KeyUsage": "

Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported.

", - "KeyMetadata$KeyUsage": "

A value that specifies what operation(s) the key can perform.

" + "KeyMetadata$KeyUsage": "

The cryptographic operations for which you can use the key. Currently the only allowed value is ENCRYPT_DECRYPT, which means you can use the key for the Encrypt and Decrypt operations.

" } }, "LimitExceededException": { - "base": "

The request was rejected because a quota was exceeded.

", + "base": "

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": "

Specify this parameter when paginating results to indicate the maximum number of aliases you want in each response. If there are additional aliases beyond the maximum you specify, the Truncated response element will be set to true.

", - "ListGrantsRequest$Limit": "

Specify this parameter only when paginating results to indicate the maximum number of grants you want listed in the response. If there are additional grants beyond the maximum you specify, the Truncated response element will be set to true.

", - "ListKeyPoliciesRequest$Limit": "

Specify this parameter only when paginating results to indicate the maximum number of policies you want listed in the response. If there are additional policies beyond the maximum you specify, the Truncated response element will be set to true.

", - "ListKeysRequest$Limit": "

Specify this parameter only when paginating results to indicate the maximum number of keys you want listed in the response. If there are additional keys beyond the maximum you specify, the Truncated response element will be set to true.

" + "ListAliasesRequest$Limit": "

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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": "

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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": "

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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": "

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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.

", + "ListRetirableGrantsRequest$Limit": "

When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the Truncated element in the response is set to true.

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": { @@ -512,6 +560,11 @@ "refs": { } }, + "ListRetirableGrantsRequest": { + "base": null, + "refs": { + } + }, "MalformedPolicyDocumentException": { "base": "

The request was rejected because the specified policy is not syntactically or semantically correct.

", "refs": { @@ -520,14 +573,15 @@ "MarkerType": { "base": null, "refs": { - "ListAliasesRequest$Marker": "

Use this parameter when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker element in the response you just received.

", - "ListAliasesResponse$NextMarker": "

If Truncated is true, this value is present and contains the value to use for the Marker request parameter in a subsequent pagination request.

", - "ListGrantsRequest$Marker": "

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

", - "ListGrantsResponse$NextMarker": "

If Truncated is true, this value is present and contains the value to use for the Marker request parameter in a subsequent pagination request.

", - "ListKeyPoliciesRequest$Marker": "

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

", - "ListKeyPoliciesResponse$NextMarker": "

If Truncated is true, this value is present and contains the value to use for the Marker request parameter in a subsequent pagination request.

", - "ListKeysRequest$Marker": "

Use this parameter only when paginating results, and only in a subsequent request after you've received a response where the results are truncated. Set it to the value of the NextMarker in the response you just received.

", - "ListKeysResponse$NextMarker": "

If Truncated is true, this value is present and contains the value to use for the Marker request parameter in a subsequent pagination request.

" + "ListAliasesRequest$Marker": "

Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of NextMarker from the response you just received.

", + "ListAliasesResponse$NextMarker": "

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", + "ListGrantsRequest$Marker": "

Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of NextMarker from the response you just received.

", + "ListGrantsResponse$NextMarker": "

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", + "ListKeyPoliciesRequest$Marker": "

Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of NextMarker from the response you just received.

", + "ListKeyPoliciesResponse$NextMarker": "

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", + "ListKeysRequest$Marker": "

Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of NextMarker from the response you just received.

", + "ListKeysResponse$NextMarker": "

When Truncated is true, this value is present and contains the value to use for the Marker parameter in a subsequent pagination request.

", + "ListRetirableGrantsRequest$Marker": "

Use this parameter only when paginating results and only in a subsequent request after you've received a response with truncated results. Set it to the value of NextMarker from the response you just received.

" } }, "NotFoundException": { @@ -543,6 +597,12 @@ "GenerateRandomRequest$NumberOfBytes": "

Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. The current limit is 1024 bytes.

" } }, + "PendingWindowInDaysType": { + "base": null, + "refs": { + "ScheduleKeyDeletionRequest$PendingWindowInDays": "

The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

" + } + }, "PlaintextType": { "base": null, "refs": { @@ -569,19 +629,20 @@ "PolicyType": { "base": null, "refs": { - "CreateKeyRequest$Policy": "

Policy to be attached to the key. This is required and delegates back to the account. The key is the root of trust.

", + "CreateKeyRequest$Policy": "

Policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes).

", "GetKeyPolicyResponse$Policy": "

A policy document in JSON format.

", - "PutKeyPolicyRequest$Policy": "

The policy, in JSON format, to be attached to the key.

" + "PutKeyPolicyRequest$Policy": "

The policy to attach to the key. This is required and delegates back to the account. The key is the root of trust. The policy size limit is 32 KiB (32768 bytes).

" } }, "PrincipalIdType": { "base": null, "refs": { - "CreateGrantRequest$GranteePrincipal": "

Principal given permission by the grant to use the key identified by the keyId parameter.

", - "CreateGrantRequest$RetiringPrincipal": "

Principal given permission to retire the grant. For more information, see RetireGrant.

", - "GrantListEntry$GranteePrincipal": "

The principal that receives the grant permission.

", - "GrantListEntry$RetiringPrincipal": "

The principal that can retire the account.

", - "GrantListEntry$IssuingAccount": "

The account under which the grant was issued.

" + "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, 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, go to AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

" } }, "PutKeyPolicyRequest": { @@ -609,6 +670,16 @@ "refs": { } }, + "ScheduleKeyDeletionRequest": { + "base": null, + "refs": { + } + }, + "ScheduleKeyDeletionResponse": { + "base": null, + "refs": { + } + }, "UnsupportedOperationException": { "base": "

The request was rejected because a specified parameter is not supported.

", "refs": {