Container for the parameters to the DescribeTable operation.
Retrieves information about the table, including the current status of the table, the primary key schema and when the table was created.
If the table does not exist, Amazon DynamoDB returns a ResourceNotFoundException .
Declaration Syntax| C# |
public class DescribeTableRequest : AmazonWebServiceRequest
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | DescribeTableRequest()()()() | Initializes a new instance of the DescribeTableRequest class |
| Equals(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 you want to describe. Allowed characters are a-z, A-Z, 0-9, _ (underscore), -
(hyphen) and . (period).
Constraints: |
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| WithTableName(String) | Obsolete.
Sets the TableName property
|
ExamplesThis 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); KeySchema tableSchema = tableDescription.KeySchema; Console.WriteLine("Hash-key: Name = {0}, Type = {1}", tableSchema.HashKeyElement.AttributeName, tableSchema.HashKeyElement.AttributeType); Console.WriteLine("Range-key: Name = {0}, Type = {1}", tableSchema.RangeKeyElement.AttributeName, tableSchema.RangeKeyElement.AttributeType); Console.WriteLine("Throughput: Reads = {0}, Writes = {1}", tableDescription.ProvisionedThroughput.ReadCapacityUnits, tableDescription.ProvisionedThroughput.WriteCapacityUnits);
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| DescribeTableRequest | |