DescribeConfigRules PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(authAws, "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.)
CkAuthAws::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "config")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://config.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"config.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"ConfigRuleNames[0]","string")
CkJsonObject::ckUpdateString(json,"NextToken","string")
; The JSON request body created by the above code:
; {
; "ConfigRuleNames": [
; "string"
; ],
; "NextToken": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","StarlingDoveService.DescribeConfigRules")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,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
ConfigRuleArn.s
ConfigRuleId.s
ConfigRuleName.s
ConfigRuleState.s
CreatedBy.s
Description.s
InputParameters.s
MaximumExecutionFrequency.s
ComplianceResourceId.s
TagKey.s
TagValue.s
EnableDebugLogDelivery.i
PolicyRuntime.s
PolicyText.s
Owner.s
SourceIdentifier.s
j.i
count_j.i
strVal.s
EventSource.s
MessageType.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"ConfigRules")
While i < count_i
CkJsonObject::setCkI(jResp, i)
ConfigRuleArn = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].ConfigRuleArn")
ConfigRuleId = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].ConfigRuleId")
ConfigRuleName = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].ConfigRuleName")
ConfigRuleState = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].ConfigRuleState")
CreatedBy = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].CreatedBy")
Description = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Description")
InputParameters = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].InputParameters")
MaximumExecutionFrequency = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].MaximumExecutionFrequency")
ComplianceResourceId = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Scope.ComplianceResourceId")
TagKey = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Scope.TagKey")
TagValue = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Scope.TagValue")
EnableDebugLogDelivery = CkJsonObject::ckIntOf(jResp,"ConfigRules[i].Source.CustomPolicyDetails.EnableDebugLogDelivery")
PolicyRuntime = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Source.CustomPolicyDetails.PolicyRuntime")
PolicyText = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Source.CustomPolicyDetails.PolicyText")
Owner = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Source.Owner")
SourceIdentifier = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Source.SourceIdentifier")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"ConfigRules[i].Scope.ComplianceResourceTypes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Scope.ComplianceResourceTypes[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"ConfigRules[i].Source.SourceDetails")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
EventSource = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Source.SourceDetails[j].EventSource")
MaximumExecutionFrequency = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Source.SourceDetails[j].MaximumExecutionFrequency")
MessageType = CkJsonObject::ckStringOf(jResp,"ConfigRules[i].Source.SourceDetails[j].MessageType")
j = j + 1
Wend
i = i + 1
Wend
; 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"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
