DescribeDeliveryChannelStatus 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,"DeliveryChannelNames[0]","string")
; The JSON request body created by the above code:
; {
; "DeliveryChannelNames": [
; "string"
; ]
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","StarlingDoveService.DescribeDeliveryChannelStatus")
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
LastAttemptTime.i
LastErrorCode.s
LastErrorMessage.s
LastStatus.s
LastSuccessfulTime.i
NextDeliveryTime.i
configSnapshotDeliveryInfoLastAttemptTime.i
configSnapshotDeliveryInfoLastErrorCode.s
configSnapshotDeliveryInfoLastErrorMessage.s
configSnapshotDeliveryInfoLastStatus.s
configSnapshotDeliveryInfoLastSuccessfulTime.i
configSnapshotDeliveryInfoNextDeliveryTime.i
configStreamDeliveryInfoLastErrorCode.s
configStreamDeliveryInfoLastErrorMessage.s
configStreamDeliveryInfoLastStatus.s
LastStatusChangeTime.i
name.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"DeliveryChannelsStatus")
While i < count_i
CkJsonObject::setCkI(jResp, i)
LastAttemptTime = CkJsonObject::ckIntOf(jResp,"DeliveryChannelsStatus[i].configHistoryDeliveryInfo.lastAttemptTime")
LastErrorCode = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configHistoryDeliveryInfo.lastErrorCode")
LastErrorMessage = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configHistoryDeliveryInfo.lastErrorMessage")
LastStatus = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configHistoryDeliveryInfo.lastStatus")
LastSuccessfulTime = CkJsonObject::ckIntOf(jResp,"DeliveryChannelsStatus[i].configHistoryDeliveryInfo.lastSuccessfulTime")
NextDeliveryTime = CkJsonObject::ckIntOf(jResp,"DeliveryChannelsStatus[i].configHistoryDeliveryInfo.nextDeliveryTime")
configSnapshotDeliveryInfoLastAttemptTime = CkJsonObject::ckIntOf(jResp,"DeliveryChannelsStatus[i].configSnapshotDeliveryInfo.lastAttemptTime")
configSnapshotDeliveryInfoLastErrorCode = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configSnapshotDeliveryInfo.lastErrorCode")
configSnapshotDeliveryInfoLastErrorMessage = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configSnapshotDeliveryInfo.lastErrorMessage")
configSnapshotDeliveryInfoLastStatus = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configSnapshotDeliveryInfo.lastStatus")
configSnapshotDeliveryInfoLastSuccessfulTime = CkJsonObject::ckIntOf(jResp,"DeliveryChannelsStatus[i].configSnapshotDeliveryInfo.lastSuccessfulTime")
configSnapshotDeliveryInfoNextDeliveryTime = CkJsonObject::ckIntOf(jResp,"DeliveryChannelsStatus[i].configSnapshotDeliveryInfo.nextDeliveryTime")
configStreamDeliveryInfoLastErrorCode = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configStreamDeliveryInfo.lastErrorCode")
configStreamDeliveryInfoLastErrorMessage = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configStreamDeliveryInfo.lastErrorMessage")
configStreamDeliveryInfoLastStatus = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].configStreamDeliveryInfo.lastStatus")
LastStatusChangeTime = CkJsonObject::ckIntOf(jResp,"DeliveryChannelsStatus[i].configStreamDeliveryInfo.lastStatusChangeTime")
name = CkJsonObject::ckStringOf(jResp,"DeliveryChannelsStatus[i].name")
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "DeliveryChannelsStatus": [
; {
; "configHistoryDeliveryInfo": {
; "lastAttemptTime": number,
; "lastErrorCode": "string",
; "lastErrorMessage": "string",
; "lastStatus": "string",
; "lastSuccessfulTime": number,
; "nextDeliveryTime": number
; },
; "configSnapshotDeliveryInfo": {
; "lastAttemptTime": number,
; "lastErrorCode": "string",
; "lastErrorMessage": "string",
; "lastStatus": "string",
; "lastSuccessfulTime": number,
; "nextDeliveryTime": number
; },
; "configStreamDeliveryInfo": {
; "lastErrorCode": "string",
; "lastErrorMessage": "string",
; "lastStatus": "string",
; "lastStatusChangeTime": number
; },
; "name": "string"
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
