GetLifecyclePolicy Ruby Example
require 'chilkat'
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
rest = Chilkat::CkRest.new()
authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("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.)
authAws.put_Region("us-west-2")
authAws.put_ServiceName("dlm")
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
rest.SetAuthAws(authAws)
# URL: https://dlm.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("dlm.us-west-2.amazonaws.com",443,true,true)
if (success != true)
print "ConnectFailReason: " + rest.get_ConnectFailReason().to_s() + "\n";
print rest.lastErrorText() + "\n";
exit
end
rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","GetLifecyclePolicy")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestNoBodySb("GET","/policies/{policyId}/",sbResponseBody)
if (success != true)
print rest.lastErrorText() + "\n";
exit
end
respStatusCode = rest.get_ResponseStatusCode()
print "response status code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 200)
print "Response Header:" + "\n";
print rest.responseHeader() + "\n";
print "Response Body:" + "\n";
print sbResponseBody.getAsString() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(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
DateCreated = jResp.IntOf("Policy.DateCreated")
DateModified = jResp.IntOf("Policy.DateModified")
Description = jResp.stringOf("Policy.Description")
ExecutionRoleArn = jResp.stringOf("Policy.ExecutionRoleArn")
PolicyArn = jResp.stringOf("Policy.PolicyArn")
DescriptionRegex = jResp.stringOf("Policy.PolicyDetails.EventSource.Parameters.DescriptionRegex")
EventType = jResp.stringOf("Policy.PolicyDetails.EventSource.Parameters.EventType")
v_Type = jResp.stringOf("Policy.PolicyDetails.EventSource.Type")
ExcludeBootVolume = jResp.IntOf("Policy.PolicyDetails.Parameters.ExcludeBootVolume")
NoReboot = jResp.IntOf("Policy.PolicyDetails.Parameters.NoReboot")
PolicyType = jResp.stringOf("Policy.PolicyDetails.PolicyType")
PolicyId = jResp.stringOf("Policy.PolicyId")
State = jResp.stringOf("Policy.State")
StatusMessage = jResp.stringOf("Policy.StatusMessage")
v_String = jResp.stringOf("Policy.Tags.string")
i = 0
count_i = jResp.SizeOfArray("Policy.PolicyDetails.Actions")
while i < count_i
jResp.put_I(i)
Name = jResp.stringOf("Policy.PolicyDetails.Actions[i].Name")
j = 0
count_j = jResp.SizeOfArray("Policy.PolicyDetails.Actions[i].CrossRegionCopy")
while j < count_j
jResp.put_J(j)
CmkArn = jResp.stringOf("Policy.PolicyDetails.Actions[i].CrossRegionCopy[j].EncryptionConfiguration.CmkArn")
Encrypted = jResp.IntOf("Policy.PolicyDetails.Actions[i].CrossRegionCopy[j].EncryptionConfiguration.Encrypted")
Interval = jResp.IntOf("Policy.PolicyDetails.Actions[i].CrossRegionCopy[j].RetainRule.Interval")
IntervalUnit = jResp.stringOf("Policy.PolicyDetails.Actions[i].CrossRegionCopy[j].RetainRule.IntervalUnit")
Target = jResp.stringOf("Policy.PolicyDetails.Actions[i].CrossRegionCopy[j].Target")
j = j + 1
end
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("Policy.PolicyDetails.EventSource.Parameters.SnapshotOwner")
while i < count_i
jResp.put_I(i)
strVal = jResp.stringOf("Policy.PolicyDetails.EventSource.Parameters.SnapshotOwner[i]")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("Policy.PolicyDetails.ResourceLocations")
while i < count_i
jResp.put_I(i)
strVal = jResp.stringOf("Policy.PolicyDetails.ResourceLocations[i]")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("Policy.PolicyDetails.ResourceTypes")
while i < count_i
jResp.put_I(i)
strVal = jResp.stringOf("Policy.PolicyDetails.ResourceTypes[i]")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("Policy.PolicyDetails.Schedules")
while i < count_i
jResp.put_I(i)
CopyTags = jResp.IntOf("Policy.PolicyDetails.Schedules[i].CopyTags")
CronExpression = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CreateRule.CronExpression")
CreateRuleInterval = jResp.IntOf("Policy.PolicyDetails.Schedules[i].CreateRule.Interval")
CreateRuleIntervalUnit = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CreateRule.IntervalUnit")
Location = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CreateRule.Location")
Count = jResp.IntOf("Policy.PolicyDetails.Schedules[i].DeprecateRule.Count")
DeprecateRuleInterval = jResp.IntOf("Policy.PolicyDetails.Schedules[i].DeprecateRule.Interval")
DeprecateRuleIntervalUnit = jResp.stringOf("Policy.PolicyDetails.Schedules[i].DeprecateRule.IntervalUnit")
FastRestoreRuleCount = jResp.IntOf("Policy.PolicyDetails.Schedules[i].FastRestoreRule.Count")
FastRestoreRuleInterval = jResp.IntOf("Policy.PolicyDetails.Schedules[i].FastRestoreRule.Interval")
FastRestoreRuleIntervalUnit = jResp.stringOf("Policy.PolicyDetails.Schedules[i].FastRestoreRule.IntervalUnit")
Name = jResp.stringOf("Policy.PolicyDetails.Schedules[i].Name")
RetainRuleCount = jResp.IntOf("Policy.PolicyDetails.Schedules[i].RetainRule.Count")
RetainRuleInterval = jResp.IntOf("Policy.PolicyDetails.Schedules[i].RetainRule.Interval")
RetainRuleIntervalUnit = jResp.stringOf("Policy.PolicyDetails.Schedules[i].RetainRule.IntervalUnit")
j = 0
count_j = jResp.SizeOfArray("Policy.PolicyDetails.Schedules[i].CreateRule.Times")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CreateRule.Times[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules")
while j < count_j
jResp.put_J(j)
CmkArn = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].CmkArn")
CopyTags = jResp.IntOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].CopyTags")
DeprecateRuleInterval = jResp.IntOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].DeprecateRule.Interval")
DeprecateRuleIntervalUnit = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].DeprecateRule.IntervalUnit")
Encrypted = jResp.IntOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].Encrypted")
RetainRuleInterval = jResp.IntOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].RetainRule.Interval")
RetainRuleIntervalUnit = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].RetainRule.IntervalUnit")
Target = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].Target")
TargetRegion = jResp.stringOf("Policy.PolicyDetails.Schedules[i].CrossRegionCopyRules[j].TargetRegion")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("Policy.PolicyDetails.Schedules[i].FastRestoreRule.AvailabilityZones")
while j < count_j
jResp.put_J(j)
strVal = jResp.stringOf("Policy.PolicyDetails.Schedules[i].FastRestoreRule.AvailabilityZones[j]")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("Policy.PolicyDetails.Schedules[i].ShareRules")
while j < count_j
jResp.put_J(j)
UnshareInterval = jResp.IntOf("Policy.PolicyDetails.Schedules[i].ShareRules[j].UnshareInterval")
UnshareIntervalUnit = jResp.stringOf("Policy.PolicyDetails.Schedules[i].ShareRules[j].UnshareIntervalUnit")
k = 0
count_k = jResp.SizeOfArray("Policy.PolicyDetails.Schedules[i].ShareRules[j].TargetAccounts")
while k < count_k
jResp.put_K(k)
strVal = jResp.stringOf("Policy.PolicyDetails.Schedules[i].ShareRules[j].TargetAccounts[k]")
k = k + 1
end
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("Policy.PolicyDetails.Schedules[i].TagsToAdd")
while j < count_j
jResp.put_J(j)
Key = jResp.stringOf("Policy.PolicyDetails.Schedules[i].TagsToAdd[j].Key")
Value = jResp.stringOf("Policy.PolicyDetails.Schedules[i].TagsToAdd[j].Value")
j = j + 1
end
j = 0
count_j = jResp.SizeOfArray("Policy.PolicyDetails.Schedules[i].VariableTags")
while j < count_j
jResp.put_J(j)
Key = jResp.stringOf("Policy.PolicyDetails.Schedules[i].VariableTags[j].Key")
Value = jResp.stringOf("Policy.PolicyDetails.Schedules[i].VariableTags[j].Value")
j = j + 1
end
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("Policy.PolicyDetails.TargetTags")
while i < count_i
jResp.put_I(i)
Key = jResp.stringOf("Policy.PolicyDetails.TargetTags[i].Key")
Value = jResp.stringOf("Policy.PolicyDetails.TargetTags[i].Value")
i = i + 1
end
# A sample JSON response body parsed by the above code:
# {
# "Policy": {
# "DateCreated": number,
# "DateModified": number,
# "Description": "string",
# "ExecutionRoleArn": "string",
# "PolicyArn": "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"
# }
# ]
# },
# "PolicyId": "string",
# "State": "string",
# "StatusMessage": "string",
# "Tags": {
# "string": "string"
# }
# }
# }
