Chilkat Online Tools

DescribeImages Perl Example

Amazon AppStream

use 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("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,1,1);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    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 = chilkat::CkJsonObject->new();
$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 = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);
$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print "response status code = " . $respStatusCode . "\r\n";
if ($respStatusCode != 200) {
    print "Response Header:" . "\r\n";
    print $rest->responseHeader() . "\r\n";
    print "Response Body:" . "\r\n";
    print $sbResponseBody->getAsString() . "\r\n";
    exit;
}

$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

$NextToken = $jResp->stringOf("NextToken");
$i = 0;
$count_i = $jResp->SizeOfArray("Images");
while ($i < $count_i) {
    $jResp->put_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 < $count_j) {
        $jResp->put_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 < $count_k) {
            $jResp->put_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 < $count_k) {
            $jResp->put_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 < $count_j) {
        $jResp->put_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"
# }