DescribeRuleGroup PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "network-firewall")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://network-firewall.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"network-firewall.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"RuleGroupArn","string")
CkJsonObject::ckUpdateString(json,"RuleGroupName","string")
CkJsonObject::ckUpdateString(json,"Type","string")
; The JSON request body created by the above code:
; {
; "RuleGroupArn": "string",
; "RuleGroupName": "string",
; "Type": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
CkRest::ckAddHeader(rest,"X-Amz-Target","NetworkFirewall_20201112.DescribeRuleGroup")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
strVal.s
Action.s
Destination.s
DestinationPort.s
Direction.s
Protocol.s
Source.s
SourcePort.s
j.i
count_j.i
Keyword.s
k.i
count_k.i
ActionName.s
Value.s
Priority.i
FromPort.i
ToPort.i
AddressDefinition.s
intVal.i
Key.s
GeneratedRulesType.s = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.RulesSourceList.GeneratedRulesType")
RulesString.s = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.RulesString")
RuleOrder.s = CkJsonObject::ckStringOf(jResp,"RuleGroup.StatefulRuleOptions.RuleOrder")
Capacity.i = CkJsonObject::ckIntOf(jResp,"RuleGroupResponse.Capacity")
ConsumedCapacity.i = CkJsonObject::ckIntOf(jResp,"RuleGroupResponse.ConsumedCapacity")
Description.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.Description")
KeyId.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.EncryptionConfiguration.KeyId")
v_Type.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.EncryptionConfiguration.Type")
LastModifiedTime.i = CkJsonObject::ckIntOf(jResp,"RuleGroupResponse.LastModifiedTime")
NumberOfAssociations.i = CkJsonObject::ckIntOf(jResp,"RuleGroupResponse.NumberOfAssociations")
RuleGroupArn.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.RuleGroupArn")
RuleGroupId.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.RuleGroupId")
RuleGroupName.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.RuleGroupName")
RuleGroupStatus.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.RuleGroupStatus")
SnsTopic.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.SnsTopic")
SourceArn.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.SourceMetadata.SourceArn")
SourceUpdateToken.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.SourceMetadata.SourceUpdateToken")
RuleGroupResponseType.s = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.Type")
UpdateToken.s = CkJsonObject::ckStringOf(jResp,"UpdateToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.RulesSourceList.Targets")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.RulesSourceList.Targets[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.RulesSourceList.TargetTypes")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.RulesSourceList.TargetTypes[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatefulRules")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Action = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Action")
Destination = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.Destination")
DestinationPort = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.DestinationPort")
Direction = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.Direction")
Protocol = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.Protocol")
Source = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.Source")
SourcePort = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].Header.SourcePort")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatefulRules[i].RuleOptions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
Keyword = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Keyword")
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings[k]")
k = k + 1
Wend
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
ActionName = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionName")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
Value = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions[j].Value")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Priority = CkJsonObject::ckIntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].Priority")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
FromPort = CkJsonObject::ckIntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].FromPort")
ToPort = CkJsonObject::ckIntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].ToPort")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
AddressDefinition = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations[j].AddressDefinition")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
intVal = CkJsonObject::ckIntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
FromPort = CkJsonObject::ckIntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].FromPort")
ToPort = CkJsonObject::ckIntOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].ToPort")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
AddressDefinition = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources[j].AddressDefinition")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags[k]")
k = k + 1
Wend
k = 0
count_k = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks")
While k < count_k
CkJsonObject::setCkK(jResp, k)
strVal = CkJsonObject::ckStringOf(jResp,"RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks[k]")
k = k + 1
Wend
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RuleVariables.IPSets.string.Definition")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"RuleGroup.RuleVariables.IPSets.string.Definition[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"RuleGroup.RuleVariables.PortSets.string.Definition")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"RuleGroup.RuleVariables.PortSets.string.Definition[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"RuleGroupResponse.Tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Key = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.Tags[i].Key")
Value = CkJsonObject::ckStringOf(jResp,"RuleGroupResponse.Tags[i].Value")
i = i + 1
Wend
; 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::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
