DescribeKey.php - AWS Code Sample


DescribeKey.php demonstrates how to get detailed information about a customer master key (CMK), including the CMK ARN and key state.

<?php /** * Copyright 2010-2019, Inc. or its affiliates. All Rights Reserved. * * This file is licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. A copy of * the License is located at * * * * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * * ABOUT THIS PHP SAMPLE: This sample is part of the KMS Developer Guide topic at * * */ require 'vendor/autoload.php'; use Aws\Kms\KmsClient; use Aws\Exception\AwsException; /** * Creating an Amazon KMS client. * * This code expects that you have AWS credentials set up per: * */ //Create a KmsClient $KmsClient = new Aws\Kms\KmsClient([ 'profile' => 'default', 'version' => '2014-11-01', 'region' => 'us-east-2' ]); $keyId = 'arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab'; try { $result = $KmsClient->describeKey([ 'KeyId' => $keyId, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; }

Sample Details

Service: kms

Last tested: 2018-09-20

Author: jschwarzwalder (AWS)

Type: full-example