Chilkat Online Tools

StartPiiEntitiesDetectionJob Python Example

Amazon Comprehend

import sys
import chilkat

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

rest = chilkat.CkRest()

authAws = chilkat.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: " + str(rest.get_ConnectFailReason()))
    print(rest.lastErrorText())
    sys.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()
json.UpdateString("ClientRequestToken","string")
json.UpdateString("DataAccessRoleArn","string")
json.UpdateString("InputDataConfig.DocumentReaderConfig.DocumentReadAction","string")
json.UpdateString("InputDataConfig.DocumentReaderConfig.DocumentReadMode","string")
json.UpdateString("InputDataConfig.DocumentReaderConfig.FeatureTypes[0]","string")
json.UpdateString("InputDataConfig.InputFormat","string")
json.UpdateString("InputDataConfig.S3Uri","string")
json.UpdateString("JobName","string")
json.UpdateString("LanguageCode","string")
json.UpdateString("Mode","string")
json.UpdateString("OutputDataConfig.KmsKeyId","string")
json.UpdateString("OutputDataConfig.S3Uri","string")
json.UpdateString("RedactionConfig.MaskCharacter","string")
json.UpdateString("RedactionConfig.MaskMode","string")
json.UpdateString("RedactionConfig.PiiEntityTypes[0]","string")
json.UpdateString("Tags[0].Key","string")
json.UpdateString("Tags[0].Value","string")

# The JSON request body created by the above code:

# {
#   "ClientRequestToken": "string",
#   "DataAccessRoleArn": "string",
#   "InputDataConfig": {
#     "DocumentReaderConfig": {
#       "DocumentReadAction": "string",
#       "DocumentReadMode": "string",
#       "FeatureTypes": [
#         "string"
#       ]
#     },
#     "InputFormat": "string",
#     "S3Uri": "string"
#   },
#   "JobName": "string",
#   "LanguageCode": "string",
#   "Mode": "string",
#   "OutputDataConfig": {
#     "KmsKeyId": "string",
#     "S3Uri": "string"
#   },
#   "RedactionConfig": {
#     "MaskCharacter": "string",
#     "MaskMode": "string",
#     "PiiEntityTypes": [
#       "string"
#     ]
#   },
#   "Tags": [
#     {
#       "Key": "string",
#       "Value": "string"
#     }
#   ]
# }

rest.AddHeader("Content-Type","application/x-amz-json-1.1")
rest.AddHeader("X-Amz-Target","Comprehend_20171127.StartPiiEntitiesDetectionJob")

sbRequestBody = chilkat.CkStringBuilder()
json.EmitSb(sbRequestBody)
sbResponseBody = chilkat.CkStringBuilder()
success = rest.FullRequestSb("POST","/",sbRequestBody,sbResponseBody)
if (success != True):
    print(rest.lastErrorText())
    sys.exit()

respStatusCode = rest.get_ResponseStatusCode()
print("response status code = " + str(respStatusCode))
if (respStatusCode != 200):
    print("Response Header:")
    print(rest.responseHeader())
    print("Response Body:")
    print(sbResponseBody.getAsString())
    sys.exit()

jResp = chilkat.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

JobArn = jResp.stringOf("JobArn")
JobId = jResp.stringOf("JobId")
JobStatus = jResp.stringOf("JobStatus")

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

# {
#   "JobArn": "string",
#   "JobId": "string",
#   "JobStatus": "string"
# }