Chilkat Online Tools

ListEntitiesDetectionJobs TCL Example

Amazon Comprehend

load ./chilkat.dll

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

set rest [new_CkRest]

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "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.)
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "comprehend"
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest_SetAuthAws $rest $authAws

# URL: https://comprehend.us-west-2.amazonaws.com/
# Use the same region as specified above.
set success [CkRest_Connect $rest "comprehend.us-west-2.amazonaws.com" 443 1 1]
if {$success != 1} then {
    puts "ConnectFailReason: [CkRest_get_ConnectFailReason $rest]"
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "Filter.JobName" "string"
CkJsonObject_UpdateString $json "Filter.JobStatus" "string"
CkJsonObject_UpdateInt $json "Filter.SubmitTimeAfter" 123
CkJsonObject_UpdateInt $json "Filter.SubmitTimeBefore" 123
CkJsonObject_UpdateInt $json "MaxResults" 123
CkJsonObject_UpdateString $json "NextToken" "string"

# The JSON request body created by the above code:

# {
#   "Filter": {
#     "JobName": "string",
#     "JobStatus": "string",
#     "SubmitTimeAfter": number,
#     "SubmitTimeBefore": number
#   },
#   "MaxResults": number,
#   "NextToken": "string"
# }

CkRest_AddHeader $rest "Content-Type" "application/x-amz-json-1.1"
CkRest_AddHeader $rest "X-Amz-Target" "Comprehend_20171127.ListEntitiesDetectionJobs"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody
set sbResponseBody [new_CkStringBuilder]

set success [CkRest_FullRequestSb $rest "POST" "/" $sbRequestBody $sbResponseBody]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set respStatusCode [CkRest_get_ResponseStatusCode $rest]
puts "response status code = $respStatusCode"
if {$respStatusCode != 200} then {
    puts "Response Header:"
    puts [CkRest_responseHeader $rest]
    puts "Response Body:"
    puts [CkStringBuilder_getAsString $sbResponseBody]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    exit
}

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $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

set NextToken [CkJsonObject_stringOf $jResp "NextToken"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "EntitiesDetectionJobPropertiesList"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set DataAccessRoleArn [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].DataAccessRoleArn"]
    set EndTime [CkJsonObject_IntOf $jResp "EntitiesDetectionJobPropertiesList[i].EndTime"]
    set EntityRecognizerArn [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].EntityRecognizerArn"]
    set DocumentReadAction [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.DocumentReadAction"]
    set DocumentReadMode [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.DocumentReadMode"]
    set InputFormat [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].InputDataConfig.InputFormat"]
    set S3Uri [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].InputDataConfig.S3Uri"]
    set JobArn [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].JobArn"]
    set JobId [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].JobId"]
    set JobName [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].JobName"]
    set JobStatus [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].JobStatus"]
    set LanguageCode [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].LanguageCode"]
    set Message [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].Message"]
    set KmsKeyId [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].OutputDataConfig.KmsKeyId"]
    set OutputDataConfigS3Uri [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].OutputDataConfig.S3Uri"]
    set SubmitTime [CkJsonObject_IntOf $jResp "EntitiesDetectionJobPropertiesList[i].SubmitTime"]
    set VolumeKmsKeyId [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].VolumeKmsKeyId"]
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "EntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.FeatureTypes"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.FeatureTypes[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "EntitiesDetectionJobPropertiesList[i].VpcConfig.SecurityGroupIds"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].VpcConfig.SecurityGroupIds[j]"]
        set j [expr $j + 1]
    }
    set j 0
    set count_j [CkJsonObject_SizeOfArray $jResp "EntitiesDetectionJobPropertiesList[i].VpcConfig.Subnets"]
    while {$j < $count_j} {
        CkJsonObject_put_J $jResp $j
        set strVal [CkJsonObject_stringOf $jResp "EntitiesDetectionJobPropertiesList[i].VpcConfig.Subnets[j]"]
        set j [expr $j + 1]
    }
    set i [expr $i + 1]
}

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

# {
#   "EntitiesDetectionJobPropertiesList": [
#     {
#       "DataAccessRoleArn": "string",
#       "EndTime": number,
#       "EntityRecognizerArn": "string",
#       "InputDataConfig": {
#         "DocumentReaderConfig": {
#           "DocumentReadAction": "string",
#           "DocumentReadMode": "string",
#           "FeatureTypes": [
#             "string"
#           ]
#         },
#         "InputFormat": "string",
#         "S3Uri": "string"
#       },
#       "JobArn": "string",
#       "JobId": "string",
#       "JobName": "string",
#       "JobStatus": "string",
#       "LanguageCode": "string",
#       "Message": "string",
#       "OutputDataConfig": {
#         "KmsKeyId": "string",
#         "S3Uri": "string"
#       },
#       "SubmitTime": number,
#       "VolumeKmsKeyId": "string",
#       "VpcConfig": {
#         "SecurityGroupIds": [
#           "string"
#         ],
#         "Subnets": [
#           "string"
#         ]
#       }
#     }
#   ],
#   "NextToken": "string"
# }

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp