Chilkat Online Tools

DescribeConfigRules Ruby Example

AWS Config

require 'chilkat'

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = Chilkat::CkRest.new()

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_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.put_Region("us-west-2")
authAws.put_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 != true)
    print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
    print rest.lastErrorText() + "\n";
    exit
end

# 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 = Chilkat::CkJsonObject.new()
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 = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != true)
    print rest.lastErrorText() + "\n";
    exit
end

respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
    print "Response Header:" + "\n";
    print rest.responseHeader() + "\n";
    print "Response Body:" + "\n";
    print sbResponseBody.getAsString() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
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 < count_i
    jResp.put_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 < count_j
        jResp.put_J(j)
        strVal = jResp.stringOf("ConfigRules[i].Scope.ComplianceResourceTypes[j]")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("ConfigRules[i].Source.SourceDetails")
    while j < count_j
        jResp.put_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
    end
    i = i + 1
end

# 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"
# }