DescribeStream Ruby Example
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("kinesisvideo")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
# URL: https://kinesisvideo.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("kinesisvideo.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("ExclusiveStartShardId","string")
json.UpdateInt("Limit",123)
json.UpdateString("StreamName","string")
# The JSON request body created by the above code:
# {
# "ExclusiveStartShardId": "string",
# "Limit": number,
# "StreamName": "string"
# }
rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","DescribeStream")
sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/describeStream",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
EncryptionType = jResp.stringOf("StreamDescription.EncryptionType")
HasMoreShards = jResp.IntOf("StreamDescription.HasMoreShards")
KeyId = jResp.stringOf("StreamDescription.KeyId")
RetentionPeriodHours = jResp.IntOf("StreamDescription.RetentionPeriodHours")
StreamARN = jResp.stringOf("StreamDescription.StreamARN")
StreamCreationTimestamp = jResp.IntOf("StreamDescription.StreamCreationTimestamp")
StreamMode = jResp.stringOf("StreamDescription.StreamModeDetails.StreamMode")
StreamName = jResp.stringOf("StreamDescription.StreamName")
StreamStatus = jResp.stringOf("StreamDescription.StreamStatus")
i = 0
count_i = jResp.SizeOfArray("StreamDescription.EnhancedMonitoring")
while i < count_i
jResp.put_I(i)
j = 0
count_j = jResp.SizeOfArray("StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics[j]")
j = j + 1
end
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("StreamDescription.Shards")
while i < count_i
jResp.put_I(i)
AdjacentParentShardId = jResp.stringOf("StreamDescription.Shards[i].AdjacentParentShardId")
EndingHashKey = jResp.stringOf("StreamDescription.Shards[i].HashKeyRange.EndingHashKey")
StartingHashKey = jResp.stringOf("StreamDescription.Shards[i].HashKeyRange.StartingHashKey")
ParentShardId = jResp.stringOf("StreamDescription.Shards[i].ParentShardId")
EndingSequenceNumber = jResp.stringOf("StreamDescription.Shards[i].SequenceNumberRange.EndingSequenceNumber")
StartingSequenceNumber = jResp.stringOf("StreamDescription.Shards[i].SequenceNumberRange.StartingSequenceNumber")
ShardId = jResp.stringOf("StreamDescription.Shards[i].ShardId")
i = i + 1
end
# 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"
# }
# }