« blib/lib/Paws/QLDB/DescribeLedgerResponse.pm
↑ Summary
blib/lib/Paws/QLDB/ExportJournalToS3Response.pm »
| 1 | |||
| 2 | package Paws::QLDB::ExportJournalToS3; | ||
| 3 | use Moose; | ||
| 4 | has ExclusiveEndTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has InclusiveStartTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 7 | has RoleArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has S3ExportConfiguration => (is => 'ro', isa => 'Paws::QLDB::S3ExportConfiguration', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExportJournalToS3'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ledgers/{name}/journal-s3-exports'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::QLDB::ExportJournalToS3Response'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::QLDB::ExportJournalToS3 - Arguments for method ExportJournalToS3 on L<Paws::QLDB> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ExportJournalToS3 on the | ||
| 27 | L<Amazon QLDB|Paws::QLDB> service. Use the attributes of this class | ||
| 28 | as arguments to method ExportJournalToS3. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExportJournalToS3. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $qldb = Paws->service('QLDB'); | ||
| 35 | my $ExportJournalToS3Response = $qldb->ExportJournalToS3( | ||
| 36 | ExclusiveEndTime => '1970-01-01T01:00:00', | ||
| 37 | InclusiveStartTime => '1970-01-01T01:00:00', | ||
| 38 | Name => 'MyLedgerName', | ||
| 39 | RoleArn => 'MyArn', | ||
| 40 | S3ExportConfiguration => { | ||
| 41 | Bucket => 'MyS3Bucket', # min: 3, max: 255 | ||
| 42 | EncryptionConfiguration => { | ||
| 43 | ObjectEncryptionType => | ||
| 44 | 'SSE_KMS', # values: SSE_KMS, SSE_S3, NO_ENCRYPTION | ||
| 45 | KmsKeyArn => 'MyArn', # min: 20, max: 1600 | ||
| 46 | }, | ||
| 47 | Prefix => 'MyS3Prefix', # max: 128 | ||
| 48 | |||
| 49 | }, | ||
| 50 | |||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $ExportId = $ExportJournalToS3Response->ExportId; | ||
| 55 | |||
| 56 | # Returns a L<Paws::QLDB::ExportJournalToS3Response> object. | ||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/qldb/ExportJournalToS3> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> ExclusiveEndTime => Str | ||
| 65 | |||
| 66 | The exclusive end date and time for the range of journal contents to | ||
| 67 | export. | ||
| 68 | |||
| 69 | The C<ExclusiveEndTime> must be in C<ISO 8601> date and time format and | ||
| 70 | in Universal Coordinated Time (UTC). For example: | ||
| 71 | C<2019-06-13T21:36:34Z>. | ||
| 72 | |||
| 73 | The C<ExclusiveEndTime> must be less than or equal to the current UTC | ||
| 74 | date and time. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> InclusiveStartTime => Str | ||
| 79 | |||
| 80 | The inclusive start date and time for the range of journal contents to | ||
| 81 | export. | ||
| 82 | |||
| 83 | The C<InclusiveStartTime> must be in C<ISO 8601> date and time format | ||
| 84 | and in Universal Coordinated Time (UTC). For example: | ||
| 85 | C<2019-06-13T21:36:34Z>. | ||
| 86 | |||
| 87 | The C<InclusiveStartTime> must be before C<ExclusiveEndTime>. | ||
| 88 | |||
| 89 | If you provide an C<InclusiveStartTime> that is before the ledger's | ||
| 90 | C<CreationDateTime>, Amazon QLDB defaults it to the ledger's | ||
| 91 | C<CreationDateTime>. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> Name => Str | ||
| 96 | |||
| 97 | The name of the ledger. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> RoleArn => Str | ||
| 102 | |||
| 103 | The Amazon Resource Name (ARN) of the IAM role that grants QLDB | ||
| 104 | permissions for a journal export job to do the following: | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Write objects into your Amazon Simple Storage Service (Amazon S3) | ||
| 111 | bucket. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | (Optional) Use your customer master key (CMK) in AWS Key Management | ||
| 116 | Service (AWS KMS) for server-side encryption of your exported data. | ||
| 117 | |||
| 118 | =back | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 B<REQUIRED> S3ExportConfiguration => L<Paws::QLDB::S3ExportConfiguration> | ||
| 124 | |||
| 125 | The configuration settings of the Amazon S3 bucket destination for your | ||
| 126 | export request. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, documenting arguments for method ExportJournalToS3 in L<Paws::QLDB> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |