blib/lib/Paws/SecretsManager/GetResourcePolicy.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::GetResourcePolicy;
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 => 'GetResourcePolicy');
9 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SecretsManager::GetResourcePolicyResponse');
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::GetResourcePolicy - Arguments for method GetResourcePolicy on L<Paws::SecretsManager>
18  
19 =head1 DESCRIPTION
20  
21 This class represents the parameters used for calling the method GetResourcePolicy on the
22 L<AWS Secrets Manager|Paws::SecretsManager> service. Use the attributes of this class
23 as arguments to method GetResourcePolicy.
24  
25 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetResourcePolicy.
26  
27 =head1 SYNOPSIS
28  
29 my $secretsmanager = Paws->service('SecretsManager');
30 # To retrieve the resource-based policy attached to a secret
31 # The following example shows how to retrieve the resource-based policy that is
32 # attached to a secret.
33 my $GetResourcePolicyResponse = $secretsmanager->GetResourcePolicy(
34 'SecretId' => 'MyTestDatabaseSecret' );
35  
36 # Results:
37 my $ARN = $GetResourcePolicyResponse->ARN;
38 my $Name = $GetResourcePolicyResponse->Name;
39 my $ResourcePolicy = $GetResourcePolicyResponse->ResourcePolicy;
40  
41 # Returns a L<Paws::SecretsManager::GetResourcePolicyResponse> object.
42  
43 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.
44 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/GetResourcePolicy>
45  
46 =head1 ATTRIBUTES
47  
48  
49 =head2 B<REQUIRED> SecretId => Str
50  
51 Specifies the secret that you want to retrieve the attached
52 resource-based policy for. You can specify either the Amazon Resource
53 Name (ARN) or the friendly name of the secret.
54  
55 If you specify an ARN, we generally recommend that you specify a
56 complete ARN. You can specify a partial ARN tooE<mdash>for example, if
57 you donE<rsquo>t include the final hyphen and six random characters
58 that Secrets Manager adds at the end of the ARN when you created the
59 secret. A partial ARN match can work as long as it uniquely matches
60 only one secret. However, if your secret has a name that ends in a
61 hyphen followed by six characters (before Secrets Manager adds the
62 hyphen and six characters to the ARN) and you try to use that as a
63 partial ARN, then those characters cause Secrets Manager to assume that
64 youE<rsquo>re specifying a complete ARN. This confusion can cause
65 unexpected results. To avoid this situation, we recommend that you
66 donE<rsquo>t create secret names ending with a hyphen followed by six
67 characters.
68  
69 If you specify an incomplete ARN without the random suffix, and instead
70 provide the 'friendly name', you I<must> not include the random suffix.
71 If you do include the random suffix added by Secrets Manager, you
72 receive either a I<ResourceNotFoundException> or an
73 I<AccessDeniedException> error, depending on your permissions.
74  
75  
76  
77  
78 =head1 SEE ALSO
79  
80 This class forms part of L<Paws>, documenting arguments for method GetResourcePolicy in L<Paws::SecretsManager>
81  
82 =head1 BUGS and CONTRIBUTIONS
83  
84 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
85  
86 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
87  
88 =cut
89