UpdateLifecyclePolicy 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, "dlm")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://dlm.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"dlm.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,"Description","string")
CkJsonObject::ckUpdateString(json,"ExecutionRoleArn","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Actions[0].CrossRegionCopy[0].EncryptionConfiguration.CmkArn","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Actions[0].CrossRegionCopy[0].EncryptionConfiguration.Encrypted",123)
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Actions[0].CrossRegionCopy[0].RetainRule.Interval",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Actions[0].CrossRegionCopy[0].RetainRule.IntervalUnit","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Actions[0].CrossRegionCopy[0].Target","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Actions[0].Name","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.EventSource.Parameters.DescriptionRegex","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.EventSource.Parameters.EventType","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.EventSource.Parameters.SnapshotOwner[0]","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.EventSource.Type","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Parameters.ExcludeBootVolume",123)
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Parameters.NoReboot",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.PolicyType","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.ResourceLocations[0]","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.ResourceTypes[0]","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].CopyTags",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CreateRule.CronExpression","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].CreateRule.Interval",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CreateRule.IntervalUnit","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CreateRule.Location","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CreateRule.Times[0]","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].CmkArn","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].CopyTags",123)
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].DeprecateRule.Interval",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].DeprecateRule.IntervalUnit","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].Encrypted",123)
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].RetainRule.Interval",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].RetainRule.IntervalUnit","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].Target","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].CrossRegionCopyRules[0].TargetRegion","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].DeprecateRule.Count",123)
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].DeprecateRule.Interval",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].DeprecateRule.IntervalUnit","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].FastRestoreRule.AvailabilityZones[0]","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].FastRestoreRule.Count",123)
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].FastRestoreRule.Interval",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].FastRestoreRule.IntervalUnit","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].Name","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].RetainRule.Count",123)
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].RetainRule.Interval",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].RetainRule.IntervalUnit","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].ShareRules[0].TargetAccounts[0]","string")
CkJsonObject::ckUpdateInt(json,"PolicyDetails.Schedules[0].ShareRules[0].UnshareInterval",123)
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].ShareRules[0].UnshareIntervalUnit","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].TagsToAdd[0].Key","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].TagsToAdd[0].Value","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].VariableTags[0].Key","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.Schedules[0].VariableTags[0].Value","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.TargetTags[0].Key","string")
CkJsonObject::ckUpdateString(json,"PolicyDetails.TargetTags[0].Value","string")
CkJsonObject::ckUpdateString(json,"State","string")
; The JSON request body created by the above code:
; {
; "Description": "string",
; "ExecutionRoleArn": "string",
; "PolicyDetails": {
; "Actions": [
; {
; "CrossRegionCopy": [
; {
; "EncryptionConfiguration": {
; "CmkArn": "string",
; "Encrypted": boolean
; },
; "RetainRule": {
; "Interval": number,
; "IntervalUnit": "string"
; },
; "Target": "string"
; }
; ],
; "Name": "string"
; }
; ],
; "EventSource": {
; "Parameters": {
; "DescriptionRegex": "string",
; "EventType": "string",
; "SnapshotOwner": [
; "string"
; ]
; },
; "Type": "string"
; },
; "Parameters": {
; "ExcludeBootVolume": boolean,
; "NoReboot": boolean
; },
; "PolicyType": "string",
; "ResourceLocations": [
; "string"
; ],
; "ResourceTypes": [
; "string"
; ],
; "Schedules": [
; {
; "CopyTags": boolean,
; "CreateRule": {
; "CronExpression": "string",
; "Interval": number,
; "IntervalUnit": "string",
; "Location": "string",
; "Times": [
; "string"
; ]
; },
; "CrossRegionCopyRules": [
; {
; "CmkArn": "string",
; "CopyTags": boolean,
; "DeprecateRule": {
; "Interval": number,
; "IntervalUnit": "string"
; },
; "Encrypted": boolean,
; "RetainRule": {
; "Interval": number,
; "IntervalUnit": "string"
; },
; "Target": "string",
; "TargetRegion": "string"
; }
; ],
; "DeprecateRule": {
; "Count": number,
; "Interval": number,
; "IntervalUnit": "string"
; },
; "FastRestoreRule": {
; "AvailabilityZones": [
; "string"
; ],
; "Count": number,
; "Interval": number,
; "IntervalUnit": "string"
; },
; "Name": "string",
; "RetainRule": {
; "Count": number,
; "Interval": number,
; "IntervalUnit": "string"
; },
; "ShareRules": [
; {
; "TargetAccounts": [
; "string"
; ],
; "UnshareInterval": number,
; "UnshareIntervalUnit": "string"
; }
; ],
; "TagsToAdd": [
; {
; "Key": "string",
; "Value": "string"
; }
; ],
; "VariableTags": [
; {
; "Key": "string",
; "Value": "string"
; }
; ]
; }
; ],
; "TargetTags": [
; {
; "Key": "string",
; "Value": "string"
; }
; ]
; },
; "State": "string"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","UpdateLifecyclePolicy")
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,"PATCH","/policies/{policyId}",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
; A sample JSON response body parsed by the above code:
; {}
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
