Get an object's KMS key name
Stay organized with collections
Save and categorize content based on your preferences.
Get a resource's KMS key name that's used to encrypt an object.
Explore further
For detailed documentation that includes this code sample, see the following:
Code sample
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
[[["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"]],[],[],[],null,["# Get an object's KMS key name\n\nGet a resource's KMS key name that's used to encrypt an object.\n\nExplore further\n---------------\n\n\nFor detailed documentation that includes this code sample, see the following:\n\n- [Use customer-managed encryption keys](/storage/docs/encryption/using-customer-managed-keys)\n\nCode sample\n-----------\n\n### C++\n\n\nFor more information, see the\n[Cloud Storage C++ API\nreference documentation](/cpp/docs/reference/storage/latest).\n\n\nTo authenticate to Cloud Storage, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for client libraries](/storage/docs/authentication#client-libs).\n\n namespace gcs = ::google::cloud::storage;\n using ::google::cloud::StatusOr;\n [](gcs::Client client, std::string const& bucket_name,\n std::string const& object_name) {\n StatusOr\u003cgcs::ObjectMetadata\u003e metadata =\n client.GetObjectMetadata(bucket_name, object_name);\n if (!metadata) throw std::move(metadata).status();\n\n std::cout \u003c\u003c \"KMS key on object \" \u003c\u003c metadata-\u003ename() \u003c\u003c \" in bucket \"\n \u003c\u003c metadata-\u003ebucket() \u003c\u003c \": \" \u003c\u003c metadata-\u003ekms_key_name() \u003c\u003c \"\\n\";\n }\n\n### PHP\n\n\nFor more information, see the\n[Cloud Storage PHP API\nreference documentation](https://googleapis.github.io/google-cloud-php/#/docs/google-cloud/latest/storage/storageclient).\n\n\nTo authenticate to Cloud Storage, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for client libraries](/storage/docs/authentication#client-libs).\n\n use Google\\Cloud\\Storage\\StorageClient;\n\n /**\n * Retrieve the KMS key of an object.\n *\n * @param string $bucketName The name of your Cloud Storage bucket.\n * (e.g. 'my-bucket')\n * @param string $objectName The name of your object in the bucket.\n * (e.g. 'my-object')\n */\n function object_get_kms_key(string $bucketName, string $objectName): void\n {\n $storage = new StorageClient();\n $bucket = $storage-\u003ebucket($bucketName);\n $object = $bucket-\u003eobject($objectName);\n $info = $object-\u003einfo();\n\n printf(\n 'The KMS key of the object is %s' . PHP_EOL,\n $info['kmsKeyName'],\n );\n }\n\n### Python\n\n\nFor more information, see the\n[Cloud Storage Python API\nreference documentation](https://cloud.google.com/python/docs/reference/storage/latest).\n\n\nTo authenticate to Cloud Storage, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for client libraries](/storage/docs/authentication#client-libs).\n\n from google.cloud import https://cloud.google.com/python/docs/reference/storage/latest/\n\n\n def object_get_kms_key(bucket_name, blob_name):\n \"\"\"Retrieve the KMS key of a blob\"\"\"\n # bucket_name = \"your-bucket-name\"\n # blob_name = \"your-object-name\"\n\n storage_client = https://cloud.google.com/python/docs/reference/storage/latest/.https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.client.Client.html()\n\n bucket = storage_client.https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.client.Client.html#google_cloud_storage_client_Client_bucket(bucket_name)\n blob = bucket.https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.bucket.Bucket.html#google_cloud_storage_bucket_Bucket_get_blob(blob_name)\n\n kms_key = blob.https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.blob.Blob.html#google_cloud_storage_blob_Blob_kms_key_name\n\n print(f\"The KMS key of a blob is {blob.https://cloud.google.com/python/docs/reference/storage/latest/google.cloud.storage.blob.Blob.html#google_cloud_storage_blob_Blob_kms_key_name}\")\n return kms_key\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=storage)."]]
