AWS SDK for .NET Documentation
TableDescription Class
AmazonAmazon.DynamoDBv2.ModelTableDescription Did this page help you?   Yes   No    Tell us about it...

Represents the properties of a table.

Declaration Syntax
C#
public class TableDescription
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
TableDescription()()()()
Initializes a new instance of the TableDescription class

AttributeDefinitions
An array of 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:
  • AttributeName - The name of the attribute.
  • AttributeType - The data type for the attribute.

CreationDateTime
The date and time when the table was created, in UNIX epoch time format.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
GlobalSecondaryIndexes
The global secondary indexes, if any, on the table. Each index is scoped to a given hash key value. Each element is composed of:
  • IndexName - The name of the global secondary index.
  • 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.
  • IndexStatus - The current status of the global secondary index:
    • CREATING - The index is being created.
    • UPDATING - The index is being updated.
    • DELETING - The index is being deleted.
    • ACTIVE - The index is ready for use.
  • 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.
  • 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 hash key attribute as the table.
  • 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:
    • ProjectionType - One of the following:
      • KEYS_ONLY - Only the index and primary keys are projected into the index.
      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
      • ALL - All of the table attributes are projected into the index.
    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified 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.
If the table is in the DELETING state, no information about indexes will be returned.

ItemCount
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.

KeySchema
The primary key structure for the table. Each KeySchemaElement consists of:
  • AttributeName - The name of the attribute.
  • KeyType - The key type for the attribute. Can be either HASH or RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Constraints:

Length
1 - 2


LocalSecondaryIndexes
Represents one or more local secondary indexes on the table. Each index is scoped to a given hash 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.
  • 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 hash key attribute as the table.
  • 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:
    • ProjectionType - One of the following:
      • KEYS_ONLY - Only the index and primary keys are projected into the index.
      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.
      • ALL - All of the table attributes are projected into the index.
    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified 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.
  • 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.
If the table is in the DELETING state, no information about indexes will be returned.

ProvisionedThroughput
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

TableName
The name of the table.

Constraints:

Length
3 - 255
Pattern
[a-zA-Z0-9_.-]+


TableSizeBytes
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.

TableStatus
The current state of the table:
  • CREATING - The table is being created, as the result of a CreateTable operation.
  • UPDATING - The table is being updated, as the result of an UpdateTable operation.
  • DELETING - The table is being deleted, as the result of a DeleteTable operation.
  • ACTIVE - The table is ready for use.

Constraints:

Allowed Values
CREATING, UPDATING, DELETING, ACTIVE


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithAttributeDefinitions(array<AttributeDefinition>[]()[][]) Obsolete.
Adds elements to the AttributeDefinitions collection

WithAttributeDefinitions(IEnumerable<(Of <<'(AttributeDefinition>)>>)) Obsolete.
Adds elements to the AttributeDefinitions collection

WithCreationDateTime(DateTime) Obsolete.
Sets the CreationDateTime property

WithGlobalSecondaryIndexes(array<GlobalSecondaryIndexDescription>[]()[][]) Obsolete.
Adds elements to the GlobalSecondaryIndexes collection

WithGlobalSecondaryIndexes(IEnumerable<(Of <<'(GlobalSecondaryIndexDescription>)>>)) Obsolete.
Adds elements to the GlobalSecondaryIndexes collection

WithItemCount(Int64) Obsolete.
Sets the ItemCount property

WithKeySchema(array<KeySchemaElement>[]()[][]) Obsolete.
Adds elements to the KeySchema collection

WithKeySchema(IEnumerable<(Of <<'(KeySchemaElement>)>>)) Obsolete.
Adds elements to the KeySchema collection

WithLocalSecondaryIndexes(array<LocalSecondaryIndexDescription>[]()[][]) Obsolete.
Adds elements to the LocalSecondaryIndexes collection

WithLocalSecondaryIndexes(IEnumerable<(Of <<'(LocalSecondaryIndexDescription>)>>)) Obsolete.
Adds elements to the LocalSecondaryIndexes collection

WithProvisionedThroughput(ProvisionedThroughputDescription) Obsolete.
Sets the ProvisionedThroughput property

WithTableName(String) Obsolete.
Sets the TableName property

WithTableSizeBytes(Int64) Obsolete.
Sets the TableSizeBytes property

WithTableStatus(String) Obsolete.
Sets the TableStatus property

Inheritance Hierarchy
Object
TableDescription

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)