Chilkat Online Tools

DescribeStream Powershell Example

Amazon Kinesis Video Streams

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

# 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

$json = New-Object 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")

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/describeStream",$sbRequestBody,$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

$EncryptionType = $jResp.StringOf("StreamDescription.EncryptionType")
$HasMoreShards = $jResp.IntOf("StreamDescription.HasMoreShards")
$KeyId = $jResp.StringOf("StreamDescription.KeyId")
$RetentionPeriodHours = $jResp.IntOf("StreamDescription.RetentionPeriodHours")
$StreamARN = $jResp.StringOf("StreamDescription.StreamARN")
$StreamCreationTimestamp = $jResp.IntOf("StreamDescription.StreamCreationTimestamp")
$StreamMode = $jResp.StringOf("StreamDescription.StreamModeDetails.StreamMode")
$StreamName = $jResp.StringOf("StreamDescription.StreamName")
$StreamStatus = $jResp.StringOf("StreamDescription.StreamStatus")
$i = 0
$count_i = $jResp.SizeOfArray("StreamDescription.EnhancedMonitoring")
while ($i -lt $count_i) {
    $jResp.I = $i
    $j = 0
    $count_j = $jResp.SizeOfArray("StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $strVal = $jResp.StringOf("StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics[j]")
        $j = $j + 1
    }

    $i = $i + 1
}

$i = 0
$count_i = $jResp.SizeOfArray("StreamDescription.Shards")
while ($i -lt $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
}

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