Chilkat Online Tools

DescribeImages Powershell Example

Amazon AppStream

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

# URL: https://appstream2.us-west-2.amazonaws.com/
# Use the same region as specified above.
$success = $rest.Connect("appstream2.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("Arns[0]","string")
$json.UpdateInt("MaxResults",123)
$json.UpdateString("Names[0]","string")
$json.UpdateString("NextToken","string")
$json.UpdateString("Type","string")

# The JSON request body created by the above code:

# {
#   "Arns": [
#     "string"
#   ],
#   "MaxResults": number,
#   "Names": [
#     "string"
#   ],
#   "NextToken": "string",
#   "Type": "string"
# }

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

$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("Images")
while ($i -lt $count_i) {
    $jResp.I = $i
    $AppstreamAgentVersion = $jResp.StringOf("Images[i].AppstreamAgentVersion")
    $Arn = $jResp.StringOf("Images[i].Arn")
    $BaseImageArn = $jResp.StringOf("Images[i].BaseImageArn")
    $CreatedTime = $jResp.IntOf("Images[i].CreatedTime")
    $Description = $jResp.StringOf("Images[i].Description")
    $DisplayName = $jResp.StringOf("Images[i].DisplayName")
    $ImageBuilderName = $jResp.StringOf("Images[i].ImageBuilderName")
    $ImageBuilderSupported = $jResp.IntOf("Images[i].ImageBuilderSupported")
    $AllowFleet = $jResp.IntOf("Images[i].ImagePermissions.allowFleet")
    $AllowImageBuilder = $jResp.IntOf("Images[i].ImagePermissions.allowImageBuilder")
    $Name = $jResp.StringOf("Images[i].Name")
    $Platform = $jResp.StringOf("Images[i].Platform")
    $PublicBaseImageReleasedDate = $jResp.IntOf("Images[i].PublicBaseImageReleasedDate")
    $State = $jResp.StringOf("Images[i].State")
    $Code = $jResp.StringOf("Images[i].StateChangeReason.Code")
    $Message = $jResp.StringOf("Images[i].StateChangeReason.Message")
    $Visibility = $jResp.StringOf("Images[i].Visibility")
    $j = 0
    $count_j = $jResp.SizeOfArray("Images[i].Applications")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $AppBlockArn = $jResp.StringOf("Images[i].Applications[j].AppBlockArn")
        $Arn = $jResp.StringOf("Images[i].Applications[j].Arn")
        $CreatedTime = $jResp.IntOf("Images[i].Applications[j].CreatedTime")
        $Description = $jResp.StringOf("Images[i].Applications[j].Description")
        $DisplayName = $jResp.StringOf("Images[i].Applications[j].DisplayName")
        $Enabled = $jResp.IntOf("Images[i].Applications[j].Enabled")
        $S3Bucket = $jResp.StringOf("Images[i].Applications[j].IconS3Location.S3Bucket")
        $S3Key = $jResp.StringOf("Images[i].Applications[j].IconS3Location.S3Key")
        $IconURL = $jResp.StringOf("Images[i].Applications[j].IconURL")
        $LaunchParameters = $jResp.StringOf("Images[i].Applications[j].LaunchParameters")
        $LaunchPath = $jResp.StringOf("Images[i].Applications[j].LaunchPath")
        $v_String = $jResp.StringOf("Images[i].Applications[j].Metadata.string")
        $Name = $jResp.StringOf("Images[i].Applications[j].Name")
        $WorkingDirectory = $jResp.StringOf("Images[i].Applications[j].WorkingDirectory")
        $k = 0
        $count_k = $jResp.SizeOfArray("Images[i].Applications[j].InstanceFamilies")
        while ($k -lt $count_k) {
            $jResp.K = $k
            $strVal = $jResp.StringOf("Images[i].Applications[j].InstanceFamilies[k]")
            $k = $k + 1
        }

        $k = 0
        $count_k = $jResp.SizeOfArray("Images[i].Applications[j].Platforms")
        while ($k -lt $count_k) {
            $jResp.K = $k
            $strVal = $jResp.StringOf("Images[i].Applications[j].Platforms[k]")
            $k = $k + 1
        }

        $j = $j + 1
    }

    $j = 0
    $count_j = $jResp.SizeOfArray("Images[i].ImageErrors")
    while ($j -lt $count_j) {
        $jResp.J = $j
        $ErrorCode = $jResp.StringOf("Images[i].ImageErrors[j].ErrorCode")
        $ErrorMessage = $jResp.StringOf("Images[i].ImageErrors[j].ErrorMessage")
        $ErrorTimestamp = $jResp.IntOf("Images[i].ImageErrors[j].ErrorTimestamp")
        $j = $j + 1
    }

    $i = $i + 1
}

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

# {
#   "Images": [
#     {
#       "Applications": [
#         {
#           "AppBlockArn": "string",
#           "Arn": "string",
#           "CreatedTime": number,
#           "Description": "string",
#           "DisplayName": "string",
#           "Enabled": boolean,
#           "IconS3Location": {
#             "S3Bucket": "string",
#             "S3Key": "string"
#           },
#           "IconURL": "string",
#           "InstanceFamilies": [
#             "string"
#           ],
#           "LaunchParameters": "string",
#           "LaunchPath": "string",
#           "Metadata": {
#             "string": "string"
#           },
#           "Name": "string",
#           "Platforms": [
#             "string"
#           ],
#           "WorkingDirectory": "string"
#         }
#       ],
#       "AppstreamAgentVersion": "string",
#       "Arn": "string",
#       "BaseImageArn": "string",
#       "CreatedTime": number,
#       "Description": "string",
#       "DisplayName": "string",
#       "ImageBuilderName": "string",
#       "ImageBuilderSupported": boolean,
#       "ImageErrors": [
#         {
#           "ErrorCode": "string",
#           "ErrorMessage": "string",
#           "ErrorTimestamp": number
#         }
#       ],
#       "ImagePermissions": {
#         "allowFleet": boolean,
#         "allowImageBuilder": boolean
#       },
#       "Name": "string",
#       "Platform": "string",
#       "PublicBaseImageReleasedDate": number,
#       "State": "string",
#       "StateChangeReason": {
#         "Code": "string",
#         "Message": "string"
#       },
#       "Visibility": "string"
#     }
#   ],
#   "NextToken": "string"
# }