« blib/lib/Paws/DynamoDB/ExportSummary.pm
↑ Summary
blib/lib/Paws/DynamoDB/ExportTableToPointInTimeOutput.pm »
| 1 | |||
| 2 | package Paws::DynamoDB::ExportTableToPointInTime; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 5 | has ExportFormat => (is => 'ro', isa => 'Str'); | ||
| 6 | has ExportTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has S3Bucket => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has S3BucketOwner => (is => 'ro', isa => 'Str'); | ||
| 9 | has S3Prefix => (is => 'ro', isa => 'Str'); | ||
| 10 | has S3SseAlgorithm => (is => 'ro', isa => 'Str'); | ||
| 11 | has S3SseKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 12 | has TableArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ExportTableToPointInTime'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::ExportTableToPointInTimeOutput'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::DynamoDB::ExportTableToPointInTime - Arguments for method ExportTableToPointInTime on L<Paws::DynamoDB> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ExportTableToPointInTime on the | ||
| 30 | L<Amazon DynamoDB|Paws::DynamoDB> service. Use the attributes of this class | ||
| 31 | as arguments to method ExportTableToPointInTime. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ExportTableToPointInTime. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $dynamodb = Paws->service('DynamoDB'); | ||
| 38 | my $ExportTableToPointInTimeOutput = $dynamodb->ExportTableToPointInTime( | ||
| 39 | S3Bucket => 'MyS3Bucket', | ||
| 40 | TableArn => 'MyTableArn', | ||
| 41 | ClientToken => 'MyClientToken', # OPTIONAL | ||
| 42 | ExportFormat => 'DYNAMODB_JSON', # OPTIONAL | ||
| 43 | ExportTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 44 | S3BucketOwner => 'MyS3BucketOwner', # OPTIONAL | ||
| 45 | S3Prefix => 'MyS3Prefix', # OPTIONAL | ||
| 46 | S3SseAlgorithm => 'AES256', # OPTIONAL | ||
| 47 | S3SseKmsKeyId => 'MyS3SseKmsKeyId', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $ExportDescription = $ExportTableToPointInTimeOutput->ExportDescription; | ||
| 52 | |||
| 53 | # Returns a L<Paws::DynamoDB::ExportTableToPointInTimeOutput> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dynamodb/ExportTableToPointInTime> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 ClientToken => Str | ||
| 62 | |||
| 63 | Providing a C<ClientToken> makes the call to | ||
| 64 | C<ExportTableToPointInTimeInput> idempotent, meaning that multiple | ||
| 65 | identical calls have the same effect as one single call. | ||
| 66 | |||
| 67 | A client token is valid for 8 hours after the first request that uses | ||
| 68 | it is completed. After 8 hours, any request with the same client token | ||
| 69 | is treated as a new request. Do not resubmit the same request with the | ||
| 70 | same client token for more than 8 hours, or the result might not be | ||
| 71 | idempotent. | ||
| 72 | |||
| 73 | If you submit a request with the same client token but a change in | ||
| 74 | other parameters within the 8-hour idempotency window, DynamoDB returns | ||
| 75 | an C<IdempotentParameterMismatch> exception. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 ExportFormat => Str | ||
| 80 | |||
| 81 | The format for the exported data. Valid values for C<ExportFormat> are | ||
| 82 | C<DYNAMODB_JSON> or C<ION>. | ||
| 83 | |||
| 84 | Valid values are: C<"DYNAMODB_JSON">, C<"ION"> | ||
| 85 | |||
| 86 | =head2 ExportTime => Str | ||
| 87 | |||
| 88 | Time in the past from which to export table data. The table export will | ||
| 89 | be a snapshot of the table's state at this point in time. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> S3Bucket => Str | ||
| 94 | |||
| 95 | The name of the Amazon S3 bucket to export the snapshot to. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 S3BucketOwner => Str | ||
| 100 | |||
| 101 | The ID of the AWS account that owns the bucket the export will be | ||
| 102 | stored in. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 S3Prefix => Str | ||
| 107 | |||
| 108 | The Amazon S3 bucket prefix to use as the file name and path of the | ||
| 109 | exported snapshot. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 S3SseAlgorithm => Str | ||
| 114 | |||
| 115 | Type of encryption used on the bucket where export data will be stored. | ||
| 116 | Valid values for C<S3SseAlgorithm> are: | ||
| 117 | |||
| 118 | =over | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | C<AES256> - server-side encryption with Amazon S3 managed keys | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<KMS> - server-side encryption with AWS KMS managed keys | ||
| 127 | |||
| 128 | =back | ||
| 129 | |||
| 130 | |||
| 131 | Valid values are: C<"AES256">, C<"KMS"> | ||
| 132 | |||
| 133 | =head2 S3SseKmsKeyId => Str | ||
| 134 | |||
| 135 | The ID of the AWS KMS managed key used to encrypt the S3 bucket where | ||
| 136 | export data will be stored (if applicable). | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 B<REQUIRED> TableArn => Str | ||
| 141 | |||
| 142 | The Amazon Resource Name (ARN) associated with the table to export. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head1 SEE ALSO | ||
| 148 | |||
| 149 | This class forms part of L<Paws>, documenting arguments for method ExportTableToPointInTime in L<Paws::DynamoDB> | ||
| 150 | |||
| 151 | =head1 BUGS and CONTRIBUTIONS | ||
| 152 | |||
| 153 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 154 | |||
| 155 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 156 | |||
| 157 | =cut | ||
| 158 |