File Coverage

blib/lib/Paws/KMS/DescribeKey.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::KMS::DescribeKey;
3 1     1   296 use Moose;
  1         2  
  1         6  
4             has GrantTokens => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has KeyId => (is => 'ro', isa => 'Str', required => 1);
6              
7 1     1   5506 use MooseX::ClassAttribute;
  1         3  
  1         9  
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 Paws::KMS
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method DescribeKey on the
23             AWS Key Management Service 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             As an example:
29              
30             $service_obj->DescribeKey(Att1 => $value1, Att2 => $value2, ...);
31              
32             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.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 GrantTokens => ArrayRef[Str|Undef]
38              
39             A list of grant tokens.
40              
41             For more information, see Grant Tokens in the I<AWS Key Management
42             Service Developer Guide>.
43              
44              
45              
46             =head2 B<REQUIRED> KeyId => Str
47              
48             A unique identifier for the customer master key. This value can be a
49             globally unique identifier, a fully specified ARN to either an alias or
50             a key, or an alias name prefixed by "alias/".
51              
52             =over
53              
54             =item *
55              
56             Key ARN Example -
57             arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
58              
59             =item *
60              
61             Alias ARN Example -
62             arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
63              
64             =item *
65              
66             Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
67              
68             =item *
69              
70             Alias Name Example - alias/MyAliasName
71              
72             =back
73              
74              
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, documenting arguments for method DescribeKey in L<Paws::KMS>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89