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

filter: Statementstmt 0.0% 0 / 12 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 14 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::KMS::ListRetirableGrants;
3 use Moose;
4 has Limit => (is => 'ro', isa => 'Int');
5 has Marker => (is => 'ro', isa => 'Str');
6 has RetiringPrincipal => (is => 'ro', isa => 'Str', required => 1);
7  
8 use MooseX::ClassAttribute;
9  
10 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListRetirableGrants');
11 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::ListGrantsResponse');
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::ListRetirableGrants - Arguments for method ListRetirableGrants on L<Paws::KMS>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method ListRetirableGrants on the
24 L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class
25 as arguments to method ListRetirableGrants.
26  
27 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListRetirableGrants.
28  
29 =head1 SYNOPSIS
30  
31 my $kms = Paws->service('KMS');
32 # To list grants that the specified principal can retire
33 # The following example lists the grants that the specified principal (identity)
34 # can retire.
35 my $ListGrantsResponse = $kms->ListRetirableGrants(
36 'RetiringPrincipal' => 'arn:aws:iam::111122223333:role/ExampleRole' );
37  
38 # Results:
39 my $Grants = $ListGrantsResponse->Grants;
40 my $Truncated = $ListGrantsResponse->Truncated;
41  
42 # Returns a L<Paws::KMS::ListGrantsResponse> object.
43  
44 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.
45 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/ListRetirableGrants>
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 Limit => Int
51  
52 Use this parameter to specify the maximum number of items to return.
53 When this value is present, AWS KMS does not return more than the
54 specified number of items, but it might return fewer.
55  
56 This value is optional. If you include a value, it must be between 1
57 and 100, inclusive. If you do not include a value, it defaults to 50.
58  
59  
60  
61 =head2 Marker => Str
62  
63 Use this parameter in a subsequent request after you receive a response
64 with truncated results. Set it to the value of C<NextMarker> from the
65 truncated response you just received.
66  
67  
68  
69 =head2 B<REQUIRED> RetiringPrincipal => Str
70  
71 The retiring principal for which to list grants. Enter a principal in
72 your AWS account.
73  
74 To specify the retiring principal, use the Amazon Resource Name (ARN)
75 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
76 of an AWS principal. Valid AWS principals include AWS accounts (root),
77 IAM users, federated users, and assumed role users. For examples of the
78 ARN syntax for specifying a principal, see AWS Identity and Access
79 Management (IAM)
80 (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-iam)
81 in the Example ARNs section of the I<Amazon Web Services General
82 Reference>.
83  
84  
85  
86  
87 =head1 SEE ALSO
88  
89 This class forms part of L<Paws>, documenting arguments for method ListRetirableGrants in L<Paws::KMS>
90  
91 =head1 BUGS and CONTRIBUTIONS
92  
93 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
94  
95 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
96  
97 =cut
98