Chilkat Online Tools

DescribeStream Xojo Example

Amazon Kinesis Video Streams

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim rest As New Chilkat.Rest
Dim success As Boolean

Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.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.Region = "us-west-2"
authAws.ServiceName = "kinesisvideo"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
success = 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) Then
    System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
    System.DebugLog(rest.LastErrorText)
    Return
End If

// 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

Dim json As New Chilkat.JsonObject
success = json.UpdateString("ExclusiveStartShardId","string")
success = json.UpdateInt("Limit",123)
success = json.UpdateString("StreamName","string")

// The JSON request body created by the above code:

// {
//   "ExclusiveStartShardId": "string",
//   "Limit": number,
//   "StreamName": "string"
// }

success = rest.AddHeader("Content-Type","application/x-amz-json-1.1")
success = rest.AddHeader("X-Amz-Target","DescribeStream")

Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/describeStream",sbRequestBody,sbResponseBody)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode
System.DebugLog("response status code = " + Str(respStatusCode))
If (respStatusCode <> 200) Then
    System.DebugLog("Response Header:")
    System.DebugLog(rest.ResponseHeader)
    System.DebugLog("Response Body:")
    System.DebugLog(sbResponseBody.GetAsString())
    Return
End If

Dim jResp As New Chilkat.JsonObject
success = 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

Dim j As Int32
Dim count_j As Int32
Dim strVal As String
Dim AdjacentParentShardId As String
Dim EndingHashKey As String
Dim StartingHashKey As String
Dim ParentShardId As String
Dim EndingSequenceNumber As String
Dim StartingSequenceNumber As String
Dim ShardId As String

Dim EncryptionType As String
EncryptionType = jResp.StringOf("StreamDescription.EncryptionType")
Dim HasMoreShards As Int32
HasMoreShards = jResp.IntOf("StreamDescription.HasMoreShards")
Dim KeyId As String
KeyId = jResp.StringOf("StreamDescription.KeyId")
Dim RetentionPeriodHours As Int32
RetentionPeriodHours = jResp.IntOf("StreamDescription.RetentionPeriodHours")
Dim StreamARN As String
StreamARN = jResp.StringOf("StreamDescription.StreamARN")
Dim StreamCreationTimestamp As Int32
StreamCreationTimestamp = jResp.IntOf("StreamDescription.StreamCreationTimestamp")
Dim StreamMode As String
StreamMode = jResp.StringOf("StreamDescription.StreamModeDetails.StreamMode")
Dim StreamName As String
StreamName = jResp.StringOf("StreamDescription.StreamName")
Dim StreamStatus As String
StreamStatus = jResp.StringOf("StreamDescription.StreamStatus")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("StreamDescription.EnhancedMonitoring")
While i < count_i
    jResp.I = i
    j = 0
    count_j = jResp.SizeOfArray("StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics")
    While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics[j]")
        j = j + 1
    Wend
    i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("StreamDescription.Shards")
While i < count_i
    jResp.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
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"
//   }
// }