Chilkat Online Tools

DescribeStatement TCL Example

Amazon Redshift Data API

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $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_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "redshift-data"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://redshift-data.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "redshift-data.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# The following code creates the JSON request body.
# The JSON created by this code is shown below.

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "Id" "string"

# The JSON request body created by the above code:

# {
#   "Id": "string"
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "RedshiftData.DescribeStatement"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody

# The following code parses the JSON response.
# A sample JSON response is shown below the sample code.

# Use this online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set ClusterIdentifier [CkJsonObject_stringOf $jResp "ClusterIdentifier"]
set CreatedAt [CkJsonObject_IntOf $jResp "CreatedAt"]
set Database [CkJsonObject_stringOf $jResp "Database"]
set DbUser [CkJsonObject_stringOf $jResp "DbUser"]
set Duration [CkJsonObject_IntOf $jResp "Duration"]
set Error [CkJsonObject_stringOf $jResp "Error"]
set HasResultSet [CkJsonObject_IntOf $jResp "HasResultSet"]
set Id [CkJsonObject_stringOf $jResp "Id"]
set QueryString [CkJsonObject_stringOf $jResp "QueryString"]
set RedshiftPid [CkJsonObject_IntOf $jResp "RedshiftPid"]
set RedshiftQueryId [CkJsonObject_IntOf $jResp "RedshiftQueryId"]
set ResultRows [CkJsonObject_IntOf $jResp "ResultRows"]
set ResultSize [CkJsonObject_IntOf $jResp "ResultSize"]
set SecretArn [CkJsonObject_stringOf $jResp "SecretArn"]
set Status [CkJsonObject_stringOf $jResp "Status"]
set UpdatedAt [CkJsonObject_IntOf $jResp "UpdatedAt"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "QueryParameters"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set name [CkJsonObject_stringOf $jResp "QueryParameters[i].name"]
    set value [CkJsonObject_stringOf $jResp "QueryParameters[i].value"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "SubStatements"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set CreatedAt [CkJsonObject_IntOf $jResp "SubStatements[i].CreatedAt"]
    set Duration [CkJsonObject_IntOf $jResp "SubStatements[i].Duration"]
    set Error [CkJsonObject_stringOf $jResp "SubStatements[i].Error"]
    set HasResultSet [CkJsonObject_IntOf $jResp "SubStatements[i].HasResultSet"]
    set Id [CkJsonObject_stringOf $jResp "SubStatements[i].Id"]
    set QueryString [CkJsonObject_stringOf $jResp "SubStatements[i].QueryString"]
    set RedshiftQueryId [CkJsonObject_IntOf $jResp "SubStatements[i].RedshiftQueryId"]
    set ResultRows [CkJsonObject_IntOf $jResp "SubStatements[i].ResultRows"]
    set ResultSize [CkJsonObject_IntOf $jResp "SubStatements[i].ResultSize"]
    set Status [CkJsonObject_stringOf $jResp "SubStatements[i].Status"]
    set UpdatedAt [CkJsonObject_IntOf $jResp "SubStatements[i].UpdatedAt"]
    set i [expr $i + 1]
}

# A sample JSON response body parsed by the above code:

# {
#   "ClusterIdentifier": "string",
#   "CreatedAt": number,
#   "Database": "string",
#   "DbUser": "string",
#   "Duration": number,
#   "Error": "string",
#   "HasResultSet": boolean,
#   "Id": "string",
#   "QueryParameters": [
#     {
#       "name": "string",
#       "value": "string"
#     }
#   ],
#   "QueryString": "string",
#   "RedshiftPid": number,
#   "RedshiftQueryId": number,
#   "ResultRows": number,
#   "ResultSize": number,
#   "SecretArn": "string",
#   "Status": "string",
#   "SubStatements": [
#     {
#       "CreatedAt": number,
#       "Duration": number,
#       "Error": "string",
#       "HasResultSet": boolean,
#       "Id": "string",
#       "QueryString": "string",
#       "RedshiftQueryId": number,
#       "ResultRows": number,
#       "ResultSize": number,
#       "Status": "string",
#       "UpdatedAt": number
#     }
#   ],
#   "UpdatedAt": number
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp