Chilkat Online Tools

UpdateLifecyclePolicy Ruby Example

Amazon Data Lifecycle Manager

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

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("Description","string")
json.UpdateString("ExecutionRoleArn","string")
json.UpdateString("PolicyDetails.Actions[0].CrossRegionCopy[0].EncryptionConfiguration.CmkArn","string")
json.UpdateInt("PolicyDetails.Actions[0].CrossRegionCopy[0].EncryptionConfiguration.Encrypted",123)
json.UpdateInt("PolicyDetails.Actions[0].CrossRegionCopy[0].RetainRule.Interval",123)
json.UpdateString("PolicyDetails.Actions[0].CrossRegionCopy[0].RetainRule.IntervalUnit","string")
json.UpdateString("PolicyDetails.Actions[0].CrossRegionCopy[0].Target","string")
json.UpdateString("PolicyDetails.Actions[0].Name","string")
json.UpdateString("PolicyDetails.EventSource.Parameters.DescriptionRegex","string")
json.UpdateString("PolicyDetails.EventSource.Parameters.EventType","string")
json.UpdateString("PolicyDetails.EventSource.Parameters.SnapshotOwner[0]","string")
json.UpdateString("PolicyDetails.EventSource.Type","string")
json.UpdateInt("PolicyDetails.Parameters.ExcludeBootVolume",123)
json.UpdateInt("PolicyDetails.Parameters.NoReboot",123)
json.UpdateString("PolicyDetails.PolicyType","string")
json.UpdateString("PolicyDetails.ResourceLocations[0]","string")
json.UpdateString("PolicyDetails.ResourceTypes[0]","string")
json.UpdateInt("PolicyDetails.Schedules[0].CopyTags",123)
json.UpdateString("PolicyDetails.Schedules[0].CreateRule.CronExpression","string")
json.UpdateInt("PolicyDetails.Schedules[0].CreateRule.Interval",123)
json.UpdateString("PolicyDetails.Schedules[0].CreateRule.IntervalUnit","string")
json.UpdateString("PolicyDetails.Schedules[0].CreateRule.Location","string")
json.UpdateString("PolicyDetails.Schedules[0].CreateRule.Times[0]","string")
json.UpdateString("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].CmkArn","string")
json.UpdateInt("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].CopyTags",123)
json.UpdateInt("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].DeprecateRule.Interval",123)
json.UpdateString("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].DeprecateRule.IntervalUnit","string")
json.UpdateInt("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].Encrypted",123)
json.UpdateInt("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].RetainRule.Interval",123)
json.UpdateString("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].RetainRule.IntervalUnit","string")
json.UpdateString("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].Target","string")
json.UpdateString("PolicyDetails.Schedules[0].CrossRegionCopyRules[0].TargetRegion","string")
json.UpdateInt("PolicyDetails.Schedules[0].DeprecateRule.Count",123)
json.UpdateInt("PolicyDetails.Schedules[0].DeprecateRule.Interval",123)
json.UpdateString("PolicyDetails.Schedules[0].DeprecateRule.IntervalUnit","string")
json.UpdateString("PolicyDetails.Schedules[0].FastRestoreRule.AvailabilityZones[0]","string")
json.UpdateInt("PolicyDetails.Schedules[0].FastRestoreRule.Count",123)
json.UpdateInt("PolicyDetails.Schedules[0].FastRestoreRule.Interval",123)
json.UpdateString("PolicyDetails.Schedules[0].FastRestoreRule.IntervalUnit","string")
json.UpdateString("PolicyDetails.Schedules[0].Name","string")
json.UpdateInt("PolicyDetails.Schedules[0].RetainRule.Count",123)
json.UpdateInt("PolicyDetails.Schedules[0].RetainRule.Interval",123)
json.UpdateString("PolicyDetails.Schedules[0].RetainRule.IntervalUnit","string")
json.UpdateString("PolicyDetails.Schedules[0].ShareRules[0].TargetAccounts[0]","string")
json.UpdateInt("PolicyDetails.Schedules[0].ShareRules[0].UnshareInterval",123)
json.UpdateString("PolicyDetails.Schedules[0].ShareRules[0].UnshareIntervalUnit","string")
json.UpdateString("PolicyDetails.Schedules[0].TagsToAdd[0].Key","string")
json.UpdateString("PolicyDetails.Schedules[0].TagsToAdd[0].Value","string")
json.UpdateString("PolicyDetails.Schedules[0].VariableTags[0].Key","string")
json.UpdateString("PolicyDetails.Schedules[0].VariableTags[0].Value","string")
json.UpdateString("PolicyDetails.TargetTags[0].Key","string")
json.UpdateString("PolicyDetails.TargetTags[0].Value","string")
json.UpdateString("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"
# }

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","UpdateLifecyclePolicy")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)
sbResponseBody = Chilkat::CkStringBuilder.new()
success = rest.FullRequestSb("PATCH","/policies/{policyId}",sbRequestBody,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

# A sample JSON response body parsed by the above code:

# {}