Provides interfaces for usingCloud KMS
Autokey <https://cloud.google.com/kms/help/autokey>__ to provision
newCryptoKeys, ready for Customer
Managed Encryption Key (CMEK) use, on-demand. To support certain
client tooling, this feature is modeled around aKeyHandleresource: creating aKeyHandlein a resource project and
given location triggers Cloud KMS Autokey to provision aCryptoKeyin the configured key
project and the same location.
Prior to use in a given resource project,UpdateAutokeyConfigshould have been called on an ancestor folder, setting the key
project where Cloud KMS Autokey should create newCryptoKeys. See documentation for
additional prerequisites. To check what key project, if any, is
currently configured on a resource project's ancestor folder, seeShowEffectiveAutokeyConfig.
Provides interfaces for usingCloud KMS
Autokey <https://cloud.google.com/kms/help/autokey>__ to provision
newCryptoKeys, ready for Customer
Managed Encryption Key (CMEK) use, on-demand. To support certain
client tooling, this feature is modeled around aKeyHandleresource: creating aKeyHandlein a resource project and
given location triggers Cloud KMS Autokey to provision aCryptoKeyin the configured key
project and the same location.
Prior to use in a given resource project,UpdateAutokeyConfigshould have been called on an ancestor folder, setting the key
project where Cloud KMS Autokey should create newCryptoKeys. See documentation for
additional prerequisites. To check what key project, if any, is
currently configured on a resource project's ancestor folder, seeShowEffectiveAutokeyConfig.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Package autokey (3.5.1)\n\nVersion latestkeyboard_arrow_down\n\n- [3.5.1 (latest)](/python/docs/reference/cloudkms/latest/google.cloud.kms_v1.services.autokey)\n- [3.5.0](/python/docs/reference/cloudkms/3.5.0/google.cloud.kms_v1.services.autokey)\n- [3.4.0](/python/docs/reference/cloudkms/3.4.0/google.cloud.kms_v1.services.autokey)\n- [3.3.1](/python/docs/reference/cloudkms/3.3.1/google.cloud.kms_v1.services.autokey)\n- [3.2.2](/python/docs/reference/cloudkms/3.2.2/google.cloud.kms_v1.services.autokey)\n- [3.1.1](/python/docs/reference/cloudkms/3.1.1/google.cloud.kms_v1.services.autokey)\n- [3.0.0](/python/docs/reference/cloudkms/3.0.0/google.cloud.kms_v1.services.autokey)\n- [2.24.2](/python/docs/reference/cloudkms/2.24.2/google.cloud.kms_v1.services.autokey)\n- [2.23.0](/python/docs/reference/cloudkms/2.23.0/google.cloud.kms_v1.services.autokey)\n- [2.22.0](/python/docs/reference/cloudkms/2.22.0/google.cloud.kms_v1.services.autokey)\n- [2.21.4](/python/docs/reference/cloudkms/2.21.4/google.cloud.kms_v1.services.autokey)\n- [2.20.0](/python/docs/reference/cloudkms/2.20.0/google.cloud.kms_v1.services.autokey)\n- [2.19.2](/python/docs/reference/cloudkms/2.19.2/google.cloud.kms_v1.services.autokey)\n- [2.18.0](/python/docs/reference/cloudkms/2.18.0/google.cloud.kms_v1.services.autokey)\n- [2.17.0](/python/docs/reference/cloudkms/2.17.0/google.cloud.kms_v1.services.autokey)\n- [2.16.1](/python/docs/reference/cloudkms/2.16.1/google.cloud.kms_v1.services.autokey)\n- [2.15.0](/python/docs/reference/cloudkms/2.15.0/google.cloud.kms_v1.services.autokey)\n- [2.14.1](/python/docs/reference/cloudkms/2.14.1/google.cloud.kms_v1.services.autokey)\n- [2.13.0](/python/docs/reference/cloudkms/2.13.0/google.cloud.kms_v1.services.autokey)\n- [2.12.3](/python/docs/reference/cloudkms/2.12.3/google.cloud.kms_v1.services.autokey)\n- [2.11.2](/python/docs/reference/cloudkms/2.11.2/google.cloud.kms_v1.services.autokey)\n- [2.10.1](/python/docs/reference/cloudkms/2.10.1/google.cloud.kms_v1.services.autokey)\n- [2.9.0](/python/docs/reference/cloudkms/2.9.0/google.cloud.kms_v1.services.autokey)\n- [2.8.0](/python/docs/reference/cloudkms/2.8.0/google.cloud.kms_v1.services.autokey)\n- [2.7.0](/python/docs/reference/cloudkms/2.7.0/google.cloud.kms_v1.services.autokey)\n- [2.6.1](/python/docs/reference/cloudkms/2.6.1/google.cloud.kms_v1.services.autokey)\n- [2.5.0](/python/docs/reference/cloudkms/2.5.0/google.cloud.kms_v1.services.autokey)\n- [2.4.3](/python/docs/reference/cloudkms/2.4.3/google.cloud.kms_v1.services.autokey)\n- [2.3.0](/python/docs/reference/cloudkms/2.3.0/google.cloud.kms_v1.services.autokey)\n- [2.2.0](/python/docs/reference/cloudkms/2.2.0/google.cloud.kms_v1.services.autokey)\n- [2.1.0](/python/docs/reference/cloudkms/2.1.0/google.cloud.kms_v1.services.autokey)\n- [2.0.1](/python/docs/reference/cloudkms/2.0.1/google.cloud.kms_v1.services.autokey)\n- [1.4.2](/python/docs/reference/cloudkms/1.4.2/google.cloud.kms_v1.services.autokey)\n- [1.3.0](/python/docs/reference/cloudkms/1.3.0/google.cloud.kms_v1.services.autokey)\n- [1.2.1](/python/docs/reference/cloudkms/1.2.1/google.cloud.kms_v1.services.autokey)\n- [1.1.0](/python/docs/reference/cloudkms/1.1.0/google.cloud.kms_v1.services.autokey) \nAPI documentation for `kms_v1.services.autokey` package. \n\nClasses\n-------\n\n### [AutokeyAsyncClient](/python/docs/reference/cloudkms/latest/google.cloud.kms_v1.services.autokey.AutokeyAsyncClient)\n\nProvides interfaces for using `Cloud KMS\nAutokey \u003chttps://cloud.google.com/kms/help/autokey\u003e`__ to provision\nnew CryptoKeys, ready for Customer\nManaged Encryption Key (CMEK) use, on-demand. To support certain\nclient tooling, this feature is modeled around a\nKeyHandle resource: creating a\nKeyHandle in a resource project and\ngiven location triggers Cloud KMS Autokey to provision a\nCryptoKey in the configured key\nproject and the same location.\n\nPrior to use in a given resource project,\nUpdateAutokeyConfig\nshould have been called on an ancestor folder, setting the key\nproject where Cloud KMS Autokey should create new\nCryptoKeys. See documentation for\nadditional prerequisites. To check what key project, if any, is\ncurrently configured on a resource project's ancestor folder, see\nShowEffectiveAutokeyConfig.\n\n### [AutokeyClient](/python/docs/reference/cloudkms/latest/google.cloud.kms_v1.services.autokey.AutokeyClient)\n\nProvides interfaces for using `Cloud KMS\nAutokey \u003chttps://cloud.google.com/kms/help/autokey\u003e`__ to provision\nnew CryptoKeys, ready for Customer\nManaged Encryption Key (CMEK) use, on-demand. To support certain\nclient tooling, this feature is modeled around a\nKeyHandle resource: creating a\nKeyHandle in a resource project and\ngiven location triggers Cloud KMS Autokey to provision a\nCryptoKey in the configured key\nproject and the same location.\n\nPrior to use in a given resource project,\nUpdateAutokeyConfig\nshould have been called on an ancestor folder, setting the key\nproject where Cloud KMS Autokey should create new\nCryptoKeys. See documentation for\nadditional prerequisites. To check what key project, if any, is\ncurrently configured on a resource project's ancestor folder, see\nShowEffectiveAutokeyConfig.\n\nModules\n-------\n\n### [pagers](/python/docs/reference/cloudkms/latest/google.cloud.kms_v1.services.autokey.pagers)\n\nAPI documentation for `kms_v1.services.autokey.pagers` module."]]