Chilkat Online Tools

DescribeFirewallPolicy TCL Example

AWS Network Firewall

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $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_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $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.
set success [CkRest_Connect $rest "network-firewall.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# 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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "FirewallPolicyArn" "string"
CkJsonObject_UpdateString $json "FirewallPolicyName" "string"

# The JSON request body created by the above code:

# {
#   "FirewallPolicyArn": "string",
#   "FirewallPolicyName": "string"
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.0"
CkRest_AddHeader $rest "X-Amz-Target" "NetworkFirewall_20201112.DescribeFirewallPolicy"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

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

set RuleOrder [CkJsonObject_stringOf $jResp "FirewallPolicy.StatefulEngineOptions.RuleOrder"]
set ConsumedStatefulRuleCapacity [CkJsonObject_IntOf $jResp "FirewallPolicyResponse.ConsumedStatefulRuleCapacity"]
set ConsumedStatelessRuleCapacity [CkJsonObject_IntOf $jResp "FirewallPolicyResponse.ConsumedStatelessRuleCapacity"]
set Description [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.Description"]
set KeyId [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.EncryptionConfiguration.KeyId"]
set v_Type [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.EncryptionConfiguration.Type"]
set FirewallPolicyArn [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.FirewallPolicyArn"]
set FirewallPolicyId [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.FirewallPolicyId"]
set FirewallPolicyName [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.FirewallPolicyName"]
set FirewallPolicyStatus [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.FirewallPolicyStatus"]
set LastModifiedTime [CkJsonObject_IntOf $jResp "FirewallPolicyResponse.LastModifiedTime"]
set NumberOfAssociations [CkJsonObject_IntOf $jResp "FirewallPolicyResponse.NumberOfAssociations"]
set UpdateToken [CkJsonObject_stringOf $jResp "UpdateToken"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "FirewallPolicy.StatefulDefaultActions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "FirewallPolicy.StatefulDefaultActions[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "FirewallPolicy.StatefulRuleGroupReferences"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Action [CkJsonObject_stringOf $jResp "FirewallPolicy.StatefulRuleGroupReferences[i].Override.Action"]
    set Priority [CkJsonObject_IntOf $jResp "FirewallPolicy.StatefulRuleGroupReferences[i].Priority"]
    set ResourceArn [CkJsonObject_stringOf $jResp "FirewallPolicy.StatefulRuleGroupReferences[i].ResourceArn"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "FirewallPolicy.StatelessCustomActions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set ActionName [CkJsonObject_stringOf $jResp "FirewallPolicy.StatelessCustomActions[i].ActionName"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "FirewallPolicy.StatelessCustomActions[i].ActionDefinition.PublishMetricAction.Dimensions"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set Value [CkJsonObject_stringOf $jResp "FirewallPolicy.StatelessCustomActions[i].ActionDefinition.PublishMetricAction.Dimensions[j].Value"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "FirewallPolicy.StatelessDefaultActions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "FirewallPolicy.StatelessDefaultActions[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "FirewallPolicy.StatelessFragmentDefaultActions"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set strVal [CkJsonObject_stringOf $jResp "FirewallPolicy.StatelessFragmentDefaultActions[i]"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "FirewallPolicy.StatelessRuleGroupReferences"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Priority [CkJsonObject_IntOf $jResp "FirewallPolicy.StatelessRuleGroupReferences[i].Priority"]
    set ResourceArn [CkJsonObject_stringOf $jResp "FirewallPolicy.StatelessRuleGroupReferences[i].ResourceArn"]
    set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "FirewallPolicyResponse.Tags"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set Key [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.Tags[i].Key"]
    set Value [CkJsonObject_stringOf $jResp "FirewallPolicyResponse.Tags[i].Value"]
    set i [expr $i + 1]
}

# 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"
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp