(SQL Server) 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

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @rest int
    -- Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

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

    DECLARE @authAws int
    -- Use "Chilkat_9_5_0.AuthAws" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.AuthAws', @authAws OUT

    EXEC sp_OASetProperty @authAws, 'AccessKey', 'AWS_ACCESS_KEY'
    EXEC sp_OASetProperty @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.)
    EXEC sp_OASetProperty @authAws, 'Region', 'us-west-2'
    EXEC sp_OASetProperty @authAws, 'ServiceName', 'dynamodb'
    -- SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    EXEC sp_OAMethod @rest, 'SetAuthAws', @success OUT, @authAws

    -- URL: https://dynamodb.us-west-2.amazonaws.com/
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    -- Don't forget to change the region domain (us-west-2.amazonaws.com) to your particular region.
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'dynamodb.us-west-2.amazonaws.com', @port, @bTls, @bAutoReconnect
    IF @success <> 1
      BEGIN

        EXEC sp_OAGetProperty @rest, 'ConnectFailReason', @iTmp0 OUT
        PRINT 'ConnectFailReason: ' + @iTmp0
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @authAws
        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"
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'TableName', 'Thread'

    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Content-Type', 'application/x-amz-json-1.0'
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'X-Amz-Target', 'DynamoDB_20120810.DescribeTable'
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Accept-Encoding', 'identity'

    DECLARE @sbRequestBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
    DECLARE @sbResponseBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @rest, 'FullRequestSb', @success OUT, 'POST', '/', @sbRequestBody, @sbResponseBody
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @authAws
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END
    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @respStatusCode OUT

    PRINT 'response status code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Status Code = ' + @respStatusCode

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @rest, 'ResponseHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Response Body:'
        EXEC sp_OAMethod @sbResponseBody, 'GetAsString', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @authAws
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    DECLARE @jsonResponse int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonResponse OUT

    EXEC sp_OAMethod @jsonResponse, 'LoadSb', @success OUT, @sbResponseBody

    EXEC sp_OASetProperty @jsonResponse, 'EmitCompact', 0
    EXEC sp_OAMethod @jsonResponse, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

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

    DECLARE @AttributeName nvarchar(4000)

    DECLARE @AttributeType nvarchar(4000)

    DECLARE @KeyType nvarchar(4000)

    DECLARE @IndexArn nvarchar(4000)

    DECLARE @IndexName nvarchar(4000)

    DECLARE @IndexSizeBytes int

    DECLARE @ItemCount int

    DECLARE @ProjectionProjectionType nvarchar(4000)

    DECLARE @j int

    DECLARE @count_j int

    DECLARE @TableTableArn nvarchar(4000)
    EXEC sp_OAMethod @jsonResponse, 'StringOf', @TableTableArn OUT, 'Table.TableArn'
    DECLARE @TableCreationDateTime nvarchar(4000)
    EXEC sp_OAMethod @jsonResponse, 'StringOf', @TableCreationDateTime OUT, 'Table.CreationDateTime'
    DECLARE @TableItemCount int
    EXEC sp_OAMethod @jsonResponse, 'IntOf', @TableItemCount OUT, 'Table.ItemCount'
    DECLARE @TableProvisionedThroughputNumberOfDecreasesToday int
    EXEC sp_OAMethod @jsonResponse, 'IntOf', @TableProvisionedThroughputNumberOfDecreasesToday OUT, 'Table.ProvisionedThroughput.NumberOfDecreasesToday'
    DECLARE @TableProvisionedThroughputReadCapacityUnits int
    EXEC sp_OAMethod @jsonResponse, 'IntOf', @TableProvisionedThroughputReadCapacityUnits OUT, 'Table.ProvisionedThroughput.ReadCapacityUnits'
    DECLARE @TableProvisionedThroughputWriteCapacityUnits int
    EXEC sp_OAMethod @jsonResponse, 'IntOf', @TableProvisionedThroughputWriteCapacityUnits OUT, 'Table.ProvisionedThroughput.WriteCapacityUnits'
    DECLARE @TableTableName nvarchar(4000)
    EXEC sp_OAMethod @jsonResponse, 'StringOf', @TableTableName OUT, 'Table.TableName'
    DECLARE @TableTableSizeBytes int
    EXEC sp_OAMethod @jsonResponse, 'IntOf', @TableTableSizeBytes OUT, 'Table.TableSizeBytes'
    DECLARE @TableTableStatus nvarchar(4000)
    EXEC sp_OAMethod @jsonResponse, 'StringOf', @TableTableStatus OUT, 'Table.TableStatus'
    DECLARE @i int
    SELECT @i = 0
    DECLARE @count_i int
    EXEC sp_OAMethod @jsonResponse, 'SizeOfArray', @count_i OUT, 'Table.AttributeDefinitions'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jsonResponse, 'I', @i
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @AttributeName OUT, 'Table.AttributeDefinitions[i].AttributeName'
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @AttributeType OUT, 'Table.AttributeDefinitions[i].AttributeType'
        SELECT @i = @i + 1
      END
    SELECT @i = 0
    EXEC sp_OAMethod @jsonResponse, 'SizeOfArray', @count_i OUT, 'Table.KeySchema'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jsonResponse, 'I', @i
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @AttributeName OUT, 'Table.KeySchema[i].AttributeName'
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @KeyType OUT, 'Table.KeySchema[i].KeyType'
        SELECT @i = @i + 1
      END
    SELECT @i = 0
    EXEC sp_OAMethod @jsonResponse, 'SizeOfArray', @count_i OUT, 'Table.LocalSecondaryIndexes'
    WHILE @i < @count_i
      BEGIN
        EXEC sp_OASetProperty @jsonResponse, 'I', @i
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @IndexArn OUT, 'Table.LocalSecondaryIndexes[i].IndexArn'
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @IndexName OUT, 'Table.LocalSecondaryIndexes[i].IndexName'
        EXEC sp_OAMethod @jsonResponse, 'IntOf', @IndexSizeBytes OUT, 'Table.LocalSecondaryIndexes[i].IndexSizeBytes'
        EXEC sp_OAMethod @jsonResponse, 'IntOf', @ItemCount OUT, 'Table.LocalSecondaryIndexes[i].ItemCount'
        EXEC sp_OAMethod @jsonResponse, 'StringOf', @ProjectionProjectionType OUT, 'Table.LocalSecondaryIndexes[i].Projection.ProjectionType'
        SELECT @j = 0
        EXEC sp_OAMethod @jsonResponse, 'SizeOfArray', @count_j OUT, 'Table.LocalSecondaryIndexes[i].KeySchema'
        WHILE @j < @count_j
          BEGIN
            EXEC sp_OASetProperty @jsonResponse, 'J', @j
            EXEC sp_OAMethod @jsonResponse, 'StringOf', @AttributeName OUT, 'Table.LocalSecondaryIndexes[i].KeySchema[j].AttributeName'
            EXEC sp_OAMethod @jsonResponse, 'StringOf', @KeyType OUT, 'Table.LocalSecondaryIndexes[i].KeySchema[j].KeyType'
            SELECT @j = @j + 1
          END
        SELECT @i = @i + 1
      END

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @authAws
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jsonResponse


END
GO