AWS SDK for .NET Documentation
DescribeTableRequest Class
AmazonAmazon.DynamoDBv2.ModelDescribeTableRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the DescribeTable operation.

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

Declaration Syntax
C#
public class DescribeTableRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



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

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.)
TableName
The name of the table to describe.

Constraints:

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


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithTableName(String) Obsolete.
Sets the TableName property

Examples

This example shows how to get a description for an existing table.

CopyDescribeTable sample
// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Create DescribeTable request
DescribeTableRequest request = new DescribeTableRequest
{
    TableName = "SampleTable"
};

// Issue DescribeTable request and retrieve the table description
TableDescription tableDescription = client.DescribeTable(request).DescribeTableResult.Table;

// View new table properties
Console.WriteLine("Table name: {0}", tableDescription.TableName);
Console.WriteLine("Creation time: {0}", tableDescription.CreationDateTime);
Console.WriteLine("Item count: {0}", tableDescription.ItemCount);
Console.WriteLine("Table size (bytes): {0}", tableDescription.TableSizeBytes);
Console.WriteLine("Table status: {0}", tableDescription.TableStatus);
// List table key schema
List<KeySchemaElement> tableSchema = tableDescription.KeySchema;
for (int i = 0; i < tableSchema.Count; i++)
{
    KeySchemaElement element = tableSchema[i];
    Console.WriteLine("Key: Name = {0}, KeyType = {1}",
        element.AttributeName, element.KeyType);
}

// List attribute definitions
List<AttributeDefinition> attributeDefinitions = tableDescription.AttributeDefinitions;
for (int i = 0; i < attributeDefinitions.Count; i++)
{
    AttributeDefinition definition = attributeDefinitions[i];
    Console.WriteLine("Attribute: Name = {0}, Type = {1}",
        definition.AttributeName, definition.AttributeType);
}
Console.WriteLine("Throughput: Reads = {0}, Writes = {1}",
    tableDescription.ProvisionedThroughput.ReadCapacityUnits,
    tableDescription.ProvisionedThroughput.WriteCapacityUnits);
Inheritance Hierarchy
Object
AmazonWebServiceRequest
 DescribeTableRequest
See Also

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