blib/lib/Paws/RedShift/DescribeSnapshotCopyGrants.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 16 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::RedShift::DescribeSnapshotCopyGrants;
3 use Moose;
4 has Marker => (is => 'ro', isa => 'Str');
5 has MaxRecords => (is => 'ro', isa => 'Int');
6 has SnapshotCopyGrantName => (is => 'ro', isa => 'Str');
7 has TagKeys => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 has TagValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSnapshotCopyGrants');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::SnapshotCopyGrantMessage');
14 class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeSnapshotCopyGrantsResult');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::RedShift::DescribeSnapshotCopyGrants - Arguments for method DescribeSnapshotCopyGrants on L<Paws::RedShift>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeSnapshotCopyGrants on the
26 L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class
27 as arguments to method DescribeSnapshotCopyGrants.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSnapshotCopyGrants.
30  
31 =head1 SYNOPSIS
32  
33 my $redshift = Paws->service('RedShift');
34 my $SnapshotCopyGrantMessage = $redshift->DescribeSnapshotCopyGrants(
35 Marker => 'MyString', # OPTIONAL
36 MaxRecords => 1, # OPTIONAL
37 SnapshotCopyGrantName => 'MyString', # OPTIONAL
38 TagKeys => [
39 'MyString', ... # max: 2147483647
40 ], # OPTIONAL
41 TagValues => [
42 'MyString', ... # max: 2147483647
43 ], # OPTIONAL
44 );
45  
46 # Results:
47 my $Marker = $SnapshotCopyGrantMessage->Marker;
48 my $SnapshotCopyGrants = $SnapshotCopyGrantMessage->SnapshotCopyGrants;
49  
50 # Returns a L<Paws::RedShift::SnapshotCopyGrantMessage> object.
51  
52 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.
53 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/DescribeSnapshotCopyGrants>
54  
55 =head1 ATTRIBUTES
56  
57  
58 =head2 Marker => Str
59  
60 An optional parameter that specifies the starting point to return a set
61 of response records. When the results of a C<DescribeSnapshotCopyGrant>
62 request exceed the value specified in C<MaxRecords>, AWS returns a
63 value in the C<Marker> field of the response. You can retrieve the next
64 set of response records by providing the returned marker value in the
65 C<Marker> parameter and retrying the request.
66  
67 Constraints: You can specify either the B<SnapshotCopyGrantName>
68 parameter or the B<Marker> parameter, but not both.
69  
70  
71  
72 =head2 MaxRecords => Int
73  
74 The maximum number of response records to return in each call. If the
75 number of remaining response records exceeds the specified
76 C<MaxRecords> value, a value is returned in a C<marker> field of the
77 response. You can retrieve the next set of records by retrying the
78 command with the returned marker value.
79  
80 Default: C<100>
81  
82 Constraints: minimum 20, maximum 100.
83  
84  
85  
86 =head2 SnapshotCopyGrantName => Str
87  
88 The name of the snapshot copy grant.
89  
90  
91  
92 =head2 TagKeys => ArrayRef[Str|Undef]
93  
94 A tag key or keys for which you want to return all matching resources
95 that are associated with the specified key or keys. For example,
96 suppose that you have resources tagged with keys called C<owner> and
97 C<environment>. If you specify both of these tag keys in the request,
98 Amazon Redshift returns a response with all resources that have either
99 or both of these tag keys associated with them.
100  
101  
102  
103 =head2 TagValues => ArrayRef[Str|Undef]
104  
105 A tag value or values for which you want to return all matching
106 resources that are associated with the specified value or values. For
107 example, suppose that you have resources tagged with values called
108 C<admin> and C<test>. If you specify both of these tag values in the
109 request, Amazon Redshift returns a response with all resources that
110 have either or both of these tag values associated with them.
111  
112  
113  
114  
115 =head1 SEE ALSO
116  
117 This class forms part of L<Paws>, documenting arguments for method DescribeSnapshotCopyGrants in L<Paws::RedShift>
118  
119 =head1 BUGS and CONTRIBUTIONS
120  
121 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
122  
123 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
124  
125 =cut
126