Chilkat Online Tools

DescribePipelines phpExt Example

AWS Data Pipeline

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$rest = new CkRest();

$authAws = new CkAuthAws();
$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('datapipeline');
// SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest->SetAuthAws($authAws);

// URL: https://datapipeline.us-west-2.amazonaws.com/
// Use the same region as specified above.
$success = $rest->Connect('datapipeline.us-west-2.amazonaws.com',443,true,true);
if ($success != true) {
    print 'ConnectFailReason: ' . $rest->get_ConnectFailReason() . "\n";
    print $rest->lastErrorText() . "\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 = new CkJsonObject();
$json->UpdateString('pipelineIds[0]','string');

// The JSON request body created by the above code:

// {
//   "pipelineIds": [
//     "string"
//   ]
// }

$rest->AddHeader('Content-Type','application/x-amz-json-1.1');
$rest->AddHeader('X-Amz-Target','DataPipeline.DescribePipelines');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);
$sbResponseBody = new CkStringBuilder();
$success = $rest->FullRequestSb('POST','/',$sbRequestBody,$sbResponseBody);
if ($success != true) {
    print $rest->lastErrorText() . "\n";
    exit;
}

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

$jResp = new CkJsonObject();
$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('pipelineDescriptionList');
while ($i < $count_i) {
    $jResp->put_I($i);
    $description = $jResp->stringOf('pipelineDescriptionList[i].description');
    $name = $jResp->stringOf('pipelineDescriptionList[i].name');
    $pipelineId = $jResp->stringOf('pipelineDescriptionList[i].pipelineId');
    $j = 0;
    $count_j = $jResp->SizeOfArray('pipelineDescriptionList[i].fields');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $key = $jResp->stringOf('pipelineDescriptionList[i].fields[j].key');
        $refValue = $jResp->stringOf('pipelineDescriptionList[i].fields[j].refValue');
        $stringValue = $jResp->stringOf('pipelineDescriptionList[i].fields[j].stringValue');
        $j = $j + 1;
    }

    $j = 0;
    $count_j = $jResp->SizeOfArray('pipelineDescriptionList[i].tags');
    while ($j < $count_j) {
        $jResp->put_J($j);
        $key = $jResp->stringOf('pipelineDescriptionList[i].tags[j].key');
        $value = $jResp->stringOf('pipelineDescriptionList[i].tags[j].value');
        $j = $j + 1;
    }

    $i = $i + 1;
}

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

// {
//   "pipelineDescriptionList": [
//     {
//       "description": "string",
//       "fields": [
//         {
//           "key": "string",
//           "refValue": "string",
//           "stringValue": "string"
//         }
//       ],
//       "name": "string",
//       "pipelineId": "string",
//       "tags": [
//         {
//           "key": "string",
//           "value": "string"
//         }
//       ]
//     }
//   ]
// }

?>