DescribeFirewallPolicy 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,"FirewallPolicyArn","string")
CkJsonObject::ckUpdateString(json,"FirewallPolicyName","string")
; The JSON request body created by the above code:
; {
; "FirewallPolicyArn": "string",
; "FirewallPolicyName": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
CkRest::ckAddHeader(rest,"X-Amz-Target","NetworkFirewall_20201112.DescribeFirewallPolicy")
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
Priority.i
ResourceArn.s
ActionName.s
j.i
count_j.i
Value.s
Key.s
RuleOrder.s = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatefulEngineOptions.RuleOrder")
ConsumedStatefulRuleCapacity.i = CkJsonObject::ckIntOf(jResp,"FirewallPolicyResponse.ConsumedStatefulRuleCapacity")
ConsumedStatelessRuleCapacity.i = CkJsonObject::ckIntOf(jResp,"FirewallPolicyResponse.ConsumedStatelessRuleCapacity")
Description.s = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.Description")
KeyId.s = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.EncryptionConfiguration.KeyId")
v_Type.s = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.EncryptionConfiguration.Type")
FirewallPolicyArn.s = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.FirewallPolicyArn")
FirewallPolicyId.s = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.FirewallPolicyId")
FirewallPolicyName.s = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.FirewallPolicyName")
FirewallPolicyStatus.s = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.FirewallPolicyStatus")
LastModifiedTime.i = CkJsonObject::ckIntOf(jResp,"FirewallPolicyResponse.LastModifiedTime")
NumberOfAssociations.i = CkJsonObject::ckIntOf(jResp,"FirewallPolicyResponse.NumberOfAssociations")
UpdateToken.s = CkJsonObject::ckStringOf(jResp,"UpdateToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"FirewallPolicy.StatefulDefaultActions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatefulDefaultActions[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"FirewallPolicy.StatefulRuleGroupReferences")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Action = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatefulRuleGroupReferences[i].Override.Action")
Priority = CkJsonObject::ckIntOf(jResp,"FirewallPolicy.StatefulRuleGroupReferences[i].Priority")
ResourceArn = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatefulRuleGroupReferences[i].ResourceArn")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"FirewallPolicy.StatelessCustomActions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
ActionName = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatelessCustomActions[i].ActionName")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"FirewallPolicy.StatelessCustomActions[i].ActionDefinition.PublishMetricAction.Dimensions")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
Value = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatelessCustomActions[i].ActionDefinition.PublishMetricAction.Dimensions[j].Value")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"FirewallPolicy.StatelessDefaultActions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatelessDefaultActions[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"FirewallPolicy.StatelessFragmentDefaultActions")
While i < count_i
CkJsonObject::setCkI(jResp, i)
strVal = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatelessFragmentDefaultActions[i]")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"FirewallPolicy.StatelessRuleGroupReferences")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Priority = CkJsonObject::ckIntOf(jResp,"FirewallPolicy.StatelessRuleGroupReferences[i].Priority")
ResourceArn = CkJsonObject::ckStringOf(jResp,"FirewallPolicy.StatelessRuleGroupReferences[i].ResourceArn")
i = i + 1
Wend
i = 0
count_i = CkJsonObject::ckSizeOfArray(jResp,"FirewallPolicyResponse.Tags")
While i < count_i
CkJsonObject::setCkI(jResp, i)
Key = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.Tags[i].Key")
Value = CkJsonObject::ckStringOf(jResp,"FirewallPolicyResponse.Tags[i].Value")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "FirewallPolicy": {
; "StatefulDefaultActions": [
; "string"
; ],
; "StatefulEngineOptions": {
; "RuleOrder": "string"
; },
; "StatefulRuleGroupReferences": [
; {
; "Override": {
; "Action": "string"
; },
; "Priority": number,
; "ResourceArn": "string"
; }
; ],
; "StatelessCustomActions": [
; {
; "ActionDefinition": {
; "PublishMetricAction": {
; "Dimensions": [
; {
; "Value": "string"
; }
; ]
; }
; },
; "ActionName": "string"
; }
; ],
; "StatelessDefaultActions": [
; "string"
; ],
; "StatelessFragmentDefaultActions": [
; "string"
; ],
; "StatelessRuleGroupReferences": [
; {
; "Priority": number,
; "ResourceArn": "string"
; }
; ]
; },
; "FirewallPolicyResponse": {
; "ConsumedStatefulRuleCapacity": number,
; "ConsumedStatelessRuleCapacity": number,
; "Description": "string",
; "EncryptionConfiguration": {
; "KeyId": "string",
; "Type": "string"
; },
; "FirewallPolicyArn": "string",
; "FirewallPolicyId": "string",
; "FirewallPolicyName": "string",
; "FirewallPolicyStatus": "string",
; "LastModifiedTime": number,
; "NumberOfAssociations": number,
; "Tags": [
; {
; "Key": "string",
; "Value": "string"
; }
; ]
; },
; "UpdateToken": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
