DescribeDatastore TCL Example
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" "DescribeDatastore"
set sbResponseBody [new_CkStringBuilder]
set success [CkRest_FullRequestNoBodySb $rest "GET" "/datastores/{datastoreName}" $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 "datastore.arn"]
set CreationTime [CkJsonObject_IntOf $jResp "datastore.creationTime"]
set LastMessageArrivalTime [CkJsonObject_IntOf $jResp "datastore.lastMessageArrivalTime"]
set LastUpdateTime [CkJsonObject_IntOf $jResp "datastore.lastUpdateTime"]
set Name [CkJsonObject_stringOf $jResp "datastore.name"]
set NumberOfDays [CkJsonObject_IntOf $jResp "datastore.retentionPeriod.numberOfDays"]
set Unlimited [CkJsonObject_IntOf $jResp "datastore.retentionPeriod.unlimited"]
set Status [CkJsonObject_stringOf $jResp "datastore.status"]
set Bucket [CkJsonObject_stringOf $jResp "datastore.storage.customerManagedS3.bucket"]
set KeyPrefix [CkJsonObject_stringOf $jResp "datastore.storage.customerManagedS3.keyPrefix"]
set RoleArn [CkJsonObject_stringOf $jResp "datastore.storage.customerManagedS3.roleArn"]
set CustomerManagedS3StorageBucket [CkJsonObject_stringOf $jResp "datastore.storage.iotSiteWiseMultiLayerStorage.customerManagedS3Storage.bucket"]
set CustomerManagedS3StorageKeyPrefix [CkJsonObject_stringOf $jResp "datastore.storage.iotSiteWiseMultiLayerStorage.customerManagedS3Storage.keyPrefix"]
set EstimatedOn [CkJsonObject_IntOf $jResp "statistics.size.estimatedOn"]
set EstimatedSizeInBytes [CkJsonObject_IntOf $jResp "statistics.size.estimatedSizeInBytes"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "datastore.datastorePartitions.partitions"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set AttributeName [CkJsonObject_stringOf $jResp "datastore.datastorePartitions.partitions[i].attributePartition.attributeName"]
set timestampPartitionAttributeName [CkJsonObject_stringOf $jResp "datastore.datastorePartitions.partitions[i].timestampPartition.attributeName"]
set TimestampFormat [CkJsonObject_stringOf $jResp "datastore.datastorePartitions.partitions[i].timestampPartition.timestampFormat"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "datastore.fileFormatConfiguration.parquetConfiguration.schemaDefinition.columns"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "datastore.fileFormatConfiguration.parquetConfiguration.schemaDefinition.columns[i].name"]
set v_type [CkJsonObject_stringOf $jResp "datastore.fileFormatConfiguration.parquetConfiguration.schemaDefinition.columns[i].type"]
set i [expr $i + 1]
}
# A sample JSON response body parsed by the above code:
# {
# "datastore": {
# "arn": "string",
# "creationTime": number,
# "datastorePartitions": {
# "partitions": [
# {
# "attributePartition": {
# "attributeName": "string"
# },
# "timestampPartition": {
# "attributeName": "string",
# "timestampFormat": "string"
# }
# }
# ]
# },
# "fileFormatConfiguration": {
# "jsonConfiguration": {},
# "parquetConfiguration": {
# "schemaDefinition": {
# "columns": [
# {
# "name": "string",
# "type": "string"
# }
# ]
# }
# }
# },
# "lastMessageArrivalTime": number,
# "lastUpdateTime": number,
# "name": "string",
# "retentionPeriod": {
# "numberOfDays": number,
# "unlimited": boolean
# },
# "status": "string",
# "storage": {
# "customerManagedS3": {
# "bucket": "string",
# "keyPrefix": "string",
# "roleArn": "string"
# },
# "iotSiteWiseMultiLayerStorage": {
# "customerManagedS3Storage": {
# "bucket": "string",
# "keyPrefix": "string"
# }
# },
# "serviceManagedS3": {}
# }
# },
# "statistics": {
# "size": {
# "estimatedOn": number,
# "estimatedSizeInBytes": number
# }
# }
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
