blib/lib/Paws/KMS/DescribeKey.pm untested

filter: Statementstmt 0.0% 0 / 11 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 13 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::KMS::DescribeKey;
3 use Moose;
4 has GrantTokens => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has KeyId => (is => 'ro', isa => 'Str', required => 1);
6  
7 use MooseX::ClassAttribute;
8  
9 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeKey');
10 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::DescribeKeyResponse');
11 class_has _result_key => (isa => 'Str', is => 'ro');
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::KMS::DescribeKey - Arguments for method DescribeKey on L<Paws::KMS>
19  
20 =head1 DESCRIPTION
21  
22 This class represents the parameters used for calling the method DescribeKey on the
23 L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class
24 as arguments to method DescribeKey.
25  
26 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeKey.
27  
28 =head1 SYNOPSIS
29  
30 my $kms = Paws->service('KMS');
31 # To obtain information about a customer master key (CMK)
32 # The following example returns information (metadata) about the specified CMK.
33 my $DescribeKeyResponse =
34 $kms->DescribeKey( 'KeyId' => '1234abcd-12ab-34cd-56ef-1234567890ab' );
35  
36 # Results:
37 my $KeyMetadata = $DescribeKeyResponse->KeyMetadata;
38  
39 # Returns a L<Paws::KMS::DescribeKeyResponse> object.
40  
41 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
42 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/DescribeKey>
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 GrantTokens => ArrayRef[Str|Undef]
48  
49 A list of grant tokens.
50  
51 Use a grant token when your permission to call this operation comes
52 from a new grant that has not yet achieved I<eventual consistency>. For
53 more information, see Grant token
54 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token)
55 in the I<AWS Key Management Service Developer Guide>.
56  
57  
58  
59 =head2 B<REQUIRED> KeyId => Str
60  
61 Describes the specified customer master key (CMK).
62  
63 If you specify a predefined AWS alias (an AWS alias with no key ID),
64 KMS associates the alias with an AWS managed CMK
65 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys)
66 and returns its C<KeyId> and C<Arn> in the response.
67  
68 To specify a CMK, use its key ID, key ARN, alias name, or alias ARN.
69 When using an alias name, prefix it with C<"alias/">. To specify a CMK
70 in a different AWS account, you must use the key ARN or alias ARN.
71  
72 For example:
73  
74 =over
75  
76 =item *
77  
78 Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab>
79  
80 =item *
81  
82 Key ARN:
83 C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab>
84  
85 =item *
86  
87 Alias name: C<alias/ExampleAlias>
88  
89 =item *
90  
91 Alias ARN: C<arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias>
92  
93 =back
94  
95 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
96 To get the alias name and alias ARN, use ListAliases.
97  
98  
99  
100  
101 =head1 SEE ALSO
102  
103 This class forms part of L<Paws>, documenting arguments for method DescribeKey in L<Paws::KMS>
104  
105 =head1 BUGS and CONTRIBUTIONS
106  
107 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
108  
109 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
110  
111 =cut
112