Chilkat Online Tools

DescribeHostedConnections TCL Example

AWS Direct Connect

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

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

# The JSON request body created by the above code:

# {
#   "connectionId": "string"
# }

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

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 "connections"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set awsDevice [CkJsonObject_stringOf $jResp "connections[i].awsDevice"]
    set awsDeviceV2 [CkJsonObject_stringOf $jResp "connections[i].awsDeviceV2"]
    set awsLogicalDeviceId [CkJsonObject_stringOf $jResp "connections[i].awsLogicalDeviceId"]
    set bandwidth [CkJsonObject_stringOf $jResp "connections[i].bandwidth"]
    set connectionId [CkJsonObject_stringOf $jResp "connections[i].connectionId"]
    set connectionName [CkJsonObject_stringOf $jResp "connections[i].connectionName"]
    set connectionState [CkJsonObject_stringOf $jResp "connections[i].connectionState"]
    set encryptionMode [CkJsonObject_stringOf $jResp "connections[i].encryptionMode"]
    set hasLogicalRedundancy [CkJsonObject_stringOf $jResp "connections[i].hasLogicalRedundancy"]
    set jumboFrameCapable [CkJsonObject_IntOf $jResp "connections[i].jumboFrameCapable"]
    set lagId [CkJsonObject_stringOf $jResp "connections[i].lagId"]
    set loaIssueTime [CkJsonObject_IntOf $jResp "connections[i].loaIssueTime"]
    set location [CkJsonObject_stringOf $jResp "connections[i].location"]
    set macSecCapable [CkJsonObject_IntOf $jResp "connections[i].macSecCapable"]
    set ownerAccount [CkJsonObject_stringOf $jResp "connections[i].ownerAccount"]
    set partnerName [CkJsonObject_stringOf $jResp "connections[i].partnerName"]
    set portEncryptionStatus [CkJsonObject_stringOf $jResp "connections[i].portEncryptionStatus"]
    set providerName [CkJsonObject_stringOf $jResp "connections[i].providerName"]
    set region [CkJsonObject_stringOf $jResp "connections[i].region"]
    set vlan [CkJsonObject_IntOf $jResp "connections[i].vlan"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "connections[i].macSecKeys"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set ckn [CkJsonObject_stringOf $jResp "connections[i].macSecKeys[j].ckn"]
        set secretARN [CkJsonObject_stringOf $jResp "connections[i].macSecKeys[j].secretARN"]
        set startOn [CkJsonObject_stringOf $jResp "connections[i].macSecKeys[j].startOn"]
        set state [CkJsonObject_stringOf $jResp "connections[i].macSecKeys[j].state"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "connections[i].tags"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set key [CkJsonObject_stringOf $jResp "connections[i].tags[j].key"]
        set value [CkJsonObject_stringOf $jResp "connections[i].tags[j].value"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

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

# {
#   "connections": [
#     {
#       "awsDevice": "string",
#       "awsDeviceV2": "string",
#       "awsLogicalDeviceId": "string",
#       "bandwidth": "string",
#       "connectionId": "string",
#       "connectionName": "string",
#       "connectionState": "string",
#       "encryptionMode": "string",
#       "hasLogicalRedundancy": "string",
#       "jumboFrameCapable": boolean,
#       "lagId": "string",
#       "loaIssueTime": number,
#       "location": "string",
#       "macSecCapable": boolean,
#       "macSecKeys": [
#         {
#           "ckn": "string",
#           "secretARN": "string",
#           "startOn": "string",
#           "state": "string"
#         }
#       ],
#       "ownerAccount": "string",
#       "partnerName": "string",
#       "portEncryptionStatus": "string",
#       "providerName": "string",
#       "region": "string",
#       "tags": [
#         {
#           "key": "string",
#           "value": "string"
#         }
#       ],
#       "vlan": number
#     }
#   ]
# }

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