dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/kms/2014-11-01/service-2.json
TANIGUCHI Takaki ebf3d00fef Import python-botocore_1.3.9.orig.tar.gz
2015-11-24 20:34:53 +09:00

3206 lines
142 KiB
JSON
Raw Blame History

{
"version":"2.0",
"metadata":{
"apiVersion":"2014-11-01",
"endpointPrefix":"kms",
"jsonVersion":"1.1",
"serviceAbbreviation":"KMS",
"serviceFullName":"AWS Key Management Service",
"signatureVersion":"v4",
"targetPrefix":"TrentService",
"protocol":"json"
},
"documentation":"<fullname>AWS Key Management Service</fullname> <p>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 <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/\">AWS Key Management Service Developer Guide</a>.</p> <note> <p>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 <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note> <p>We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.</p> <p>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. </p> <p><b>Signing Requests</b></p> <p>Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you <i>do not</i> 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.</p> <p>All AWS KMS operations require <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p> <p><b>Logging API Requests</b></p> <p>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 <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/\">AWS CloudTrail User Guide</a>.</p> <p><b>Additional Resources</b></p> <p>For more information about credentials and request signing, see the following:</p> <ul> <li> <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html\">AWS Security Credentials</a> - This topic provides general information about the types of credentials used for accessing AWS. </li> <li> <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/\">AWS Security Token Service</a> - This guide describes how to create and use temporary security credentials. </li> <li> <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> - This set of topics walks you through the process of signing a request using an access key ID and a secret access key. </li> </ul> <p><b>Commonly Used APIs</b></p> <p> 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.</p> <ul> <li><a>Encrypt</a></li> <li><a>Decrypt</a></li> <li><a>GenerateDataKey</a></li> <li><a>GenerateDataKeyWithoutPlaintext</a></li> </ul>",
"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,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the <code>Disabled</code> state. To enable a CMK, use <a>EnableKey</a>.</p> <p>For more information about scheduling and canceling deletion of a CMK, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"CreateAlias":{
"name":"CreateAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateAliasRequest"},
"errors":[
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"AlreadyExistsException",
"error":{
"code":"AlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because it attempted to create a resource that already exists.</p>"
},
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidAliasNameException",
"error":{
"code":"InvalidAliasName",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified alias name is not valid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"LimitExceededException",
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a limit was exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/limits.html\">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>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). </p> <p>The alias and the key it is mapped to must be in the same AWS account and the same region.</p> <p>To map an alias to a different key, call <a>UpdateAlias</a>.</p>"
},
"CreateGrant":{
"name":"CreateGrant",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateGrantRequest"},
"output":{"shape":"CreateGrantResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DisabledException",
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"InvalidGrantTokenException",
"error":{
"code":"InvalidGrantToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a grant token provided as part of the request is invalid.</p>"
},
{
"shape":"LimitExceededException",
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a limit was exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/limits.html\">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>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.</p> <p>For more information about grants, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/grants.html\">Grants</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"CreateKey":{
"name":"CreateKey",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateKeyRequest"},
"output":{"shape":"CreateKeyResponse"},
"errors":[
{
"shape":"MalformedPolicyDocumentException",
"error":{
"code":"MalformedPolicyDocument",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified policy is not syntactically or semantically correct. </p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"UnsupportedOperationException",
"error":{
"code":"UnsupportedOperation",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified parameter is not supported.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"LimitExceededException",
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a limit was exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/limits.html\">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>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 <a>GenerateDataKey</a> and <a>GenerateDataKeyWithoutPlaintext</a>.</p>"
},
"Decrypt":{
"name":"Decrypt",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DecryptRequest"},
"output":{"shape":"DecryptResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DisabledException",
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
{
"shape":"InvalidCiphertextException",
"error":{
"code":"InvalidCiphertext",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.</p>"
},
{
"shape":"KeyUnavailableException",
"error":{
"code":"KeyUnavailable",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"<p>The request was rejected because the key was not available. The request can be retried.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidGrantTokenException",
"error":{
"code":"InvalidGrantToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a grant token provided as part of the request is invalid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following functions: <ul> <li><a>GenerateDataKey</a></li> <li><a>GenerateDataKeyWithoutPlaintext</a></li> <li><a>Encrypt</a></li> </ul> </p> <p>Note that if a caller has been granted access permissions to all keys (through, for example, IAM user policies that grant <code>Decrypt</code> 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 <code>Decrypt</code> access in an IAM user policy. Instead grant <code>Decrypt</code> access only in key policies. If you must grant <code>Decrypt</code> access in an IAM user policy, you should scope the resource to specific keys or to specific trusted accounts. </p>"
},
"DeleteAlias":{
"name":"DeleteAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteAliasRequest"},
"errors":[
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Deletes the specified alias. To map an alias to a different key, call <a>UpdateAlias</a>.</p>"
},
"DescribeKey":{
"name":"DescribeKey",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeKeyRequest"},
"output":{"shape":"DescribeKeyResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
}
],
"documentation":"<p>Provides detailed information about the specified customer master key.</p>"
},
"DisableKey":{
"name":"DisableKey",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableKeyRequest"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>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 <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"DisableKeyRotation":{
"name":"DisableKeyRotation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableKeyRotationRequest"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DisabledException",
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Disables rotation of the specified key.</p>"
},
"EnableKey":{
"name":"EnableKey",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableKeyRequest"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"LimitExceededException",
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a limit was exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/limits.html\">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Marks a key as enabled, thereby permitting its use.</p>"
},
"EnableKeyRotation":{
"name":"EnableKeyRotation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableKeyRotationRequest"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DisabledException",
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Enables rotation of the specified customer master key.</p>"
},
"Encrypt":{
"name":"Encrypt",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EncryptRequest"},
"output":{"shape":"EncryptResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DisabledException",
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
{
"shape":"KeyUnavailableException",
"error":{
"code":"KeyUnavailable",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"<p>The request was rejected because the key was not available. The request can be retried.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidKeyUsageException",
"error":{
"code":"InvalidKeyUsage",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </p>"
},
{
"shape":"InvalidGrantTokenException",
"error":{
"code":"InvalidGrantToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a grant token provided as part of the request is invalid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Encrypts plaintext into ciphertext by using a customer master key. The <code>Encrypt</code> function has two primary use cases: <ul> <li>You can encrypt up to 4 KB of arbitrary data such as an RSA key, a database password, or other sensitive customer information.</li> <li>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. </li> </ul> </p> <p>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 <a>GenerateDataKey</a> or <a>GenerateDataKeyWithoutPlaintext</a> function. Data keys don't need to be encrypted again by calling <code>Encrypt</code>. </p> <p>If you want to encrypt data locally in your application, you can use the <code>GenerateDataKey</code> function to return a plaintext data encryption key and a copy of the key encrypted under the customer master key (CMK) of your choosing. </p>"
},
"GenerateDataKey":{
"name":"GenerateDataKey",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GenerateDataKeyRequest"},
"output":{"shape":"GenerateDataKeyResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DisabledException",
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
{
"shape":"KeyUnavailableException",
"error":{
"code":"KeyUnavailable",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"<p>The request was rejected because the key was not available. The request can be retried.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidKeyUsageException",
"error":{
"code":"InvalidKeyUsage",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </p>"
},
{
"shape":"InvalidGrantTokenException",
"error":{
"code":"InvalidGrantToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a grant token provided as part of the request is invalid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>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 <code>Plaintext</code> field of the response object and an encrypted copy of the key in the <code>CiphertextBlob</code> field. The key is encrypted by using the master key specified by the <code>KeyId</code> field. To decrypt the encrypted key, pass it to the <code>Decrypt</code> API. </p> <p>We recommend that you use the following pattern to locally encrypt data: call the <code>GenerateDataKey</code> API, use the key returned in the <code>Plaintext</code> response field to locally encrypt data, and then erase the plaintext data key from memory. Store the encrypted data key (contained in the <code>CiphertextBlob</code> field) alongside of the locally encrypted data. </p> <note>You should not call the <code>Encrypt</code> function to re-encrypt your data keys within a region. <code>GenerateDataKey</code> 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. </note> <p>If you decide to use the optional <code>EncryptionContext</code> 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 <code>Decrypt</code> 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 <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html\">Encryption Context</a>. </p> <p>To decrypt data, pass the encrypted data key to the <code>Decrypt</code> API. <code>Decrypt</code> 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. </p>"
},
"GenerateDataKeyWithoutPlaintext":{
"name":"GenerateDataKeyWithoutPlaintext",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GenerateDataKeyWithoutPlaintextRequest"},
"output":{"shape":"GenerateDataKeyWithoutPlaintextResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DisabledException",
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
{
"shape":"KeyUnavailableException",
"error":{
"code":"KeyUnavailable",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"<p>The request was rejected because the key was not available. The request can be retried.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidKeyUsageException",
"error":{
"code":"InvalidKeyUsage",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </p>"
},
{
"shape":"InvalidGrantTokenException",
"error":{
"code":"InvalidGrantToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a grant token provided as part of the request is invalid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Returns a data key encrypted by a customer master key without the plaintext copy of that key. Otherwise, this API functions exactly like <a>GenerateDataKey</a>. 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. </p>"
},
"GenerateRandom":{
"name":"GenerateRandom",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GenerateRandomRequest"},
"output":{"shape":"GenerateRandomResponse"},
"errors":[
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
}
],
"documentation":"<p>Generates an unpredictable byte string. </p>"
},
"GetKeyPolicy":{
"name":"GetKeyPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetKeyPolicyRequest"},
"output":{"shape":"GetKeyPolicyResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Retrieves a policy attached to the specified key.</p>"
},
"GetKeyRotationStatus":{
"name":"GetKeyRotationStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetKeyRotationStatusRequest"},
"output":{"shape":"GetKeyRotationStatusResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Retrieves a Boolean value that indicates whether key rotation is enabled for the specified key.</p>"
},
"ListAliases":{
"name":"ListAliases",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListAliasesRequest"},
"output":{"shape":"ListAliasesResponse"},
"errors":[
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidMarkerException",
"error":{
"code":"InvalidMarker",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the marker that specifies where pagination should next begin is not valid. </p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
}
],
"documentation":"<p>Lists all of the key aliases in the account.</p>"
},
"ListGrants":{
"name":"ListGrants",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListGrantsRequest"},
"output":{"shape":"ListGrantsResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidMarkerException",
"error":{
"code":"InvalidMarker",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the marker that specifies where pagination should next begin is not valid. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>List the grants for a specified key.</p>"
},
"ListKeyPolicies":{
"name":"ListKeyPolicies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListKeyPoliciesRequest"},
"output":{"shape":"ListKeyPoliciesResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Retrieves a list of policies attached to a key.</p>"
},
"ListKeys":{
"name":"ListKeys",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListKeysRequest"},
"output":{"shape":"ListKeysResponse"},
"errors":[
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
}
],
"documentation":"<p>Lists the customer master keys.</p>"
},
"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,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidMarkerException",
"error":{
"code":"InvalidMarker",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the marker that specifies where pagination should next begin is not valid. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
}
],
"documentation":"<p>Returns a list of all grants for which the grant's <code>RetiringPrincipal</code> matches the one specified.</p> <p>A typical use is to list all grants that you are able to retire. To retire a grant, use <a>RetireGrant</a>.</p>"
},
"PutKeyPolicy":{
"name":"PutKeyPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutKeyPolicyRequest"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"MalformedPolicyDocumentException",
"error":{
"code":"MalformedPolicyDocument",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified policy is not syntactically or semantically correct. </p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"UnsupportedOperationException",
"error":{
"code":"UnsupportedOperation",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified parameter is not supported.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"LimitExceededException",
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a limit was exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/limits.html\">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Attaches a policy to the specified key.</p>"
},
"ReEncrypt":{
"name":"ReEncrypt",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ReEncryptRequest"},
"output":{"shape":"ReEncryptResponse"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DisabledException",
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
{
"shape":"InvalidCiphertextException",
"error":{
"code":"InvalidCiphertext",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.</p>"
},
{
"shape":"KeyUnavailableException",
"error":{
"code":"KeyUnavailable",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"<p>The request was rejected because the key was not available. The request can be retried.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidKeyUsageException",
"error":{
"code":"InvalidKeyUsage",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </p>"
},
{
"shape":"InvalidGrantTokenException",
"error":{
"code":"InvalidGrantToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a grant token provided as part of the request is invalid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>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. </p> <p>Unlike other actions, <code>ReEncrypt</code> is authorized twice - once as <code>ReEncryptFrom</code> on the source key and once as <code>ReEncryptTo</code> on the destination key. We therefore recommend that you include the <code>\"action\":\"kms:ReEncrypt*\"</code> 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 <a>PutKeyPolicy</a> function. </p>"
},
"RetireGrant":{
"name":"RetireGrant",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RetireGrantRequest"},
"errors":[
{
"shape":"InvalidGrantTokenException",
"error":{
"code":"InvalidGrantToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a grant token provided as part of the request is invalid.</p>"
},
{
"shape":"InvalidGrantIdException",
"error":{
"code":"InvalidGrantId",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>"
},
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>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: <ul> <li>The account that created the grant</li> <li>The <code>RetiringPrincipal</code>, if present</li> <li>The <code>GranteePrincipal</code>, if <code>RetireGrant</code> is a grantee operation</li> </ul> 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 <code>CreateGrant</code> function. </p>"
},
"RevokeGrant":{
"name":"RevokeGrant",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RevokeGrantRequest"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"InvalidGrantIdException",
"error":{
"code":"InvalidGrantId",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Revokes a grant. You can revoke a grant to actively deny operations that depend on it.</p>"
},
"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,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>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 <code>PendingDeletion</code>. Before the waiting period ends, you can use <a>CancelKeyDeletion</a> 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.</p> <important> <p>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 <a>DisableKey</a>.</p> </important> <p>For more information about scheduling a CMK for deletion, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\">Deleting Customer Master Keys</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"UpdateAlias":{
"name":"UpdateAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateAliasRequest"},
"errors":[
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Updates an alias to map it to a different key.</p> <p>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. </p> <p>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). </p> <p>The alias and the key it is mapped to must be in the same AWS account and the same region.</p>"
},
"UpdateKeyDescription":{
"name":"UpdateKeyDescription",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateKeyDescriptionRequest"},
"errors":[
{
"shape":"NotFoundException",
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
{
"shape":"InvalidArnException",
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
{
"shape":"DependencyTimeoutException",
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
{
"shape":"KMSInternalException",
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
{
"shape":"KMSInvalidStateException",
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
],
"documentation":"<p>Updates the description of a key.</p>"
}
},
"shapes":{
"AWSAccountIdType":{"type":"string"},
"AliasList":{
"type":"list",
"member":{"shape":"AliasListEntry"}
},
"AliasListEntry":{
"type":"structure",
"members":{
"AliasName":{
"shape":"AliasNameType",
"documentation":"<p>String that contains the alias.</p>"
},
"AliasArn":{
"shape":"ArnType",
"documentation":"<p>String that contains the key ARN.</p>"
},
"TargetKeyId":{
"shape":"KeyIdType",
"documentation":"<p>String that contains the key identifier pointed to by the alias.</p>"
}
},
"documentation":"<p>Contains information about an alias.</p>"
},
"AliasNameType":{
"type":"string",
"min":1,
"max":256,
"pattern":"^[a-zA-Z0-9:/_-]+$"
},
"AlreadyExistsException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"AlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because it attempted to create a resource that already exists.</p>"
},
"ArnType":{
"type":"string",
"min":20,
"max":2048
},
"BooleanType":{"type":"boolean"},
"CancelKeyDeletionRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The unique identifier for the customer master key (CMK) for which to cancel deletion.</p> <p>To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul> <li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li> <li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li> </ul> </p> <p>To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>"
}
}
},
"CancelKeyDeletionResponse":{
"type":"structure",
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The unique identifier of the master key for which deletion is canceled.</p>"
}
}
},
"CiphertextType":{
"type":"blob",
"min":1,
"max":6144
},
"CreateAliasRequest":{
"type":"structure",
"required":[
"AliasName",
"TargetKeyId"
],
"members":{
"AliasName":{
"shape":"AliasNameType",
"documentation":"<p>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. </p>"
},
"TargetKeyId":{
"shape":"KeyIdType",
"documentation":"<p>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. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
}
}
},
"CreateGrantRequest":{
"type":"structure",
"required":[
"KeyId",
"GranteePrincipal"
],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The unique identifier for the customer master key (CMK) that the grant applies to.</p> <p>To specify this value, use the globally unique key ID or the Amazon Resource Name (ARN) of the key. Examples: <ul> <li>Globally unique key ID: 12345678-1234-1234-1234-123456789012</li> <li>Key ARN: arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012</li> </ul> </p>"
},
"GranteePrincipal":{
"shape":"PrincipalIdType",
"documentation":"<p>The principal that is given permission to perform the operations that the grant permits.</p> <p>To specify the principal, use the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> 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 <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam\">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>AWS General Reference</i>.</p>"
},
"RetiringPrincipal":{
"shape":"PrincipalIdType",
"documentation":"<p>The principal that is given permission to retire the grant by using <a>RetireGrant</a> operation.</p> <p>To specify the principal, use the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> 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 <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam\">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>AWS General Reference</i>.</p>"
},
"Operations":{
"shape":"GrantOperationList",
"documentation":"<p>A list of operations that the grant permits. The list can contain any combination of one or more of the following values: <ul> <li>Decrypt</li> <li>Encrypt</li> <li>GenerateDataKey</li> <li>GenerateDataKeyWithoutPlaintext</li> <li>ReEncryptFrom</li> <li>ReEncryptTo</li> <li>CreateGrant</li> <li>RetireGrant</li> </ul> </p>"
},
"Constraints":{
"shape":"GrantConstraints",
"documentation":"<p>The conditions under which the operations permitted by the grant are allowed.</p> <p>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 <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
"documentation":"<p>A list of grant tokens.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token\">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"Name":{
"shape":"GrantNameType",
"documentation":"<p>A friendly name for identifying the grant. Use this value to prevent unintended creation of duplicate grants when retrying this request.</p> <p>When this value is absent, all <code>CreateGrant</code> requests result in a new grant with a unique <code>GrantId</code> even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the <code>CreateGrant</code> request.</p> <p>When this value is present, you can retry a <code>CreateGrant</code> request with identical parameters; if the grant already exists, the original <code>GrantId</code> is returned without creating a new grant. Note that the returned grant token is unique with every <code>CreateGrant</code> request, even when a duplicate <code>GrantId</code> is returned. All grant tokens obtained in this way can be used interchangeably.</p>"
}
}
},
"CreateGrantResponse":{
"type":"structure",
"members":{
"GrantToken":{
"shape":"GrantTokenType",
"documentation":"<p>The grant token.</p> <p>For more information about using grant tokens, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token\">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>. </p>"
},
"GrantId":{
"shape":"GrantIdType",
"documentation":"<p>The unique identifier for the grant.</p> <p>You can use the <code>GrantId</code> in a subsequent <a>RetireGrant</a> or <a>RevokeGrant</a> operation.</p>"
}
}
},
"CreateKeyRequest":{
"type":"structure",
"members":{
"Policy":{
"shape":"PolicyType",
"documentation":"<p>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). </p>"
},
"Description":{
"shape":"DescriptionType",
"documentation":"<p>Description of the key. We recommend that you choose a description that helps your customer decide whether the key is appropriate for a task. </p>"
},
"KeyUsage":{
"shape":"KeyUsageType",
"documentation":"<p>Specifies the intended use of the key. Currently this defaults to ENCRYPT/DECRYPT, and only symmetric encryption and decryption are supported. </p>"
}
}
},
"CreateKeyResponse":{
"type":"structure",
"members":{
"KeyMetadata":{
"shape":"KeyMetadata",
"documentation":"<p>Metadata associated with the key.</p>"
}
}
},
"DataKeySpec":{
"type":"string",
"enum":[
"AES_256",
"AES_128"
]
},
"DateType":{"type":"timestamp"},
"DecryptRequest":{
"type":"structure",
"required":["CiphertextBlob"],
"members":{
"CiphertextBlob":{
"shape":"CiphertextType",
"documentation":"<p>Ciphertext to be decrypted. The blob includes metadata.</p>"
},
"EncryptionContext":{
"shape":"EncryptionContextType",
"documentation":"<p>The encryption context. If this was specified in the <a>Encrypt</a> function, it must be specified here or the decryption operation will fail. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html\">Encryption Context</a>. </p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
"documentation":"<p>A list of grant tokens.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token\">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
}
},
"DecryptResponse":{
"type":"structure",
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation. </p>"
},
"Plaintext":{
"shape":"PlaintextType",
"documentation":"<p>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.</p>"
}
}
},
"DeleteAliasRequest":{
"type":"structure",
"required":["AliasName"],
"members":{
"AliasName":{
"shape":"AliasNameType",
"documentation":"<p>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.</p>"
}
}
},
"DependencyTimeoutException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"DependencyTimeout",
"httpStatusCode":503
},
"exception":true,
"fault":true,
"documentation":"<p>The system timed out while trying to fulfill the request. The request can be retried.</p>"
},
"DescribeKeyRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>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/\". <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> <li>Alias Name Example - alias/MyAliasName</li> </ul> </p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
"documentation":"<p>A list of grant tokens.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token\">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
}
},
"DescribeKeyResponse":{
"type":"structure",
"members":{
"KeyMetadata":{
"shape":"KeyMetadata",
"documentation":"<p>Metadata associated with the key.</p>"
}
}
},
"DescriptionType":{
"type":"string",
"min":0,
"max":8192
},
"DisableKeyRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
}
}
},
"DisableKeyRotationRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
}
}
},
"DisabledException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"Disabled",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified key was marked as disabled.</p>"
},
"EnableKeyRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
}
}
},
"EnableKeyRotationRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
}
}
},
"EncryptRequest":{
"type":"structure",
"required":[
"KeyId",
"Plaintext"
],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>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/\". <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> <li>Alias Name Example - alias/MyAliasName</li> </ul> </p>"
},
"Plaintext":{
"shape":"PlaintextType",
"documentation":"<p>Data to be encrypted.</p>"
},
"EncryptionContext":{
"shape":"EncryptionContextType",
"documentation":"<p>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 <code>Decrypt</code> API or decryption will fail. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html\">Encryption Context</a>. </p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
"documentation":"<p>A list of grant tokens.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token\">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
}
},
"EncryptResponse":{
"type":"structure",
"members":{
"CiphertextBlob":{
"shape":"CiphertextType",
"documentation":"<p>The encrypted plaintext. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.</p>"
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The ID of the key used during encryption.</p>"
}
}
},
"EncryptionContextKey":{"type":"string"},
"EncryptionContextType":{
"type":"map",
"key":{"shape":"EncryptionContextKey"},
"value":{"shape":"EncryptionContextValue"}
},
"EncryptionContextValue":{"type":"string"},
"ErrorMessageType":{"type":"string"},
"GenerateDataKeyRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>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/\". <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> <li>Alias Name Example - alias/MyAliasName</li> </ul> </p>"
},
"EncryptionContext":{
"shape":"EncryptionContextType",
"documentation":"<p>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. </p>"
},
"NumberOfBytes":{
"shape":"NumberOfBytesType",
"documentation":"<p>Integer that contains the number of bytes to generate. Common values are 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you use the <code>KeySpec</code> parameter instead. </p>"
},
"KeySpec":{
"shape":"DataKeySpec",
"documentation":"<p>Value that identifies the encryption algorithm and key size to generate a data key for. Currently this can be AES_128 or AES_256. </p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
"documentation":"<p>A list of grant tokens.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token\">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
}
},
"GenerateDataKeyResponse":{
"type":"structure",
"members":{
"CiphertextBlob":{
"shape":"CiphertextType",
"documentation":"<p>Ciphertext that contains the encrypted data key. You must store the blob and enough information to reconstruct the encryption context so that the data encrypted by using the key can later be decrypted. You must provide both the ciphertext blob and the encryption context to the <a>Decrypt</a> API to recover the plaintext data key and decrypt the object. </p> <p>If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.</p>"
},
"Plaintext":{
"shape":"PlaintextType",
"documentation":"<p>Plaintext that contains the data key. Use this for encryption and decryption and then remove it from memory as soon as possible. </p>"
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.</p>"
}
}
},
"GenerateDataKeyWithoutPlaintextRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>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/\". <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> <li>Alias Name Example - alias/MyAliasName</li> </ul> </p>"
},
"EncryptionContext":{
"shape":"EncryptionContextType",
"documentation":"<p>Name:value pair that contains additional data to be authenticated during the encryption and decryption processes. </p>"
},
"KeySpec":{
"shape":"DataKeySpec",
"documentation":"<p>Value that identifies the encryption algorithm and key size. Currently this can be AES_128 or AES_256. </p>"
},
"NumberOfBytes":{
"shape":"NumberOfBytesType",
"documentation":"<p>Integer that contains the number of bytes to generate. Common values are 128, 256, 512, 1024 and so on. We recommend that you use the <code>KeySpec</code> parameter instead. </p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
"documentation":"<p>A list of grant tokens.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token\">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
}
},
"GenerateDataKeyWithoutPlaintextResponse":{
"type":"structure",
"members":{
"CiphertextBlob":{
"shape":"CiphertextType",
"documentation":"<p>Ciphertext that contains the wrapped data key. You must store the blob and encryption context so that the key can be used in a future decrypt operation. </p> <p>If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded. </p>"
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.</p>"
}
}
},
"GenerateRandomRequest":{
"type":"structure",
"members":{
"NumberOfBytes":{
"shape":"NumberOfBytesType",
"documentation":"<p>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. </p>"
}
}
},
"GenerateRandomResponse":{
"type":"structure",
"members":{
"Plaintext":{
"shape":"PlaintextType",
"documentation":"<p>Plaintext that contains the unpredictable byte string.</p>"
}
}
},
"GetKeyPolicyRequest":{
"type":"structure",
"required":[
"KeyId",
"PolicyName"
],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
},
"PolicyName":{
"shape":"PolicyNameType",
"documentation":"<p>String that contains the name of the policy. Currently, this must be \"default\". Policy names can be discovered by calling <a>ListKeyPolicies</a>. </p>"
}
}
},
"GetKeyPolicyResponse":{
"type":"structure",
"members":{
"Policy":{
"shape":"PolicyType",
"documentation":"<p>A policy document in JSON format.</p>"
}
}
},
"GetKeyRotationStatusRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
}
}
},
"GetKeyRotationStatusResponse":{
"type":"structure",
"members":{
"KeyRotationEnabled":{
"shape":"BooleanType",
"documentation":"<p>A Boolean value that specifies whether key rotation is enabled.</p>"
}
}
},
"GrantConstraints":{
"type":"structure",
"members":{
"EncryptionContextSubset":{
"shape":"EncryptionContextType",
"documentation":"<p>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.</p>"
},
"EncryptionContextEquals":{
"shape":"EncryptionContextType",
"documentation":"<p>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.</p>"
}
},
"documentation":"<p>A structure for specifying the conditions under which the operations permitted by the grant are allowed.</p> <p>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 <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/encrypt-context.html\">Encryption Context</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"GrantIdType":{
"type":"string",
"min":1,
"max":128
},
"GrantList":{
"type":"list",
"member":{"shape":"GrantListEntry"}
},
"GrantListEntry":{
"type":"structure",
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The unique identifier for the customer master key (CMK) to which the grant applies.</p>"
},
"GrantId":{
"shape":"GrantIdType",
"documentation":"<p>The unique identifier for the grant.</p>"
},
"Name":{
"shape":"GrantNameType",
"documentation":"<p>The friendly name that identifies the grant. If a name was provided in the <a>CreateGrant</a> request, that name is returned. Otherwise this value is null.</p>"
},
"CreationDate":{
"shape":"DateType",
"documentation":"<p>The date and time when the grant was created.</p>"
},
"GranteePrincipal":{
"shape":"PrincipalIdType",
"documentation":"<p>The principal that receives the grant's permissions.</p>"
},
"RetiringPrincipal":{
"shape":"PrincipalIdType",
"documentation":"<p>The principal that can retire the grant.</p>"
},
"IssuingAccount":{
"shape":"PrincipalIdType",
"documentation":"<p>The AWS account under which the grant was issued.</p>"
},
"Operations":{
"shape":"GrantOperationList",
"documentation":"<p>The list of operations permitted by the grant.</p>"
},
"Constraints":{
"shape":"GrantConstraints",
"documentation":"<p>The conditions under which the grant's operations are allowed.</p>"
}
},
"documentation":"<p>Contains information about an entry in a list of grants.</p>"
},
"GrantNameType":{
"type":"string",
"min":1,
"max":256,
"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"},
"min":0,
"max":10
},
"GrantTokenType":{
"type":"string",
"min":1,
"max":8192
},
"InvalidAliasNameException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"InvalidAliasName",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified alias name is not valid.</p>"
},
"InvalidArnException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"InvalidArn",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified ARN was not valid.</p>"
},
"InvalidCiphertextException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"InvalidCiphertext",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified ciphertext has been corrupted or is otherwise invalid.</p>"
},
"InvalidGrantIdException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"InvalidGrantId",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified <code>GrantId</code> is not valid.</p>"
},
"InvalidGrantTokenException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"InvalidGrantToken",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a grant token provided as part of the request is invalid.</p>"
},
"InvalidKeyUsageException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"InvalidKeyUsage",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified KeySpec parameter is not valid. The currently supported value is ENCRYPT/DECRYPT. </p>"
},
"InvalidMarkerException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"InvalidMarker",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the marker that specifies where pagination should next begin is not valid. </p>"
},
"KMSInternalException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"KMSInternal",
"httpStatusCode":500
},
"exception":true,
"documentation":"<p>The request was rejected because an internal exception occurred. The request can be retried.</p>"
},
"KMSInvalidStateException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"KMSInvalidStateException",
"httpStatusCode":409,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the state of the specified resource is not valid for this request.</p> <p>For more information about how key state affects the use of a customer master key (CMK), go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"KeyIdType":{
"type":"string",
"min":1,
"max":256
},
"KeyList":{
"type":"list",
"member":{"shape":"KeyListEntry"}
},
"KeyListEntry":{
"type":"structure",
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>Unique identifier of the key.</p>"
},
"KeyArn":{
"shape":"ArnType",
"documentation":"<p>ARN of the key.</p>"
}
},
"documentation":"<p>Contains information about each entry in the key list.</p>"
},
"KeyMetadata":{
"type":"structure",
"required":["KeyId"],
"members":{
"AWSAccountId":{
"shape":"AWSAccountIdType",
"documentation":"<p>The twelve-digit account ID of the AWS account that owns the key.</p>"
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The globally unique identifier for the key.</p>"
},
"Arn":{
"shape":"ArnType",
"documentation":"<p>The Amazon Resource Name (ARN) of the key. For examples, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms\">AWS Key Management Service (AWS KMS)</a> in the Example ARNs section of the <i>AWS General Reference</i>.</p>"
},
"CreationDate":{
"shape":"DateType",
"documentation":"<p>The date and time when the key was created.</p>"
},
"Enabled":{
"shape":"BooleanType",
"documentation":"<p>Specifies whether the key is enabled. When <code>KeyState</code> is <code>Enabled</code> this value is true, otherwise it is false.</p>"
},
"Description":{
"shape":"DescriptionType",
"documentation":"<p>The friendly description of the key.</p>"
},
"KeyUsage":{
"shape":"KeyUsageType",
"documentation":"<p>The cryptographic operations for which you can use the key. Currently the only allowed value is <code>ENCRYPT_DECRYPT</code>, which means you can use the key for the <a>Encrypt</a> and <a>Decrypt</a> operations.</p>"
},
"KeyState":{
"shape":"KeyState",
"documentation":"<p>The state of the customer master key (CMK).</p> <p>For more information about how key state affects the use of a CMK, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects the Use of a Customer Master Key</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"DeletionDate":{
"shape":"DateType",
"documentation":"<p>The date and time after which AWS KMS deletes the customer master key (CMK). This value is present only when <code>KeyState</code> is <code>PendingDeletion</code>, otherwise this value is null.</p>"
}
},
"documentation":"<p>Contains metadata about a customer master key (CMK).</p> <p>This data type is used as a response element for the <a>CreateKey</a> and <a>DescribeKey</a> operations.</p>"
},
"KeyState":{
"type":"string",
"enum":[
"Enabled",
"Disabled",
"PendingDeletion"
]
},
"KeyUnavailableException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"KeyUnavailable",
"httpStatusCode":500
},
"exception":true,
"fault":true,
"documentation":"<p>The request was rejected because the key was not available. The request can be retried.</p>"
},
"KeyUsageType":{
"type":"string",
"enum":["ENCRYPT_DECRYPT"]
},
"LimitExceededException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"LimitExceeded",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a limit was exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/limits.html\">Limits</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
},
"LimitType":{
"type":"integer",
"min":1,
"max":1000
},
"ListAliasesRequest":{
"type":"structure",
"members":{
"Limit":{
"shape":"LimitType",
"documentation":"<p>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</p><p>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.</p>"
},
"Marker":{
"shape":"MarkerType",
"documentation":"<p>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 <code>NextMarker</code> from the response you just received.</p>"
}
}
},
"ListAliasesResponse":{
"type":"structure",
"members":{
"Aliases":{
"shape":"AliasList",
"documentation":"<p>A list of key aliases in the user's account.</p>"
},
"NextMarker":{
"shape":"MarkerType",
"documentation":"<p>When <code>Truncated</code> is true, this value is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>"
},
"Truncated":{
"shape":"BooleanType",
"documentation":"<p>A flag that indicates whether there are more items in the list. If your results were truncated, you can use the <code>Marker</code> parameter to make a subsequent pagination request to retrieve more items in the list.</p>"
}
}
},
"ListGrantsRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"Limit":{
"shape":"LimitType",
"documentation":"<p>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</p><p>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.</p>"
},
"Marker":{
"shape":"MarkerType",
"documentation":"<p>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 <code>NextMarker</code> from the response you just received.</p>"
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
}
}
},
"ListGrantsResponse":{
"type":"structure",
"members":{
"Grants":{
"shape":"GrantList",
"documentation":"<p>A list of grants.</p>"
},
"NextMarker":{
"shape":"MarkerType",
"documentation":"<p>When <code>Truncated</code> is true, this value is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>"
},
"Truncated":{
"shape":"BooleanType",
"documentation":"<p>A flag that indicates whether there are more items in the list. If your results were truncated, you can use the <code>Marker</code> parameter to make a subsequent pagination request to retrieve more items in the list.</p>"
}
}
},
"ListKeyPoliciesRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>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/\". <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> <li>Alias Name Example - alias/MyAliasName</li> </ul> </p>"
},
"Limit":{
"shape":"LimitType",
"documentation":"<p>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</p><p>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.</p><p>Currently only 1 policy can be attached to a key.</p>"
},
"Marker":{
"shape":"MarkerType",
"documentation":"<p>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 <code>NextMarker</code> from the response you just received.</p>"
}
}
},
"ListKeyPoliciesResponse":{
"type":"structure",
"members":{
"PolicyNames":{
"shape":"PolicyNameList",
"documentation":"<p>A list of policy names. Currently, there is only one policy and it is named \"Default\".</p>"
},
"NextMarker":{
"shape":"MarkerType",
"documentation":"<p>When <code>Truncated</code> is true, this value is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>"
},
"Truncated":{
"shape":"BooleanType",
"documentation":"<p>A flag that indicates whether there are more items in the list. If your results were truncated, you can use the <code>Marker</code> parameter to make a subsequent pagination request to retrieve more items in the list.</p>"
}
}
},
"ListKeysRequest":{
"type":"structure",
"members":{
"Limit":{
"shape":"LimitType",
"documentation":"<p>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</p><p>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.</p>"
},
"Marker":{
"shape":"MarkerType",
"documentation":"<p>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 <code>NextMarker</code> from the response you just received.</p>"
}
}
},
"ListKeysResponse":{
"type":"structure",
"members":{
"Keys":{
"shape":"KeyList",
"documentation":"<p>A list of keys.</p>"
},
"NextMarker":{
"shape":"MarkerType",
"documentation":"<p>When <code>Truncated</code> is true, this value is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>"
},
"Truncated":{
"shape":"BooleanType",
"documentation":"<p>A flag that indicates whether there are more items in the list. If your results were truncated, you can use the <code>Marker</code> parameter to make a subsequent pagination request to retrieve more items in the list.</p>"
}
}
},
"ListRetirableGrantsRequest":{
"type":"structure",
"required":["RetiringPrincipal"],
"members":{
"Limit":{
"shape":"LimitType",
"documentation":"<p>When paginating results, specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>Truncated</code> element in the response is set to true.</p><p>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.</p>"
},
"Marker":{
"shape":"MarkerType",
"documentation":"<p>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 <code>NextMarker</code> from the response you just received.</p>"
},
"RetiringPrincipal":{
"shape":"PrincipalIdType",
"documentation":"<p>The retiring principal for which to list grants.</p> <p>To specify the retiring principal, use the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> 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 <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam\">AWS Identity and Access Management (IAM)</a> in the Example ARNs section of the <i>Amazon Web Services General Reference</i>.</p>"
}
}
},
"MalformedPolicyDocumentException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"MalformedPolicyDocument",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified policy is not syntactically or semantically correct. </p>"
},
"MarkerType":{
"type":"string",
"min":1,
"max":320,
"pattern":"[\\u0020-\\u00FF]*"
},
"NotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"NotFound",
"httpStatusCode":404,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because the specified entity or resource could not be found. </p>"
},
"NumberOfBytesType":{
"type":"integer",
"min":1,
"max":1024
},
"PendingWindowInDaysType":{
"type":"integer",
"min":1,
"max":365
},
"PlaintextType":{
"type":"blob",
"min":1,
"max":4096,
"sensitive":true
},
"PolicyNameList":{
"type":"list",
"member":{"shape":"PolicyNameType"}
},
"PolicyNameType":{
"type":"string",
"min":1,
"max":128,
"pattern":"[\\w]+"
},
"PolicyType":{
"type":"string",
"min":1,
"max":131072,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+"
},
"PrincipalIdType":{
"type":"string",
"min":1,
"max":256
},
"PutKeyPolicyRequest":{
"type":"structure",
"required":[
"KeyId",
"PolicyName",
"Policy"
],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
},
"PolicyName":{
"shape":"PolicyNameType",
"documentation":"<p>Name of the policy to be attached. Currently, the only supported name is \"default\".</p>"
},
"Policy":{
"shape":"PolicyType",
"documentation":"<p>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). </p>"
}
}
},
"ReEncryptRequest":{
"type":"structure",
"required":[
"CiphertextBlob",
"DestinationKeyId"
],
"members":{
"CiphertextBlob":{
"shape":"CiphertextType",
"documentation":"<p>Ciphertext of the data to re-encrypt.</p>"
},
"SourceEncryptionContext":{
"shape":"EncryptionContextType",
"documentation":"<p>Encryption context used to encrypt and decrypt the data specified in the <code>CiphertextBlob</code> parameter. </p>"
},
"DestinationKeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key used to re-encrypt 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/\". <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> <li>Alias Name Example - alias/MyAliasName</li> </ul> </p>"
},
"DestinationEncryptionContext":{
"shape":"EncryptionContextType",
"documentation":"<p>Encryption context to be used when the data is re-encrypted.</p>"
},
"GrantTokens":{
"shape":"GrantTokenList",
"documentation":"<p>A list of grant tokens.</p> <p>For more information, go to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token\">Grant Tokens</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>"
}
}
},
"ReEncryptResponse":{
"type":"structure",
"members":{
"CiphertextBlob":{
"shape":"CiphertextType",
"documentation":"<p>The re-encrypted data. If you are using the CLI, the value is Base64 encoded. Otherwise, it is not encoded.</p>"
},
"SourceKeyId":{
"shape":"KeyIdType",
"documentation":"<p>Unique identifier of the key used to originally encrypt the data.</p>"
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>Unique identifier of the key used to re-encrypt the data.</p>"
}
}
},
"RetireGrantRequest":{
"type":"structure",
"members":{
"GrantToken":{
"shape":"GrantTokenType",
"documentation":"<p>Token that identifies the grant to be retired.</p>"
},
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>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. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
},
"GrantId":{
"shape":"GrantIdType",
"documentation":"<p> Unique identifier of the grant to be retired. The grant ID is returned by the <code>CreateGrant</code> function. <ul> <li>Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123</li> </ul> </p>"
}
}
},
"RevokeGrantRequest":{
"type":"structure",
"required":[
"KeyId",
"GrantId"
],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>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. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
},
"GrantId":{
"shape":"GrantIdType",
"documentation":"<p>Identifier of the grant to be revoked.</p>"
}
}
},
"ScheduleKeyDeletionRequest":{
"type":"structure",
"required":["KeyId"],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The unique identifier for the customer master key (CMK) to delete.</p> <p>To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples: <ul> <li>Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab</li> <li>Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</li> </ul> </p> <p>To obtain the unique key ID and key ARN for a given CMK, use <a>ListKeys</a> or <a>DescribeKey</a>.</p>"
},
"PendingWindowInDays":{
"shape":"PendingWindowInDaysType",
"documentation":"<p>The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).</p> <p>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.</p>"
}
}
},
"ScheduleKeyDeletionResponse":{
"type":"structure",
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>The unique identifier of the customer master key (CMK) for which deletion is scheduled.</p>"
},
"DeletionDate":{
"shape":"DateType",
"documentation":"<p>The date and time after which AWS KMS deletes the customer master key (CMK).</p>"
}
}
},
"UnsupportedOperationException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessageType"}
},
"error":{
"code":"UnsupportedOperation",
"httpStatusCode":400,
"senderFault":true
},
"exception":true,
"documentation":"<p>The request was rejected because a specified parameter is not supported.</p>"
},
"UpdateAliasRequest":{
"type":"structure",
"required":[
"AliasName",
"TargetKeyId"
],
"members":{
"AliasName":{
"shape":"AliasNameType",
"documentation":"<p>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.</p>"
},
"TargetKeyId":{
"shape":"KeyIdType",
"documentation":"<p>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. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p> <p>You can call <a>ListAliases</a> to verify that the alias is mapped to the correct <code>TargetKeyId</code>.</p>"
}
}
},
"UpdateKeyDescriptionRequest":{
"type":"structure",
"required":[
"KeyId",
"Description"
],
"members":{
"KeyId":{
"shape":"KeyIdType",
"documentation":"<p>A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key. <ul> <li>Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</li> <li>Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012</li> </ul> </p>"
},
"Description":{
"shape":"DescriptionType",
"documentation":"<p>New description for the key.</p>"
}
}
}
},
"examples":{
}
}
Reference in a new issue View git blame Copy permalink