Chilkat Online Tools

DescribeStream VB.NET 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
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
    Debug.WriteLine("ConnectFailReason: " & rest.ConnectFailReason)
    Debug.WriteLine(rest.LastErrorText)
    Exit Sub
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
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")

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

Dim respStatusCode As Integer = rest.ResponseStatusCode
Debug.WriteLine("response status code = " & respStatusCode)
If (respStatusCode <> 200) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(rest.ResponseHeader)
    Debug.WriteLine("Response Body:")
    Debug.WriteLine(sbResponseBody.GetAsString())
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
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 Integer
Dim count_j As Integer
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 = jResp.StringOf("StreamDescription.EncryptionType")
Dim HasMoreShards As Integer = jResp.IntOf("StreamDescription.HasMoreShards")
Dim KeyId As String = jResp.StringOf("StreamDescription.KeyId")
Dim RetentionPeriodHours As Integer = jResp.IntOf("StreamDescription.RetentionPeriodHours")
Dim StreamARN As String = jResp.StringOf("StreamDescription.StreamARN")
Dim StreamCreationTimestamp As Integer = jResp.IntOf("StreamDescription.StreamCreationTimestamp")
Dim StreamMode As String = jResp.StringOf("StreamDescription.StreamModeDetails.StreamMode")
Dim StreamName As String = jResp.StringOf("StreamDescription.StreamName")
Dim StreamStatus As String = jResp.StringOf("StreamDescription.StreamStatus")
Dim i As Integer = 0
Dim count_i As Integer = 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
    End While
    i = i + 1
End While
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
End While


' 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"
'   }
' }