blib/lib/Paws/SecretsManager/ListSecretVersionIds.pm untested

filter: Statementstmt 0.0% 0 / 13 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 15 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SecretsManager::ListSecretVersionIds;
3 use Moose;
4 has IncludeDeprecated => (is => 'ro', isa => 'Bool');
5 has MaxResults => (is => 'ro', isa => 'Int');
6 has NextToken => (is => 'ro', isa => 'Str');
7 has SecretId => (is => 'ro', isa => 'Str', required => 1);
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListSecretVersionIds');
12 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SecretsManager::ListSecretVersionIdsResponse');
13 class_has _result_key => (isa => 'Str', is => 'ro');
14 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::SecretsManager::ListSecretVersionIds - Arguments for method ListSecretVersionIds on L<Paws::SecretsManager>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method ListSecretVersionIds on the
25 L<AWS Secrets Manager|Paws::SecretsManager> service. Use the attributes of this class
26 as arguments to method ListSecretVersionIds.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListSecretVersionIds.
29  
30 =head1 SYNOPSIS
31  
32 my $secretsmanager = Paws->service('SecretsManager');
33 # To list all of the secret versions associated with a secret
34 # The following example shows how to retrieve a list of all of the versions of a
35 # secret, including those without any staging labels.
36 my $ListSecretVersionIdsResponse = $secretsmanager->ListSecretVersionIds(
37 'IncludeDeprecated' => 1,
38 'SecretId' => 'MyTestDatabaseSecret'
39 );
40  
41 # Results:
42 my $ARN = $ListSecretVersionIdsResponse->ARN;
43 my $Name = $ListSecretVersionIdsResponse->Name;
44 my $Versions = $ListSecretVersionIdsResponse->Versions;
45  
46 # Returns a L<Paws::SecretsManager::ListSecretVersionIdsResponse> object.
47  
48 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.
49 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/ListSecretVersionIds>
50  
51 =head1 ATTRIBUTES
52  
53  
54 =head2 IncludeDeprecated => Bool
55  
56 (Optional) Specifies that you want the results to include versions that
57 do not have any staging labels attached to them. Such versions are
58 considered deprecated and are subject to deletion by Secrets Manager as
59 needed.
60  
61  
62  
63 =head2 MaxResults => Int
64  
65 (Optional) Limits the number of results you want to include in the
66 response. If you don't include this parameter, it defaults to a value
67 that's specific to the operation. If additional items exist beyond the
68 maximum you specify, the C<NextToken> response element is present and
69 has a value (isn't null). Include that value as the C<NextToken>
70 request parameter in the next call to the operation to get the next
71 part of the results. Note that Secrets Manager might return fewer
72 results than the maximum even when there are more results available.
73 You should check C<NextToken> after every operation to ensure that you
74 receive all of the results.
75  
76  
77  
78 =head2 NextToken => Str
79  
80 (Optional) Use this parameter in a request if you receive a
81 C<NextToken> response in a previous request indicating there's more
82 output available. In a subsequent call, set it to the value of the
83 previous call C<NextToken> response to indicate where the output should
84 continue from.
85  
86  
87  
88 =head2 B<REQUIRED> SecretId => Str
89  
90 The identifier for the secret containing the versions you want to list.
91 You can specify either the Amazon Resource Name (ARN) or the friendly
92 name of the secret.
93  
94 If you specify an ARN, we generally recommend that you specify a
95 complete ARN. You can specify a partial ARN tooE<mdash>for example, if
96 you donE<rsquo>t include the final hyphen and six random characters
97 that Secrets Manager adds at the end of the ARN when you created the
98 secret. A partial ARN match can work as long as it uniquely matches
99 only one secret. However, if your secret has a name that ends in a
100 hyphen followed by six characters (before Secrets Manager adds the
101 hyphen and six characters to the ARN) and you try to use that as a
102 partial ARN, then those characters cause Secrets Manager to assume that
103 youE<rsquo>re specifying a complete ARN. This confusion can cause
104 unexpected results. To avoid this situation, we recommend that you
105 donE<rsquo>t create secret names ending with a hyphen followed by six
106 characters.
107  
108 If you specify an incomplete ARN without the random suffix, and instead
109 provide the 'friendly name', you I<must> not include the random suffix.
110 If you do include the random suffix added by Secrets Manager, you
111 receive either a I<ResourceNotFoundException> or an
112 I<AccessDeniedException> error, depending on your permissions.
113  
114  
115  
116  
117 =head1 SEE ALSO
118  
119 This class forms part of L<Paws>, documenting arguments for method ListSecretVersionIds in L<Paws::SecretsManager>
120  
121 =head1 BUGS and CONTRIBUTIONS
122  
123 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
124  
125 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
126  
127 =cut
128