Chilkat Online Tools

DescribeTable Python Example

Amazon Redshift Data API

import sys
import chilkat

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

rest = chilkat.CkRest()

authAws = chilkat.CkAuthAws()
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: " + str(rest.get_ConnectFailReason()))
    print(rest.lastErrorText())
    sys.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

json = chilkat.CkJsonObject()
json.UpdateString("ClusterIdentifier","string")
json.UpdateString("ConnectedDatabase","string")
json.UpdateString("Database","string")
json.UpdateString("DbUser","string")
json.UpdateInt("MaxResults",123)
json.UpdateString("NextToken","string")
json.UpdateString("Schema","string")
json.UpdateString("SecretArn","string")
json.UpdateString("Table","string")

# The JSON request body created by the above code:

# {
#   "ClusterIdentifier": "string",
#   "ConnectedDatabase": "string",
#   "Database": "string",
#   "DbUser": "string",
#   "MaxResults": number,
#   "NextToken": "string",
#   "Schema": "string",
#   "SecretArn": "string",
#   "Table": "string"
# }

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

sbRequestBody = chilkat.CkStringBuilder()
json.EmitSb(sbRequestBody)
sbResponseBody = chilkat.CkStringBuilder()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != True):
    print(rest.lastErrorText())
    sys.exit()

respStatusCode = rest.get_ResponseStatusCode()
print("response status code = " + str(respStatusCode))
if (respStatusCode != 200):
    print("Response Header:")
    print(rest.responseHeader())
    print("Response Body:")
    print(sbResponseBody.getAsString())
    sys.exit()

jResp = chilkat.CkJsonObject()
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

NextToken = jResp.stringOf("NextToken")
TableName = jResp.stringOf("TableName")
i = 0
count_i = jResp.SizeOfArray("ColumnList")
while i < count_i :
    jResp.put_I(i)
    columnDefault = jResp.stringOf("ColumnList[i].columnDefault")
    isCaseSensitive = jResp.IntOf("ColumnList[i].isCaseSensitive")
    isCurrency = jResp.IntOf("ColumnList[i].isCurrency")
    isSigned = jResp.IntOf("ColumnList[i].isSigned")
    label = jResp.stringOf("ColumnList[i].label")
    length = jResp.IntOf("ColumnList[i].length")
    name = jResp.stringOf("ColumnList[i].name")
    nullable = jResp.IntOf("ColumnList[i].nullable")
    precision = jResp.IntOf("ColumnList[i].precision")
    scale = jResp.IntOf("ColumnList[i].scale")
    schemaName = jResp.stringOf("ColumnList[i].schemaName")
    tableName = jResp.stringOf("ColumnList[i].tableName")
    typeName = jResp.stringOf("ColumnList[i].typeName")
    i = i + 1

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

# {
#   "ColumnList": [
#     {
#       "columnDefault": "string",
#       "isCaseSensitive": boolean,
#       "isCurrency": boolean,
#       "isSigned": boolean,
#       "label": "string",
#       "length": number,
#       "name": "string",
#       "nullable": number,
#       "precision": number,
#       "scale": number,
#       "schemaName": "string",
#       "tableName": "string",
#       "typeName": "string"
#     }
#   ],
#   "NextToken": "string",
#   "TableName": "string"
# }