blib/lib/Paws/KMS/ListAliases.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::ListAliases;
3 use Moose;
4 has KeyId => (is => 'ro', isa => 'Str');
5 has Limit => (is => 'ro', isa => 'Int');
6 has Marker => (is => 'ro', isa => 'Str');
7  
8 use MooseX::ClassAttribute;
9  
10 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListAliases');
11 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::ListAliasesResponse');
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::ListAliases - Arguments for method ListAliases on L<Paws::KMS>
20  
21 =head1 DESCRIPTION
22  
23 This class represents the parameters used for calling the method ListAliases on the
24 L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class
25 as arguments to method ListAliases.
26  
27 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListAliases.
28  
29 =head1 SYNOPSIS
30  
31 my $kms = Paws->service('KMS');
32 # To list aliases
33 # The following example lists aliases.
34 my $ListAliasesResponse = $kms->ListAliases();
35  
36 # Results:
37 my $Aliases = $ListAliasesResponse->Aliases;
38 my $Truncated = $ListAliasesResponse->Truncated;
39  
40 # Returns a L<Paws::KMS::ListAliasesResponse> object.
41  
42 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.
43 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/ListAliases>
44  
45 =head1 ATTRIBUTES
46  
47  
48 =head2 KeyId => Str
49  
50 Lists only aliases that are associated with the specified CMK. Enter a
51 CMK in your AWS account.
52  
53 This parameter is optional. If you omit it, C<ListAliases> returns all
54 aliases in the account and Region.
55  
56 Specify the key ID or key ARN of the CMK.
57  
58 For example:
59  
60 =over
61  
62 =item *
63  
64 Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab>
65  
66 =item *
67  
68 Key ARN:
69 C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab>
70  
71 =back
72  
73 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
74  
75  
76  
77 =head2 Limit => Int
78  
79 Use this parameter to specify the maximum number of items to return.
80 When this value is present, AWS KMS does not return more than the
81 specified number of items, but it might return fewer.
82  
83 This value is optional. If you include a value, it must be between 1
84 and 100, inclusive. If you do not include a value, it defaults to 50.
85  
86  
87  
88 =head2 Marker => Str
89  
90 Use this parameter in a subsequent request after you receive a response
91 with truncated results. Set it to the value of C<NextMarker> from the
92 truncated response you just received.
93  
94  
95  
96  
97 =head1 SEE ALSO
98  
99 This class forms part of L<Paws>, documenting arguments for method ListAliases in L<Paws::KMS>
100  
101 =head1 BUGS and CONTRIBUTIONS
102  
103 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
104  
105 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
106  
107 =cut
108