Chilkat Online Tools

DescribeDocumentClassificationJob phpExt Example

Amazon Comprehend

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

// URL: https://comprehend.us-west-2.amazonaws.com/
// Use the same region as specified above.
$success = $rest->Connect('comprehend.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('JobId','string');

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

// {
//   "JobId": "string"
// }

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

$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

$DataAccessRoleArn = $jResp->stringOf('DocumentClassificationJobProperties.DataAccessRoleArn');
$DocumentClassifierArn = $jResp->stringOf('DocumentClassificationJobProperties.DocumentClassifierArn');
$EndTime = $jResp->IntOf('DocumentClassificationJobProperties.EndTime');
$DocumentReadAction = $jResp->stringOf('DocumentClassificationJobProperties.InputDataConfig.DocumentReaderConfig.DocumentReadAction');
$DocumentReadMode = $jResp->stringOf('DocumentClassificationJobProperties.InputDataConfig.DocumentReaderConfig.DocumentReadMode');
$InputFormat = $jResp->stringOf('DocumentClassificationJobProperties.InputDataConfig.InputFormat');
$S3Uri = $jResp->stringOf('DocumentClassificationJobProperties.InputDataConfig.S3Uri');
$JobArn = $jResp->stringOf('DocumentClassificationJobProperties.JobArn');
$JobId = $jResp->stringOf('DocumentClassificationJobProperties.JobId');
$JobName = $jResp->stringOf('DocumentClassificationJobProperties.JobName');
$JobStatus = $jResp->stringOf('DocumentClassificationJobProperties.JobStatus');
$Message = $jResp->stringOf('DocumentClassificationJobProperties.Message');
$KmsKeyId = $jResp->stringOf('DocumentClassificationJobProperties.OutputDataConfig.KmsKeyId');
$OutputDataConfigS3Uri = $jResp->stringOf('DocumentClassificationJobProperties.OutputDataConfig.S3Uri');
$SubmitTime = $jResp->IntOf('DocumentClassificationJobProperties.SubmitTime');
$VolumeKmsKeyId = $jResp->stringOf('DocumentClassificationJobProperties.VolumeKmsKeyId');
$i = 0;
$count_i = $jResp->SizeOfArray('DocumentClassificationJobProperties.InputDataConfig.DocumentReaderConfig.FeatureTypes');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('DocumentClassificationJobProperties.InputDataConfig.DocumentReaderConfig.FeatureTypes[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('DocumentClassificationJobProperties.VpcConfig.SecurityGroupIds');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('DocumentClassificationJobProperties.VpcConfig.SecurityGroupIds[i]');
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray('DocumentClassificationJobProperties.VpcConfig.Subnets');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('DocumentClassificationJobProperties.VpcConfig.Subnets[i]');
    $i = $i + 1;
}

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

// {
//   "DocumentClassificationJobProperties": {
//     "DataAccessRoleArn": "string",
//     "DocumentClassifierArn": "string",
//     "EndTime": number,
//     "InputDataConfig": {
//       "DocumentReaderConfig": {
//         "DocumentReadAction": "string",
//         "DocumentReadMode": "string",
//         "FeatureTypes": [
//           "string"
//         ]
//       },
//       "InputFormat": "string",
//       "S3Uri": "string"
//     },
//     "JobArn": "string",
//     "JobId": "string",
//     "JobName": "string",
//     "JobStatus": "string",
//     "Message": "string",
//     "OutputDataConfig": {
//       "KmsKeyId": "string",
//       "S3Uri": "string"
//     },
//     "SubmitTime": number,
//     "VolumeKmsKeyId": "string",
//     "VpcConfig": {
//       "SecurityGroupIds": [
//         "string"
//       ],
//       "Subnets": [
//         "string"
//       ]
//     }
//   }
// }

?>