DescribeRuleGroup Swift Example
func chilkatTest() {
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let rest = CkoRest()
var success: Bool
let authAws = CkoAuthAws()
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", port: 443, tls: true, autoReconnect: true)
if success != true {
print("ConnectFailReason: \(rest.ConnectFailReason.intValue)")
print("\(rest.LastErrorText)")
return
}
// 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
let json = CkoJsonObject()
json.UpdateString("RuleGroupArn", value: "string")
json.UpdateString("RuleGroupName", value: "string")
json.UpdateString("Type", value: "string")
// The JSON request body created by the above code:
// {
// "RuleGroupArn": "string",
// "RuleGroupName": "string",
// "Type": "string"
// }
rest.AddHeader("Content-Type", value: "application/x-amz-json-1.0")
rest.AddHeader("X-Amz-Target", value: "NetworkFirewall_20201112.DescribeRuleGroup")
let sbRequestBody = CkoStringBuilder()
json.EmitSb(sbRequestBody)
let sbResponseBody = CkoStringBuilder()
success = rest.FullRequestSb("POST", uriPath: "/", requestBody: sbRequestBody, responseBody: sbResponseBody)
if success != true {
print("\(rest.LastErrorText)")
return
}
var respStatusCode: Int = rest.ResponseStatusCode.intValue
print("response status code = \(respStatusCode)")
if respStatusCode != 200 {
print("Response Header:")
print("\(rest.ResponseHeader)")
print("Response Body:")
print("\(sbResponseBody.GetAsString())")
return
}
let jResp = CkoJsonObject()
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
var strVal: String?
var Action: String?
var Destination: String?
var DestinationPort: String?
var Direction: String?
var Protocol: String?
var Source: String?
var SourcePort: String?
var j: Int
var count_j: Int
var Keyword: String?
var k: Int
var count_k: Int
var ActionName: String?
var Value: String?
var Priority: Int
var FromPort: Int
var ToPort: Int
var AddressDefinition: String?
var intVal: Int
var Key: String?
var GeneratedRulesType: String? = jResp.StringOf("RuleGroup.RulesSource.RulesSourceList.GeneratedRulesType")
var RulesString: String? = jResp.StringOf("RuleGroup.RulesSource.RulesString")
var RuleOrder: String? = jResp.StringOf("RuleGroup.StatefulRuleOptions.RuleOrder")
var Capacity: Int = jResp.IntOf("RuleGroupResponse.Capacity").intValue
var ConsumedCapacity: Int = jResp.IntOf("RuleGroupResponse.ConsumedCapacity").intValue
var Description: String? = jResp.StringOf("RuleGroupResponse.Description")
var KeyId: String? = jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.KeyId")
var v_Type: String? = jResp.StringOf("RuleGroupResponse.EncryptionConfiguration.Type")
var LastModifiedTime: Int = jResp.IntOf("RuleGroupResponse.LastModifiedTime").intValue
var NumberOfAssociations: Int = jResp.IntOf("RuleGroupResponse.NumberOfAssociations").intValue
var RuleGroupArn: String? = jResp.StringOf("RuleGroupResponse.RuleGroupArn")
var RuleGroupId: String? = jResp.StringOf("RuleGroupResponse.RuleGroupId")
var RuleGroupName: String? = jResp.StringOf("RuleGroupResponse.RuleGroupName")
var RuleGroupStatus: String? = jResp.StringOf("RuleGroupResponse.RuleGroupStatus")
var SnsTopic: String? = jResp.StringOf("RuleGroupResponse.SnsTopic")
var SourceArn: String? = jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceArn")
var SourceUpdateToken: String? = jResp.StringOf("RuleGroupResponse.SourceMetadata.SourceUpdateToken")
var RuleGroupResponseType: String? = jResp.StringOf("RuleGroupResponse.Type")
var UpdateToken: String? = jResp.StringOf("UpdateToken")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("RuleGroup.RulesSource.RulesSourceList.Targets").intValue
while i < 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").intValue
while i < 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").intValue
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").intValue
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").intValue
while k < 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").intValue
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").intValue
while j < 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").intValue
while i < count_i {
jResp.I = i
Priority = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].Priority").intValue
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.Actions").intValue
while j < 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").intValue
while j < count_j {
jResp.J = j
FromPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].FromPort").intValue
ToPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.DestinationPorts[j].ToPort").intValue
j = j + 1
}
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Destinations").intValue
while j < 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").intValue
while j < count_j {
jResp.J = j
intVal = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Protocols[j]").intValue
j = j + 1
}
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts").intValue
while j < count_j {
jResp.J = j
FromPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].FromPort").intValue
ToPort = jResp.IntOf("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.SourcePorts[j].ToPort").intValue
j = j + 1
}
j = 0
count_j = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.Sources").intValue
while j < 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").intValue
while j < count_j {
jResp.J = j
k = 0
count_k = jResp.SizeOfArray("RuleGroup.RulesSource.StatelessRulesAndCustomActions.StatelessRules[i].RuleDefinition.MatchAttributes.TCPFlags[j].Flags").intValue
while k < 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").intValue
while k < 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").intValue
while i < 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").intValue
while i < 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").intValue
while i < 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"
// }
}
