DescribeRuleGroup Powershell Example
Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$rest = New-Object Chilkat.Rest
$authAws = New-Object 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
$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 -ne $true) {
$("ConnectFailReason: " + $rest.ConnectFailReason)
$($rest.LastErrorText)
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
$json = New-Object Chilkat.JsonObject
$json.UpdateString("RuleGroupArn","string")
$json.UpdateString("RuleGroupName","string")
$json.UpdateString("Type","string")
# The JSON request body created by the above code:
# {
# "RuleGroupArn": "string",
# "RuleGroupName": "string",
# "Type": "string"
# }
$rest.AddHeader("Content-Type","application/x-amz-json-1.0")
$rest.AddHeader("X-Amz-Target","NetworkFirewall_20201112.DescribeRuleGroup")
$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
$($rest.LastErrorText)
exit
}
$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
$("Response Header:")
$($rest.ResponseHeader)
$("Response Body:")
$($sbResponseBody.GetAsString())
exit
}
$jResp = New-Object Chilkat.JsonObject
$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
$GeneratedRulesType = $jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.GeneratedRulesType")
$RulesString = $jResp.StringOf("RuleGroup.RulesSource.RulesString")
$RuleOrder = $jResp.StringOf("RuleGroup.StatefulRuleOptions.RuleOrder")
$Capacity = $jResp.IntOf("RuleGroupResponse.Capacity")
$ConsumedCapacity = $jResp.IntOf("RuleGroupResponse.ConsumedCapacity")
$Description = $jResp.StringOf("RuleGroupResponse.Description")
$KeyId = $jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.KeyId")
$v_Type = $jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.Type")
$LastModifiedTime = $jResp.IntOf("RuleGroupResponse.LastModifiedTime")
$NumberOfAssociations = $jResp.IntOf("RuleGroupResponse.NumberOfAssociations")
$RuleGroupArn = $jResp.StringOf("RuleGroupResponse.RuleGroupArn")
$RuleGroupId = $jResp.StringOf("RuleGroupResponse.RuleGroupId")
$RuleGroupName = $jResp.StringOf("RuleGroupResponse.RuleGroupName")
$RuleGroupStatus = $jResp.StringOf("RuleGroupResponse.RuleGroupStatus")
$SnsTopic = $jResp.StringOf("RuleGroupResponse.SnsTopic")
$SourceArn = $jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceArn")
$SourceUpdateToken = $jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceUpdateToken")
$RuleGroupResponseType = $jResp.StringOf("RuleGroupResponse.Type")
$UpdateToken = $jResp.StringOf("UpdateToken")
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroup.RulesSource.RulesSourceList.Targets")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.Targets[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroup.RulesSource.RulesSourceList.TargetTypes")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.TargetTypes[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroup.RulesSource.StatefulRules")
while ($i -lt $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 -lt $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 -lt $count_k) {
$jResp.K = $k
$strVal = $jResp.StringOf("RuleGroup.RulesSource.StatefulRules[i].RuleOptions[j].Settings[k]")
$k = $k + 1
}
$j = $j + 1
}
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions")
while ($i -lt $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 -lt $count_j) {
$jResp.J = $j
$Value = $jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.CustomActions[i].ActionDefinition.PublishMetricAction.Dimensions[j].Value")
$j = $j + 1
}
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules")
while ($i -lt $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 -lt $count_j) {
$jResp.J = $j
$strVal = $jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions[j]")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts")
while ($j -lt $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
}
$j = 0
$count_j = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations")
while ($j -lt $count_j) {
$jResp.J = $j
$AddressDefinition = $jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations[j].AddressDefinition")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols")
while ($j -lt $count_j) {
$jResp.J = $j
$intVal = $jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols[j]")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts")
while ($j -lt $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
}
$j = 0
$count_j = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources")
while ($j -lt $count_j) {
$jResp.J = $j
$AddressDefinition = $jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources[j].AddressDefinition")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags")
while ($j -lt $count_j) {
$jResp.J = $j
$k = 0
$count_k = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags")
while ($k -lt $count_k) {
$jResp.K = $k
$strVal = $jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags[k]")
$k = $k + 1
}
$k = 0
$count_k = $jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks")
while ($k -lt $count_k) {
$jResp.K = $k
$strVal = $jResp.StringOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Masks[k]")
$k = $k + 1
}
$j = $j + 1
}
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroup.RuleVariables.IPSets.string.Definition")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("RuleGroup.RuleVariables.IPSets.string.Definition[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroup.RuleVariables.PortSets.string.Definition")
while ($i -lt $count_i) {
$jResp.I = $i
$strVal = $jResp.StringOf("RuleGroup.RuleVariables.PortSets.string.Definition[i]")
$i = $i + 1
}
$i = 0
$count_i = $jResp.SizeOfArray("RuleGroupResponse.Tags")
while ($i -lt $count_i) {
$jResp.I = $i
$Key = $jResp.StringOf("RuleGroupResponse.Tags[i].Key")
$Value = $jResp.StringOf("RuleGroupResponse.Tags[i].Value")
$i = $i + 1
}
# 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"
# }
