|
|
(JavaScript) 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
var success = false;
var rest = new CkRest();
// 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
var authAws = new CkAuthAws();
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/
var bTls = true;
var port = 443;
var 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) {
console.log("ConnectFailReason: " + rest.ConnectFailReason);
console.log(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"
// }
var json = new CkJsonObject();
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");
var sbRequestBody = new CkStringBuilder();
json.EmitSb(sbRequestBody);
var sbResponseBody = new CkStringBuilder();
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody);
if (success !== true) {
console.log(rest.LastErrorText);
return;
}
var respStatusCode = rest.ResponseStatusCode;
console.log("response status code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Status Code = " + respStatusCode);
console.log("Response Header:");
console.log(rest.ResponseHeader);
console.log("Response Body:");
console.log(sbResponseBody.GetAsString());
return;
}
var jsonResponse = new CkJsonObject();
jsonResponse.LoadSb(sbResponseBody);
jsonResponse.EmitCompact = false;
console.log(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
var AttributeName;
var AttributeType;
var KeyType;
var IndexArn;
var IndexName;
var IndexSizeBytes;
var ItemCount;
var ProjectionProjectionType;
var j;
var count_j;
var TableTableArn = jsonResponse.StringOf("Table.TableArn");
var TableCreationDateTime = jsonResponse.StringOf("Table.CreationDateTime");
var TableItemCount = jsonResponse.IntOf("Table.ItemCount");
var TableProvisionedThroughputNumberOfDecreasesToday = jsonResponse.IntOf("Table.ProvisionedThroughput.NumberOfDecreasesToday");
var TableProvisionedThroughputReadCapacityUnits = jsonResponse.IntOf("Table.ProvisionedThroughput.ReadCapacityUnits");
var TableProvisionedThroughputWriteCapacityUnits = jsonResponse.IntOf("Table.ProvisionedThroughput.WriteCapacityUnits");
var TableTableName = jsonResponse.StringOf("Table.TableName");
var TableTableSizeBytes = jsonResponse.IntOf("Table.TableSizeBytes");
var TableTableStatus = jsonResponse.StringOf("Table.TableStatus");
var i = 0;
var 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;
}
|
