Chilkat Online Tools

DescribeRuleGroupMetadata 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 "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.DescribeRuleGroupMetadata"

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 Capacity [CkJsonObject_IntOf $jResp "Capacity"]
set Description [CkJsonObject_stringOf $jResp "Description"]
set LastModifiedTime [CkJsonObject_IntOf $jResp "LastModifiedTime"]
set RuleGroupArn [CkJsonObject_stringOf $jResp "RuleGroupArn"]
set RuleGroupName [CkJsonObject_stringOf $jResp "RuleGroupName"]
set RuleOrder [CkJsonObject_stringOf $jResp "StatefulRuleOptions.RuleOrder"]
set v_Type [CkJsonObject_stringOf $jResp "Type"]

# A sample JSON response body parsed by the above code:

# {
#   "Capacity": number,
#   "Description": "string",
#   "LastModifiedTime": number,
#   "RuleGroupArn": "string",
#   "RuleGroupName": "string",
#   "StatefulRuleOptions": {
#     "RuleOrder": "string"
#   },
#   "Type": "string"
# }

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