DescribeTable method
Written by
Updated at February 26, 2024
Returns information about a table, including its current status, creation time, primary key schema, and indexes.
Request
The request contains data in JSON format.
{
"TableName": "string"
}
Parameters
| Parameter | Description |
|---|---|
TableName |
Name of the table that information is requested about. May contain a path in the directory hierarchy like path/to/table. Type: String Length: 3 - 255 characters Pattern: [a-zA-Z0-9_.-]+ Requested: Yes |
Response
If successful, HTTP code 200 is returned.
The response is returned in JSON format.
{
"Table": {
"AttributeDefinitions": [
{
"AttributeName": "string",
"AttributeType": "string"
}
],
"CreationDateTime": number,
"ItemCount": number,
"KeySchema": [
{
"AttributeName": "string",
"KeyType": "string"
}
],
"StreamSpecification": {
"StreamEnabled": boolean,
"StreamViewType": "string"
},
"TableName": "string",
"TableSizeBytes": number,
"TableStatus": "string"
}
}
Parameters
| Parameter | Description |
|---|---|
Table |
Table properties. Type: Object of the TableDescription type. |
Errors
| Parameter | Description |
|---|---|
InternalServerError |
An internal error occurred on the server side. HTTP status code: 500 |
ResourceNotFoundException |
The specified table doesn't exist or is still being created by the method createTable HTTP status code: 400 |
There may be common errors as well. These are errors that are common to all methods.