DescribeStream C++ Example
#include <CkRest.h>
#include <CkAuthAws.h>
#include <CkJsonObject.h>
#include <CkStringBuilder.h>
void ChilkatSample(void)
{
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkRest rest;
bool success;
CkAuthAws authAws;
authAws.put_AccessKey("AWS_ACCESS_KEY");
authAws.put_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.put_Region("us-west-2");
authAws.put_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) {
std::cout << "ConnectFailReason: " << rest.get_ConnectFailReason() << "\r\n";
std::cout << rest.lastErrorText() << "\r\n";
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
CkJsonObject json;
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");
CkStringBuilder sbRequestBody;
json.EmitSb(sbRequestBody);
CkStringBuilder sbResponseBody;
success = rest.FullRequestSb("POST","/describeStream",sbRequestBody,sbResponseBody);
if (success != true) {
std::cout << rest.lastErrorText() << "\r\n";
return;
}
int respStatusCode = rest.get_ResponseStatusCode();
std::cout << "response status code = " << respStatusCode << "\r\n";
if (respStatusCode != 200) {
std::cout << "Response Header:" << "\r\n";
std::cout << rest.responseHeader() << "\r\n";
std::cout << "Response Body:" << "\r\n";
std::cout << sbResponseBody.getAsString() << "\r\n";
return;
}
CkJsonObject jResp;
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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
// See this example explaining how this memory should be used: const char * functions.
int j;
int count_j;
const char *strVal = 0;
const char *AdjacentParentShardId = 0;
const char *EndingHashKey = 0;
const char *StartingHashKey = 0;
const char *ParentShardId = 0;
const char *EndingSequenceNumber = 0;
const char *StartingSequenceNumber = 0;
const char *ShardId = 0;
const char *EncryptionType = jResp.stringOf("StreamDescription.EncryptionType");
int HasMoreShards = jResp.IntOf("StreamDescription.HasMoreShards");
const char *KeyId = jResp.stringOf("StreamDescription.KeyId");
int RetentionPeriodHours = jResp.IntOf("StreamDescription.RetentionPeriodHours");
const char *StreamARN = jResp.stringOf("StreamDescription.StreamARN");
int StreamCreationTimestamp = jResp.IntOf("StreamDescription.StreamCreationTimestamp");
const char *StreamMode = jResp.stringOf("StreamDescription.StreamModeDetails.StreamMode");
const char *StreamName = jResp.stringOf("StreamDescription.StreamName");
const char *StreamStatus = jResp.stringOf("StreamDescription.StreamStatus");
int i = 0;
int count_i = jResp.SizeOfArray("StreamDescription.EnhancedMonitoring");
while (i < count_i) {
jResp.put_I(i);
j = 0;
count_j = jResp.SizeOfArray("StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics");
while (j < count_j) {
jResp.put_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.put_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"
// }
// }
}