DescribeRuleGroup Xojo Example
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Dim rest As New Chilkat.Rest
Dim success As Boolean
Dim authAws As New Chilkat.AuthAws
authAws.AccessKey = "AWS_ACCESS_KEY"
authAws.SecretKey = "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.)
authAws.Region = "us-west-2"
authAws.ServiceName = "network-firewall"
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
success = rest.SetAuthAws(authAws)
// URL: https://network-firewall.us-west-2.amazonaws.com/
// Use the same region as specified above.
success = rest.Connect("network-firewall.us-west-2.amazonaws.com",443,True,True)
If (success <> True) Then
System.DebugLog("ConnectFailReason: " + Str(rest.ConnectFailReason))
System.DebugLog(rest.LastErrorText)
Return
End If
// 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
Dim json As New Chilkat.JsonObject
success = json.UpdateString("RuleGroupArn","string")
success = json.UpdateString("RuleGroupName","string")
success = json.UpdateString("Type","string")
// The JSON request body created by the above code:
// {
// "RuleGroupArn": "string",
// "RuleGroupName": "string",
// "Type": "string"
// }
success = rest.AddHeader("Content-Type","application/x-amz-json-1.0")
success = rest.AddHeader("X-Amz-Target","NetworkFirewall_20201112.DescribeRuleGroup")
Dim sbRequestBody As New Chilkat.StringBuilder
success = json.EmitSb(sbRequestBody)
Dim sbResponseBody As New Chilkat.StringBuilder
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
If (success <> True) Then
System.DebugLog(rest.LastErrorText)
Return
End If
Dim respStatusCode As Int32
respStatusCode = rest.ResponseStatusCode
System.DebugLog("response status code = " + Str(respStatusCode))
If (respStatusCode <> 200) Then
System.DebugLog("Response Header:")
System.DebugLog(rest.ResponseHeader)
System.DebugLog("Response Body:")
System.DebugLog(sbResponseBody.GetAsString())
Return
End If
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(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
Dim strVal As String
Dim Action As String
Dim Destination As String
Dim DestinationPort As String
Dim Direction As String
Dim Protocol As String
Dim Source As String
Dim SourcePort As String
Dim j As Int32
Dim count_j As Int32
Dim Keyword As String
Dim k As Int32
Dim count_k As Int32
Dim ActionName As String
Dim Value As String
Dim Priority As Int32
Dim FromPort As Int32
Dim ToPort As Int32
Dim AddressDefinition As String
Dim intVal As Int32
Dim Key As String
Dim GeneratedRulesType As String
GeneratedRulesType = jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.GeneratedRulesType")
Dim RulesString As String
RulesString = jResp.StringOf("RuleGroup.RulesSource.RulesString")
Dim RuleOrder As String
RuleOrder = jResp.StringOf("RuleGroup.StatefulRuleOptions.RuleOrder")
Dim Capacity As Int32
Capacity = jResp.IntOf("RuleGroupResponse.Capacity")
Dim ConsumedCapacity As Int32
ConsumedCapacity = jResp.IntOf("RuleGroupResponse.ConsumedCapacity")
Dim Description As String
Description = jResp.StringOf("RuleGroupResponse.Description")
Dim KeyId As String
KeyId = jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.KeyId")
Dim v_Type As String
v_Type = jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.Type")
Dim LastModifiedTime As Int32
LastModifiedTime = jResp.IntOf("RuleGroupResponse.LastModifiedTime")
Dim NumberOfAssociations As Int32
NumberOfAssociations = jResp.IntOf("RuleGroupResponse.NumberOfAssociations")
Dim RuleGroupArn As String
RuleGroupArn = jResp.StringOf("RuleGroupResponse.RuleGroupArn")
Dim RuleGroupId As String
RuleGroupId = jResp.StringOf("RuleGroupResponse.RuleGroupId")
Dim RuleGroupName As String
RuleGroupName = jResp.StringOf("RuleGroupResponse.RuleGroupName")
Dim RuleGroupStatus As String
RuleGroupStatus = jResp.StringOf("RuleGroupResponse.RuleGroupStatus")
Dim SnsTopic As String
SnsTopic = jResp.StringOf("RuleGroupResponse.SnsTopic")
Dim SourceArn As String
SourceArn = jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceArn")
Dim SourceUpdateToken As String
SourceUpdateToken = jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceUpdateToken")
Dim RuleGroupResponseType As String
RuleGroupResponseType = jResp.StringOf("RuleGroupResponse.Type")
Dim UpdateToken As String
UpdateToken = jResp.StringOf("UpdateToken")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("RuleGroup.RulesSource.RulesSourceList.Targets")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.Targets[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("RuleGroup.RulesSource.RulesSourceList.TargetTypes")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.TargetTypes[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("RuleGroup.RulesSource.StatefulRules")
While i < count_i
jResp.I = i
Action = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Action")
Destination = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.Destination")
DestinationPort = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.DestinationPort")
Direction = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.Direction")
Protocol = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.Protocol")
Source = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.Source")
SourcePort = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].Header.SourcePort")
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatefulRules[i].RuleOptions")
While j < count_j
jResp.J = j
Keyword = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Keyword")
k = 0
count_k = jResp.SizeOfArray("RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings")
While k < count_k
jResp.K = k
strVal = jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings[k]")
k = k + 1
Wend
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions")
While i < count_i
jResp.I = i
ActionName = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionName")
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions")
While j < count_j
jResp.J = j
Value = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions[j].Value")
j = j + 1
Wend
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules")
While i < count_i
jResp.I = i
Priority = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].Priority")
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions")
While j < count_j
jResp.J = j
strVal = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions[j]")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts")
While j < count_j
jResp.J = j
FromPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].FromPort")
ToPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].ToPort")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations")
While j < count_j
jResp.J = j
AddressDefinition = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations[j].AddressDefinition")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols")
While j < count_j
jResp.J = j
intVal = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols[j]")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts")
While j < count_j
jResp.J = j
FromPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].FromPort")
ToPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].ToPort")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources")
While j < count_j
jResp.J = j
AddressDefinition = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources[j].AddressDefinition")
j = j + 1
Wend
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags")
While j < count_j
jResp.J = j
k = 0
count_k = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags")
While k < count_k
jResp.K = k
strVal = jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags[k]")
k = k + 1
Wend
k = 0
count_k = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks")
While k < count_k
jResp.K = k
strVal = jResp.StringOf("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 = jResp.SizeOfArray("RuleGroup.RuleVariables.IPSets.string.Definition")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("RuleGroup.RuleVariables.IPSets.string.Definition[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("RuleGroup.RuleVariables.PortSets.string.Definition")
While i < count_i
jResp.I = i
strVal = jResp.StringOf("RuleGroup.RuleVariables.PortSets.string.Definition[i]")
i = i + 1
Wend
i = 0
count_i = jResp.SizeOfArray("RuleGroupResponse.Tags")
While i < count_i
jResp.I = i
Key = jResp.StringOf("RuleGroupResponse.Tags[i].Key")
Value = jResp.StringOf("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"
// }
