DescribeOrganizationConfigRules 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::ckUpdateInt(json,"Limit",123)
CkJsonObject::ckUpdateString(json,"NextToken","string")
CkJsonObject::ckUpdateString(json,"OrganizationConfigRuleNames[0]","string")
; The JSON request body created by the above code:
; {
; "Limit": number,
; "NextToken": "string",
; "OrganizationConfigRuleNames": [
; "string"
; ]
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","StarlingDoveService.DescribeOrganizationConfigRules")
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
LastUpdateTime.i
OrganizationConfigRuleArn.s
OrganizationConfigRuleName.s
Description.s
InputParameters.s
MaximumExecutionFrequency.s
PolicyRuntime.s
ResourceIdScope.s
TagKeyScope.s
TagValueScope.s
OrganizationCustomRuleMetadataDescription.s
OrganizationCustomRuleMetadataInputParameters.s
LambdaFunctionArn.s
OrganizationCustomRuleMetadataMaximumExecutionFrequency.s
OrganizationCustomRuleMetadataResourceIdScope.s
OrganizationCustomRuleMetadataTagKeyScope.s
OrganizationCustomRuleMetadataTagValueScope.s
OrganizationManagedRuleMetadataDescription.s
OrganizationManagedRuleMetadataInputParameters.s
OrganizationManagedRuleMetadataMaximumExecutionFrequency.s
OrganizationManagedRuleMetadataResourceIdScope.s
RuleIdentifier.s
OrganizationManagedRuleMetadataTagKeyScope.s
OrganizationManagedRuleMetadataTagValueScope.s
j.i
count_j.i
strVal.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"OrganizationConfigRules")
While i < count_i
CkJsonObject::setCkI(jResp, i)
LastUpdateTime = CkJsonObject::ckIntOf(jResp,"OrganizationConfigRules[i].LastUpdateTime")
OrganizationConfigRuleArn = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationConfigRuleArn")
OrganizationConfigRuleName = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationConfigRuleName")
Description = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.Description")
InputParameters = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.InputParameters")
MaximumExecutionFrequency = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.MaximumExecutionFrequency")
PolicyRuntime = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.PolicyRuntime")
ResourceIdScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.ResourceIdScope")
TagKeyScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.TagKeyScope")
TagValueScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.TagValueScope")
OrganizationCustomRuleMetadataDescription = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.Description")
OrganizationCustomRuleMetadataInputParameters = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.InputParameters")
LambdaFunctionArn = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.LambdaFunctionArn")
OrganizationCustomRuleMetadataMaximumExecutionFrequency = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.MaximumExecutionFrequency")
OrganizationCustomRuleMetadataResourceIdScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.ResourceIdScope")
OrganizationCustomRuleMetadataTagKeyScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.TagKeyScope")
OrganizationCustomRuleMetadataTagValueScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.TagValueScope")
OrganizationManagedRuleMetadataDescription = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.Description")
OrganizationManagedRuleMetadataInputParameters = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.InputParameters")
OrganizationManagedRuleMetadataMaximumExecutionFrequency = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.MaximumExecutionFrequency")
OrganizationManagedRuleMetadataResourceIdScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.ResourceIdScope")
RuleIdentifier = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.RuleIdentifier")
OrganizationManagedRuleMetadataTagKeyScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.TagKeyScope")
OrganizationManagedRuleMetadataTagValueScope = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.TagValueScope")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"OrganizationConfigRules[i].ExcludedAccounts")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].ExcludedAccounts[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.DebugLogDeliveryAccounts")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.DebugLogDeliveryAccounts[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.OrganizationConfigRuleTriggerTypes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.OrganizationConfigRuleTriggerTypes[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.ResourceTypesScope")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomPolicyRuleMetadata.ResourceTypesScope[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.OrganizationConfigRuleTriggerTypes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.OrganizationConfigRuleTriggerTypes[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.ResourceTypesScope")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationCustomRuleMetadata.ResourceTypesScope[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.ResourceTypesScope")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"OrganizationConfigRules[i].OrganizationManagedRuleMetadata.ResourceTypesScope[j]")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "NextToken": "string",
; "OrganizationConfigRules": [
; {
; "ExcludedAccounts": [
; "string"
; ],
; "LastUpdateTime": number,
; "OrganizationConfigRuleArn": "string",
; "OrganizationConfigRuleName": "string",
; "OrganizationCustomPolicyRuleMetadata": {
; "DebugLogDeliveryAccounts": [
; "string"
; ],
; "Description": "string",
; "InputParameters": "string",
; "MaximumExecutionFrequency": "string",
; "OrganizationConfigRuleTriggerTypes": [
; "string"
; ],
; "PolicyRuntime": "string",
; "ResourceIdScope": "string",
; "ResourceTypesScope": [
; "string"
; ],
; "TagKeyScope": "string",
; "TagValueScope": "string"
; },
; "OrganizationCustomRuleMetadata": {
; "Description": "string",
; "InputParameters": "string",
; "LambdaFunctionArn": "string",
; "MaximumExecutionFrequency": "string",
; "OrganizationConfigRuleTriggerTypes": [
; "string"
; ],
; "ResourceIdScope": "string",
; "ResourceTypesScope": [
; "string"
; ],
; "TagKeyScope": "string",
; "TagValueScope": "string"
; },
; "OrganizationManagedRuleMetadata": {
; "Description": "string",
; "InputParameters": "string",
; "MaximumExecutionFrequency": "string",
; "ResourceIdScope": "string",
; "ResourceTypesScope": [
; "string"
; ],
; "RuleIdentifier": "string",
; "TagKeyScope": "string",
; "TagValueScope": "string"
; }
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
