Chilkat Online Tools

DescribeConfigRules Powershell Example

AWS Config

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 = "config"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest.SetAuthAws($authAws)

# URL: https://config.us-west-2.amazonaws.com/
# Use the same region as specified above.
$success = $rest.Connect("config.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("ConfigRuleNames[0]","string")
$json.UpdateString("NextToken","string")

# The JSON request body created by the above code:

# {
#   "ConfigRuleNames": [
#     "string"
#   ],
#   "NextToken": "string"
# }

$rest.AddHeader("Content-Type","application/x-amz-json-1.1")
$rest.AddHeader("X-Amz-Target","StarlingDoveService.DescribeConfigRules")

$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

$NextToken = $jResp.StringOf("NextToken")
$i = 0
$count_i = $jResp.SizeOfArray("ConfigRules")
while ($i -lt $count_i) {
    $jResp.I = $i
    $ConfigRuleArn = $jResp.StringOf("ConfigRules[i].ConfigRuleArn")
    $ConfigRuleId = $jResp.StringOf("ConfigRules[i].ConfigRuleId")
    $ConfigRuleName = $jResp.StringOf("ConfigRules[i].ConfigRuleName")
    $ConfigRuleState = $jResp.StringOf("ConfigRules[i].ConfigRuleState")
    $CreatedBy = $jResp.StringOf("ConfigRules[i].CreatedBy")
    $Description = $jResp.StringOf("ConfigRules[i].Description")
    $InputParameters = $jResp.StringOf("ConfigRules[i].InputParameters")
    $MaximumExecutionFrequency = $jResp.StringOf("ConfigRules[i].MaximumExecutionFrequency")
    $ComplianceResourceId = $jResp.StringOf("ConfigRules[i].Scope.ComplianceResourceId")
    $TagKey = $jResp.StringOf("ConfigRules[i].Scope.TagKey")
    $TagValue = $jResp.StringOf("ConfigRules[i].Scope.TagValue")
    $EnableDebugLogDelivery = $jResp.IntOf("ConfigRules[i].Source.CustomPolicyDetails.EnableDebugLogDelivery")
    $PolicyRuntime = $jResp.StringOf("ConfigRules[i].Source.CustomPolicyDetails.PolicyRuntime")
    $PolicyText = $jResp.StringOf("ConfigRules[i].Source.CustomPolicyDetails.PolicyText")
    $Owner = $jResp.StringOf("ConfigRules[i].Source.Owner")
    $SourceIdentifier = $jResp.StringOf("ConfigRules[i].Source.SourceIdentifier")
    $j = 0
    $count_j = $jResp.SizeOfArray("ConfigRules[i].Scope.ComplianceResourceTypes")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $strVal = $jResp.StringOf("ConfigRules[i].Scope.ComplianceResourceTypes[j]")
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("ConfigRules[i].Source.SourceDetails")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $EventSource = $jResp.StringOf("ConfigRules[i].Source.SourceDetails[j].EventSource")
        $MaximumExecutionFrequency = $jResp.StringOf("ConfigRules[i].Source.SourceDetails[j].MaximumExecutionFrequency")
        $MessageType = $jResp.StringOf("ConfigRules[i].Source.SourceDetails[j].MessageType")
        $j = $j + 1
    }

    $i = $i + 1
}

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

# {
#   "ConfigRules": [
#     {
#       "ConfigRuleArn": "string",
#       "ConfigRuleId": "string",
#       "ConfigRuleName": "string",
#       "ConfigRuleState": "string",
#       "CreatedBy": "string",
#       "Description": "string",
#       "InputParameters": "string",
#       "MaximumExecutionFrequency": "string",
#       "Scope": {
#         "ComplianceResourceId": "string",
#         "ComplianceResourceTypes": [
#           "string"
#         ],
#         "TagKey": "string",
#         "TagValue": "string"
#       },
#       "Source": {
#         "CustomPolicyDetails": {
#           "EnableDebugLogDelivery": boolean,
#           "PolicyRuntime": "string",
#           "PolicyText": "string"
#         },
#         "Owner": "string",
#         "SourceDetails": [
#           {
#             "EventSource": "string",
#             "MaximumExecutionFrequency": "string",
#             "MessageType": "string"
#           }
#         ],
#         "SourceIdentifier": "string"
#       }
#     }
#   ],
#   "NextToken": "string"
# }