| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DynamoDB::TableDescription; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has ArchivalSummary => (is => 'ro', isa => 'Paws::DynamoDB::ArchivalSummary'); | |
| 5 | 1 | has AttributeDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::AttributeDefinition]'); | |
| 6 | 1 | has BillingModeSummary => (is => 'ro', isa => 'Paws::DynamoDB::BillingModeSummary'); | |
| 7 | 1 | has CreationDateTime => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has GlobalSecondaryIndexes => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::GlobalSecondaryIndexDescription]'); | |
| 9 | 1 | has GlobalTableVersion => (is => 'ro', isa => 'Str'); | |
| 10 | 1 | has ItemCount => (is => 'ro', isa => 'Int'); | |
| 11 | 1 | has KeySchema => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::KeySchemaElement]'); | |
| 12 | 1 | has LatestStreamArn => (is => 'ro', isa => 'Str'); | |
| 13 | 1 | has LatestStreamLabel => (is => 'ro', isa => 'Str'); | |
| 14 | 1 | has LocalSecondaryIndexes => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::LocalSecondaryIndexDescription]'); | |
| 15 | 1 | has ProvisionedThroughput => (is => 'ro', isa => 'Paws::DynamoDB::ProvisionedThroughputDescription'); | |
| 16 | 1 | has Replicas => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::ReplicaDescription]'); | |
| 17 | 1 | has RestoreSummary => (is => 'ro', isa => 'Paws::DynamoDB::RestoreSummary'); | |
| 18 | 1 | has SSEDescription => (is => 'ro', isa => 'Paws::DynamoDB::SSEDescription'); | |
| 19 | 1 | has StreamSpecification => (is => 'ro', isa => 'Paws::DynamoDB::StreamSpecification'); | |
| 20 | 1 | has TableArn => (is => 'ro', isa => 'Str'); | |
| 21 | 1 | has TableId => (is => 'ro', isa => 'Str'); | |
| 22 | 1 | has TableName => (is => 'ro', isa => 'Str'); | |
| 23 | 1 | has TableSizeBytes => (is => 'ro', isa => 'Int'); | |
| 24 | 1 | has TableStatus => (is => 'ro', isa => 'Str'); | |
| 25 | |||
| 26 | 1 | 1; | |
| 27 | |||
| 28 | ### main pod documentation begin ### | ||
| 29 | |||
| 30 | =head1 NAME | ||
| 31 | |||
| 32 | Paws::DynamoDB::TableDescription | ||
| 33 | |||
| 34 | =head1 USAGE | ||
| 35 | |||
| 36 | This class represents one of two things: | ||
| 37 | |||
| 38 | =head3 Arguments in a call to a service | ||
| 39 | |||
| 40 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 41 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 42 | |||
| 43 | As an example, if Att1 is expected to be a Paws::DynamoDB::TableDescription object: | ||
| 44 | |||
| 45 | $service_obj->Method(Att1 => { ArchivalSummary => $value, ..., TableStatus => $value }); | ||
| 46 | |||
| 47 | =head3 Results returned from an API call | ||
| 48 | |||
| 49 | Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::TableDescription object: | ||
| 50 | |||
| 51 | $result = $service_obj->Method(...); | ||
| 52 | $result->Att1->ArchivalSummary | ||
| 53 | |||
| 54 | =head1 DESCRIPTION | ||
| 55 | |||
| 56 | Represents the properties of a table. | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 ArchivalSummary => L<Paws::DynamoDB::ArchivalSummary> | ||
| 62 | |||
| 63 | Contains information about the table archive. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 AttributeDefinitions => ArrayRef[L<Paws::DynamoDB::AttributeDefinition>] | ||
| 67 | |||
| 68 | An array of C<AttributeDefinition> objects. Each of these objects | ||
| 69 | describes one attribute in the table and index key schema. | ||
| 70 | |||
| 71 | Each C<AttributeDefinition> object in this array is composed of: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<AttributeName> - The name of the attribute. | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<AttributeType> - The data type for the attribute. | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 BillingModeSummary => L<Paws::DynamoDB::BillingModeSummary> | ||
| 88 | |||
| 89 | Contains the details for the read/write capacity mode. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 CreationDateTime => Str | ||
| 93 | |||
| 94 | The date and time when the table was created, in UNIX epoch time | ||
| 95 | (http://www.epochconverter.com/) format. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 GlobalSecondaryIndexes => ArrayRef[L<Paws::DynamoDB::GlobalSecondaryIndexDescription>] | ||
| 99 | |||
| 100 | The global secondary indexes, if any, on the table. Each index is | ||
| 101 | scoped to a given partition key value. Each element is composed of: | ||
| 102 | |||
| 103 | =over | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<Backfilling> - If true, then the index is currently in the | ||
| 108 | backfilling phase. Backfilling occurs only when a new global secondary | ||
| 109 | index is added to the table. It is the process by which DynamoDB | ||
| 110 | populates the new index with data from the table. (This attribute does | ||
| 111 | not appear for indexes that were created during a C<CreateTable> | ||
| 112 | operation.) | ||
| 113 | |||
| 114 | You can delete an index that is being created during the C<Backfilling> | ||
| 115 | phase when C<IndexStatus> is set to CREATING and C<Backfilling> is | ||
| 116 | true. You can't delete the index that is being created when | ||
| 117 | C<IndexStatus> is set to CREATING and C<Backfilling> is false. (This | ||
| 118 | attribute does not appear for indexes that were created during a | ||
| 119 | C<CreateTable> operation.) | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | C<IndexName> - The name of the global secondary index. | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | C<IndexSizeBytes> - The total size of the global secondary index, in | ||
| 128 | bytes. DynamoDB updates this value approximately every six hours. | ||
| 129 | Recent changes might not be reflected in this value. | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | C<IndexStatus> - The current status of the global secondary index: | ||
| 134 | |||
| 135 | =over | ||
| 136 | |||
| 137 | =item * | ||
| 138 | |||
| 139 | C<CREATING> - The index is being created. | ||
| 140 | |||
| 141 | =item * | ||
| 142 | |||
| 143 | C<UPDATING> - The index is being updated. | ||
| 144 | |||
| 145 | =item * | ||
| 146 | |||
| 147 | C<DELETING> - The index is being deleted. | ||
| 148 | |||
| 149 | =item * | ||
| 150 | |||
| 151 | C<ACTIVE> - The index is ready for use. | ||
| 152 | |||
| 153 | =back | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<ItemCount> - The number of items in the global secondary index. | ||
| 158 | DynamoDB updates this value approximately every six hours. Recent | ||
| 159 | changes might not be reflected in this value. | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | C<KeySchema> - Specifies the complete index key schema. The attribute | ||
| 164 | names in the key schema must be between 1 and 255 characters | ||
| 165 | (inclusive). The key schema must begin with the same partition key as | ||
| 166 | the table. | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | C<Projection> - Specifies attributes that are copied (projected) from | ||
| 171 | the table into the index. These are in addition to the primary key | ||
| 172 | attributes and index key attributes, which are automatically projected. | ||
| 173 | Each attribute specification is composed of: | ||
| 174 | |||
| 175 | =over | ||
| 176 | |||
| 177 | =item * | ||
| 178 | |||
| 179 | C<ProjectionType> - One of the following: | ||
| 180 | |||
| 181 | =over | ||
| 182 | |||
| 183 | =item * | ||
| 184 | |||
| 185 | C<KEYS_ONLY> - Only the index and primary keys are projected into the | ||
| 186 | index. | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | C<INCLUDE> - In addition to the attributes described in C<KEYS_ONLY>, | ||
| 191 | the secondary index will include other non-key attributes that you | ||
| 192 | specify. | ||
| 193 | |||
| 194 | =item * | ||
| 195 | |||
| 196 | C<ALL> - All of the table attributes are projected into the index. | ||
| 197 | |||
| 198 | =back | ||
| 199 | |||
| 200 | =item * | ||
| 201 | |||
| 202 | C<NonKeyAttributes> - A list of one or more non-key attribute names | ||
| 203 | that are projected into the secondary index. The total count of | ||
| 204 | attributes provided in C<NonKeyAttributes>, summed across all of the | ||
| 205 | secondary indexes, must not exceed 20. If you project the same | ||
| 206 | attribute into two different indexes, this counts as two distinct | ||
| 207 | attributes when determining the total. | ||
| 208 | |||
| 209 | =back | ||
| 210 | |||
| 211 | =item * | ||
| 212 | |||
| 213 | C<ProvisionedThroughput> - The provisioned throughput settings for the | ||
| 214 | global secondary index, consisting of read and write capacity units, | ||
| 215 | along with data about increases and decreases. | ||
| 216 | |||
| 217 | =back | ||
| 218 | |||
| 219 | If the table is in the C<DELETING> state, no information about indexes | ||
| 220 | will be returned. | ||
| 221 | |||
| 222 | |||
| 223 | =head2 GlobalTableVersion => Str | ||
| 224 | |||
| 225 | Represents the version of global tables | ||
| 226 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) | ||
| 227 | in use, if the table is replicated across AWS Regions. | ||
| 228 | |||
| 229 | |||
| 230 | =head2 ItemCount => Int | ||
| 231 | |||
| 232 | The number of items in the specified table. DynamoDB updates this value | ||
| 233 | approximately every six hours. Recent changes might not be reflected in | ||
| 234 | this value. | ||
| 235 | |||
| 236 | |||
| 237 | =head2 KeySchema => ArrayRef[L<Paws::DynamoDB::KeySchemaElement>] | ||
| 238 | |||
| 239 | The primary key structure for the table. Each C<KeySchemaElement> | ||
| 240 | consists of: | ||
| 241 | |||
| 242 | =over | ||
| 243 | |||
| 244 | =item * | ||
| 245 | |||
| 246 | C<AttributeName> - The name of the attribute. | ||
| 247 | |||
| 248 | =item * | ||
| 249 | |||
| 250 | C<KeyType> - The role of the attribute: | ||
| 251 | |||
| 252 | =over | ||
| 253 | |||
| 254 | =item * | ||
| 255 | |||
| 256 | C<HASH> - partition key | ||
| 257 | |||
| 258 | =item * | ||
| 259 | |||
| 260 | C<RANGE> - sort key | ||
| 261 | |||
| 262 | =back | ||
| 263 | |||
| 264 | The partition key of an item is also known as its I<hash attribute>. | ||
| 265 | The term "hash attribute" derives from DynamoDB's usage of an internal | ||
| 266 | hash function to evenly distribute data items across partitions, based | ||
| 267 | on their partition key values. | ||
| 268 | |||
| 269 | The sort key of an item is also known as its I<range attribute>. The | ||
| 270 | term "range attribute" derives from the way DynamoDB stores items with | ||
| 271 | the same partition key physically close together, in sorted order by | ||
| 272 | the sort key value. | ||
| 273 | |||
| 274 | =back | ||
| 275 | |||
| 276 | For more information about primary keys, see Primary Key | ||
| 277 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey) | ||
| 278 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 279 | |||
| 280 | |||
| 281 | =head2 LatestStreamArn => Str | ||
| 282 | |||
| 283 | The Amazon Resource Name (ARN) that uniquely identifies the latest | ||
| 284 | stream for this table. | ||
| 285 | |||
| 286 | |||
| 287 | =head2 LatestStreamLabel => Str | ||
| 288 | |||
| 289 | A timestamp, in ISO 8601 format, for this stream. | ||
| 290 | |||
| 291 | Note that C<LatestStreamLabel> is not a unique identifier for the | ||
| 292 | stream, because it is possible that a stream from another table might | ||
| 293 | have the same timestamp. However, the combination of the following | ||
| 294 | three elements is guaranteed to be unique: | ||
| 295 | |||
| 296 | =over | ||
| 297 | |||
| 298 | =item * | ||
| 299 | |||
| 300 | AWS customer ID | ||
| 301 | |||
| 302 | =item * | ||
| 303 | |||
| 304 | Table name | ||
| 305 | |||
| 306 | =item * | ||
| 307 | |||
| 308 | C<StreamLabel> | ||
| 309 | |||
| 310 | =back | ||
| 311 | |||
| 312 | |||
| 313 | |||
| 314 | =head2 LocalSecondaryIndexes => ArrayRef[L<Paws::DynamoDB::LocalSecondaryIndexDescription>] | ||
| 315 | |||
| 316 | Represents one or more local secondary indexes on the table. Each index | ||
| 317 | is scoped to a given partition key value. Tables with one or more local | ||
| 318 | secondary indexes are subject to an item collection size limit, where | ||
| 319 | the amount of data within a given item collection cannot exceed 10 GB. | ||
| 320 | Each element is composed of: | ||
| 321 | |||
| 322 | =over | ||
| 323 | |||
| 324 | =item * | ||
| 325 | |||
| 326 | C<IndexName> - The name of the local secondary index. | ||
| 327 | |||
| 328 | =item * | ||
| 329 | |||
| 330 | C<KeySchema> - Specifies the complete index key schema. The attribute | ||
| 331 | names in the key schema must be between 1 and 255 characters | ||
| 332 | (inclusive). The key schema must begin with the same partition key as | ||
| 333 | the table. | ||
| 334 | |||
| 335 | =item * | ||
| 336 | |||
| 337 | C<Projection> - Specifies attributes that are copied (projected) from | ||
| 338 | the table into the index. These are in addition to the primary key | ||
| 339 | attributes and index key attributes, which are automatically projected. | ||
| 340 | Each attribute specification is composed of: | ||
| 341 | |||
| 342 | =over | ||
| 343 | |||
| 344 | =item * | ||
| 345 | |||
| 346 | C<ProjectionType> - One of the following: | ||
| 347 | |||
| 348 | =over | ||
| 349 | |||
| 350 | =item * | ||
| 351 | |||
| 352 | C<KEYS_ONLY> - Only the index and primary keys are projected into the | ||
| 353 | index. | ||
| 354 | |||
| 355 | =item * | ||
| 356 | |||
| 357 | C<INCLUDE> - Only the specified table attributes are projected into the | ||
| 358 | index. The list of projected attributes is in C<NonKeyAttributes>. | ||
| 359 | |||
| 360 | =item * | ||
| 361 | |||
| 362 | C<ALL> - All of the table attributes are projected into the index. | ||
| 363 | |||
| 364 | =back | ||
| 365 | |||
| 366 | =item * | ||
| 367 | |||
| 368 | C<NonKeyAttributes> - A list of one or more non-key attribute names | ||
| 369 | that are projected into the secondary index. The total count of | ||
| 370 | attributes provided in C<NonKeyAttributes>, summed across all of the | ||
| 371 | secondary indexes, must not exceed 20. If you project the same | ||
| 372 | attribute into two different indexes, this counts as two distinct | ||
| 373 | attributes when determining the total. | ||
| 374 | |||
| 375 | =back | ||
| 376 | |||
| 377 | =item * | ||
| 378 | |||
| 379 | C<IndexSizeBytes> - Represents the total size of the index, in bytes. | ||
| 380 | DynamoDB updates this value approximately every six hours. Recent | ||
| 381 | changes might not be reflected in this value. | ||
| 382 | |||
| 383 | =item * | ||
| 384 | |||
| 385 | C<ItemCount> - Represents the number of items in the index. DynamoDB | ||
| 386 | updates this value approximately every six hours. Recent changes might | ||
| 387 | not be reflected in this value. | ||
| 388 | |||
| 389 | =back | ||
| 390 | |||
| 391 | If the table is in the C<DELETING> state, no information about indexes | ||
| 392 | will be returned. | ||
| 393 | |||
| 394 | |||
| 395 | =head2 ProvisionedThroughput => L<Paws::DynamoDB::ProvisionedThroughputDescription> | ||
| 396 | |||
| 397 | The provisioned throughput settings for the table, consisting of read | ||
| 398 | and write capacity units, along with data about increases and | ||
| 399 | decreases. | ||
| 400 | |||
| 401 | |||
| 402 | =head2 Replicas => ArrayRef[L<Paws::DynamoDB::ReplicaDescription>] | ||
| 403 | |||
| 404 | Represents replicas of the table. | ||
| 405 | |||
| 406 | |||
| 407 | =head2 RestoreSummary => L<Paws::DynamoDB::RestoreSummary> | ||
| 408 | |||
| 409 | Contains details for the restore. | ||
| 410 | |||
| 411 | |||
| 412 | =head2 SSEDescription => L<Paws::DynamoDB::SSEDescription> | ||
| 413 | |||
| 414 | The description of the server-side encryption status on the specified | ||
| 415 | table. | ||
| 416 | |||
| 417 | |||
| 418 | =head2 StreamSpecification => L<Paws::DynamoDB::StreamSpecification> | ||
| 419 | |||
| 420 | The current DynamoDB Streams configuration for the table. | ||
| 421 | |||
| 422 | |||
| 423 | =head2 TableArn => Str | ||
| 424 | |||
| 425 | The Amazon Resource Name (ARN) that uniquely identifies the table. | ||
| 426 | |||
| 427 | |||
| 428 | =head2 TableId => Str | ||
| 429 | |||
| 430 | Unique identifier for the table for which the backup was created. | ||
| 431 | |||
| 432 | |||
| 433 | =head2 TableName => Str | ||
| 434 | |||
| 435 | The name of the table. | ||
| 436 | |||
| 437 | |||
| 438 | =head2 TableSizeBytes => Int | ||
| 439 | |||
| 440 | The total size of the specified table, in bytes. DynamoDB updates this | ||
| 441 | value approximately every six hours. Recent changes might not be | ||
| 442 | reflected in this value. | ||
| 443 | |||
| 444 | |||
| 445 | =head2 TableStatus => Str | ||
| 446 | |||
| 447 | The current state of the table: | ||
| 448 | |||
| 449 | =over | ||
| 450 | |||
| 451 | =item * | ||
| 452 | |||
| 453 | C<CREATING> - The table is being created. | ||
| 454 | |||
| 455 | =item * | ||
| 456 | |||
| 457 | C<UPDATING> - The table is being updated. | ||
| 458 | |||
| 459 | =item * | ||
| 460 | |||
| 461 | C<DELETING> - The table is being deleted. | ||
| 462 | |||
| 463 | =item * | ||
| 464 | |||
| 465 | C<ACTIVE> - The table is ready for use. | ||
| 466 | |||
| 467 | =item * | ||
| 468 | |||
| 469 | C<INACCESSIBLE_ENCRYPTION_CREDENTIALS> - The AWS KMS key used to | ||
| 470 | encrypt the table in inaccessible. Table operations may fail due to | ||
| 471 | failure to use the AWS KMS key. DynamoDB will initiate the table | ||
| 472 | archival process when a table's AWS KMS key remains inaccessible for | ||
| 473 | more than seven days. | ||
| 474 | |||
| 475 | =item * | ||
| 476 | |||
| 477 | C<ARCHIVING> - The table is being archived. Operations are not allowed | ||
| 478 | until archival is complete. | ||
| 479 | |||
| 480 | =item * | ||
| 481 | |||
| 482 | C<ARCHIVED> - The table has been archived. See the ArchivalReason for | ||
| 483 | more information. | ||
| 484 | |||
| 485 | =back | ||
| 486 | |||
| 487 | |||
| 488 | |||
| 489 | |||
| 490 | =head1 SEE ALSO | ||
| 491 | |||
| 492 | This class forms part of L<Paws>, describing an object used in L<Paws::DynamoDB> | ||
| 493 | |||
| 494 | =head1 BUGS and CONTRIBUTIONS | ||
| 495 | |||
| 496 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 497 | |||
| 498 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 499 | |||
| 500 | =cut | ||
| 501 | |||