blib/lib/Paws/QLDB.pm untested

filter: Statementstmt 0.0% 0 / 73 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 26 Podpod 0.0% 0 / 25 totaltotal 0.0% 0 / 124 CC 1 SCAR 6.9
CC
1
Cov
0%
service
2.0
signing_name
2.0
version
2.0
CRAP 2.0
1 package Paws::QLDB;
2 use Moose;
3 sub service { 'qldb' }
4 sub signing_name { 'qldb' }
5 sub version { '2019-01-02' }
6 sub flattened_arrays { 0 }
7 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 has retry => (is => 'ro', isa => 'HashRef', default => sub {
9 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 });
11 has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
12 ] });
13  
14 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 sub CancelJournalKinesisStream {
18 my $self = shift;
19 my $call_object = $self->new_with_coercions('Paws::QLDB::CancelJournalKinesisStream', @_);
20 return $self->caller->do_call($self, $call_object);
21 }
22 sub CreateLedger {
23 my $self = shift;
24 my $call_object = $self->new_with_coercions('Paws::QLDB::CreateLedger', @_);
25 return $self->caller->do_call($self, $call_object);
26 }
27 sub DeleteLedger {
28 my $self = shift;
29 my $call_object = $self->new_with_coercions('Paws::QLDB::DeleteLedger', @_);
30 return $self->caller->do_call($self, $call_object);
31 }
32 sub DescribeJournalKinesisStream {
33 my $self = shift;
34 my $call_object = $self->new_with_coercions('Paws::QLDB::DescribeJournalKinesisStream', @_);
35 return $self->caller->do_call($self, $call_object);
36 }
37 sub DescribeJournalS3Export {
38 my $self = shift;
39 my $call_object = $self->new_with_coercions('Paws::QLDB::DescribeJournalS3Export', @_);
40 return $self->caller->do_call($self, $call_object);
41 }
42 sub DescribeLedger {
43 my $self = shift;
44 my $call_object = $self->new_with_coercions('Paws::QLDB::DescribeLedger', @_);
45 return $self->caller->do_call($self, $call_object);
46 }
47 sub ExportJournalToS3 {
48 my $self = shift;
49 my $call_object = $self->new_with_coercions('Paws::QLDB::ExportJournalToS3', @_);
50 return $self->caller->do_call($self, $call_object);
51 }
52 sub GetBlock {
53 my $self = shift;
54 my $call_object = $self->new_with_coercions('Paws::QLDB::GetBlock', @_);
55 return $self->caller->do_call($self, $call_object);
56 }
57 sub GetDigest {
58 my $self = shift;
59 my $call_object = $self->new_with_coercions('Paws::QLDB::GetDigest', @_);
60 return $self->caller->do_call($self, $call_object);
61 }
62 sub GetRevision {
63 my $self = shift;
64 my $call_object = $self->new_with_coercions('Paws::QLDB::GetRevision', @_);
65 return $self->caller->do_call($self, $call_object);
66 }
67 sub ListJournalKinesisStreamsForLedger {
68 my $self = shift;
69 my $call_object = $self->new_with_coercions('Paws::QLDB::ListJournalKinesisStreamsForLedger', @_);
70 return $self->caller->do_call($self, $call_object);
71 }
72 sub ListJournalS3Exports {
73 my $self = shift;
74 my $call_object = $self->new_with_coercions('Paws::QLDB::ListJournalS3Exports', @_);
75 return $self->caller->do_call($self, $call_object);
76 }
77 sub ListJournalS3ExportsForLedger {
78 my $self = shift;
79 my $call_object = $self->new_with_coercions('Paws::QLDB::ListJournalS3ExportsForLedger', @_);
80 return $self->caller->do_call($self, $call_object);
81 }
82 sub ListLedgers {
83 my $self = shift;
84 my $call_object = $self->new_with_coercions('Paws::QLDB::ListLedgers', @_);
85 return $self->caller->do_call($self, $call_object);
86 }
87 sub ListTagsForResource {
88 my $self = shift;
89 my $call_object = $self->new_with_coercions('Paws::QLDB::ListTagsForResource', @_);
90 return $self->caller->do_call($self, $call_object);
91 }
92 sub StreamJournalToKinesis {
93 my $self = shift;
94 my $call_object = $self->new_with_coercions('Paws::QLDB::StreamJournalToKinesis', @_);
95 return $self->caller->do_call($self, $call_object);
96 }
97 sub TagResource {
98 my $self = shift;
99 my $call_object = $self->new_with_coercions('Paws::QLDB::TagResource', @_);
100 return $self->caller->do_call($self, $call_object);
101 }
102 sub UntagResource {
103 my $self = shift;
104 my $call_object = $self->new_with_coercions('Paws::QLDB::UntagResource', @_);
105 return $self->caller->do_call($self, $call_object);
106 }
107 sub UpdateLedger {
108 my $self = shift;
109 my $call_object = $self->new_with_coercions('Paws::QLDB::UpdateLedger', @_);
110 return $self->caller->do_call($self, $call_object);
111 }
112 sub UpdateLedgerPermissionsMode {
113 my $self = shift;
114 my $call_object = $self->new_with_coercions('Paws::QLDB::UpdateLedgerPermissionsMode', @_);
115 return $self->caller->do_call($self, $call_object);
116 }
117
118  
119  
120 sub operations { qw/CancelJournalKinesisStream CreateLedger DeleteLedger DescribeJournalKinesisStream DescribeJournalS3Export DescribeLedger ExportJournalToS3 GetBlock GetDigest GetRevision ListJournalKinesisStreamsForLedger ListJournalS3Exports ListJournalS3ExportsForLedger ListLedgers ListTagsForResource StreamJournalToKinesis TagResource UntagResource UpdateLedger UpdateLedgerPermissionsMode / }
121  
122 1;
123  
124 ### main pod documentation begin ###
125  
126 =head1 NAME
127  
128 Paws::QLDB - Perl Interface to AWS Amazon QLDB
129  
130 =head1 SYNOPSIS
131  
132 use Paws;
133  
134 my $obj = Paws->service('QLDB');
135 my $res = $obj->Method(
136 Arg1 => $val1,
137 Arg2 => [ 'V1', 'V2' ],
138 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
139 # of the arguments type
140 Arg3 => { Att1 => 'Val1' },
141 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
142 # the constructor of the arguments type
143 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
144 );
145  
146 =head1 DESCRIPTION
147  
148 The control plane for Amazon QLDB
149  
150 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/qldb-2019-01-02>
151  
152  
153 =head1 METHODS
154  
155 =head2 CancelJournalKinesisStream
156  
157 =over
158  
159 =item LedgerName => Str
160  
161 =item StreamId => Str
162  
163  
164 =back
165  
166 Each argument is described in detail in: L<Paws::QLDB::CancelJournalKinesisStream>
167  
168 Returns: a L<Paws::QLDB::CancelJournalKinesisStreamResponse> instance
169  
170 Ends a given Amazon QLDB journal stream. Before a stream can be
171 canceled, its current status must be C<ACTIVE>.
172  
173 You can't restart a stream after you cancel it. Canceled QLDB stream
174 resources are subject to a 7-day retention period, so they are
175 automatically deleted after this limit expires.
176  
177  
178 =head2 CreateLedger
179  
180 =over
181  
182 =item Name => Str
183  
184 =item PermissionsMode => Str
185  
186 =item [DeletionProtection => Bool]
187  
188 =item [Tags => L<Paws::QLDB::Tags>]
189  
190  
191 =back
192  
193 Each argument is described in detail in: L<Paws::QLDB::CreateLedger>
194  
195 Returns: a L<Paws::QLDB::CreateLedgerResponse> instance
196  
197 Creates a new ledger in your AWS account in the current Region.
198  
199  
200 =head2 DeleteLedger
201  
202 =over
203  
204 =item Name => Str
205  
206  
207 =back
208  
209 Each argument is described in detail in: L<Paws::QLDB::DeleteLedger>
210  
211 Returns: nothing
212  
213 Deletes a ledger and all of its contents. This action is irreversible.
214  
215 If deletion protection is enabled, you must first disable it before you
216 can delete the ledger. You can disable it by calling the
217 C<UpdateLedger> operation to set the flag to C<false>.
218  
219  
220 =head2 DescribeJournalKinesisStream
221  
222 =over
223  
224 =item LedgerName => Str
225  
226 =item StreamId => Str
227  
228  
229 =back
230  
231 Each argument is described in detail in: L<Paws::QLDB::DescribeJournalKinesisStream>
232  
233 Returns: a L<Paws::QLDB::DescribeJournalKinesisStreamResponse> instance
234  
235 Returns detailed information about a given Amazon QLDB journal stream.
236 The output includes the Amazon Resource Name (ARN), stream name,
237 current status, creation time, and the parameters of the original
238 stream creation request.
239  
240 This action does not return any expired journal streams. For more
241 information, see Expiration for terminal streams
242 (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration)
243 in the I<Amazon QLDB Developer Guide>.
244  
245  
246 =head2 DescribeJournalS3Export
247  
248 =over
249  
250 =item ExportId => Str
251  
252 =item Name => Str
253  
254  
255 =back
256  
257 Each argument is described in detail in: L<Paws::QLDB::DescribeJournalS3Export>
258  
259 Returns: a L<Paws::QLDB::DescribeJournalS3ExportResponse> instance
260  
261 Returns information about a journal export job, including the ledger
262 name, export ID, creation time, current status, and the parameters of
263 the original export creation request.
264  
265 This action does not return any expired export jobs. For more
266 information, see Export job expiration
267 (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration)
268 in the I<Amazon QLDB Developer Guide>.
269  
270 If the export job with the given C<ExportId> doesn't exist, then throws
271 C<ResourceNotFoundException>.
272  
273 If the ledger with the given C<Name> doesn't exist, then throws
274 C<ResourceNotFoundException>.
275  
276  
277 =head2 DescribeLedger
278  
279 =over
280  
281 =item Name => Str
282  
283  
284 =back
285  
286 Each argument is described in detail in: L<Paws::QLDB::DescribeLedger>
287  
288 Returns: a L<Paws::QLDB::DescribeLedgerResponse> instance
289  
290 Returns information about a ledger, including its state and when it was
291 created.
292  
293  
294 =head2 ExportJournalToS3
295  
296 =over
297  
298 =item ExclusiveEndTime => Str
299  
300 =item InclusiveStartTime => Str
301  
302 =item Name => Str
303  
304 =item RoleArn => Str
305  
306 =item S3ExportConfiguration => L<Paws::QLDB::S3ExportConfiguration>
307  
308  
309 =back
310  
311 Each argument is described in detail in: L<Paws::QLDB::ExportJournalToS3>
312  
313 Returns: a L<Paws::QLDB::ExportJournalToS3Response> instance
314  
315 Exports journal contents within a date and time range from a ledger
316 into a specified Amazon Simple Storage Service (Amazon S3) bucket. The
317 data is written as files in Amazon Ion format.
318  
319 If the ledger with the given C<Name> doesn't exist, then throws
320 C<ResourceNotFoundException>.
321  
322 If the ledger with the given C<Name> is in C<CREATING> status, then
323 throws C<ResourcePreconditionNotMetException>.
324  
325 You can initiate up to two concurrent journal export requests for each
326 ledger. Beyond this limit, journal export requests throw
327 C<LimitExceededException>.
328  
329  
330 =head2 GetBlock
331  
332 =over
333  
334 =item BlockAddress => L<Paws::QLDB::ValueHolder>
335  
336 =item Name => Str
337  
338 =item [DigestTipAddress => L<Paws::QLDB::ValueHolder>]
339  
340  
341 =back
342  
343 Each argument is described in detail in: L<Paws::QLDB::GetBlock>
344  
345 Returns: a L<Paws::QLDB::GetBlockResponse> instance
346  
347 Returns a block object at a specified address in a journal. Also
348 returns a proof of the specified block for verification if
349 C<DigestTipAddress> is provided.
350  
351 For information about the data contents in a block, see Journal
352 contents
353 (https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html)
354 in the I<Amazon QLDB Developer Guide>.
355  
356 If the specified ledger doesn't exist or is in C<DELETING> status, then
357 throws C<ResourceNotFoundException>.
358  
359 If the specified ledger is in C<CREATING> status, then throws
360 C<ResourcePreconditionNotMetException>.
361  
362 If no block exists with the specified address, then throws
363 C<InvalidParameterException>.
364  
365  
366 =head2 GetDigest
367  
368 =over
369  
370 =item Name => Str
371  
372  
373 =back
374  
375 Each argument is described in detail in: L<Paws::QLDB::GetDigest>
376  
377 Returns: a L<Paws::QLDB::GetDigestResponse> instance
378  
379 Returns the digest of a ledger at the latest committed block in the
380 journal. The response includes a 256-bit hash value and a block
381 address.
382  
383  
384 =head2 GetRevision
385  
386 =over
387  
388 =item BlockAddress => L<Paws::QLDB::ValueHolder>
389  
390 =item DocumentId => Str
391  
392 =item Name => Str
393  
394 =item [DigestTipAddress => L<Paws::QLDB::ValueHolder>]
395  
396  
397 =back
398  
399 Each argument is described in detail in: L<Paws::QLDB::GetRevision>
400  
401 Returns: a L<Paws::QLDB::GetRevisionResponse> instance
402  
403 Returns a revision data object for a specified document ID and block
404 address. Also returns a proof of the specified revision for
405 verification if C<DigestTipAddress> is provided.
406  
407  
408 =head2 ListJournalKinesisStreamsForLedger
409  
410 =over
411  
412 =item LedgerName => Str
413  
414 =item [MaxResults => Int]
415  
416 =item [NextToken => Str]
417  
418  
419 =back
420  
421 Each argument is described in detail in: L<Paws::QLDB::ListJournalKinesisStreamsForLedger>
422  
423 Returns: a L<Paws::QLDB::ListJournalKinesisStreamsForLedgerResponse> instance
424  
425 Returns an array of all Amazon QLDB journal stream descriptors for a
426 given ledger. The output of each stream descriptor includes the same
427 details that are returned by C<DescribeJournalKinesisStream>.
428  
429 This action does not return any expired journal streams. For more
430 information, see Expiration for terminal streams
431 (https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration)
432 in the I<Amazon QLDB Developer Guide>.
433  
434 This action returns a maximum of C<MaxResults> items. It is paginated
435 so that you can retrieve all the items by calling
436 C<ListJournalKinesisStreamsForLedger> multiple times.
437  
438  
439 =head2 ListJournalS3Exports
440  
441 =over
442  
443 =item [MaxResults => Int]
444  
445 =item [NextToken => Str]
446  
447  
448 =back
449  
450 Each argument is described in detail in: L<Paws::QLDB::ListJournalS3Exports>
451  
452 Returns: a L<Paws::QLDB::ListJournalS3ExportsResponse> instance
453  
454 Returns an array of journal export job descriptions for all ledgers
455 that are associated with the current AWS account and Region.
456  
457 This action returns a maximum of C<MaxResults> items, and is paginated
458 so that you can retrieve all the items by calling
459 C<ListJournalS3Exports> multiple times.
460  
461 This action does not return any expired export jobs. For more
462 information, see Export job expiration
463 (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration)
464 in the I<Amazon QLDB Developer Guide>.
465  
466  
467 =head2 ListJournalS3ExportsForLedger
468  
469 =over
470  
471 =item Name => Str
472  
473 =item [MaxResults => Int]
474  
475 =item [NextToken => Str]
476  
477  
478 =back
479  
480 Each argument is described in detail in: L<Paws::QLDB::ListJournalS3ExportsForLedger>
481  
482 Returns: a L<Paws::QLDB::ListJournalS3ExportsForLedgerResponse> instance
483  
484 Returns an array of journal export job descriptions for a specified
485 ledger.
486  
487 This action returns a maximum of C<MaxResults> items, and is paginated
488 so that you can retrieve all the items by calling
489 C<ListJournalS3ExportsForLedger> multiple times.
490  
491 This action does not return any expired export jobs. For more
492 information, see Export job expiration
493 (https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration)
494 in the I<Amazon QLDB Developer Guide>.
495  
496  
497 =head2 ListLedgers
498  
499 =over
500  
501 =item [MaxResults => Int]
502  
503 =item [NextToken => Str]
504  
505  
506 =back
507  
508 Each argument is described in detail in: L<Paws::QLDB::ListLedgers>
509  
510 Returns: a L<Paws::QLDB::ListLedgersResponse> instance
511  
512 Returns an array of ledger summaries that are associated with the
513 current AWS account and Region.
514  
515 This action returns a maximum of 100 items and is paginated so that you
516 can retrieve all the items by calling C<ListLedgers> multiple times.
517  
518  
519 =head2 ListTagsForResource
520  
521 =over
522  
523 =item ResourceArn => Str
524  
525  
526 =back
527  
528 Each argument is described in detail in: L<Paws::QLDB::ListTagsForResource>
529  
530 Returns: a L<Paws::QLDB::ListTagsForResourceResponse> instance
531  
532 Returns all tags for a specified Amazon QLDB resource.
533  
534  
535 =head2 StreamJournalToKinesis
536  
537 =over
538  
539 =item InclusiveStartTime => Str
540  
541 =item KinesisConfiguration => L<Paws::QLDB::KinesisConfiguration>
542  
543 =item LedgerName => Str
544  
545 =item RoleArn => Str
546  
547 =item StreamName => Str
548  
549 =item [ExclusiveEndTime => Str]
550  
551 =item [Tags => L<Paws::QLDB::Tags>]
552  
553  
554 =back
555  
556 Each argument is described in detail in: L<Paws::QLDB::StreamJournalToKinesis>
557  
558 Returns: a L<Paws::QLDB::StreamJournalToKinesisResponse> instance
559  
560 Creates a journal stream for a given Amazon QLDB ledger. The stream
561 captures every document revision that is committed to the ledger's
562 journal and delivers the data to a specified Amazon Kinesis Data
563 Streams resource.
564  
565  
566 =head2 TagResource
567  
568 =over
569  
570 =item ResourceArn => Str
571  
572 =item Tags => L<Paws::QLDB::Tags>
573  
574  
575 =back
576  
577 Each argument is described in detail in: L<Paws::QLDB::TagResource>
578  
579 Returns: a L<Paws::QLDB::TagResourceResponse> instance
580  
581 Adds one or more tags to a specified Amazon QLDB resource.
582  
583 A resource can have up to 50 tags. If you try to create more than 50
584 tags for a resource, your request fails and returns an error.
585  
586  
587 =head2 UntagResource
588  
589 =over
590  
591 =item ResourceArn => Str
592  
593 =item TagKeys => ArrayRef[Str|Undef]
594  
595  
596 =back
597  
598 Each argument is described in detail in: L<Paws::QLDB::UntagResource>
599  
600 Returns: a L<Paws::QLDB::UntagResourceResponse> instance
601  
602 Removes one or more tags from a specified Amazon QLDB resource. You can
603 specify up to 50 tag keys to remove.
604  
605  
606 =head2 UpdateLedger
607  
608 =over
609  
610 =item Name => Str
611  
612 =item [DeletionProtection => Bool]
613  
614  
615 =back
616  
617 Each argument is described in detail in: L<Paws::QLDB::UpdateLedger>
618  
619 Returns: a L<Paws::QLDB::UpdateLedgerResponse> instance
620  
621 Updates properties on a ledger.
622  
623  
624 =head2 UpdateLedgerPermissionsMode
625  
626 =over
627  
628 =item Name => Str
629  
630 =item PermissionsMode => Str
631  
632  
633 =back
634  
635 Each argument is described in detail in: L<Paws::QLDB::UpdateLedgerPermissionsMode>
636  
637 Returns: a L<Paws::QLDB::UpdateLedgerPermissionsModeResponse> instance
638  
639 Updates the permissions mode of a ledger.
640  
641 Before you switch to the C<STANDARD> permissions mode, you must first
642 create all required IAM policies and table tags to avoid disruption to
643 your users. To learn more, see Migrating to the standard permissions
644 mode
645 (https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating)
646 in the I<Amazon QLDB Developer Guide>.
647  
648  
649  
650  
651 =head1 PAGINATORS
652  
653 Paginator methods are helpers that repetively call methods that return partial results
654  
655  
656  
657  
658 =head1 SEE ALSO
659  
660 This service class forms part of L<Paws>
661  
662 =head1 BUGS and CONTRIBUTIONS
663  
664 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
665  
666 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
667  
668 =cut
669