Chilkat Online Tools

DescribeChannel TCL Example

AWS IoT Analytics

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 "iotanalytics"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://iotanalytics.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "iotanalytics.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
}

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

set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestNoBodySb $rest "GET" "/channels/{channelName}" $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    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_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 Arn [CkJsonObject_stringOf $jResp "channel.arn"]
set CreationTime [CkJsonObject_IntOf $jResp "channel.creationTime"]
set LastMessageArrivalTime [CkJsonObject_IntOf $jResp "channel.lastMessageArrivalTime"]
set LastUpdateTime [CkJsonObject_IntOf $jResp "channel.lastUpdateTime"]
set Name [CkJsonObject_stringOf $jResp "channel.name"]
set NumberOfDays [CkJsonObject_IntOf $jResp "channel.retentionPeriod.numberOfDays"]
set Unlimited [CkJsonObject_IntOf $jResp "channel.retentionPeriod.unlimited"]
set Status [CkJsonObject_stringOf $jResp "channel.status"]
set Bucket [CkJsonObject_stringOf $jResp "channel.storage.customerManagedS3.bucket"]
set KeyPrefix [CkJsonObject_stringOf $jResp "channel.storage.customerManagedS3.keyPrefix"]
set RoleArn [CkJsonObject_stringOf $jResp "channel.storage.customerManagedS3.roleArn"]
set EstimatedOn [CkJsonObject_IntOf $jResp "statistics.size.estimatedOn"]
set EstimatedSizeInBytes [CkJsonObject_IntOf $jResp "statistics.size.estimatedSizeInBytes"]

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

# {
#   "channel": {
#     "arn": "string",
#     "creationTime": number,
#     "lastMessageArrivalTime": number,
#     "lastUpdateTime": number,
#     "name": "string",
#     "retentionPeriod": {
#       "numberOfDays": number,
#       "unlimited": boolean
#     },
#     "status": "string",
#     "storage": {
#       "customerManagedS3": {
#         "bucket": "string",
#         "keyPrefix": "string",
#         "roleArn": "string"
#       },
#       "serviceManagedS3": {}
#     }
#   },
#   "statistics": {
#     "size": {
#       "estimatedOn": number,
#       "estimatedSizeInBytes": number
#     }
#   }
# }

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