DescribeStream PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "kinesisvideo")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://kinesisvideo.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"kinesisvideo.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"ExclusiveStartShardId","string")
CkJsonObject::ckUpdateInt(json,"Limit",123)
CkJsonObject::ckUpdateString(json,"StreamName","string")
; The JSON request body created by the above code:
; {
; "ExclusiveStartShardId": "string",
; "Limit": number,
; "StreamName": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","DescribeStream")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/describeStream",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
j.i
count_j.i
strVal.s
AdjacentParentShardId.s
EndingHashKey.s
StartingHashKey.s
ParentShardId.s
EndingSequenceNumber.s
StartingSequenceNumber.s
ShardId.s
EncryptionType.s = CkJsonObject::ckStringOf(jResp,"StreamDescription.EncryptionType")
HasMoreShards.i = CkJsonObject::ckIntOf(jResp,"StreamDescription.HasMoreShards")
KeyId.s = CkJsonObject::ckStringOf(jResp,"StreamDescription.KeyId")
RetentionPeriodHours.i = CkJsonObject::ckIntOf(jResp,"StreamDescription.RetentionPeriodHours")
StreamARN.s = CkJsonObject::ckStringOf(jResp,"StreamDescription.StreamARN")
StreamCreationTimestamp.i = CkJsonObject::ckIntOf(jResp,"StreamDescription.StreamCreationTimestamp")
StreamMode.s = CkJsonObject::ckStringOf(jResp,"StreamDescription.StreamModeDetails.StreamMode")
StreamName.s = CkJsonObject::ckStringOf(jResp,"StreamDescription.StreamName")
StreamStatus.s = CkJsonObject::ckStringOf(jResp,"StreamDescription.StreamStatus")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"StreamDescription.EnhancedMonitoring")
While i < count_i
CkJsonObject::setCkI(jResp, i)
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics[j]")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"StreamDescription.Shards")
While i < count_i
CkJsonObject::setCkI(jResp, i)
AdjacentParentShardId = CkJsonObject::ckStringOf(jResp,"StreamDescription.Shards[i].AdjacentParentShardId")
EndingHashKey = CkJsonObject::ckStringOf(jResp,"StreamDescription.Shards[i].HashKeyRange.EndingHashKey")
StartingHashKey = CkJsonObject::ckStringOf(jResp,"StreamDescription.Shards[i].HashKeyRange.StartingHashKey")
ParentShardId = CkJsonObject::ckStringOf(jResp,"StreamDescription.Shards[i].ParentShardId")
EndingSequenceNumber = CkJsonObject::ckStringOf(jResp,"StreamDescription.Shards[i].SequenceNumberRange.EndingSequenceNumber")
StartingSequenceNumber = CkJsonObject::ckStringOf(jResp,"StreamDescription.Shards[i].SequenceNumberRange.StartingSequenceNumber")
ShardId = CkJsonObject::ckStringOf(jResp,"StreamDescription.Shards[i].ShardId")
i = i + 1
Wend
; 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"
; }
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
