DescribeKey.java - AWS Code Sample

DescribeKey.java

DescribeKey.java demonstrates how to obtain information about an AWS KMS key.

/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.* * 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 * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. 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. */ package com.example.kms; import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.kms.KmsClient; import software.amazon.awssdk.services.kms.model.DescribeKeyRequest; import software.amazon.awssdk.services.kms.model.DescribeKeyResponse; import software.amazon.awssdk.services.kms.model.KmsException; public class DescribeKey { public static void main(String[] args) { final String USAGE = "To run this example, supply a key ID value\n" + "Usage: DescribeKey <key-id>\n" + "Example: DescribeKey 1234abcd-12ab-34cd-56ef-1234567890ab \n"; if (args.length != 1) { System.out.println(USAGE); System.exit(1); } String keyId = args[0]; Region region = Region.US_WEST_2; KmsClient kmsClient = KmsClient.builder() .region(region) .build(); describeSpecifcKey(kmsClient, keyId ); } public static void describeSpecifcKey(KmsClient kmsClient,String keyId ){ try { DescribeKeyRequest keyRequest = DescribeKeyRequest.builder() .keyId(keyId) .build(); DescribeKeyResponse response = kmsClient.describeKey(keyRequest); System.out.println("The key description is "+response.keyMetadata().description()); System.out.println("The key ARN is "+response.keyMetadata().arn()); } catch (KmsException e) { System.err.println(e.getMessage()); System.exit(1); } } }

Sample Details

Service: AWS Key Management Service

Last tested: 8/10/2020

Author: scmacdon-aws

Type: full-example