Chilkat Online Tools

DescribeStream Node.js Example

Amazon Kinesis Video Streams

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node17-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node17-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node17-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node17-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node17-linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('@chilkat/ck-node17-macosx');
}

function chilkatExample() {

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

    var rest = new chilkat.Rest();
    var success;

    var authAws = 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) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

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

    var json = 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");

    var sbRequestBody = new chilkat.StringBuilder();
    json.EmitSb(sbRequestBody);
    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestSb("POST","/describeStream",sbRequestBody,sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var respStatusCode = rest.ResponseStatusCode;
    console.log("response status code = " + respStatusCode);
    if (respStatusCode !== 200) {
        console.log("Response Header:");
        console.log(rest.ResponseHeader);
        console.log("Response Body:");
        console.log(sbResponseBody.GetAsString());
        return;
    }

    var jResp = 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

    var j;
    var count_j;
    var strVal;
    var AdjacentParentShardId;
    var EndingHashKey;
    var StartingHashKey;
    var ParentShardId;
    var EndingSequenceNumber;
    var StartingSequenceNumber;
    var ShardId;

    var EncryptionType = jResp.StringOf("StreamDescription.EncryptionType");
    var HasMoreShards = jResp.IntOf("StreamDescription.HasMoreShards");
    var KeyId = jResp.StringOf("StreamDescription.KeyId");
    var RetentionPeriodHours = jResp.IntOf("StreamDescription.RetentionPeriodHours");
    var StreamARN = jResp.StringOf("StreamDescription.StreamARN");
    var StreamCreationTimestamp = jResp.IntOf("StreamDescription.StreamCreationTimestamp");
    var StreamMode = jResp.StringOf("StreamDescription.StreamModeDetails.StreamMode");
    var StreamName = jResp.StringOf("StreamDescription.StreamName");
    var StreamStatus = jResp.StringOf("StreamDescription.StreamStatus");
    var i = 0;
    var 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;
        }

        i = i+1;
    }

    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;
    }

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

}

chilkatExample();