Chilkat Online Tools

DescribeFirewall PureBasic Example

AWS Network Firewall

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,"FirewallArn","string")
    CkJsonObject::ckUpdateString(json,"FirewallName","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "FirewallArn": "string",
    ;   "FirewallName": "string"
    ; }

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.0")
    CkRest::ckAddHeader(rest,"X-Amz-Target","NetworkFirewall_20201112.DescribeFirewall")

    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

    Key.s
    Value.s

    DeleteProtection.i = CkJsonObject::ckIntOf(jResp,"Firewall.DeleteProtection")
    Description.s = CkJsonObject::ckStringOf(jResp,"Firewall.Description")
    KeyId.s = CkJsonObject::ckStringOf(jResp,"Firewall.EncryptionConfiguration.KeyId")
    v_Type.s = CkJsonObject::ckStringOf(jResp,"Firewall.EncryptionConfiguration.Type")
    FirewallArn.s = CkJsonObject::ckStringOf(jResp,"Firewall.FirewallArn")
    FirewallId.s = CkJsonObject::ckStringOf(jResp,"Firewall.FirewallId")
    FirewallName.s = CkJsonObject::ckStringOf(jResp,"Firewall.FirewallName")
    FirewallPolicyArn.s = CkJsonObject::ckStringOf(jResp,"Firewall.FirewallPolicyArn")
    FirewallPolicyChangeProtection.i = CkJsonObject::ckIntOf(jResp,"Firewall.FirewallPolicyChangeProtection")
    SubnetChangeProtection.i = CkJsonObject::ckIntOf(jResp,"Firewall.SubnetChangeProtection")
    VpcId.s = CkJsonObject::ckStringOf(jResp,"Firewall.VpcId")
    ConfigurationSyncStateSummary.s = CkJsonObject::ckStringOf(jResp,"FirewallStatus.ConfigurationSyncStateSummary")
    Status.s = CkJsonObject::ckStringOf(jResp,"FirewallStatus.Status")
    EndpointId.s = CkJsonObject::ckStringOf(jResp,"FirewallStatus.SyncStates.string.Attachment.EndpointId")
    AttachmentStatus.s = CkJsonObject::ckStringOf(jResp,"FirewallStatus.SyncStates.string.Attachment.Status")
    SubnetId.s = CkJsonObject::ckStringOf(jResp,"FirewallStatus.SyncStates.string.Attachment.SubnetId")
    SyncStatus.s = CkJsonObject::ckStringOf(jResp,"FirewallStatus.SyncStates.string.Config.string.SyncStatus")
    UpdateToken.s = CkJsonObject::ckStringOf(jResp,"FirewallStatus.SyncStates.string.Config.string.UpdateToken")
    UpdateToken = CkJsonObject::ckStringOf(jResp,"UpdateToken")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Firewall.SubnetMappings")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        SubnetId = CkJsonObject::ckStringOf(jResp,"Firewall.SubnetMappings[i].SubnetId")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"Firewall.Tags")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Key = CkJsonObject::ckStringOf(jResp,"Firewall.Tags[i].Key")
        Value = CkJsonObject::ckStringOf(jResp,"Firewall.Tags[i].Value")
        i = i + 1
    Wend

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

    ; {
    ;   "Firewall": {
    ;     "DeleteProtection": boolean,
    ;     "Description": "string",
    ;     "EncryptionConfiguration": {
    ;       "KeyId": "string",
    ;       "Type": "string"
    ;     },
    ;     "FirewallArn": "string",
    ;     "FirewallId": "string",
    ;     "FirewallName": "string",
    ;     "FirewallPolicyArn": "string",
    ;     "FirewallPolicyChangeProtection": boolean,
    ;     "SubnetChangeProtection": boolean,
    ;     "SubnetMappings": [
    ;       {
    ;         "SubnetId": "string"
    ;       }
    ;     ],
    ;     "Tags": [
    ;       {
    ;         "Key": "string",
    ;         "Value": "string"
    ;       }
    ;     ],
    ;     "VpcId": "string"
    ;   },
    ;   "FirewallStatus": {
    ;     "ConfigurationSyncStateSummary": "string",
    ;     "Status": "string",
    ;     "SyncStates": {
    ;       "string": {
    ;         "Attachment": {
    ;           "EndpointId": "string",
    ;           "Status": "string",
    ;           "SubnetId": "string"
    ;         },
    ;         "Config": {
    ;           "string": {
    ;             "SyncStatus": "string",
    ;             "UpdateToken": "string"
    ;           }
    ;         }
    ;       }
    ;     }
    ;   },
    ;   "UpdateToken": "string"
    ; }


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure