(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

Dim rest As New Chilkat.Rest
Dim success As Boolean

// 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

Dim authAws As 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
success = rest.SetAuthAws(authAws)

// URL: https://dynamodb.us-west-2.amazonaws.com/
Dim bTls As Boolean
bTls = True
Dim port As Int32
port = 443
Dim bAutoReconnect As Boolean
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) Then
    System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
    System.DebugLog(rest.LastErrorText)
    Return
End If

// 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"
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("TableName","Thread")

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

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode
System.DebugLog("response status code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Status Code = " + Str(respStatusCode))
    System.DebugLog("Response Header:")
    System.DebugLog(rest.ResponseHeader)
    System.DebugLog("Response Body:")
    System.DebugLog(sbResponseBody.GetAsString())
    Return
End If

Dim jsonResponse As New Chilkat.JsonObject
success = jsonResponse.LoadSb(sbResponseBody)

jsonResponse.EmitCompact = False
System.DebugLog(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

Dim AttributeName As String
Dim AttributeType As String
Dim KeyType As String
Dim IndexArn As String
Dim IndexName As String
Dim IndexSizeBytes As Int32
Dim ItemCount As Int32
Dim ProjectionProjectionType As String
Dim j As Int32
Dim count_j As Int32

Dim TableTableArn As String
TableTableArn = jsonResponse.StringOf("Table.TableArn")
Dim TableCreationDateTime As String
TableCreationDateTime = jsonResponse.StringOf("Table.CreationDateTime")
Dim TableItemCount As Int32
TableItemCount = jsonResponse.IntOf("Table.ItemCount")
Dim TableProvisionedThroughputNumberOfDecreasesToday As Int32
TableProvisionedThroughputNumberOfDecreasesToday = jsonResponse.IntOf("Table.ProvisionedThroughput.NumberOfDecreasesToday")
Dim TableProvisionedThroughputReadCapacityUnits As Int32
TableProvisionedThroughputReadCapacityUnits = jsonResponse.IntOf("Table.ProvisionedThroughput.ReadCapacityUnits")
Dim TableProvisionedThroughputWriteCapacityUnits As Int32
TableProvisionedThroughputWriteCapacityUnits = jsonResponse.IntOf("Table.ProvisionedThroughput.WriteCapacityUnits")
Dim TableTableName As String
TableTableName = jsonResponse.StringOf("Table.TableName")
Dim TableTableSizeBytes As Int32
TableTableSizeBytes = jsonResponse.IntOf("Table.TableSizeBytes")
Dim TableTableStatus As String
TableTableStatus = jsonResponse.StringOf("Table.TableStatus")
Dim i As Int32
i = 0
Dim count_i As Int32
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
Wend
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
Wend
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
    Wend
    i = i + 1
Wend