Chilkat Online Tools

DescribeBackups Powershell Example

AWS OpsWorks CM

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

# URL: https://opsworks-cm.us-west-2.amazonaws.com/
# Use the same region as specified above.
$success = $rest.Connect("opsworks-cm.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("BackupId","string")
$json.UpdateInt("MaxResults",123)
$json.UpdateString("NextToken","string")
$json.UpdateString("ServerName","string")

# The JSON request body created by the above code:

# {
#   "BackupId": "string",
#   "MaxResults": number,
#   "NextToken": "string",
#   "ServerName": "string"
# }

$rest.AddHeader("Content-Type","application/x-amz-json-1.1")
$rest.AddHeader("X-Amz-Target","OpsWorksCM_V2016_11_01.DescribeBackups")

$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

$NextToken = $jResp.StringOf("NextToken")
$i = 0
$count_i = $jResp.SizeOfArray("Backups")
while ($i -lt $count_i) {
    $jResp.I = $i
    $BackupArn = $jResp.StringOf("Backups[i].BackupArn")
    $BackupId = $jResp.StringOf("Backups[i].BackupId")
    $BackupType = $jResp.StringOf("Backups[i].BackupType")
    $CreatedAt = $jResp.IntOf("Backups[i].CreatedAt")
    $Description = $jResp.StringOf("Backups[i].Description")
    $Engine = $jResp.StringOf("Backups[i].Engine")
    $EngineModel = $jResp.StringOf("Backups[i].EngineModel")
    $EngineVersion = $jResp.StringOf("Backups[i].EngineVersion")
    $InstanceProfileArn = $jResp.StringOf("Backups[i].InstanceProfileArn")
    $InstanceType = $jResp.StringOf("Backups[i].InstanceType")
    $KeyPair = $jResp.StringOf("Backups[i].KeyPair")
    $PreferredBackupWindow = $jResp.StringOf("Backups[i].PreferredBackupWindow")
    $PreferredMaintenanceWindow = $jResp.StringOf("Backups[i].PreferredMaintenanceWindow")
    $S3DataSize = $jResp.IntOf("Backups[i].S3DataSize")
    $S3DataUrl = $jResp.StringOf("Backups[i].S3DataUrl")
    $S3LogUrl = $jResp.StringOf("Backups[i].S3LogUrl")
    $ServerName = $jResp.StringOf("Backups[i].ServerName")
    $ServiceRoleArn = $jResp.StringOf("Backups[i].ServiceRoleArn")
    $Status = $jResp.StringOf("Backups[i].Status")
    $StatusDescription = $jResp.StringOf("Backups[i].StatusDescription")
    $ToolsVersion = $jResp.StringOf("Backups[i].ToolsVersion")
    $UserArn = $jResp.StringOf("Backups[i].UserArn")
    $j = 0
    $count_j = $jResp.SizeOfArray("Backups[i].SecurityGroupIds")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $strVal = $jResp.StringOf("Backups[i].SecurityGroupIds[j]")
        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("Backups[i].SubnetIds")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $strVal = $jResp.StringOf("Backups[i].SubnetIds[j]")
        $j = $j + 1
    }

    $i = $i + 1
}

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

# {
#   "Backups": [
#     {
#       "BackupArn": "string",
#       "BackupId": "string",
#       "BackupType": "string",
#       "CreatedAt": number,
#       "Description": "string",
#       "Engine": "string",
#       "EngineModel": "string",
#       "EngineVersion": "string",
#       "InstanceProfileArn": "string",
#       "InstanceType": "string",
#       "KeyPair": "string",
#       "PreferredBackupWindow": "string",
#       "PreferredMaintenanceWindow": "string",
#       "S3DataSize": number,
#       "S3DataUrl": "string",
#       "S3LogUrl": "string",
#       "SecurityGroupIds": [
#         "string"
#       ],
#       "ServerName": "string",
#       "ServiceRoleArn": "string",
#       "Status": "string",
#       "StatusDescription": "string",
#       "SubnetIds": [
#         "string"
#       ],
#       "ToolsVersion": "string",
#       "UserArn": "string"
#     }
#   ],
#   "NextToken": "string"
# }