DescribeStream C Example
#include <C_CkRest.h>
#include <C_CkAuthAws.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkRest rest;
BOOL success;
HCkAuthAws authAws;
HCkJsonObject json;
HCkStringBuilder sbRequestBody;
HCkStringBuilder sbResponseBody;
int respStatusCode;
HCkJsonObject jResp;
int j;
int count_j;
const char *strVal;
const char *AdjacentParentShardId;
const char *EndingHashKey;
const char *StartingHashKey;
const char *ParentShardId;
const char *EndingSequenceNumber;
const char *StartingSequenceNumber;
const char *ShardId;
const char *EncryptionType;
int HasMoreShards;
const char *KeyId;
int RetentionPeriodHours;
const char *StreamARN;
int StreamCreationTimestamp;
const char *StreamMode;
const char *StreamName;
const char *StreamStatus;
int i;
int count_i;
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
rest = CkRest_Create();
authAws = CkAuthAws_Create();
CkAuthAws_putAccessKey(authAws,"AWS_ACCESS_KEY");
CkAuthAws_putSecretKey(authAws,"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.)
CkAuthAws_putRegion(authAws,"us-west-2");
CkAuthAws_putServiceName(authAws,"kinesisvideo");
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws(rest,authAws);
// URL: https://kinesisvideo.us-west-2.amazonaws.com/
// Use the same region as specified above.
success = CkRest_Connect(rest,"kinesisvideo.us-west-2.amazonaws.com",443,TRUE,TRUE);
if (success != TRUE) {
printf("ConnectFailReason: %d\n",CkRest_getConnectFailReason(rest));
printf("%s\n",CkRest_lastErrorText(rest));
CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
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
json = CkJsonObject_Create();
CkJsonObject_UpdateString(json,"ExclusiveStartShardId","string");
CkJsonObject_UpdateInt(json,"Limit",123);
CkJsonObject_UpdateString(json,"StreamName","string");
// The JSON request body created by the above code:
// {
// "ExclusiveStartShardId": "string",
// "Limit": number,
// "StreamName": "string"
// }
CkRest_AddHeader(rest,"Content-Type","application/x-amz-json-1.1");
CkRest_AddHeader(rest,"X-Amz-Target","DescribeStream");
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
sbResponseBody = CkStringBuilder_Create();
success = CkRest_FullRequestSb(rest,"POST","/describeStream",sbRequestBody,sbResponseBody);
if (success != TRUE) {
printf("%s\n",CkRest_lastErrorText(rest));
CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
respStatusCode = CkRest_getResponseStatusCode(rest);
printf("response status code = %d\n",respStatusCode);
if (respStatusCode != 200) {
printf("Response Header:\n");
printf("%s\n",CkRest_responseHeader(rest));
printf("Response Body:\n");
printf("%s\n",CkStringBuilder_getAsString(sbResponseBody));
CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,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.
EncryptionType = CkJsonObject_stringOf(jResp,"StreamDescription.EncryptionType");
HasMoreShards = CkJsonObject_IntOf(jResp,"StreamDescription.HasMoreShards");
KeyId = CkJsonObject_stringOf(jResp,"StreamDescription.KeyId");
RetentionPeriodHours = CkJsonObject_IntOf(jResp,"StreamDescription.RetentionPeriodHours");
StreamARN = CkJsonObject_stringOf(jResp,"StreamDescription.StreamARN");
StreamCreationTimestamp = CkJsonObject_IntOf(jResp,"StreamDescription.StreamCreationTimestamp");
StreamMode = CkJsonObject_stringOf(jResp,"StreamDescription.StreamModeDetails.StreamMode");
StreamName = CkJsonObject_stringOf(jResp,"StreamDescription.StreamName");
StreamStatus = CkJsonObject_stringOf(jResp,"StreamDescription.StreamStatus");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"StreamDescription.EnhancedMonitoring");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
strVal = CkJsonObject_stringOf(jResp,"StreamDescription.EnhancedMonitoring[i].ShardLevelMetrics[j]");
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"StreamDescription.Shards");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
AdjacentParentShardId = CkJsonObject_stringOf(jResp,"StreamDescription.Shards[i].AdjacentParentShardId");
EndingHashKey = CkJsonObject_stringOf(jResp,"StreamDescription.Shards[i].HashKeyRange.EndingHashKey");
StartingHashKey = CkJsonObject_stringOf(jResp,"StreamDescription.Shards[i].HashKeyRange.StartingHashKey");
ParentShardId = CkJsonObject_stringOf(jResp,"StreamDescription.Shards[i].ParentShardId");
EndingSequenceNumber = CkJsonObject_stringOf(jResp,"StreamDescription.Shards[i].SequenceNumberRange.EndingSequenceNumber");
StartingSequenceNumber = CkJsonObject_stringOf(jResp,"StreamDescription.Shards[i].SequenceNumberRange.StartingSequenceNumber");
ShardId = CkJsonObject_stringOf(jResp,"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"
// }
// }
CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
