(C#) DynamoDB - DescribeTable

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 more information, see https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html

Chilkat .NET Downloads Chilkat .NET Framework Chilkat for .NET Core

Chilkat.Rest rest = new Chilkat.Rest();
bool success;

// Implements the following CURL command:

// curl -X POST https://dynamodb.us-west-2.amazonaws.com/ \
//   -H "Accept-Encoding: identity" \
//   -H "Content-Type: application/x-amz-json-1.0" \
//   -H "Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>" \
//   -H "X-Amz-Date: <Date>" \
//   -H "X-Amz-Target: DynamoDB_20120810.DescribeTable" \
//   -d '{
//     "TableName":"Thread"
// }'

// Use the following online tool to generate REST code from a CURL command
// Convert a cURL Command to REST Source Code

Chilkat.AuthAws authAws = new Chilkat.AuthAws();
authAws.AccessKey = "AWS_ACCESS_KEY";
authAws.SecretKey = "AWS_SECRET_KEY";
// Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
authAws.Region = "us-west-2";
authAws.ServiceName = "dynamodb";
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws);

// URL: https://dynamodb.us-west-2.amazonaws.com/
bool bTls = true;
int port = 443;
bool bAutoReconnect = true;
// Don't forget to change the region domain (us-west-2.amazonaws.com) to your particular region.
success = rest.Connect("dynamodb.us-west-2.amazonaws.com",port,bTls,bAutoReconnect);
if (success != true) {
    Debug.WriteLine("ConnectFailReason: " + Convert.ToString(rest.ConnectFailReason));
    Debug.WriteLine(rest.LastErrorText);
    return;
}

// Note: The above code does not need to be repeatedly called for each REST request.
// The rest object can be setup once, and then many requests can be sent.  Chilkat will automatically
// reconnect within a FullRequest* method as needed.  It is only the very first connection that is explicitly
// made via the Connect method.

// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "TableName": "Thread"
// }

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.UpdateString("TableName","Thread");

rest.AddHeader("Content-Type","application/x-amz-json-1.0");
rest.AddHeader("X-Amz-Target","DynamoDB_20120810.DescribeTable");
rest.AddHeader("Accept-Encoding","identity");

Chilkat.StringBuilder sbRequestBody = new Chilkat.StringBuilder();
json.EmitSb(sbRequestBody);
Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
if (success != true) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

int respStatusCode = rest.ResponseStatusCode;
Debug.WriteLine("response status code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(rest.ResponseHeader);
    Debug.WriteLine("Response Body:");
    Debug.WriteLine(sbResponseBody.GetAsString());
    return;
}

Chilkat.JsonObject jsonResponse = new Chilkat.JsonObject();
jsonResponse.LoadSb(sbResponseBody);

jsonResponse.EmitCompact = false;
Debug.WriteLine(jsonResponse.Emit());

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "Table": {
//     "TableArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread",
//     "AttributeDefinitions": [
//       {
//         "AttributeName": "ForumName",
//         "AttributeType": "S"
//       },
//       {
//         "AttributeName": "LastPostDateTime",
//         "AttributeType": "S"
//       },
//       {
//         "AttributeName": "Subject",
//         "AttributeType": "S"
//       }
//     ],
//     "CreationDateTime": 1.363729002358E9,
//     "ItemCount": 0,
//     "KeySchema": [
//       {
//         "AttributeName": "ForumName",
//         "KeyType": "HASH"
//       },
//       {
//         "AttributeName": "Subject",
//         "KeyType": "RANGE"
//       }
//     ],
//     "LocalSecondaryIndexes": [
//       {
//         "IndexArn": "arn:aws:dynamodb:us-west-2:123456789012:table/Thread/index/LastPostIndex",
//         "IndexName": "LastPostIndex",
//         "IndexSizeBytes": 0,
//         "ItemCount": 0,
//         "KeySchema": [
//           {
//             "AttributeName": "ForumName",
//             "KeyType": "HASH"
//           },
//           {
//             "AttributeName": "LastPostDateTime",
//             "KeyType": "RANGE"
//           }
//         ],
//         "Projection": {
//           "ProjectionType": "KEYS_ONLY"
//         }
//       }
//     ],
//     "ProvisionedThroughput": {
//       "NumberOfDecreasesToday": 0,
//       "ReadCapacityUnits": 5,
//       "WriteCapacityUnits": 5
//     },
//     "TableName": "Thread",
//     "TableSizeBytes": 0,
//     "TableStatus": "ACTIVE"
//   }
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

string AttributeName;
string AttributeType;
string KeyType;
string IndexArn;
string IndexName;
int IndexSizeBytes;
int ItemCount;
string ProjectionProjectionType;
int j;
int count_j;

string TableTableArn = jsonResponse.StringOf("Table.TableArn");
string TableCreationDateTime = jsonResponse.StringOf("Table.CreationDateTime");
int TableItemCount = jsonResponse.IntOf("Table.ItemCount");
int TableProvisionedThroughputNumberOfDecreasesToday = jsonResponse.IntOf("Table.ProvisionedThroughput.NumberOfDecreasesToday");
int TableProvisionedThroughputReadCapacityUnits = jsonResponse.IntOf("Table.ProvisionedThroughput.ReadCapacityUnits");
int TableProvisionedThroughputWriteCapacityUnits = jsonResponse.IntOf("Table.ProvisionedThroughput.WriteCapacityUnits");
string TableTableName = jsonResponse.StringOf("Table.TableName");
int TableTableSizeBytes = jsonResponse.IntOf("Table.TableSizeBytes");
string TableTableStatus = jsonResponse.StringOf("Table.TableStatus");
int i = 0;
int count_i = jsonResponse.SizeOfArray("Table.AttributeDefinitions");
while (i < count_i) {
    jsonResponse.I = i;
    AttributeName = jsonResponse.StringOf("Table.AttributeDefinitions[i].AttributeName");
    AttributeType = jsonResponse.StringOf("Table.AttributeDefinitions[i].AttributeType");
    i = i + 1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("Table.KeySchema");
while (i < count_i) {
    jsonResponse.I = i;
    AttributeName = jsonResponse.StringOf("Table.KeySchema[i].AttributeName");
    KeyType = jsonResponse.StringOf("Table.KeySchema[i].KeyType");
    i = i + 1;
}

i = 0;
count_i = jsonResponse.SizeOfArray("Table.LocalSecondaryIndexes");
while (i < count_i) {
    jsonResponse.I = i;
    IndexArn = jsonResponse.StringOf("Table.LocalSecondaryIndexes[i].IndexArn");
    IndexName = jsonResponse.StringOf("Table.LocalSecondaryIndexes[i].IndexName");
    IndexSizeBytes = jsonResponse.IntOf("Table.LocalSecondaryIndexes[i].IndexSizeBytes");
    ItemCount = jsonResponse.IntOf("Table.LocalSecondaryIndexes[i].ItemCount");
    ProjectionProjectionType = jsonResponse.StringOf("Table.LocalSecondaryIndexes[i].Projection.ProjectionType");
    j = 0;
    count_j = jsonResponse.SizeOfArray("Table.LocalSecondaryIndexes[i].KeySchema");
    while (j < count_j) {
        jsonResponse.J = j;
        AttributeName = jsonResponse.StringOf("Table.LocalSecondaryIndexes[i].KeySchema[j].AttributeName");
        KeyType = jsonResponse.StringOf("Table.LocalSecondaryIndexes[i].KeySchema[j].KeyType");
        j = j + 1;
    }

    i = i + 1;
}