Chilkat Online Tools

DescribeChannel Powershell Example

AWS IoT Analytics

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$rest = New-Object Chilkat.Rest

$authAws = New-Object 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 -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

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

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestNoBodySb("GET","/channels/{channelName}",$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jResp = New-Object 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

$Arn = $jResp.StringOf("channel.arn")
$CreationTime = $jResp.IntOf("channel.creationTime")
$LastMessageArrivalTime = $jResp.IntOf("channel.lastMessageArrivalTime")
$LastUpdateTime = $jResp.IntOf("channel.lastUpdateTime")
$Name = $jResp.StringOf("channel.name")
$NumberOfDays = $jResp.IntOf("channel.retentionPeriod.numberOfDays")
$Unlimited = $jResp.IntOf("channel.retentionPeriod.unlimited")
$Status = $jResp.StringOf("channel.status")
$Bucket = $jResp.StringOf("channel.storage.customerManagedS3.bucket")
$KeyPrefix = $jResp.StringOf("channel.storage.customerManagedS3.keyPrefix")
$RoleArn = $jResp.StringOf("channel.storage.customerManagedS3.roleArn")
$EstimatedOn = $jResp.IntOf("statistics.size.estimatedOn")
$EstimatedSizeInBytes = $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
#     }
#   }
# }