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

filter: Statementstmt 0.0% 0 / 10 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 12 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::SecretsManager::DescribeSecret;
3 use Moose;
4 has SecretId => (is => 'ro', isa => 'Str', required => 1);
5  
6 use MooseX::ClassAttribute;
7  
8 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSecret');
9 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SecretsManager::DescribeSecretResponse');
10 class_has _result_key => (isa => 'Str', is => 'ro');
11 1;
12  
13 ### main pod documentation begin ###
14  
15 =head1 NAME
16  
17 Paws::SecretsManager::DescribeSecret - Arguments for method DescribeSecret on L<Paws::SecretsManager>
18  
19 =head1 DESCRIPTION
20  
21 This class represents the parameters used for calling the method DescribeSecret on the
22 L<AWS Secrets Manager|Paws::SecretsManager> service. Use the attributes of this class
23 as arguments to method DescribeSecret.
24  
25 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSecret.
26  
27 =head1 SYNOPSIS
28  
29 my $secretsmanager = Paws->service('SecretsManager');
30 # To retrieve the details of a secret
31 # The following example shows how to get the details about a secret.
32 my $DescribeSecretResponse =
33 $secretsmanager->DescribeSecret( 'SecretId' => 'MyTestDatabaseSecret' );
34  
35 # Results:
36 my $ARN = $DescribeSecretResponse->ARN;
37 my $Description = $DescribeSecretResponse->Description;
38 my $KmsKeyId = $DescribeSecretResponse->KmsKeyId;
39 my $LastAccessedDate = $DescribeSecretResponse->LastAccessedDate;
40 my $LastChangedDate = $DescribeSecretResponse->LastChangedDate;
41 my $LastRotatedDate = $DescribeSecretResponse->LastRotatedDate;
42 my $Name = $DescribeSecretResponse->Name;
43 my $RotationEnabled = $DescribeSecretResponse->RotationEnabled;
44 my $RotationLambdaARN = $DescribeSecretResponse->RotationLambdaARN;
45 my $RotationRules = $DescribeSecretResponse->RotationRules;
46 my $Tags = $DescribeSecretResponse->Tags;
47 my $VersionIdsToStages = $DescribeSecretResponse->VersionIdsToStages;
48  
49 # Returns a L<Paws::SecretsManager::DescribeSecretResponse> object.
50  
51 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.
52 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/DescribeSecret>
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 B<REQUIRED> SecretId => Str
58  
59 The identifier of the secret whose details you want to retrieve. You
60 can specify either the Amazon Resource Name (ARN) or the friendly name
61 of the secret.
62  
63 If you specify an ARN, we generally recommend that you specify a
64 complete ARN. You can specify a partial ARN tooE<mdash>for example, if
65 you donE<rsquo>t include the final hyphen and six random characters
66 that Secrets Manager adds at the end of the ARN when you created the
67 secret. A partial ARN match can work as long as it uniquely matches
68 only one secret. However, if your secret has a name that ends in a
69 hyphen followed by six characters (before Secrets Manager adds the
70 hyphen and six characters to the ARN) and you try to use that as a
71 partial ARN, then those characters cause Secrets Manager to assume that
72 youE<rsquo>re specifying a complete ARN. This confusion can cause
73 unexpected results. To avoid this situation, we recommend that you
74 donE<rsquo>t create secret names ending with a hyphen followed by six
75 characters.
76  
77 If you specify an incomplete ARN without the random suffix, and instead
78 provide the 'friendly name', you I<must> not include the random suffix.
79 If you do include the random suffix added by Secrets Manager, you
80 receive either a I<ResourceNotFoundException> or an
81 I<AccessDeniedException> error, depending on your permissions.
82  
83  
84  
85  
86 =head1 SEE ALSO
87  
88 This class forms part of L<Paws>, documenting arguments for method DescribeSecret in L<Paws::SecretsManager>
89  
90 =head1 BUGS and CONTRIBUTIONS
91  
92 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
93  
94 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
95  
96 =cut
97