openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 157 kB

JSON

{"openapi":"3.0.0","info":{"version":"2014-11-01","x-release":"v4","title":"AWS Key Management Service","description":"<fullname>AWS Key Management Service</fullname> 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>. <note> AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, 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>. </note> We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS. Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes. Signing Requests Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests. All AWS KMS operations require <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. Logging API Requests AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/\">AWS CloudTrail User Guide</a>. Additional Resources For more information about credentials and request signing, see the following: <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 of credentials used for accessing AWS. </li> <li> <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html\">Temporary Security Credentials</a> - This section of the IAM User Guide describes how to create and use temporary security credentials. </li> <li> <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</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> Commonly Used APIs Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console. <ul> <li> <a>Encrypt</a> </li> <li> <a>Decrypt</a> </li> <li> <a>GenerateDataKey</a> </li> <li> <a>GenerateDataKeyWithoutPlaintext</a> </li> </ul>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"kms","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/kms-2014-11-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/kms/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/":{"post":{"operationId":"CancelKeyDeletion","description":"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>. You cannot perform this operation on a CMK in a different AWS account. For more information about scheduling and canceling deletion of a CMK, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html\">Deleting Customer Master Keys</a> in the AWS Key Management Service Developer Guide. The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelKeyDeletionResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"483":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"484":{"description":"KMSInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInvalidStateException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelKeyDeletionRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#ConnectCustomKeyStore":{"post":{"operationId":"ConnectCustomKeyStore","description":"Connects or reconnects a <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html\">custom key store</a> to its associated AWS CloudHSM cluster. The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time. To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters\">DescribeClusters</a> operation. To add HSMs to the cluster, use the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_CreateHsm\">CreateHsm</a> operation. The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the <a>DescribeCustomKeyStores</a> operation. During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser\"> <code>kmsuser</code> crypto user</a> (CU), and rotates its password. The <code>ConnectCustomKeyStore</code> operation might fail for various reasons. To find the reason, use the <a>DescribeCustomKeyStores</a> operation and see the <code>ConnectionErrorCode</code> in the response. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>. To fix the failure, use the <a>DisconnectCustomKeyStore</a> operation to disconnect the custom key store, correct the error, use the <a>UpdateCustomKeyStore</a> operation if necessary, and then use <code>ConnectCustomKeyStore</code> again. If you are having trouble connecting or disconnecting a custom key store, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\">Troubleshooting a Custom Key Store</a> in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectCustomKeyStoreResponse"}}}},"480":{"description":"CloudHsmClusterNotActiveException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudHsmClusterNotActiveException"}}}},"481":{"description":"CustomKeyStoreInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreInvalidStateException"}}}},"482":{"description":"CustomKeyStoreNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreNotFoundException"}}}},"483":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"484":{"description":"CloudHsmClusterInvalidConfigurationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudHsmClusterInvalidConfigurationException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectCustomKeyStoreRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateAlias":{"post":{"operationId":"CreateAlias","description":"Creates a display name for a customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as <a>Encrypt</a> and <a>GenerateDataKey</a>. Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region. Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs, use the <a>ListAliases</a> operation. An alias must start with the word <code>alias</code> followed by a forward slash (<code>alias/</code>). The alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). Alias names cannot begin with <code>aws</code>; that alias name prefix is reserved by Amazon Web Services (AWS). The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account. To map an existing alias to a different CMK, call <a>UpdateAlias</a>. The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success"},"480":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"481":{"description":"AlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlreadyExistsException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InvalidAliasNameException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAliasNameException"}}}},"484":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"485":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"486":{"description":"KMSInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInvalidStateException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAliasRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateCustomKeyStore":{"post":{"operationId":"CreateCustomKeyStore","description":"Creates a <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html\">custom key store</a> that is associated with an <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/clusters.html\">AWS CloudHSM cluster</a> that you own and manage. This operation is part of the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the <a>ConnectCustomKeyStore</a> operation to connect the new key store to its AWS CloudHSM cluster. The <code>CreateCustomKeyStore</code> operation requires the following elements. <ul> <li> You must specify an active AWS CloudHSM cluster in the same account and AWS Region as the custom key store. You can use an existing cluster or <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/create-cluster.html\">create and activate a new AWS CloudHSM cluster</a> for the key store. AWS KMS does not require exclusive use of the cluster. </li> <li> You must include the content of the trust anchor certificate for the cluster. You created this certificate, and saved it in the <code>customerCA.crt</code> file, when you <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/initialize-cluster.html#sign-csr\">initialized the cluster</a>. </li> <li> You must provide the password of the dedicated <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser\"> <code>kmsuser</code> crypto user</a> (CU) account in the cluster. Before you create the custom key store, use the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/cloudhsm_mgmt_util-createUser.html\">createUser</a> command in <code>cloudhsm_mgmt_util</code> to create <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-concepts.html#concept-kmsuser\">a crypto user (CU) named <code>kmsuser</code> </a>in specified AWS CloudHSM cluster. AWS KMS uses the <code>kmsuser</code> CU account to create and manage key material on your behalf. For instructions, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html#before-keystore\">Create the kmsuser Crypto User</a> in the AWS Key Management Service Developer Guide. </li> </ul> The AWS CloudHSM cluster that you specify must meet the following requirements. <ul> <li> The cluster must be active and be in the same AWS account and Region as the custom key store. </li> <li> Each custom key store must be associated with a different AWS CloudHSM cluster. The cluster cannot be associated with another custom key store or have the same cluster certificate as a cluster that is associated with another custom key store. To view the cluster certificate, use the AWS CloudHSM <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/API_DescribeClusters.html\">DescribeClusters</a> operation. Clusters that share a backup history have the same cluster certificate. </li> <li> The cluster must be configured with subnets in at least two different Availability Zones in the Region. Because AWS CloudHSM is not supported in all Availability Zones, we recommend that the cluster have subnets in all Availability Zones in the Region. </li> <li> The cluster must contain at least two active HSMs, each in a different Availability Zone. </li> </ul> New custom key stores are not automatically connected. After you create your custom key store, use the <a>ConnectCustomKeyStore</a> operation to connect the custom key store to its associated AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it. If this operation succeeds, it returns the ID of the new custom key store. For help with failures, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html\">Troubleshoot a Custom Key Store</a> in the AWS KMS Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomKeyStoreResponse"}}}},"480":{"description":"CloudHsmClusterInUseException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudHsmClusterInUseException"}}}},"481":{"description":"CustomKeyStoreNameInUseException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreNameInUseException"}}}},"482":{"description":"CloudHsmClusterNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudHsmClusterNotFoundException"}}}},"483":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"484":{"description":"CloudHsmClusterNotActiveException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudHsmClusterNotActiveException"}}}},"485":{"description":"IncorrectTrustAnchorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncorrectTrustAnchorException"}}}},"486":{"description":"CloudHsmClusterInvalidConfigurationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudHsmClusterInvalidConfigurationException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomKeyStoreRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateGrant":{"post":{"operationId":"CreateGrant","description":"Adds a grant to a customer master key (CMK). The grant specifies who can use the CMK and under what conditions. When setting permissions, grants are an alternative to key policies. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the <code>KeyId</code> parameter. For more information about grants, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/grants.html\">Grants</a> in the AWS Key Management Service Developer Guide. The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGrantResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"DisabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisabledException"}}}},"482":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"483":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"484":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"485":{"description":"InvalidGrantTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidGrantTokenException"}}}},"486":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"487":{"description":"KMSInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInvalidStateException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGrantRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateKey":{"post":{"operationId":"CreateKey","description":"Creates a customer master key (CMK) in the caller's AWS account. You can use a CMK to encrypt small amounts of data (4 KiB or less) directly, but CMKs are more commonly used to encrypt data keys, which are used to encrypt raw data. For more information about data keys and the difference between CMKs and data keys, see the following: <ul> <li> The <a>GenerateDataKey</a> operation </li> <li> <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html\">AWS Key Management Service Concepts</a> in the AWS Key Management Service Developer Guide </li> </ul> If you plan to <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">import key material</a>, use the <code>Origin</code> parameter with a value of <code>EXTERNAL</code> to create a CMK with no key material. To create a CMK in a <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html\">custom key store</a>, use <code>CustomKeyStoreId</code> parameter to specify the custom key store. You must also use the <code>Origin</code> parameter with a value of <code>AWS_CLOUDHSM</code>. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region. You cannot use this operation to create a CMK in a different AWS account.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKeyResponse"}}}},"480":{"description":"MalformedPolicyDocumentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MalformedPolicyDocumentException"}}}},"481":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"482":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"483":{"description":"UnsupportedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedOperationException"}}}},"484":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"485":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"486":{"description":"TagException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagException"}}}},"487":{"description":"CustomKeyStoreNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreNotFoundException"}}}},"488":{"description":"CustomKeyStoreInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreInvalidStateException"}}}},"489":{"description":"CloudHsmClusterInvalidConfigurationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudHsmClusterInvalidConfigurationException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKeyRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#Decrypt":{"post":{"operationId":"Decrypt","description":"Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations: <ul> <li> <a>GenerateDataKey</a> </li> <li> <a>GenerateDataKeyWithoutPlaintext</a> </li> <li> <a>Encrypt</a> </li> </ul> 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. The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecryptResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"DisabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisabledException"}}}},"482":{"description":"InvalidCiphertextException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCiphertextException"}}}},"483":{"description":"KeyUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeyUnavailableException"}}}},"484":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"485":{"description":"InvalidGrantTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidGrantTokenException"}}}},"486":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"487":{"description":"KMSInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInvalidStateException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecryptRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteAlias":{"post":{"operationId":"DeleteAlias","description":"Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account. Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the <a>DescribeKey</a> operation. To get the aliases of all CMKs, use the <a>ListAliases</a> operation. Each CMK can have multiple aliases. To change the alias of a CMK, use <a>DeleteAlias</a> to delete the current alias and <a>CreateAlias</a> to create a new alias. To associate an existing alias with a different customer master key (CMK), call <a>UpdateAlias</a>.","responses":{"200":{"description":"Success"},"480":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"483":{"description":"KMSInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInvalidStateException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAliasRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteCustomKeyStore":{"post":{"operationId":"DeleteCustomKeyStore","description":"Deletes a <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html\">custom key store</a>. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster. The custom key store that you delete cannot contain any AWS KMS <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys\">customer master keys (CMKs)</a>. Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use <a>ScheduleKeyDeletion</a> to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the <code>ScheduleKeyDeletion</code> operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore.html#fix-keystore-orphaned-key\">delete the orphaned key material</a> from the cluster and its backups. After all CMKs are deleted from AWS KMS, use <a>DisconnectCustomKeyStore</a> to disconnect the key store from AWS KMS. Then, you can delete the custom key store. Instead of deleting the custom key store, consider using <a>DisconnectCustomKeyStore</a> to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCustomKeyStoreResponse"}}}},"480":{"description":"CustomKeyStoreHasCMKsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreHasCMKsException"}}}},"481":{"description":"CustomKeyStoreInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreInvalidStateException"}}}},"482":{"description":"CustomKeyStoreNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreNotFoundException"}}}},"483":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCustomKeyStoreRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DeleteImportedKeyMaterial":{"post":{"operationId":"DeleteImportedKeyMaterial","description":"Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html\">Importing Key Material</a> in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account. When the specified CMK is in the <code>PendingDeletion</code> state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to <code>PendingImport</code>. After you delete key material, you can use <a>ImportKeyMaterial</a> to reimport the same key material into the CMK. The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success"},"480":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"481":{"description":"UnsupportedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedOperationException"}}}},"482":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"483":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"484":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"485":{"description":"KMSInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInvalidStateException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteImportedKeyMaterialRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DescribeCustomKeyStores":{"post":{"operationId":"DescribeCustomKeyStores","description":"Gets information about <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html\">custom key stores</a> in the account and region. This operation is part of the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store. By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the <code>CustomKeyStoreName</code> or <code>CustomKeyStoreId</code> parameter (but not both). To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the <code>ConnectionState</code> element in the response. If an attempt to connect the custom key store failed, the <code>ConnectionState</code> value is <code>FAILED</code> and the <code>ConnectionErrorCode</code> element in the response indicates the cause of the failure. For help interpreting the <code>ConnectionErrorCode</code>, see <a>CustomKeyStoresListEntry</a>. Custom key stores have a <code>DISCONNECTED</code> connection state if the key store has never been connected or you use the <a>DisconnectCustomKeyStore</a> operation to disconnect it. If your custom key store state is <code>CONNECTED</code> but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any. For help repairing your custom key store, see the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/fix-keystore-html\">Troubleshooting Custom Key Stores</a> topic in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeCustomKeyStoresResponse"}}}},"480":{"description":"CustomKeyStoreNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreNotFoundException"}}}},"481":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeCustomKeyStoresRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DescribeKey":{"post":{"operationId":"DescribeKey","description":"Provides detailed information about the specified customer master key (CMK). If you use <code>DescribeKey</code> on a predefined AWS alias, that is, an AWS alias with no key ID, AWS KMS associates the alias with an <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys\">AWS managed CMK</a> and returns its <code>KeyId</code> and <code>Arn</code> in the response. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeKeyResponse"}}}},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"483":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeKeyRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DisableKey":{"post":{"operationId":"DisableKey","description":"Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account. For more information about how key state affects the use of a CMK, see <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 AWS Key Management Service Developer Guide. The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"483":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"484":{"description":"KMSInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInvalidStateException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisableKeyRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DisableKeyRotation":{"post":{"operationId":"DisableKeyRotation","description":"Disables <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html\">automatic rotation of the key material</a> for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account. The result of this operation varies with the key state of the CMK. For details, see <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-state.html\">How Key State Affects Use of a Customer Master Key</a> in the AWS Key Management Service Developer Guide.","responses":{"200":{"description":"Success"},"480":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"481":{"description":"DisabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisabledException"}}}},"482":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"483":{"description":"DependencyTimeoutException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DependencyTimeoutException"}}}},"484":{"description":"KMSInternalException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInternalException"}}}},"485":{"description":"KMSInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KMSInvalidStateException"}}}},"486":{"description":"UnsupportedOperationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedOperationException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisableKeyRotationRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#DisconnectCustomKeyStore":{"post":{"operationId":"DisconnectCustomKeyStore","description":"Disconnects the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/key-store-overview.html\">custom key store</a> from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time. <note> While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data. </note> To find the connection state of a custom key store, use the <a>DescribeCustomKeyStores</a> operation. To reconnect a custom key store, use the <a>ConnectCustomKeyStore</a> operation. If the operation succeeds, it returns a JSON object with no properties. This operation is part of the <a href=\"http://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html\">Custom Key Store feature</a> feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisconnectCustomKeyStoreResponse"}}}},"480":{"description":"CustomKeyStoreInvalidStateException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomKeyStoreInvalidStateException"}}}},"481":{"description":"CustomKeyStoreNotFoundException","content":{"applic