Describe Entities Detection Job

comprehend_describe_entities_detection_job

R Documentation

Gets the properties associated with an entities detection job

Description

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

Usage

comprehend_describe_entities_detection_job(JobId)

Arguments

JobId

[required] The identifier that Amazon Comprehend generated for the job. The start_entities_detection_job operation returns this identifier in its response.

Value

A list with the following syntax:

list(
  EntitiesDetectionJobProperties = list(
    JobId = "string",
    JobArn = "string",
    JobName = "string",
    JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOP_REQUESTED"|"STOPPED",
    Message = "string",
    SubmitTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    EntityRecognizerArn = "string",
    InputDataConfig = list(
      S3Uri = "string",
      InputFormat = "ONE_DOC_PER_FILE"|"ONE_DOC_PER_LINE",
      DocumentReaderConfig = list(
        DocumentReadAction = "TEXTRACT_DETECT_DOCUMENT_TEXT"|"TEXTRACT_ANALYZE_DOCUMENT",
        DocumentReadMode = "SERVICE_DEFAULT"|"FORCE_DOCUMENT_READ_ACTION",
        FeatureTypes = list(
          "TABLES"|"FORMS"
        )
      )
    ),
    OutputDataConfig = list(
      S3Uri = "string",
      KmsKeyId = "string"
    ),
    LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW",
    DataAccessRoleArn = "string",
    VolumeKmsKeyId = "string",
    VpcConfig = list(
      SecurityGroupIds = list(
        "string"
      ),
      Subnets = list(
        "string"
      )
    ),
    FlywheelArn = "string"
  )
)

Request syntax

svc$describe_entities_detection_job(
  JobId = "string"
)