Chilkat Online Tools

UpdateLifecyclePolicy TCL Example

Amazon Data Lifecycle Manager

load ./chilkat.dll

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $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_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "dlm"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://dlm.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "dlm.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# 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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "Description" "string"
CkJsonObject_UpdateString $json "ExecutionRoleArn" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Actions[0].CrossRegionCopy[0].EncryptionConfiguration.CmkArn" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Actions[0].CrossRegionCopy[0].EncryptionConfiguration.Encrypted" 123
CkJsonObject_UpdateInt $json "PolicyDetails.Actions[0].CrossRegionCopy[0].RetainRule.Interval" 123
CkJsonObject_UpdateString $json "PolicyDetails.Actions[0].CrossRegionCopy[0].RetainRule.IntervalUnit" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Actions[0].CrossRegionCopy[0].Target" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Actions[0].Name" "string"
CkJsonObject_UpdateString $json "PolicyDetails.EventSource.Parameters.DescriptionRegex" "string"
CkJsonObject_UpdateString $json "PolicyDetails.EventSource.Parameters.EventType" "string"
CkJsonObject_UpdateString $json "PolicyDetails.EventSource.Parameters.SnapshotOwner[0]" "string"
CkJsonObject_UpdateString $json "PolicyDetails.EventSource.Type" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Parameters.ExcludeBootVolume" 123
CkJsonObject_UpdateInt $json "PolicyDetails.Parameters.NoReboot" 123
CkJsonObject_UpdateString $json "PolicyDetails.PolicyType" "string"
CkJsonObject_UpdateString $json "PolicyDetails.ResourceLocations[0]" "string"
CkJsonObject_UpdateString $json "PolicyDetails.ResourceTypes[0]" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].CopyTags" 123
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CreateRule.CronExpression" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].CreateRule.Interval" 123
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CreateRule.IntervalUnit" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CreateRule.Location" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CreateRule.Times[0]" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].CmkArn" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].CopyTags" 123
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].DeprecateRule.Interval" 123
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].DeprecateRule.IntervalUnit" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].Encrypted" 123
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].RetainRule.Interval" 123
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].RetainRule.IntervalUnit" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].Target" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].CrossRegionCopyRules[0].TargetRegion" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].DeprecateRule.Count" 123
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].DeprecateRule.Interval" 123
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].DeprecateRule.IntervalUnit" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].FastRestoreRule.AvailabilityZones[0]" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].FastRestoreRule.Count" 123
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].FastRestoreRule.Interval" 123
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].FastRestoreRule.IntervalUnit" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].Name" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].RetainRule.Count" 123
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].RetainRule.Interval" 123
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].RetainRule.IntervalUnit" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].ShareRules[0].TargetAccounts[0]" "string"
CkJsonObject_UpdateInt $json "PolicyDetails.Schedules[0].ShareRules[0].UnshareInterval" 123
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].ShareRules[0].UnshareIntervalUnit" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].TagsToAdd[0].Key" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].TagsToAdd[0].Value" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].VariableTags[0].Key" "string"
CkJsonObject_UpdateString $json "PolicyDetails.Schedules[0].VariableTags[0].Value" "string"
CkJsonObject_UpdateString $json "PolicyDetails.TargetTags[0].Key" "string"
CkJsonObject_UpdateString $json "PolicyDetails.TargetTags[0].Value" "string"
CkJsonObject_UpdateString $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_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "UpdateLifecyclePolicy"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "PATCH" "/policies/{policyId}" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $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:

# {}

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp