Chilkat Online Tools

DescribeConnections Ruby Example

AWS Direct Connect

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

# URL: https://directconnect.us-west-2.amazonaws.com/
# Use the same region as specified above.
success = rest.Connect("directconnect.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("connectionId","string")

# The JSON request body created by the above code:

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

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

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

i = 0
count_i = jResp.SizeOfArray("connections")
while i < count_i
    jResp.put_I(i)
    awsDevice = jResp.stringOf("connections[i].awsDevice")
    awsDeviceV2 = jResp.stringOf("connections[i].awsDeviceV2")
    awsLogicalDeviceId = jResp.stringOf("connections[i].awsLogicalDeviceId")
    bandwidth = jResp.stringOf("connections[i].bandwidth")
    connectionId = jResp.stringOf("connections[i].connectionId")
    connectionName = jResp.stringOf("connections[i].connectionName")
    connectionState = jResp.stringOf("connections[i].connectionState")
    encryptionMode = jResp.stringOf("connections[i].encryptionMode")
    hasLogicalRedundancy = jResp.stringOf("connections[i].hasLogicalRedundancy")
    jumboFrameCapable = jResp.IntOf("connections[i].jumboFrameCapable")
    lagId = jResp.stringOf("connections[i].lagId")
    loaIssueTime = jResp.IntOf("connections[i].loaIssueTime")
    location = jResp.stringOf("connections[i].location")
    macSecCapable = jResp.IntOf("connections[i].macSecCapable")
    ownerAccount = jResp.stringOf("connections[i].ownerAccount")
    partnerName = jResp.stringOf("connections[i].partnerName")
    portEncryptionStatus = jResp.stringOf("connections[i].portEncryptionStatus")
    providerName = jResp.stringOf("connections[i].providerName")
    region = jResp.stringOf("connections[i].region")
    vlan = jResp.IntOf("connections[i].vlan")
    j = 0
    count_j = jResp.SizeOfArray("connections[i].macSecKeys")
    while j < count_j
        jResp.put_J(j)
        ckn = jResp.stringOf("connections[i].macSecKeys[j].ckn")
        secretARN = jResp.stringOf("connections[i].macSecKeys[j].secretARN")
        startOn = jResp.stringOf("connections[i].macSecKeys[j].startOn")
        state = jResp.stringOf("connections[i].macSecKeys[j].state")
        j = j + 1
    end
    j = 0
    count_j = jResp.SizeOfArray("connections[i].tags")
    while j < count_j
        jResp.put_J(j)
        key = jResp.stringOf("connections[i].tags[j].key")
        value = jResp.stringOf("connections[i].tags[j].value")
        j = j + 1
    end
    i = i + 1
end

# 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
#     }
#   ]
# }