Chilkat Online Tools

DescribeChannel VB.NET Example

AWS IoT Analytics

' 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 = "iotanalytics"
' SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)

' URL: https://iotanalytics.us-west-2.amazonaws.com/
' Use the same region as specified above.
success = rest.Connect("iotanalytics.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


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

Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET","/channels/{channelName}",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 Arn As String = jResp.StringOf("channel.arn")
Dim CreationTime As Integer = jResp.IntOf("channel.creationTime")
Dim LastMessageArrivalTime As Integer = jResp.IntOf("channel.lastMessageArrivalTime")
Dim LastUpdateTime As Integer = jResp.IntOf("channel.lastUpdateTime")
Dim Name As String = jResp.StringOf("channel.name")
Dim NumberOfDays As Integer = jResp.IntOf("channel.retentionPeriod.numberOfDays")
Dim Unlimited As Integer = jResp.IntOf("channel.retentionPeriod.unlimited")
Dim Status As String = jResp.StringOf("channel.status")
Dim Bucket As String = jResp.StringOf("channel.storage.customerManagedS3.bucket")
Dim KeyPrefix As String = jResp.StringOf("channel.storage.customerManagedS3.keyPrefix")
Dim RoleArn As String = jResp.StringOf("channel.storage.customerManagedS3.roleArn")
Dim EstimatedOn As Integer = jResp.IntOf("statistics.size.estimatedOn")
Dim EstimatedSizeInBytes As Integer = jResp.IntOf("statistics.size.estimatedSizeInBytes")


' A sample JSON response body parsed by the above code:

' {
'   "channel": {
'     "arn": "string",
'     "creationTime": number,
'     "lastMessageArrivalTime": number,
'     "lastUpdateTime": number,
'     "name": "string",
'     "retentionPeriod": {
'       "numberOfDays": number,
'       "unlimited": boolean
'     },
'     "status": "string",
'     "storage": {
'       "customerManagedS3": {
'         "bucket": "string",
'         "keyPrefix": "string",
'         "roleArn": "string"
'       },
'       "serviceManagedS3": {}
'     }
'   },
'   "statistics": {
'     "size": {
'       "estimatedOn": number,
'       "estimatedSizeInBytes": number
'     }
'   }
' }