File Coverage

blib/lib/Paws/RedShift/DescribeSnapshotCopyGrants.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::RedShift::DescribeSnapshotCopyGrants;
3 1     1   350 use Moose;
  1         2  
  1         7  
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 1     1   5378 use MooseX::ClassAttribute;
  1         2  
  1         10  
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 Paws::RedShift
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method DescribeSnapshotCopyGrants on the
26             Amazon 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             As an example:
32              
33             $service_obj->DescribeSnapshotCopyGrants(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 Marker => Str
41              
42             An optional parameter that specifies the starting point to return a set
43             of response records. When the results of a C<DescribeSnapshotCopyGrant>
44             request exceed the value specified in C<MaxRecords>, AWS returns a
45             value in the C<Marker> field of the response. You can retrieve the next
46             set of response records by providing the returned marker value in the
47             C<Marker> parameter and retrying the request.
48              
49             Constraints: You can specify either the B<SnapshotCopyGrantName>
50             parameter or the B<Marker> parameter, but not both.
51              
52              
53              
54             =head2 MaxRecords => Int
55              
56             The maximum number of response records to return in each call. If the
57             number of remaining response records exceeds the specified
58             C<MaxRecords> value, a value is returned in a C<marker> field of the
59             response. You can retrieve the next set of records by retrying the
60             command with the returned marker value.
61              
62             Default: C<100>
63              
64             Constraints: minimum 20, maximum 100.
65              
66              
67              
68             =head2 SnapshotCopyGrantName => Str
69              
70             The name of the snapshot copy grant.
71              
72              
73              
74             =head2 TagKeys => ArrayRef[Str|Undef]
75              
76             A tag key or keys for which you want to return all matching resources
77             that are associated with the specified key or keys. For example,
78             suppose that you have resources tagged with keys called C<owner> and
79             C<environment>. If you specify both of these tag keys in the request,
80             Amazon Redshift returns a response with all resources that have either
81             or both of these tag keys associated with them.
82              
83              
84              
85             =head2 TagValues => ArrayRef[Str|Undef]
86              
87             A tag value or values for which you want to return all matching
88             resources that are associated with the specified value or values. For
89             example, suppose that you have resources tagged with values called
90             C<admin> and C<test>. If you specify both of these tag values in the
91             request, Amazon Redshift returns a response with all resources that
92             have either or both of these tag values associated with them.
93              
94              
95              
96              
97             =head1 SEE ALSO
98              
99             This class forms part of L<Paws>, documenting arguments for method DescribeSnapshotCopyGrants in L<Paws::RedShift>
100              
101             =head1 BUGS and CONTRIBUTIONS
102              
103             The source code is located here: https://github.com/pplu/aws-sdk-perl
104              
105             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
106              
107             =cut
108