(Excel) 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

Download Excel Class Modules Chilkat Excel Class Modules

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest

' 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 Chilkat.AuthAws
Set authAws = Chilkat.NewAuthAws
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
Dim success As Boolean
success = rest.SetAuthAws(authAws)

' URL: https://dynamodb.us-west-2.amazonaws.com/

bTls = True

port = 443

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
    Debug.Print "ConnectFailReason: "; rest.ConnectFailReason
    Debug.Print rest.LastErrorText
    Exit Sub
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 Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
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 Chilkat.StringBuilder
Set sbRequestBody = Chilkat.NewStringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As Chilkat.StringBuilder
Set sbResponseBody = Chilkat.NewStringBuilder
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If


respStatusCode = rest.ResponseStatusCode
Debug.Print "response status code = "; respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Status Code = "; respStatusCode
    Debug.Print "Response Header:"
    Debug.Print rest.ResponseHeader
    Debug.Print "Response Body:"
    Debug.Print sbResponseBody.GetAsString()
    Exit Sub
End If

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

jsonResponse.EmitCompact = False
Debug.Print 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


TableTableArn = jsonResponse.StringOf("Table.TableArn")

TableCreationDateTime = jsonResponse.StringOf("Table.CreationDateTime")

TableItemCount = jsonResponse.IntOf("Table.ItemCount")

TableProvisionedThroughputNumberOfDecreasesToday = jsonResponse.IntOf("Table.ProvisionedThroughput.NumberOfDecreasesToday")

TableProvisionedThroughputReadCapacityUnits = jsonResponse.IntOf("Table.ProvisionedThroughput.ReadCapacityUnits")

TableProvisionedThroughputWriteCapacityUnits = jsonResponse.IntOf("Table.ProvisionedThroughput.WriteCapacityUnits")

TableTableName = jsonResponse.StringOf("Table.TableName")

TableTableSizeBytes = jsonResponse.IntOf("Table.TableSizeBytes")

TableTableStatus = jsonResponse.StringOf("Table.TableStatus")

i = 0

count_i = jsonResponse.SizeOfArray("Table.AttributeDefinitions")
Do While i < count_i
    jsonResponse.I = i
    AttributeName = jsonResponse.StringOf("Table.AttributeDefinitions[i].AttributeName")
    AttributeType = jsonResponse.StringOf("Table.AttributeDefinitions[i].AttributeType")
    i = i + 1
Loop
i = 0
count_i = jsonResponse.SizeOfArray("Table.KeySchema")
Do While i < count_i
    jsonResponse.I = i
    AttributeName = jsonResponse.StringOf("Table.KeySchema[i].AttributeName")
    KeyType = jsonResponse.StringOf("Table.KeySchema[i].KeyType")
    i = i + 1
Loop
i = 0
count_i = jsonResponse.SizeOfArray("Table.LocalSecondaryIndexes")
Do 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")
    Do 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
    Loop
    i = i + 1
Loop