Chilkat Online Tools

DescribePipelines TCL Example

AWS Data Pipeline

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

# URL: https://datapipeline.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "datapipeline.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 "pipelineIds[0]" "string"

# The JSON request body created by the above code:

# {
#   "pipelineIds": [
#     "string"
#   ]
# }

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

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 i 0
set count_i [CkJsonObject_SizeOfArray $jResp "pipelineDescriptionList"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set description [CkJsonObject_stringOf $jResp "pipelineDescriptionList[i].description"]
    set name [CkJsonObject_stringOf $jResp "pipelineDescriptionList[i].name"]
    set pipelineId [CkJsonObject_stringOf $jResp "pipelineDescriptionList[i].pipelineId"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "pipelineDescriptionList[i].fields"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set key [CkJsonObject_stringOf $jResp "pipelineDescriptionList[i].fields[j].key"]
        set refValue [CkJsonObject_stringOf $jResp "pipelineDescriptionList[i].fields[j].refValue"]
        set stringValue [CkJsonObject_stringOf $jResp "pipelineDescriptionList[i].fields[j].stringValue"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "pipelineDescriptionList[i].tags"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set key [CkJsonObject_stringOf $jResp "pipelineDescriptionList[i].tags[j].key"]
        set value [CkJsonObject_stringOf $jResp "pipelineDescriptionList[i].tags[j].value"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

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

# {
#   "pipelineDescriptionList": [
#     {
#       "description": "string",
#       "fields": [
#         {
#           "key": "string",
#           "refValue": "string",
#           "stringValue": "string"
#         }
#       ],
#       "name": "string",
#       "pipelineId": "string",
#       "tags": [
#         {
#           "key": "string",
#           "value": "string"
#         }
#       ]
#     }
#   ]
# }

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