AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 3.5
 
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.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DynamoDBv2.AmazonDynamoDBRequest
      Amazon.DynamoDBv2.Model.DescribeTableRequest

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class DescribeTableRequest : AmazonDynamoDBRequest
         IRequestEvents

The DescribeTableRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeTableRequest() Empty constructor used to set properties independently even when a simple constructor is available
Public Method DescribeTableRequest(string) Instantiates DescribeTableRequest with the parameterized properties

Properties

NameTypeDescription
Public Property TableName System.String Gets and sets the property TableName.

The name of the table to describe.

Examples

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

DescribeTable 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).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);

                

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8