DescribeStream 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 "kinesisvideo"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws
# URL: https://kinesisvideo.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "kinesisvideo.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 "ExclusiveStartShardId" "string"
CkJsonObject_UpdateInt $json "Limit" 123
CkJsonObject_UpdateString $json "StreamName" "string"
# The JSON request body created by the above code:
# {
# "ExclusiveStartShardId": "string",
# "Limit": number,
# "StreamName": "string"
# }
CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "DescribeStream"
set sbRequestBody [new_CkStringBuilder]
CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]
set success [CkRest_FullRequestSb $rest "POST" "/describeStream" $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 EncryptionType [CkJsonObject_stringOf $jResp "StreamDescription.EncryptionType"]
set HasMoreShards [CkJsonObject_IntOf $jResp "StreamDescription.HasMoreShards"]
set KeyId [CkJsonObject_stringOf $jResp "StreamDescription.KeyId"]
set RetentionPeriodHours [CkJsonObject_IntOf $jResp "StreamDescription.RetentionPeriodHours"]
set StreamARN [CkJsonObject_stringOf $jResp "StreamDescription.StreamARN"]
set StreamCreationTimestamp [CkJsonObject_IntOf $jResp "StreamDescription.StreamCreationTimestamp"]
set StreamMode [CkJsonObject_stringOf $jResp "StreamDescription.StreamModeDetails.StreamMode"]
set StreamName [CkJsonObject_stringOf $jResp "StreamDescription.StreamName"]
set StreamStatus [CkJsonObject_stringOf $jResp "StreamDescription.StreamStatus"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "StreamDescription.EnhancedMonitoring"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set j 0
set count_j [CkJsonObject_SizeOfArray $jResp "StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics"]
while {$j < $count_j} {
CkJsonObject_put_J $jResp $j
set strVal [CkJsonObject_stringOf $jResp "StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics[j]"]
set j [expr $j + 1]
}
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "StreamDescription.Shards"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set AdjacentParentShardId [CkJsonObject_stringOf $jResp "StreamDescription.Shards[i].AdjacentParentShardId"]
set EndingHashKey [CkJsonObject_stringOf $jResp "StreamDescription.Shards[i].HashKeyRange.EndingHashKey"]
set StartingHashKey [CkJsonObject_stringOf $jResp "StreamDescription.Shards[i].HashKeyRange.StartingHashKey"]
set ParentShardId [CkJsonObject_stringOf $jResp "StreamDescription.Shards[i].ParentShardId"]
set EndingSequenceNumber [CkJsonObject_stringOf $jResp "StreamDescription.Shards[i].SequenceNumberRange.EndingSequenceNumber"]
set StartingSequenceNumber [CkJsonObject_stringOf $jResp "StreamDescription.Shards[i].SequenceNumberRange.StartingSequenceNumber"]
set ShardId [CkJsonObject_stringOf $jResp "StreamDescription.Shards[i].ShardId"]
set i [expr $i + 1]
}
# A sample JSON response body parsed by the above code:
# {
# "StreamDescription": {
# "EncryptionType": "string",
# "EnhancedMonitoring": [
# {
# "ShardLevelMetrics": [
# "string"
# ]
# }
# ],
# "HasMoreShards": boolean,
# "KeyId": "string",
# "RetentionPeriodHours": number,
# "Shards": [
# {
# "AdjacentParentShardId": "string",
# "HashKeyRange": {
# "EndingHashKey": "string",
# "StartingHashKey": "string"
# },
# "ParentShardId": "string",
# "SequenceNumberRange": {
# "EndingSequenceNumber": "string",
# "StartingSequenceNumber": "string"
# },
# "ShardId": "string"
# }
# ],
# "StreamARN": "string",
# "StreamCreationTimestamp": number,
# "StreamModeDetails": {
# "StreamMode": "string"
# },
# "StreamName": "string",
# "StreamStatus": "string"
# }
# }
delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp