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.
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.
For global tables, this operation only applies to global tables using Version 2019.11.21
(Current version).
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.
Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z
public class DescribeTableRequest : AmazonDynamoDBRequest IAmazonWebServiceRequest
The DescribeTableRequest type exposes the following members
Name | Description | |
---|---|---|
DescribeTableRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
DescribeTableRequest(string) |
Instantiates DescribeTableRequest with the parameterized properties |
Name | Type | Description | |
---|---|---|---|
TableName | System.String |
Gets and sets the property TableName. The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter. |
This example shows how to get a description for an existing table.
// 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);
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5