DescribeRuleGroup 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;
const char *strVal;
const char *Action;
const char *Destination;
const char *DestinationPort;
const char *Direction;
const char *Protocol;
const char *Source;
const char *SourcePort;
int j;
int count_j;
const char *Keyword;
int k;
int count_k;
const char *ActionName;
const char *Value;
int Priority;
int FromPort;
int ToPort;
const char *AddressDefinition;
int intVal;
const char *Key;
const char *GeneratedRulesType;
const char *RulesString;
const char *RuleOrder;
int Capacity;
int ConsumedCapacity;
const char *Description;
const char *KeyId;
const char *v_Type;
int LastModifiedTime;
int NumberOfAssociations;
const char *RuleGroupArn;
const char *RuleGroupId;
const char *RuleGroupName;
const char *RuleGroupStatus;
const char *SnsTopic;
const char *SourceArn;
const char *SourceUpdateToken;
const char *RuleGroupResponseType;
const char *UpdateToken;
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,"network-firewall");
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws(rest,authAws);
// URL: https://network-firewall.us-west-2.amazonaws.com/
// Use the same region as specified above.
success = CkRest_Connect(rest,"network-firewall.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,"RuleGroupArn","string");
CkJsonObject_UpdateString(json,"RuleGroupName","string");
CkJsonObject_UpdateString(json,"Type","string");
// The JSON request body created by the above code:
// {
// "RuleGroupArn": "string",
// "RuleGroupName": "string",
// "Type": "string"
// }
CkRest_AddHeader(rest,"Content-Type","application/x-amz-json-1.0");
CkRest_AddHeader(rest,"X-Amz-Target","NetworkFirewall_20201112.DescribeRuleGroup");
sbRequestBody = CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);
sbResponseBody = CkStringBuilder_Create();
success = CkRest_FullRequestSb(rest,"POST","/",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.
GeneratedRulesType = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.RulesSourceList.GeneratedRulesType");
RulesString = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.RulesString");
RuleOrder = CkJsonObject_stringOf(jResp,"RuleGroup.StatefulRuleOptions.RuleOrder");
Capacity = CkJsonObject_IntOf(jResp,"RuleGroupResponse.Capacity");
ConsumedCapacity = CkJsonObject_IntOf(jResp,"RuleGroupResponse.ConsumedCapacity");
Description = CkJsonObject_stringOf(jResp,"RuleGroupResponse.Description");
KeyId = CkJsonObject_stringOf(jResp,"RuleGroupResponse.EncryptionConfiguration.KeyId");
v_Type = CkJsonObject_stringOf(jResp,"RuleGroupResponse.EncryptionConfiguration.Type");
LastModifiedTime = CkJsonObject_IntOf(jResp,"RuleGroupResponse.LastModifiedTime");
NumberOfAssociations = CkJsonObject_IntOf(jResp,"RuleGroupResponse.NumberOfAssociations");
RuleGroupArn = CkJsonObject_stringOf(jResp,"RuleGroupResponse.RuleGroupArn");
RuleGroupId = CkJsonObject_stringOf(jResp,"RuleGroupResponse.RuleGroupId");
RuleGroupName = CkJsonObject_stringOf(jResp,"RuleGroupResponse.RuleGroupName");
RuleGroupStatus = CkJsonObject_stringOf(jResp,"RuleGroupResponse.RuleGroupStatus");
SnsTopic = CkJsonObject_stringOf(jResp,"RuleGroupResponse.SnsTopic");
SourceArn = CkJsonObject_stringOf(jResp,"RuleGroupResponse.SourceMetadata.SourceArn");
SourceUpdateToken = CkJsonObject_stringOf(jResp,"RuleGroupResponse.SourceMetadata.SourceUpdateToken");
RuleGroupResponseType = CkJsonObject_stringOf(jResp,"RuleGroupResponse.Type");
UpdateToken = CkJsonObject_stringOf(jResp,"UpdateToken");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.RulesSourceList.Targets");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.RulesSourceList.Targets[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.RulesSourceList.TargetTypes");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.RulesSourceList.TargetTypes[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatefulRules");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
Action = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Action");
Destination = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.Destination");
DestinationPort = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.DestinationPort");
Direction = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.Direction");
Protocol = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.Protocol");
Source = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.Source");
SourcePort = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.SourcePort");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatefulRules[i].RuleOptions");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
Keyword = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Keyword");
k = 0;
count_k = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings");
while (k < count_k) {
CkJsonObject_putK(jResp,k);
strVal = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings[k]");
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
ActionName = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionName");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
Value = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions[j].Value");
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
Priority = CkJsonObject_IntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].Priority");
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
strVal = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
FromPort = CkJsonObject_IntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].FromPort");
ToPort = CkJsonObject_IntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].ToPort");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
AddressDefinition = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations[j].AddressDefinition");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
intVal = CkJsonObject_IntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
FromPort = CkJsonObject_IntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].FromPort");
ToPort = CkJsonObject_IntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].ToPort");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
AddressDefinition = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources[j].AddressDefinition");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags");
while (j < count_j) {
CkJsonObject_putJ(jResp,j);
k = 0;
count_k = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags");
while (k < count_k) {
CkJsonObject_putK(jResp,k);
strVal = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags[k]");
k = k + 1;
}
k = 0;
count_k = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks");
while (k < count_k) {
CkJsonObject_putK(jResp,k);
strVal = CkJsonObject_stringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks[k]");
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RuleVariables.IPSets.string.Definition");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"RuleGroup.RuleVariables.IPSets.string.Definition[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"RuleGroup.RuleVariables.PortSets.string.Definition");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"RuleGroup.RuleVariables.PortSets.string.Definition[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"RuleGroupResponse.Tags");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
Key = CkJsonObject_stringOf(jResp,"RuleGroupResponse.Tags[i].Key");
Value = CkJsonObject_stringOf(jResp,"RuleGroupResponse.Tags[i].Value");
i = i + 1;
}
// A sample JSON response body parsed by the above code:
// {
// "RuleGroup": {
// "RulesSource": {
// "RulesSourceList": {
// "GeneratedRulesType": "string",
// "Targets": [
// "string"
// ],
// "TargetTypes": [
// "string"
// ]
// },
// "RulesString": "string",
// "StatefulRules": [
// {
// "Action": "string",
// "Header": {
// "Destination": "string",
// "DestinationPort": "string",
// "Direction": "string",
// "Protocol": "string",
// "Source": "string",
// "SourcePort": "string"
// },
// "RuleOptions": [
// {
// "Keyword": "string",
// "Settings": [
// "string"
// ]
// }
// ]
// }
// ],
// "StatelessRulesAndCustomActions": {
// "CustomActions": [
// {
// "ActionDefinition": {
// "PublishMetricAction": {
// "Dimensions": [
// {
// "Value": "string"
// }
// ]
// }
// },
// "ActionName": "string"
// }
// ],
// "StatelessRules": [
// {
// "Priority": number,
// "RuleDefinition": {
// "Actions": [
// "string"
// ],
// "MatchAttributes": {
// "DestinationPorts": [
// {
// "FromPort": number,
// "ToPort": number
// }
// ],
// "Destinations": [
// {
// "AddressDefinition": "string"
// }
// ],
// "Protocols": [
// number
// ],
// "SourcePorts": [
// {
// "FromPort": number,
// "ToPort": number
// }
// ],
// "Sources": [
// {
// "AddressDefinition": "string"
// }
// ],
// "TCPFlags": [
// {
// "Flags": [
// "string"
// ],
// "Masks": [
// "string"
// ]
// }
// ]
// }
// }
// }
// ]
// }
// },
// "RuleVariables": {
// "IPSets": {
// "string": {
// "Definition": [
// "string"
// ]
// }
// },
// "PortSets": {
// "string": {
// "Definition": [
// "string"
// ]
// }
// }
// },
// "StatefulRuleOptions": {
// "RuleOrder": "string"
// }
// },
// "RuleGroupResponse": {
// "Capacity": number,
// "ConsumedCapacity": number,
// "Description": "string",
// "EncryptionConfiguration": {
// "KeyId": "string",
// "Type": "string"
// },
// "LastModifiedTime": number,
// "NumberOfAssociations": number,
// "RuleGroupArn": "string",
// "RuleGroupId": "string",
// "RuleGroupName": "string",
// "RuleGroupStatus": "string",
// "SnsTopic": "string",
// "SourceMetadata": {
// "SourceArn": "string",
// "SourceUpdateToken": "string"
// },
// "Tags": [
// {
// "Key": "string",
// "Value": "string"
// }
// ],
// "Type": "string"
// },
// "UpdateToken": "string"
// }
CkRest_Dispose(rest);
CkAuthAws_Dispose(authAws);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
