# Generated by default/object.tt package Paws::DynamoDB::TableDescription; use Moose; has ArchivalSummary => (is => 'ro', isa => 'Paws::DynamoDB::ArchivalSummary'); has AttributeDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::AttributeDefinition]'); has BillingModeSummary => (is => 'ro', isa => 'Paws::DynamoDB::BillingModeSummary'); has CreationDateTime => (is => 'ro', isa => 'Str'); has GlobalSecondaryIndexes => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::GlobalSecondaryIndexDescription]'); has GlobalTableVersion => (is => 'ro', isa => 'Str'); has ItemCount => (is => 'ro', isa => 'Int'); has KeySchema => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::KeySchemaElement]'); has LatestStreamArn => (is => 'ro', isa => 'Str'); has LatestStreamLabel => (is => 'ro', isa => 'Str'); has LocalSecondaryIndexes => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::LocalSecondaryIndexDescription]'); has ProvisionedThroughput => (is => 'ro', isa => 'Paws::DynamoDB::ProvisionedThroughputDescription'); has Replicas => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::ReplicaDescription]'); has RestoreSummary => (is => 'ro', isa => 'Paws::DynamoDB::RestoreSummary'); has SSEDescription => (is => 'ro', isa => 'Paws::DynamoDB::SSEDescription'); has StreamSpecification => (is => 'ro', isa => 'Paws::DynamoDB::StreamSpecification'); has TableArn => (is => 'ro', isa => 'Str'); has TableId => (is => 'ro', isa => 'Str'); has TableName => (is => 'ro', isa => 'Str'); has TableSizeBytes => (is => 'ro', isa => 'Int'); has TableStatus => (is => 'ro', isa => 'Str'); 1; ### main pod documentation begin ### =head1 NAME Paws::DynamoDB::TableDescription =head1 USAGE This class represents one of two things: =head3 Arguments in a call to a service Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object. As an example, if Att1 is expected to be a Paws::DynamoDB::TableDescription object: $service_obj->Method(Att1 => { ArchivalSummary => $value, ..., TableStatus => $value }); =head3 Results returned from an API call Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::TableDescription object: $result = $service_obj->Method(...); $result->Att1->ArchivalSummary =head1 DESCRIPTION Represents the properties of a table. =head1 ATTRIBUTES =head2 ArchivalSummary => L Contains information about the table archive. =head2 AttributeDefinitions => ArrayRef[L] An array of C objects. Each of these objects describes one attribute in the table and index key schema. Each C object in this array is composed of: =over =item * C - The name of the attribute. =item * C - The data type for the attribute. =back =head2 BillingModeSummary => L Contains the details for the read/write capacity mode. =head2 CreationDateTime => Str The date and time when the table was created, in UNIX epoch time (http://www.epochconverter.com/) format. =head2 GlobalSecondaryIndexes => ArrayRef[L] The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: =over =item * C - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a C operation.) You can delete an index that is being created during the C phase when C is set to CREATING and C is true. You can't delete the index that is being created when C is set to CREATING and C is false. (This attribute does not appear for indexes that were created during a C operation.) =item * C - The name of the global secondary index. =item * C - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. =item * C - The current status of the global secondary index: =over =item * C - The index is being created. =item * C - The index is being updated. =item * C - The index is being deleted. =item * C - The index is ready for use. =back =item * C - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. =item * C - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. =item * C - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: =over =item * C - One of the following: =over =item * C - Only the index and primary keys are projected into the index. =item * C - In addition to the attributes described in C, the secondary index will include other non-key attributes that you specify. =item * C - All of the table attributes are projected into the index. =back =item * C - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in C, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. =back =item * C - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. =back If the table is in the C state, no information about indexes will be returned. =head2 GlobalTableVersion => Str Represents the version of global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html) in use, if the table is replicated across AWS Regions. =head2 ItemCount => Int The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. =head2 KeySchema => ArrayRef[L] The primary key structure for the table. Each C consists of: =over =item * C - The name of the attribute. =item * C - The role of the attribute: =over =item * C - partition key =item * C - sort key =back The partition key of an item is also known as its I. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its I. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. =back For more information about primary keys, see Primary Key (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey) in the I. =head2 LatestStreamArn => Str The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table. =head2 LatestStreamLabel => Str A timestamp, in ISO 8601 format, for this stream. Note that C is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: =over =item * AWS customer ID =item * Table name =item * C =back =head2 LocalSecondaryIndexes => ArrayRef[L] Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: =over =item * C - The name of the local secondary index. =item * C - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. =item * C - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: =over =item * C - One of the following: =over =item * C - Only the index and primary keys are projected into the index. =item * C - Only the specified table attributes are projected into the index. The list of projected attributes is in C. =item * C - All of the table attributes are projected into the index. =back =item * C - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in C, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. =back =item * C - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. =item * C - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. =back If the table is in the C state, no information about indexes will be returned. =head2 ProvisionedThroughput => L The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases. =head2 Replicas => ArrayRef[L] Represents replicas of the table. =head2 RestoreSummary => L Contains details for the restore. =head2 SSEDescription => L The description of the server-side encryption status on the specified table. =head2 StreamSpecification => L The current DynamoDB Streams configuration for the table. =head2 TableArn => Str The Amazon Resource Name (ARN) that uniquely identifies the table. =head2 TableId => Str Unique identifier for the table for which the backup was created. =head2 TableName => Str The name of the table. =head2 TableSizeBytes => Int The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. =head2 TableStatus => Str The current state of the table: =over =item * C - The table is being created. =item * C - The table is being updated. =item * C - The table is being deleted. =item * C - The table is ready for use. =item * C - The AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS KMS key remains inaccessible for more than seven days. =item * C - The table is being archived. Operations are not allowed until archival is complete. =item * C - The table has been archived. See the ArchivalReason for more information. =back =head1 SEE ALSO This class forms part of L, describing an object used in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut