File Coverage

blib/lib/Paws/KMS/RetireGrant.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::RetireGrant;
3 1     1   534 use Moose;
  1         3  
  1         9  
4             has GrantId => (is => 'ro', isa => 'Str');
5             has GrantToken => (is => 'ro', isa => 'Str');
6             has KeyId => (is => 'ro', isa => 'Str');
7              
8 1     1   7081 use MooseX::ClassAttribute;
  1         2  
  1         9  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'RetireGrant');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::KMS::RetireGrant - Arguments for method RetireGrant on Paws::KMS
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method RetireGrant on the
24             AWS Key Management Service service. Use the attributes of this class
25             as arguments to method RetireGrant.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RetireGrant.
28              
29             As an example:
30              
31             $service_obj->RetireGrant(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 GrantId => Str
39              
40             Unique identifier of the grant to retire. The grant ID is returned in
41             the response to a C<CreateGrant> operation.
42              
43             =over
44              
45             =item *
46              
47             Grant ID Example -
48             0123456789012345678901234567890123456789012345678901234567890123
49              
50             =back
51              
52              
53              
54              
55             =head2 GrantToken => Str
56              
57             Token that identifies the grant to be retired.
58              
59              
60              
61             =head2 KeyId => Str
62              
63             The Amazon Resource Name of the CMK associated with the grant. Example:
64              
65             =over
66              
67             =item *
68              
69             arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
70              
71             =back
72              
73              
74              
75              
76              
77             =head1 SEE ALSO
78              
79             This class forms part of L<Paws>, documenting arguments for method RetireGrant in L<Paws::KMS>
80              
81             =head1 BUGS and CONTRIBUTIONS
82              
83             The source code is located here: https://github.com/pplu/aws-sdk-perl
84              
85             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
86              
87             =cut
88