Chilkat Online Tools

DescribePiiEntitiesDetectionJob 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("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.DescribePiiEntitiesDetectionJob")

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

DataAccessRoleArn = jResp.stringOf("PiiEntitiesDetectionJobProperties.DataAccessRoleArn")
EndTime = jResp.IntOf("PiiEntitiesDetectionJobProperties.EndTime")
DocumentReadAction = jResp.stringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.DocumentReadAction")
DocumentReadMode = jResp.stringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.DocumentReadMode")
InputFormat = jResp.stringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.InputFormat")
S3Uri = jResp.stringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.S3Uri")
JobArn = jResp.stringOf("PiiEntitiesDetectionJobProperties.JobArn")
JobId = jResp.stringOf("PiiEntitiesDetectionJobProperties.JobId")
JobName = jResp.stringOf("PiiEntitiesDetectionJobProperties.JobName")
JobStatus = jResp.stringOf("PiiEntitiesDetectionJobProperties.JobStatus")
LanguageCode = jResp.stringOf("PiiEntitiesDetectionJobProperties.LanguageCode")
Message = jResp.stringOf("PiiEntitiesDetectionJobProperties.Message")
Mode = jResp.stringOf("PiiEntitiesDetectionJobProperties.Mode")
KmsKeyId = jResp.stringOf("PiiEntitiesDetectionJobProperties.OutputDataConfig.KmsKeyId")
OutputDataConfigS3Uri = jResp.stringOf("PiiEntitiesDetectionJobProperties.OutputDataConfig.S3Uri")
MaskCharacter = jResp.stringOf("PiiEntitiesDetectionJobProperties.RedactionConfig.MaskCharacter")
MaskMode = jResp.stringOf("PiiEntitiesDetectionJobProperties.RedactionConfig.MaskMode")
SubmitTime = jResp.IntOf("PiiEntitiesDetectionJobProperties.SubmitTime")
i = 0
count_i = jResp.SizeOfArray("PiiEntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.FeatureTypes")
while i < count_i :
    jResp.put_I(i)
    strVal = jResp.stringOf("PiiEntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.FeatureTypes[i]")
    i = i + 1

i = 0
count_i = jResp.SizeOfArray("PiiEntitiesDetectionJobProperties.RedactionConfig.PiiEntityTypes")
while i < count_i :
    jResp.put_I(i)
    strVal = jResp.stringOf("PiiEntitiesDetectionJobProperties.RedactionConfig.PiiEntityTypes[i]")
    i = i + 1

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

# {
#   "PiiEntitiesDetectionJobProperties": {
#     "DataAccessRoleArn": "string",
#     "EndTime": number,
#     "InputDataConfig": {
#       "DocumentReaderConfig": {
#         "DocumentReadAction": "string",
#         "DocumentReadMode": "string",
#         "FeatureTypes": [
#           "string"
#         ]
#       },
#       "InputFormat": "string",
#       "S3Uri": "string"
#     },
#     "JobArn": "string",
#     "JobId": "string",
#     "JobName": "string",
#     "JobStatus": "string",
#     "LanguageCode": "string",
#     "Message": "string",
#     "Mode": "string",
#     "OutputDataConfig": {
#       "KmsKeyId": "string",
#       "S3Uri": "string"
#     },
#     "RedactionConfig": {
#       "MaskCharacter": "string",
#       "MaskMode": "string",
#       "PiiEntityTypes": [
#         "string"
#       ]
#     },
#     "SubmitTime": number
#   }
# }