blib/lib/Paws/S3/SelectObjectContent.pm

filter: Statementstmt 100% 26 / 26 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 28 / 28 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/S3/RestoreObject.pm ↑ Summary blib/lib/Paws/S3/SelectObjectContentEventStream.pm »
1  
2 package Paws::S3::SelectObjectContent;
3 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1);
5 2 has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']);
6 2 has Expression => (is => 'ro', isa => 'Str', required => 1);
7 2 has ExpressionType => (is => 'ro', isa => 'Str', required => 1);
8 2 has InputSerialization => (is => 'ro', isa => 'Paws::S3::InputSerialization', required => 1);
9 2 has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1);
10 2 has OutputSerialization => (is => 'ro', isa => 'Paws::S3::OutputSerialization', required => 1);
11 2 has RequestProgress => (is => 'ro', isa => 'Paws::S3::RequestProgress');
12 2 has ScanRange => (is => 'ro', isa => 'Paws::S3::ScanRange');
13 2 has SSECustomerAlgorithm => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-algorithm', traits => ['ParamInHeader']);
14 2 has SSECustomerKey => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key', traits => ['ParamInHeader']);
15 2 has SSECustomerKeyMD5 => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key-MD5', traits => ['ParamInHeader']);
16  
17  
18 2 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
19  
20 2 class_has _api_call => (isa => 'Str', is => 'ro', default => 'SelectObjectContent');
21 2 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}?select&select-type=2');
22 2 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
23 2 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::SelectObjectContentOutput');
24 2 class_has _result_key => (isa => 'Str', is => 'ro');
25 2 class_has _top_level_element => (isa => 'Str', is => 'ro', default => 'SelectObjectContentRequest');
26 2 class_has _top_level_namespace => (isa => 'Str', is => 'ro', default => 'http://s3.amazonaws.com/doc/2006-03-01/');
27 2 1;
28  
29 ### main pod documentation begin ###
30  
31 =head1 NAME
32  
33 Paws::S3::SelectObjectContent - Arguments for method SelectObjectContent on L<Paws::S3>
34  
35 =head1 DESCRIPTION
36  
37 This class represents the parameters used for calling the method SelectObjectContent on the
38 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
39 as arguments to method SelectObjectContent.
40  
41 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SelectObjectContent.
42  
43 =head1 SYNOPSIS
44  
45 my $s3 = Paws->service('S3');
46 my $SelectObjectContentOutput = $s3->SelectObjectContent(
47 Bucket => 'MyBucketName',
48 Expression => 'MyExpression',
49 ExpressionType => 'SQL',
50 InputSerialization => {
51 CSV => {
52 AllowQuotedRecordDelimiter => 1, # OPTIONAL
53 Comments => 'MyComments', # OPTIONAL
54 FieldDelimiter => 'MyFieldDelimiter', # OPTIONAL
55 FileHeaderInfo => 'USE', # values: USE, IGNORE, NONE; OPTIONAL
56 QuoteCharacter => 'MyQuoteCharacter', # OPTIONAL
57 QuoteEscapeCharacter => 'MyQuoteEscapeCharacter', # OPTIONAL
58 RecordDelimiter => 'MyRecordDelimiter', # OPTIONAL
59 }, # OPTIONAL
60 CompressionType => 'NONE', # values: NONE, GZIP, BZIP2; OPTIONAL
61 JSON => {
62 Type => 'DOCUMENT', # values: DOCUMENT, LINES; OPTIONAL
63 }, # OPTIONAL
64 Parquet => {
65  
66 }, # OPTIONAL
67 },
68 Key => 'MyObjectKey',
69 OutputSerialization => {
70 CSV => {
71 FieldDelimiter => 'MyFieldDelimiter', # OPTIONAL
72 QuoteCharacter => 'MyQuoteCharacter', # OPTIONAL
73 QuoteEscapeCharacter => 'MyQuoteEscapeCharacter', # OPTIONAL
74 QuoteFields => 'ALWAYS', # values: ALWAYS, ASNEEDED; OPTIONAL
75 RecordDelimiter => 'MyRecordDelimiter', # OPTIONAL
76 }, # OPTIONAL
77 JSON => {
78 RecordDelimiter => 'MyRecordDelimiter', # OPTIONAL
79 }, # OPTIONAL
80 },
81 ExpectedBucketOwner => 'MyAccountId', # OPTIONAL
82 RequestProgress => {
83 Enabled => 1, # OPTIONAL
84 }, # OPTIONAL
85 SSECustomerAlgorithm => 'MySSECustomerAlgorithm', # OPTIONAL
86 SSECustomerKey => 'MySSECustomerKey', # OPTIONAL
87 SSECustomerKeyMD5 => 'MySSECustomerKeyMD5', # OPTIONAL
88 ScanRange => {
89 End => 1, # OPTIONAL
90 Start => 1, # OPTIONAL
91 }, # OPTIONAL
92 );
93  
94 # Results:
95 my $Payload = $SelectObjectContentOutput->Payload;
96  
97 # Returns a L<Paws::S3::SelectObjectContentOutput> object.
98  
99 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.
100 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/SelectObjectContent>
101  
102 =head1 ATTRIBUTES
103  
104  
105 =head2 B<REQUIRED> Bucket => Str
106  
107 The S3 bucket.
108  
109  
110  
111 =head2 ExpectedBucketOwner => Str
112  
113 The account ID of the expected bucket owner. If the bucket is owned by
114 a different account, the request will fail with an HTTP C<403 (Access
115 Denied)> error.
116  
117  
118  
119 =head2 B<REQUIRED> Expression => Str
120  
121 The expression that is used to query the object.
122  
123  
124  
125 =head2 B<REQUIRED> ExpressionType => Str
126  
127 The type of the provided expression (for example, SQL).
128  
129 Valid values are: C<"SQL">
130  
131 =head2 B<REQUIRED> InputSerialization => L<Paws::S3::InputSerialization>
132  
133 Describes the format of the data in the object that is being queried.
134  
135  
136  
137 =head2 B<REQUIRED> Key => Str
138  
139 The object key.
140  
141  
142  
143 =head2 B<REQUIRED> OutputSerialization => L<Paws::S3::OutputSerialization>
144  
145 Describes the format of the data that you want Amazon S3 to return in
146 response.
147  
148  
149  
150 =head2 RequestProgress => L<Paws::S3::RequestProgress>
151  
152 Specifies if periodic request progress information should be enabled.
153  
154  
155  
156 =head2 ScanRange => L<Paws::S3::ScanRange>
157  
158 Specifies the byte range of the object to get the records from. A
159 record is processed when its first byte is contained by the range. This
160 parameter is optional, but when specified, it must not be empty. See
161 RFC 2616, Section 14.35.1 about how to specify the start and end of the
162 range.
163  
164 C<ScanRange>may be used in the following ways:
165  
166 =over
167  
168 =item *
169  
170 C<E<lt>scanrangeE<gt>E<lt>startE<gt>50E<lt>/startE<gt>E<lt>endE<gt>100E<lt>/endE<gt>E<lt>/scanrangeE<gt>>
171 - process only the records starting between the bytes 50 and 100
172 (inclusive, counting from zero)
173  
174 =item *
175  
176 C<E<lt>scanrangeE<gt>E<lt>startE<gt>50E<lt>/startE<gt>E<lt>/scanrangeE<gt>>
177 - process only the records starting after the byte 50
178  
179 =item *
180  
181 C<E<lt>scanrangeE<gt>E<lt>endE<gt>50E<lt>/endE<gt>E<lt>/scanrangeE<gt>>
182 - process only the records within the last 50 bytes of the file.
183  
184 =back
185  
186  
187  
188  
189 =head2 SSECustomerAlgorithm => Str
190  
191 The SSE Algorithm used to encrypt the object. For more information, see
192 Server-Side Encryption (Using Customer-Provided Encryption Keys
193 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).
194  
195  
196  
197 =head2 SSECustomerKey => Str
198  
199 The SSE Customer Key. For more information, see Server-Side Encryption
200 (Using Customer-Provided Encryption Keys
201 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).
202  
203  
204  
205 =head2 SSECustomerKeyMD5 => Str
206  
207 The SSE Customer Key MD5. For more information, see Server-Side
208 Encryption (Using Customer-Provided Encryption Keys
209 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).
210  
211  
212  
213  
214 =head1 SEE ALSO
215  
216 This class forms part of L<Paws>, documenting arguments for method SelectObjectContent in L<Paws::S3>
217  
218 =head1 BUGS and CONTRIBUTIONS
219  
220 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
221  
222 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
223  
224 =cut
225  
« blib/lib/Paws/S3/RestoreObject.pm ↑ Summary blib/lib/Paws/S3/SelectObjectContentEventStream.pm »