DescribeBackups 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, "opsworks-cm")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://opsworks-cm.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"opsworks-cm.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,"BackupId","string")
CkJsonObject::ckUpdateInt(json,"MaxResults",123)
CkJsonObject::ckUpdateString(json,"NextToken","string")
CkJsonObject::ckUpdateString(json,"ServerName","string")
; The JSON request body created by the above code:
; {
; "BackupId": "string",
; "MaxResults": number,
; "NextToken": "string",
; "ServerName": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","OpsWorksCM_V2016_11_01.DescribeBackups")
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
BackupArn.s
BackupId.s
BackupType.s
CreatedAt.i
Description.s
Engine.s
EngineModel.s
EngineVersion.s
InstanceProfileArn.s
InstanceType.s
KeyPair.s
PreferredBackupWindow.s
PreferredMaintenanceWindow.s
S3DataSize.i
S3DataUrl.s
S3LogUrl.s
ServerName.s
ServiceRoleArn.s
Status.s
StatusDescription.s
ToolsVersion.s
UserArn.s
j.i
count_j.i
strVal.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"Backups")
While i < count_i
CkJsonObject::setCkI(jResp, i)
BackupArn = CkJsonObject::ckStringOf(jResp,"Backups[i].BackupArn")
BackupId = CkJsonObject::ckStringOf(jResp,"Backups[i].BackupId")
BackupType = CkJsonObject::ckStringOf(jResp,"Backups[i].BackupType")
CreatedAt = CkJsonObject::ckIntOf(jResp,"Backups[i].CreatedAt")
Description = CkJsonObject::ckStringOf(jResp,"Backups[i].Description")
Engine = CkJsonObject::ckStringOf(jResp,"Backups[i].Engine")
EngineModel = CkJsonObject::ckStringOf(jResp,"Backups[i].EngineModel")
EngineVersion = CkJsonObject::ckStringOf(jResp,"Backups[i].EngineVersion")
InstanceProfileArn = CkJsonObject::ckStringOf(jResp,"Backups[i].InstanceProfileArn")
InstanceType = CkJsonObject::ckStringOf(jResp,"Backups[i].InstanceType")
KeyPair = CkJsonObject::ckStringOf(jResp,"Backups[i].KeyPair")
PreferredBackupWindow = CkJsonObject::ckStringOf(jResp,"Backups[i].PreferredBackupWindow")
PreferredMaintenanceWindow = CkJsonObject::ckStringOf(jResp,"Backups[i].PreferredMaintenanceWindow")
S3DataSize = CkJsonObject::ckIntOf(jResp,"Backups[i].S3DataSize")
S3DataUrl = CkJsonObject::ckStringOf(jResp,"Backups[i].S3DataUrl")
S3LogUrl = CkJsonObject::ckStringOf(jResp,"Backups[i].S3LogUrl")
ServerName = CkJsonObject::ckStringOf(jResp,"Backups[i].ServerName")
ServiceRoleArn = CkJsonObject::ckStringOf(jResp,"Backups[i].ServiceRoleArn")
Status = CkJsonObject::ckStringOf(jResp,"Backups[i].Status")
StatusDescription = CkJsonObject::ckStringOf(jResp,"Backups[i].StatusDescription")
ToolsVersion = CkJsonObject::ckStringOf(jResp,"Backups[i].ToolsVersion")
UserArn = CkJsonObject::ckStringOf(jResp,"Backups[i].UserArn")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"Backups[i].SecurityGroupIds")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"Backups[i].SecurityGroupIds[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"Backups[i].SubnetIds")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"Backups[i].SubnetIds[j]")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "Backups": [
; {
; "BackupArn": "string",
; "BackupId": "string",
; "BackupType": "string",
; "CreatedAt": number,
; "Description": "string",
; "Engine": "string",
; "EngineModel": "string",
; "EngineVersion": "string",
; "InstanceProfileArn": "string",
; "InstanceType": "string",
; "KeyPair": "string",
; "PreferredBackupWindow": "string",
; "PreferredMaintenanceWindow": "string",
; "S3DataSize": number,
; "S3DataUrl": "string",
; "S3LogUrl": "string",
; "SecurityGroupIds": [
; "string"
; ],
; "ServerName": "string",
; "ServiceRoleArn": "string",
; "Status": "string",
; "StatusDescription": "string",
; "SubnetIds": [
; "string"
; ],
; "ToolsVersion": "string",
; "UserArn": "string"
; }
; ],
; "NextToken": "string"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
