Chilkat Online Tools

DescribeStatement Ruby Example

Amazon Redshift Data API

require 'chilkat'

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

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_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.put_Region("us-west-2")
authAws.put_ServiceName("redshift-data")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

# URL: https://redshift-data.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("redshift-data.us-west-2.amazonaws.com",443,true,true)
if (success != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# 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

json = Chilkat::CkJsonObject.new()
json.UpdateString("Id","string")

# The JSON request body created by the above code:

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

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","RedshiftData.DescribeStatement")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(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

ClusterIdentifier = jResp.stringOf("ClusterIdentifier")
CreatedAt = jResp.IntOf("CreatedAt")
Database = jResp.stringOf("Database")
DbUser = jResp.stringOf("DbUser")
Duration = jResp.IntOf("Duration")
Error = jResp.stringOf("Error")
HasResultSet = jResp.IntOf("HasResultSet")
Id = jResp.stringOf("Id")
QueryString = jResp.stringOf("QueryString")
RedshiftPid = jResp.IntOf("RedshiftPid")
RedshiftQueryId = jResp.IntOf("RedshiftQueryId")
ResultRows = jResp.IntOf("ResultRows")
ResultSize = jResp.IntOf("ResultSize")
SecretArn = jResp.stringOf("SecretArn")
Status = jResp.stringOf("Status")
UpdatedAt = jResp.IntOf("UpdatedAt")
i = 0
count_i = jResp.SizeOfArray("QueryParameters")
while i < count_i
    jResp.put_I(i)
    name = jResp.stringOf("QueryParameters[i].name")
    value = jResp.stringOf("QueryParameters[i].value")
    i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("SubStatements")
while i < count_i
    jResp.put_I(i)
    CreatedAt = jResp.IntOf("SubStatements[i].CreatedAt")
    Duration = jResp.IntOf("SubStatements[i].Duration")
    Error = jResp.stringOf("SubStatements[i].Error")
    HasResultSet = jResp.IntOf("SubStatements[i].HasResultSet")
    Id = jResp.stringOf("SubStatements[i].Id")
    QueryString = jResp.stringOf("SubStatements[i].QueryString")
    RedshiftQueryId = jResp.IntOf("SubStatements[i].RedshiftQueryId")
    ResultRows = jResp.IntOf("SubStatements[i].ResultRows")
    ResultSize = jResp.IntOf("SubStatements[i].ResultSize")
    Status = jResp.stringOf("SubStatements[i].Status")
    UpdatedAt = jResp.IntOf("SubStatements[i].UpdatedAt")
    i = i + 1
end

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