DescribeLags Powershell Example
Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$rest = New-Object Chilkat.Rest
$authAws = New-Object Chilkat.AuthAws
$authAws.AccessKey = "AWS_ACCESS_KEY"
$authAws.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.Region = "us-west-2"
$authAws.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 -ne $true) {
$("ConnectFailReason: " + $rest.ConnectFailReason)
$($rest.LastErrorText)
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
$json = New-Object Chilkat.JsonObject
$json.UpdateString("lagId","string")
# The JSON request body created by the above code:
# {
# "lagId": "string"
# }
$rest.AddHeader("Content-Type","application/x-amz-json-1.1")
$rest.AddHeader("X-Amz-Target","OvertureService.DescribeLags")
$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
$($rest.LastErrorText)
exit
}
$respStatusCode = $rest.ResponseStatusCode
$("response status code = " + $respStatusCode)
if ($respStatusCode -ne 200) {
$("Response Header:")
$($rest.ResponseHeader)
$("Response Body:")
$($sbResponseBody.GetAsString())
exit
}
$jResp = New-Object Chilkat.JsonObject
$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("lags")
while ($i -lt $count_i) {
$jResp.I = $i
$allowsHostedConnections = $jResp.IntOf("lags[i].allowsHostedConnections")
$awsDevice = $jResp.StringOf("lags[i].awsDevice")
$awsDeviceV2 = $jResp.StringOf("lags[i].awsDeviceV2")
$awsLogicalDeviceId = $jResp.StringOf("lags[i].awsLogicalDeviceId")
$connectionsBandwidth = $jResp.StringOf("lags[i].connectionsBandwidth")
$encryptionMode = $jResp.StringOf("lags[i].encryptionMode")
$hasLogicalRedundancy = $jResp.StringOf("lags[i].hasLogicalRedundancy")
$jumboFrameCapable = $jResp.IntOf("lags[i].jumboFrameCapable")
$lagId = $jResp.StringOf("lags[i].lagId")
$lagName = $jResp.StringOf("lags[i].lagName")
$lagState = $jResp.StringOf("lags[i].lagState")
$location = $jResp.StringOf("lags[i].location")
$macSecCapable = $jResp.IntOf("lags[i].macSecCapable")
$minimumLinks = $jResp.IntOf("lags[i].minimumLinks")
$numberOfConnections = $jResp.IntOf("lags[i].numberOfConnections")
$ownerAccount = $jResp.StringOf("lags[i].ownerAccount")
$providerName = $jResp.StringOf("lags[i].providerName")
$region = $jResp.StringOf("lags[i].region")
$j = 0
$count_j = $jResp.SizeOfArray("lags[i].connections")
while ($j -lt $count_j) {
$jResp.J = $j
$awsDevice = $jResp.StringOf("lags[i].connections[j].awsDevice")
$awsDeviceV2 = $jResp.StringOf("lags[i].connections[j].awsDeviceV2")
$awsLogicalDeviceId = $jResp.StringOf("lags[i].connections[j].awsLogicalDeviceId")
$bandwidth = $jResp.StringOf("lags[i].connections[j].bandwidth")
$connectionId = $jResp.StringOf("lags[i].connections[j].connectionId")
$connectionName = $jResp.StringOf("lags[i].connections[j].connectionName")
$connectionState = $jResp.StringOf("lags[i].connections[j].connectionState")
$encryptionMode = $jResp.StringOf("lags[i].connections[j].encryptionMode")
$hasLogicalRedundancy = $jResp.StringOf("lags[i].connections[j].hasLogicalRedundancy")
$jumboFrameCapable = $jResp.IntOf("lags[i].connections[j].jumboFrameCapable")
$lagId = $jResp.StringOf("lags[i].connections[j].lagId")
$loaIssueTime = $jResp.IntOf("lags[i].connections[j].loaIssueTime")
$location = $jResp.StringOf("lags[i].connections[j].location")
$macSecCapable = $jResp.IntOf("lags[i].connections[j].macSecCapable")
$ownerAccount = $jResp.StringOf("lags[i].connections[j].ownerAccount")
$partnerName = $jResp.StringOf("lags[i].connections[j].partnerName")
$portEncryptionStatus = $jResp.StringOf("lags[i].connections[j].portEncryptionStatus")
$providerName = $jResp.StringOf("lags[i].connections[j].providerName")
$region = $jResp.StringOf("lags[i].connections[j].region")
$vlan = $jResp.IntOf("lags[i].connections[j].vlan")
$k = 0
$count_k = $jResp.SizeOfArray("lags[i].connections[j].macSecKeys")
while ($k -lt $count_k) {
$jResp.K = $k
$ckn = $jResp.StringOf("lags[i].connections[j].macSecKeys[k].ckn")
$secretARN = $jResp.StringOf("lags[i].connections[j].macSecKeys[k].secretARN")
$startOn = $jResp.StringOf("lags[i].connections[j].macSecKeys[k].startOn")
$state = $jResp.StringOf("lags[i].connections[j].macSecKeys[k].state")
$k = $k + 1
}
$k = 0
$count_k = $jResp.SizeOfArray("lags[i].connections[j].tags")
while ($k -lt $count_k) {
$jResp.K = $k
$key = $jResp.StringOf("lags[i].connections[j].tags[k].key")
$value = $jResp.StringOf("lags[i].connections[j].tags[k].value")
$k = $k + 1
}
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("lags[i].macSecKeys")
while ($j -lt $count_j) {
$jResp.J = $j
$ckn = $jResp.StringOf("lags[i].macSecKeys[j].ckn")
$secretARN = $jResp.StringOf("lags[i].macSecKeys[j].secretARN")
$startOn = $jResp.StringOf("lags[i].macSecKeys[j].startOn")
$state = $jResp.StringOf("lags[i].macSecKeys[j].state")
$j = $j + 1
}
$j = 0
$count_j = $jResp.SizeOfArray("lags[i].tags")
while ($j -lt $count_j) {
$jResp.J = $j
$key = $jResp.StringOf("lags[i].tags[j].key")
$value = $jResp.StringOf("lags[i].tags[j].value")
$j = $j + 1
}
$i = $i + 1
}
# A sample JSON response body parsed by the above code:
# {
# "lags": [
# {
# "allowsHostedConnections": boolean,
# "awsDevice": "string",
# "awsDeviceV2": "string",
# "awsLogicalDeviceId": "string",
# "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
# }
# ],
# "connectionsBandwidth": "string",
# "encryptionMode": "string",
# "hasLogicalRedundancy": "string",
# "jumboFrameCapable": boolean,
# "lagId": "string",
# "lagName": "string",
# "lagState": "string",
# "location": "string",
# "macSecCapable": boolean,
# "macSecKeys": [
# {
# "ckn": "string",
# "secretARN": "string",
# "startOn": "string",
# "state": "string"
# }
# ],
# "minimumLinks": number,
# "numberOfConnections": number,
# "ownerAccount": "string",
# "providerName": "string",
# "region": "string",
# "tags": [
# {
# "key": "string",
# "value": "string"
# }
# ]
# }
# ]
# }
