DescribeStream DataFlex Example
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoRest
Boolean iSuccess
Variant vAuthAws
Handle hoAuthAws
Handle hoJson
Variant vSbRequestBody
Handle hoSbRequestBody
Variant vSbResponseBody
Handle hoSbResponseBody
Integer iRespStatusCode
Handle hoJResp
Integer j
Integer iCount_j
String sStrVal
String sAdjacentParentShardId
String sEndingHashKey
String sStartingHashKey
String sParentShardId
String sEndingSequenceNumber
String sStartingSequenceNumber
String sShardId
String sEncryptionType
Integer iHasMoreShards
String sKeyId
Integer iRetentionPeriodHours
String sStreamARN
Integer iStreamCreationTimestamp
String sStreamMode
String sStreamName
String sStreamStatus
Integer i
Integer iCount_i
String sTemp1
Integer iTemp1
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatRest)) To hoRest
If (Not(IsComObjectCreated(hoRest))) Begin
Send CreateComObject of hoRest
End
Get Create (RefClass(cComChilkatAuthAws)) To hoAuthAws
If (Not(IsComObjectCreated(hoAuthAws))) Begin
Send CreateComObject of hoAuthAws
End
Set ComAccessKey Of hoAuthAws To "AWS_ACCESS_KEY"
Set ComSecretKey Of hoAuthAws To "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.)
Set ComRegion Of hoAuthAws To "us-west-2"
Set ComServiceName Of hoAuthAws To "kinesisvideo"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
Get pvComObject of hoAuthAws to vAuthAws
Get ComSetAuthAws Of hoRest vAuthAws To iSuccess
// URL: https://kinesisvideo.us-west-2.amazonaws.com/
// Use the same region as specified above.
Get ComConnect Of hoRest "kinesisvideo.us-west-2.amazonaws.com" 443 True True To iSuccess
If (iSuccess <> True) Begin
Get ComConnectFailReason Of hoRest To iTemp1
Showln "ConnectFailReason: " iTemp1
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
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
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "ExclusiveStartShardId" "string" To iSuccess
Get ComUpdateInt Of hoJson "Limit" 123 To iSuccess
Get ComUpdateString Of hoJson "StreamName" "string" To iSuccess
// The JSON request body created by the above code:
// {
// "ExclusiveStartShardId": "string",
// "Limit": number,
// "StreamName": "string"
// }
Get ComAddHeader Of hoRest "Content-Type" "application/x-amz-json-1.1" To iSuccess
Get ComAddHeader Of hoRest "X-Amz-Target" "DescribeStream" To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbRequestBody
If (Not(IsComObjectCreated(hoSbRequestBody))) Begin
Send CreateComObject of hoSbRequestBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get ComEmitSb Of hoJson vSbRequestBody To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbRequestBody to vSbRequestBody
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComFullRequestSb Of hoRest "POST" "/describeStream" vSbRequestBody vSbResponseBody To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoRest To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComResponseStatusCode Of hoRest To iRespStatusCode
Showln "response status code = " iRespStatusCode
If (iRespStatusCode <> 200) Begin
Showln "Response Header:"
Get ComResponseHeader Of hoRest To sTemp1
Showln sTemp1
Showln "Response Body:"
Get ComGetAsString Of hoSbResponseBody To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
// 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
Get ComStringOf Of hoJResp "StreamDescription.EncryptionType" To sEncryptionType
Get ComIntOf Of hoJResp "StreamDescription.HasMoreShards" To iHasMoreShards
Get ComStringOf Of hoJResp "StreamDescription.KeyId" To sKeyId
Get ComIntOf Of hoJResp "StreamDescription.RetentionPeriodHours" To iRetentionPeriodHours
Get ComStringOf Of hoJResp "StreamDescription.StreamARN" To sStreamARN
Get ComIntOf Of hoJResp "StreamDescription.StreamCreationTimestamp" To iStreamCreationTimestamp
Get ComStringOf Of hoJResp "StreamDescription.StreamModeDetails.StreamMode" To sStreamMode
Get ComStringOf Of hoJResp "StreamDescription.StreamName" To sStreamName
Get ComStringOf Of hoJResp "StreamDescription.StreamStatus" To sStreamStatus
Move 0 To i
Get ComSizeOfArray Of hoJResp "StreamDescription.EnhancedMonitoring" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Move 0 To j
Get ComSizeOfArray Of hoJResp "StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics[j]" To sStrVal
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "StreamDescription.Shards" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "StreamDescription.Shards[i].AdjacentParentShardId" To sAdjacentParentShardId
Get ComStringOf Of hoJResp "StreamDescription.Shards[i].HashKeyRange.EndingHashKey" To sEndingHashKey
Get ComStringOf Of hoJResp "StreamDescription.Shards[i].HashKeyRange.StartingHashKey" To sStartingHashKey
Get ComStringOf Of hoJResp "StreamDescription.Shards[i].ParentShardId" To sParentShardId
Get ComStringOf Of hoJResp "StreamDescription.Shards[i].SequenceNumberRange.EndingSequenceNumber" To sEndingSequenceNumber
Get ComStringOf Of hoJResp "StreamDescription.Shards[i].SequenceNumberRange.StartingSequenceNumber" To sStartingSequenceNumber
Get ComStringOf Of hoJResp "StreamDescription.Shards[i].ShardId" To sShardId
Move (i + 1) To i
Loop
// 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"
// }
// }
End_Procedure
