AWS SDK for .NET Documentation
DescribeTable Method (describeTableRequest)
Amazon ► Amazon.DynamoDBv2 ► AmazonDynamoDBClient ► DescribeTable(DescribeTableRequest)
Did this page help you? Yes No Tell us about it...

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 DescribeTableResponse DescribeTable(
    	DescribeTableRequest describeTableRequest
    )

Parameters

describeTableRequest (DescribeTableRequest)
  Container for the necessary parameters to execute the DescribeTable service method on AmazonDynamoDBv2.

Return Value
The response from the DescribeTable service method, as returned by AmazonDynamoDBv2.
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);

Exceptions

Exception | Condition
--- | ---
ResourceNotFoundException |
InternalServerErrorException |

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