Paws::DynamoDB::TableDescription
This class represents one of two things:
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 => { AttributeDefinitions => $value, ..., TableStatus => $value });
Use accessors for each attribute. If Att1 is expected to be an Paws::DynamoDB::TableDescription object:
$result = $service_obj->Method(...); $result->Att1->AttributeDefinitions
Represents the properties of a table.
An array of C<AttributeDefinition> objects. Each of these objects describes one attribute in the table and index key schema.
Each AttributeDefinition object in this array is composed of:
AttributeDefinition
AttributeName - The name of the attribute.
AttributeName
AttributeType - The data type for the attribute.
AttributeType
The date and time when the table was created, in UNIX epoch time format.
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:
Backfilling - 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 CreateTable operation.)
Backfilling
CreateTable
IndexName - The name of the global secondary index.
IndexName
IndexSizeBytes - 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.
IndexSizeBytes
IndexStatus - The current status of the global secondary index:
IndexStatus
CREATING - The index is being created.
CREATING
UPDATING - The index is being updated.
UPDATING
DELETING - The index is being deleted.
DELETING
ACTIVE - The index is ready for use.
ACTIVE
ItemCount - 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.
ItemCount
KeySchema - 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.
KeySchema
Projection - 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:
Projection
ProjectionType - One of the following:
ProjectionType
KEYS_ONLY - Only the index and primary keys are projected into the index.
KEYS_ONLY
INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
INCLUDE
NonKeyAttributes
ALL - All of the table attributes are projected into the index.
ALL
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, 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.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
ProvisionedThroughput
If the table is in the DELETING state, no information about indexes will be returned.
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.
The primary key structure for the table. Each C<KeySchemaElement> consists of:
KeyType - The role of the attribute:
KeyType
HASH - partition key
HASH
RANGE - sort key
RANGE
The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' 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 range attribute. 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.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
A timestamp, in ISO 8601 format, for this stream.
Note that LatestStreamLabel 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:
LatestStreamLabel
the AWS customer ID.
the table name.
the StreamLabel.
StreamLabel
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:
IndexName - The name of the local secondary index.
IndexSizeBytes - 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.
ItemCount - 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.
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
The current DynamoDB Streams configuration for the table.
The Amazon Resource Name (ARN) that uniquely identifies the table.
The name of the table.
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.
The current state of the table:
CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
This class forms part of Paws, describing an object used in Paws::DynamoDB
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.