(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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

    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "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.)
    CkAuthAws::setCkRegion(authAws, "us-west-2")
    CkAuthAws::setCkServiceName(authAws, "dynamodb")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://dynamodb.us-west-2.amazonaws.com/
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    ; Don't forget to change the region domain (us-west-2.amazonaws.com) to your particular region.
    success = CkRest::ckConnect(rest,"dynamodb.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

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

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"TableName","Thread")

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

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)
    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    respStatusCode.i = CkRest::ckResponseStatusCode(rest)
    Debug "response status code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Status Code = " + Str(respStatusCode)
        Debug "Response Header:"
        Debug CkRest::ckResponseHeader(rest)
        Debug "Response Body:"
        Debug CkStringBuilder::ckGetAsString(sbResponseBody)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)

    CkJsonObject::setCkEmitCompact(jsonResponse, 0)
    Debug CkJsonObject::ckEmit(jsonResponse)

    ; 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

    AttributeName.s
    AttributeType.s
    KeyType.s
    IndexArn.s
    IndexName.s
    IndexSizeBytes.i
    ItemCount.i
    ProjectionProjectionType.s
    j.i
    count_j.i

    TableTableArn.s = CkJsonObject::ckStringOf(jsonResponse,"Table.TableArn")
    TableCreationDateTime.s = CkJsonObject::ckStringOf(jsonResponse,"Table.CreationDateTime")
    TableItemCount.i = CkJsonObject::ckIntOf(jsonResponse,"Table.ItemCount")
    TableProvisionedThroughputNumberOfDecreasesToday.i = CkJsonObject::ckIntOf(jsonResponse,"Table.ProvisionedThroughput.NumberOfDecreasesToday")
    TableProvisionedThroughputReadCapacityUnits.i = CkJsonObject::ckIntOf(jsonResponse,"Table.ProvisionedThroughput.ReadCapacityUnits")
    TableProvisionedThroughputWriteCapacityUnits.i = CkJsonObject::ckIntOf(jsonResponse,"Table.ProvisionedThroughput.WriteCapacityUnits")
    TableTableName.s = CkJsonObject::ckStringOf(jsonResponse,"Table.TableName")
    TableTableSizeBytes.i = CkJsonObject::ckIntOf(jsonResponse,"Table.TableSizeBytes")
    TableTableStatus.s = CkJsonObject::ckStringOf(jsonResponse,"Table.TableStatus")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jsonResponse,"Table.AttributeDefinitions")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        AttributeName = CkJsonObject::ckStringOf(jsonResponse,"Table.AttributeDefinitions[i].AttributeName")
        AttributeType = CkJsonObject::ckStringOf(jsonResponse,"Table.AttributeDefinitions[i].AttributeType")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"Table.KeySchema")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        AttributeName = CkJsonObject::ckStringOf(jsonResponse,"Table.KeySchema[i].AttributeName")
        KeyType = CkJsonObject::ckStringOf(jsonResponse,"Table.KeySchema[i].KeyType")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jsonResponse,"Table.LocalSecondaryIndexes")
    While i < count_i
        CkJsonObject::setCkI(jsonResponse, i)
        IndexArn = CkJsonObject::ckStringOf(jsonResponse,"Table.LocalSecondaryIndexes[i].IndexArn")
        IndexName = CkJsonObject::ckStringOf(jsonResponse,"Table.LocalSecondaryIndexes[i].IndexName")
        IndexSizeBytes = CkJsonObject::ckIntOf(jsonResponse,"Table.LocalSecondaryIndexes[i].IndexSizeBytes")
        ItemCount = CkJsonObject::ckIntOf(jsonResponse,"Table.LocalSecondaryIndexes[i].ItemCount")
        ProjectionProjectionType = CkJsonObject::ckStringOf(jsonResponse,"Table.LocalSecondaryIndexes[i].Projection.ProjectionType")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(jsonResponse,"Table.LocalSecondaryIndexes[i].KeySchema")
        While j < count_j
            CkJsonObject::setCkJ(jsonResponse, j)
            AttributeName = CkJsonObject::ckStringOf(jsonResponse,"Table.LocalSecondaryIndexes[i].KeySchema[j].AttributeName")
            KeyType = CkJsonObject::ckStringOf(jsonResponse,"Table.LocalSecondaryIndexes[i].KeySchema[j].KeyType")
            j = j + 1
        Wend
        i = i + 1
    Wend


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure