Chilkat Online Tools

DescribeEntitiesDetectionJob PureBasic Example

Amazon Comprehend

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,"JobId","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "JobId": "string"
    ; }

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
    CkRest::ckAddHeader(rest,"X-Amz-Target","Comprehend_20171127.DescribeEntitiesDetectionJob")

    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

    strVal.s

    DataAccessRoleArn.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.DataAccessRoleArn")
    EndTime.i = CkJsonObject::ckIntOf(jResp,"EntitiesDetectionJobProperties.EndTime")
    EntityRecognizerArn.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.EntityRecognizerArn")
    DocumentReadAction.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.DocumentReadAction")
    DocumentReadMode.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.DocumentReadMode")
    InputFormat.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.InputDataConfig.InputFormat")
    S3Uri.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.InputDataConfig.S3Uri")
    JobArn.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.JobArn")
    JobId.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.JobId")
    JobName.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.JobName")
    JobStatus.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.JobStatus")
    LanguageCode.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.LanguageCode")
    Message.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.Message")
    KmsKeyId.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.OutputDataConfig.KmsKeyId")
    OutputDataConfigS3Uri.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.OutputDataConfig.S3Uri")
    SubmitTime.i = CkJsonObject::ckIntOf(jResp,"EntitiesDetectionJobProperties.SubmitTime")
    VolumeKmsKeyId.s = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.VolumeKmsKeyId")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"EntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.FeatureTypes")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.InputDataConfig.DocumentReaderConfig.FeatureTypes[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"EntitiesDetectionJobProperties.VpcConfig.SecurityGroupIds")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.VpcConfig.SecurityGroupIds[i]")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"EntitiesDetectionJobProperties.VpcConfig.Subnets")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"EntitiesDetectionJobProperties.VpcConfig.Subnets[i]")
        i = i + 1
    Wend

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

    ; {
    ;   "EntitiesDetectionJobProperties": {
    ;     "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"
    ;       ]
    ;     }
    ;   }
    ; }


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure