« blib/lib/Paws/QLDB/JournalKinesisStreamDescription.pm
↑ Summary
blib/lib/Paws/QLDB/KinesisConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::QLDB::JournalS3ExportDescription; | ||
| 3 | use Moose; | ||
| 4 | has ExclusiveEndTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ExportCreationTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ExportId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has InclusiveStartTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has LedgerName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has S3ExportConfiguration => (is => 'ro', isa => 'Paws::QLDB::S3ExportConfiguration', required => 1); | ||
| 11 | has Status => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::QLDB::JournalS3ExportDescription | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::QLDB::JournalS3ExportDescription object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { ExclusiveEndTime => $value, ..., Status => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::QLDB::JournalS3ExportDescription object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->ExclusiveEndTime | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Information about a journal export job, including the ledger name, | ||
| 44 | export ID, creation time, current status, and the parameters of the | ||
| 45 | original export creation request. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> ExclusiveEndTime => Str | ||
| 51 | |||
| 52 | The exclusive end date and time for the range of journal contents that | ||
| 53 | are specified in the original export request. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> ExportCreationTime => Str | ||
| 57 | |||
| 58 | The date and time, in epoch time format, when the export job was | ||
| 59 | created. (Epoch time format is the number of seconds elapsed since | ||
| 60 | 12:00:00 AM January 1, 1970 UTC.) | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> ExportId => Str | ||
| 64 | |||
| 65 | The UUID (represented in Base62-encoded text) of the journal export | ||
| 66 | job. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> InclusiveStartTime => Str | ||
| 70 | |||
| 71 | The inclusive start date and time for the range of journal contents | ||
| 72 | that are specified in the original export request. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> LedgerName => Str | ||
| 76 | |||
| 77 | The name of the ledger. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> RoleArn => Str | ||
| 81 | |||
| 82 | The Amazon Resource Name (ARN) of the IAM role that grants QLDB | ||
| 83 | permissions for a journal export job to do the following: | ||
| 84 | |||
| 85 | =over | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | Write objects into your Amazon Simple Storage Service (Amazon S3) | ||
| 90 | bucket. | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | (Optional) Use your customer master key (CMK) in AWS Key Management | ||
| 95 | Service (AWS KMS) for server-side encryption of your exported data. | ||
| 96 | |||
| 97 | =back | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> S3ExportConfiguration => L<Paws::QLDB::S3ExportConfiguration> | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> Status => Str | ||
| 107 | |||
| 108 | The current state of the journal export job. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head1 SEE ALSO | ||
| 113 | |||
| 114 | This class forms part of L<Paws>, describing an object used in L<Paws::QLDB> | ||
| 115 | |||
| 116 | =head1 BUGS and CONTRIBUTIONS | ||
| 117 | |||
| 118 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 119 | |||
| 120 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 121 | |||
| 122 | =cut | ||
| 123 |