« blib/lib/Paws/DynamoDB/ExpectedAttributeValue.pm
↑ Summary
blib/lib/Paws/DynamoDB/ExportSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::ExportDescription; | ||
| 3 | use Moose; | ||
| 4 | has BilledSizeBytes => (is => 'ro', isa => 'Int'); | ||
| 5 | has ClientToken => (is => 'ro', isa => 'Str'); | ||
| 6 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 7 | has ExportArn => (is => 'ro', isa => 'Str'); | ||
| 8 | has ExportFormat => (is => 'ro', isa => 'Str'); | ||
| 9 | has ExportManifest => (is => 'ro', isa => 'Str'); | ||
| 10 | has ExportStatus => (is => 'ro', isa => 'Str'); | ||
| 11 | has ExportTime => (is => 'ro', isa => 'Str'); | ||
| 12 | has FailureCode => (is => 'ro', isa => 'Str'); | ||
| 13 | has FailureMessage => (is => 'ro', isa => 'Str'); | ||
| 14 | has ItemCount => (is => 'ro', isa => 'Int'); | ||
| 15 | has S3Bucket => (is => 'ro', isa => 'Str'); | ||
| 16 | has S3BucketOwner => (is => 'ro', isa => 'Str'); | ||
| 17 | has S3Prefix => (is => 'ro', isa => 'Str'); | ||
| 18 | has S3SseAlgorithm => (is => 'ro', isa => 'Str'); | ||
| 19 | has S3SseKmsKeyId => (is => 'ro', isa => 'Str'); | ||
| 20 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 21 | has TableArn => (is => 'ro', isa => 'Str'); | ||
| 22 | has TableId => (is => 'ro', isa => 'Str'); | ||
| 23 | |||
| 24 | 1; | ||
| 25 | |||
| 26 | ### main pod documentation begin ### | ||
| 27 | |||
| 28 | =head1 NAME | ||
| 29 | |||
| 30 | Paws::DynamoDB::ExportDescription | ||
| 31 | |||
| 32 | =head1 USAGE | ||
| 33 | |||
| 34 | This class represents one of two things: | ||
| 35 | |||
| 36 | =head3 Arguments in a call to a service | ||
| 37 | |||
| 38 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 39 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 40 | |||
| 41 | As an example, if Att1 is expected to be a Paws::DynamoDB::ExportDescription object: | ||
| 42 | |||
| 43 | $service_obj->Method(Att1 => { BilledSizeBytes => $value, ..., TableId => $value }); | ||
| 44 | |||
| 45 | =head3 Results returned from an API call | ||
| 46 | |||
| 47 | Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::ExportDescription object: | ||
| 48 | |||
| 49 | $result = $service_obj->Method(...); | ||
| 50 | $result->Att1->BilledSizeBytes | ||
| 51 | |||
| 52 | =head1 DESCRIPTION | ||
| 53 | |||
| 54 | Represents the properties of the exported table. | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 BilledSizeBytes => Int | ||
| 60 | |||
| 61 | The billable size of the table export. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 ClientToken => Str | ||
| 65 | |||
| 66 | The client token that was provided for the export task. A client token | ||
| 67 | makes calls to C<ExportTableToPointInTimeInput> idempotent, meaning | ||
| 68 | that multiple identical calls have the same effect as one single call. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 EndTime => Str | ||
| 72 | |||
| 73 | The time at which the export task completed. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 ExportArn => Str | ||
| 77 | |||
| 78 | The Amazon Resource Name (ARN) of the table export. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 ExportFormat => Str | ||
| 82 | |||
| 83 | The format of the exported data. Valid values for C<ExportFormat> are | ||
| 84 | C<DYNAMODB_JSON> or C<ION>. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 ExportManifest => Str | ||
| 88 | |||
| 89 | The name of the manifest file for the export task. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 ExportStatus => Str | ||
| 93 | |||
| 94 | Export can be in one of the following states: IN_PROGRESS, COMPLETED, | ||
| 95 | or FAILED. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 ExportTime => Str | ||
| 99 | |||
| 100 | Point in time from which table data was exported. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 FailureCode => Str | ||
| 104 | |||
| 105 | Status code for the result of the failed export. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 FailureMessage => Str | ||
| 109 | |||
| 110 | Export failure reason description. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 ItemCount => Int | ||
| 114 | |||
| 115 | The number of items exported. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 S3Bucket => Str | ||
| 119 | |||
| 120 | The name of the Amazon S3 bucket containing the export. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 S3BucketOwner => Str | ||
| 124 | |||
| 125 | The ID of the AWS account that owns the bucket containing the export. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 S3Prefix => Str | ||
| 129 | |||
| 130 | The Amazon S3 bucket prefix used as the file name and path of the | ||
| 131 | exported snapshot. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 S3SseAlgorithm => Str | ||
| 135 | |||
| 136 | Type of encryption used on the bucket where export data is stored. | ||
| 137 | Valid values for C<S3SseAlgorithm> are: | ||
| 138 | |||
| 139 | =over | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | C<AES256> - server-side encryption with Amazon S3 managed keys | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | C<KMS> - server-side encryption with AWS KMS managed keys | ||
| 148 | |||
| 149 | =back | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head2 S3SseKmsKeyId => Str | ||
| 154 | |||
| 155 | The ID of the AWS KMS managed key used to encrypt the S3 bucket where | ||
| 156 | export data is stored (if applicable). | ||
| 157 | |||
| 158 | |||
| 159 | =head2 StartTime => Str | ||
| 160 | |||
| 161 | The time at which the export task began. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 TableArn => Str | ||
| 165 | |||
| 166 | The Amazon Resource Name (ARN) of the table that was exported. | ||
| 167 | |||
| 168 | |||
| 169 | =head2 TableId => Str | ||
| 170 | |||
| 171 | Unique ID of the table that was exported. | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head1 SEE ALSO | ||
| 176 | |||
| 177 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 178 | |||
| 179 | =head1 BUGS and CONTRIBUTIONS | ||
| 180 | |||
| 181 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 182 | |||
| 183 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 184 | |||
| 185 | =cut | ||
| 186 |