Chilkat Online Tools

DescribeReplicationTasks TCL Example

AWS Database Migration Service

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 "dms"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://dms.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "dms.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 "Filters[0].Name" "string"
CkJsonObject_UpdateString $json "Filters[0].Values[0]" "string"
CkJsonObject_UpdateString $json "Marker" "string"
CkJsonObject_UpdateInt $json "MaxRecords" 123
CkJsonObject_UpdateInt $json "WithoutSettings" 123

# The JSON request body created by the above code:

# {
#   "Filters": [
#     {
#       "Name": "string",
#       "Values": [
#         "string"
#       ]
#     }
#   ],
#   "Marker": "string",
#   "MaxRecords": number,
#   "WithoutSettings": boolean
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "AmazonDMSv20160101.DescribeReplicationTasks"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/" $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

set Marker [CkJsonObject_stringOf $jResp "Marker"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "ReplicationTasks"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set CdcStartPosition [CkJsonObject_stringOf $jResp "ReplicationTasks[i].CdcStartPosition"]
    set CdcStopPosition [CkJsonObject_stringOf $jResp "ReplicationTasks[i].CdcStopPosition"]
    set LastFailureMessage [CkJsonObject_stringOf $jResp "ReplicationTasks[i].LastFailureMessage"]
    set MigrationType [CkJsonObject_stringOf $jResp "ReplicationTasks[i].MigrationType"]
    set RecoveryCheckpoint [CkJsonObject_stringOf $jResp "ReplicationTasks[i].RecoveryCheckpoint"]
    set ReplicationInstanceArn [CkJsonObject_stringOf $jResp "ReplicationTasks[i].ReplicationInstanceArn"]
    set ReplicationTaskArn [CkJsonObject_stringOf $jResp "ReplicationTasks[i].ReplicationTaskArn"]
    set ReplicationTaskCreationDate [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskCreationDate"]
    set ReplicationTaskIdentifier [CkJsonObject_stringOf $jResp "ReplicationTasks[i].ReplicationTaskIdentifier"]
    set ReplicationTaskSettings [CkJsonObject_stringOf $jResp "ReplicationTasks[i].ReplicationTaskSettings"]
    set ReplicationTaskStartDate [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStartDate"]
    set ElapsedTimeMillis [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.ElapsedTimeMillis"]
    set FreshStartDate [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.FreshStartDate"]
    set FullLoadFinishDate [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.FullLoadFinishDate"]
    set FullLoadProgressPercent [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.FullLoadProgressPercent"]
    set FullLoadStartDate [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.FullLoadStartDate"]
    set StartDate [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.StartDate"]
    set StopDate [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.StopDate"]
    set TablesErrored [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.TablesErrored"]
    set TablesLoaded [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.TablesLoaded"]
    set TablesLoading [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.TablesLoading"]
    set TablesQueued [CkJsonObject_IntOf $jResp "ReplicationTasks[i].ReplicationTaskStats.TablesQueued"]
    set SourceEndpointArn [CkJsonObject_stringOf $jResp "ReplicationTasks[i].SourceEndpointArn"]
    set Status [CkJsonObject_stringOf $jResp "ReplicationTasks[i].Status"]
    set StopReason [CkJsonObject_stringOf $jResp "ReplicationTasks[i].StopReason"]
    set TableMappings [CkJsonObject_stringOf $jResp "ReplicationTasks[i].TableMappings"]
    set TargetEndpointArn [CkJsonObject_stringOf $jResp "ReplicationTasks[i].TargetEndpointArn"]
    set TargetReplicationInstanceArn [CkJsonObject_stringOf $jResp "ReplicationTasks[i].TargetReplicationInstanceArn"]
    set TaskData [CkJsonObject_stringOf $jResp "ReplicationTasks[i].TaskData"]
    set i [expr $i + 1]
}

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

# {
#   "Marker": "string",
#   "ReplicationTasks": [
#     {
#       "CdcStartPosition": "string",
#       "CdcStopPosition": "string",
#       "LastFailureMessage": "string",
#       "MigrationType": "string",
#       "RecoveryCheckpoint": "string",
#       "ReplicationInstanceArn": "string",
#       "ReplicationTaskArn": "string",
#       "ReplicationTaskCreationDate": number,
#       "ReplicationTaskIdentifier": "string",
#       "ReplicationTaskSettings": "string",
#       "ReplicationTaskStartDate": number,
#       "ReplicationTaskStats": {
#         "ElapsedTimeMillis": number,
#         "FreshStartDate": number,
#         "FullLoadFinishDate": number,
#         "FullLoadProgressPercent": number,
#         "FullLoadStartDate": number,
#         "StartDate": number,
#         "StopDate": number,
#         "TablesErrored": number,
#         "TablesLoaded": number,
#         "TablesLoading": number,
#         "TablesQueued": number
#       },
#       "SourceEndpointArn": "string",
#       "Status": "string",
#       "StopReason": "string",
#       "TableMappings": "string",
#       "TargetEndpointArn": "string",
#       "TargetReplicationInstanceArn": "string",
#       "TaskData": "string"
#     }
#   ]
# }

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