(DataFlex) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoRest
    Boolean iSuccess
    Variant vAuthAws
    Handle hoAuthAws
    Boolean iBTls
    Integer iPort
    Boolean iBAutoReconnect
    Handle hoJson
    Variant vSbRequestBody
    Handle hoSbRequestBody
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Integer iRespStatusCode
    Handle hoJsonResponse
    String sAttributeName
    String sAttributeType
    String sKeyType
    String sIndexArn
    String sIndexName
    Integer iIndexSizeBytes
    Integer iItemCount
    String sProjectionProjectionType
    Integer j
    Integer iCount_j
    String sTableTableArn
    String sTableCreationDateTime
    Integer iTableItemCount
    Integer iTableProvisionedThroughputNumberOfDecreasesToday
    Integer iTableProvisionedThroughputReadCapacityUnits
    Integer iTableProvisionedThroughputWriteCapacityUnits
    String sTableTableName
    Integer iTableTableSizeBytes
    String sTableTableStatus
    Integer i
    Integer iCount_i
    String sTemp1
    Integer iTemp1

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

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

    Get Create (RefClass(cComChilkatAuthAws)) To hoAuthAws
    If (Not(IsComObjectCreated(hoAuthAws))) Begin
        Send CreateComObject of hoAuthAws
    End
    Set ComAccessKey Of hoAuthAws To "AWS_ACCESS_KEY"
    Set ComSecretKey Of hoAuthAws To "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.)
    Set ComRegion Of hoAuthAws To "us-west-2"
    Set ComServiceName Of hoAuthAws To "dynamodb"
    // SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    Get pvComObject of hoAuthAws to vAuthAws
    Get ComSetAuthAws Of hoRest vAuthAws To iSuccess

    // URL: https://dynamodb.us-west-2.amazonaws.com/
    Move True To iBTls
    Move 443 To iPort
    Move True To iBAutoReconnect
    // Don't forget to change the region domain (us-west-2.amazonaws.com) to your particular region.
    Get ComConnect Of hoRest "dynamodb.us-west-2.amazonaws.com" iPort iBTls iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComConnectFailReason Of hoRest To iTemp1
        Showln "ConnectFailReason: " iTemp1
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "TableName" "Thread" To iSuccess

    Get ComAddHeader Of hoRest "Content-Type" "application/x-amz-json-1.0" To iSuccess
    Get ComAddHeader Of hoRest "X-Amz-Target" "DynamoDB_20120810.DescribeTable" To iSuccess
    Get ComAddHeader Of hoRest "Accept-Encoding" "identity" To iSuccess

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
    If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
        Send CreateComObject of hoSbRequestBody
    End
    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbRequestBody to vSbRequestBody
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComFullRequestSb Of hoRest "POST" "/" vSbRequestBody vSbResponseBody To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComResponseStatusCode Of hoRest To iRespStatusCode
    Showln "response status code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Status Code = " iRespStatusCode
        Showln "Response Header:"
        Get ComResponseHeader Of hoRest To sTemp1
        Showln sTemp1
        Showln "Response Body:"
        Get ComGetAsString Of hoSbResponseBody To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonResponse
    If (Not(IsComObjectCreated(hoJsonResponse))) Begin
        Send CreateComObject of hoJsonResponse
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJsonResponse vSbResponseBody To iSuccess

    Set ComEmitCompact Of hoJsonResponse To False
    Get ComEmit Of hoJsonResponse To sTemp1
    Showln sTemp1

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

    Get ComStringOf Of hoJsonResponse "Table.TableArn" To sTableTableArn
    Get ComStringOf Of hoJsonResponse "Table.CreationDateTime" To sTableCreationDateTime
    Get ComIntOf Of hoJsonResponse "Table.ItemCount" To iTableItemCount
    Get ComIntOf Of hoJsonResponse "Table.ProvisionedThroughput.NumberOfDecreasesToday" To iTableProvisionedThroughputNumberOfDecreasesToday
    Get ComIntOf Of hoJsonResponse "Table.ProvisionedThroughput.ReadCapacityUnits" To iTableProvisionedThroughputReadCapacityUnits
    Get ComIntOf Of hoJsonResponse "Table.ProvisionedThroughput.WriteCapacityUnits" To iTableProvisionedThroughputWriteCapacityUnits
    Get ComStringOf Of hoJsonResponse "Table.TableName" To sTableTableName
    Get ComIntOf Of hoJsonResponse "Table.TableSizeBytes" To iTableTableSizeBytes
    Get ComStringOf Of hoJsonResponse "Table.TableStatus" To sTableTableStatus
    Move 0 To i
    Get ComSizeOfArray Of hoJsonResponse "Table.AttributeDefinitions" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJsonResponse To i
        Get ComStringOf Of hoJsonResponse "Table.AttributeDefinitions[i].AttributeName" To sAttributeName
        Get ComStringOf Of hoJsonResponse "Table.AttributeDefinitions[i].AttributeType" To sAttributeType
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJsonResponse "Table.KeySchema" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJsonResponse To i
        Get ComStringOf Of hoJsonResponse "Table.KeySchema[i].AttributeName" To sAttributeName
        Get ComStringOf Of hoJsonResponse "Table.KeySchema[i].KeyType" To sKeyType
        Move (i + 1) To i
    Loop

    Move 0 To i
    Get ComSizeOfArray Of hoJsonResponse "Table.LocalSecondaryIndexes" To iCount_i
    While (i < iCount_i)
        Set ComI Of hoJsonResponse To i
        Get ComStringOf Of hoJsonResponse "Table.LocalSecondaryIndexes[i].IndexArn" To sIndexArn
        Get ComStringOf Of hoJsonResponse "Table.LocalSecondaryIndexes[i].IndexName" To sIndexName
        Get ComIntOf Of hoJsonResponse "Table.LocalSecondaryIndexes[i].IndexSizeBytes" To iIndexSizeBytes
        Get ComIntOf Of hoJsonResponse "Table.LocalSecondaryIndexes[i].ItemCount" To iItemCount
        Get ComStringOf Of hoJsonResponse "Table.LocalSecondaryIndexes[i].Projection.ProjectionType" To sProjectionProjectionType
        Move 0 To j
        Get ComSizeOfArray Of hoJsonResponse "Table.LocalSecondaryIndexes[i].KeySchema" To iCount_j
        While (j < iCount_j)
            Set ComJ Of hoJsonResponse To j
            Get ComStringOf Of hoJsonResponse "Table.LocalSecondaryIndexes[i].KeySchema[j].AttributeName" To sAttributeName
            Get ComStringOf Of hoJsonResponse "Table.LocalSecondaryIndexes[i].KeySchema[j].KeyType" To sKeyType
            Move (j + 1) To j
        Loop

        Move (i + 1) To i
    Loop



End_Procedure