ListPiiEntitiesDetectionJobs PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(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::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "comprehend")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://comprehend.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"comprehend.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"Filter.JobName","string")
CkJsonObject::ckUpdateString(json,"Filter.JobStatus","string")
CkJsonObject::ckUpdateInt(json,"Filter.SubmitTimeAfter",123)
CkJsonObject::ckUpdateInt(json,"Filter.SubmitTimeBefore",123)
CkJsonObject::ckUpdateInt(json,"MaxResults",123)
CkJsonObject::ckUpdateString(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::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","Comprehend_20171127.ListPiiEntitiesDetectionJobs")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(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
DataAccessRoleArn.s
EndTime.i
DocumentReadAction.s
DocumentReadMode.s
InputFormat.s
S3Uri.s
JobArn.s
JobId.s
JobName.s
JobStatus.s
LanguageCode.s
Message.s
Mode.s
KmsKeyId.s
OutputDataConfigS3Uri.s
MaskCharacter.s
MaskMode.s
SubmitTime.i
j.i
count_j.i
strVal.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"PiiEntitiesDetectionJobPropertiesList")
While i < count_i
CkJsonObject::setCkI(jResp, i)
DataAccessRoleArn = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].DataAccessRoleArn")
EndTime = CkJsonObject::ckIntOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].EndTime")
DocumentReadAction = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.DocumentReadAction")
DocumentReadMode = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.DocumentReadMode")
InputFormat = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.InputFormat")
S3Uri = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.S3Uri")
JobArn = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].JobArn")
JobId = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].JobId")
JobName = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].JobName")
JobStatus = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].JobStatus")
LanguageCode = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].LanguageCode")
Message = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].Message")
Mode = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].Mode")
KmsKeyId = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].OutputDataConfig.KmsKeyId")
OutputDataConfigS3Uri = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].OutputDataConfig.S3Uri")
MaskCharacter = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].RedactionConfig.MaskCharacter")
MaskMode = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].RedactionConfig.MaskMode")
SubmitTime = CkJsonObject::ckIntOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].SubmitTime")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.FeatureTypes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].InputDataConfig.DocumentReaderConfig.FeatureTypes[j]")
j = j + 1
Wend
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"PiiEntitiesDetectionJobPropertiesList[i].RedactionConfig.PiiEntityTypes")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
strVal = CkJsonObject::ckStringOf(jResp,"PiiEntitiesDetectionJobPropertiesList[i].RedactionConfig.PiiEntityTypes[j]")
j = j + 1
Wend
i = i + 1
Wend
; A sample JSON response body parsed by the above code:
; {
; "NextToken": "string",
; "PiiEntitiesDetectionJobPropertiesList": [
; {
; "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
; }
; ]
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
