comprehend_describe_document_classification_job: Gets the properties associated with a document classification...

Description Usage Arguments Value Request syntax

View source: R/comprehend_operations.R

Description

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

Usage

1

Arguments

JobId

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
list(
  DocumentClassificationJobProperties = list(
    JobId = "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"
    ),
    DocumentClassifierArn = "string",
    InputDataConfig = list(
      S3Uri = "string",
      InputFormat = "ONE_DOC_PER_FILE"|"ONE_DOC_PER_LINE"
    ),
    OutputDataConfig = list(
      S3Uri = "string",
      KmsKeyId = "string"
    ),
    DataAccessRoleArn = "string",
    VolumeKmsKeyId = "string",
    VpcConfig = list(
      SecurityGroupIds = list(
        "string"
      ),
      Subnets = list(
        "string"
      )
    )
  )
)

Request syntax

1
2
3
svc$describe_document_classification_job(
  JobId = "string"
)

paws.machine.learning documentation built on Aug. 23, 2021, 9:14 a.m.