Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . comprehend ]

describe-topics-detection-job

Description

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

See also: AWS API Documentation

Synopsis

  describe-topics-detection-job
--job-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--job-id (string)

The identifier assigned by the user to the detection job.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Output

TopicsDetectionJobProperties -> (structure)

The list of properties for the requested job.

JobId -> (string)

The identifier assigned to the topic detection job.

JobName -> (string)

The name of the topic detection job.

JobStatus -> (string)

The current status of the topic detection job. If the status is Failed , the reason for the failure is shown in the Message field.

Message -> (string)

A description for the status of a job.

SubmitTime -> (timestamp)

The time that the topic detection job was submitted for processing.

EndTime -> (timestamp)

The time that the topic detection job was completed.

InputDataConfig -> (structure)

The input data configuration supplied when you created the topic detection job.

S3Uri -> (string)

The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix , if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

InputFormat -> (string)

Specifies how the text in an input file should be processed:

  • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.
  • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

OutputDataConfig -> (structure)

The output data configuration supplied when you created the topic detection job.

S3Uri -> (string)

The Amazon S3 URI where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling.

The service creates an output file called output.tar.gz . It is a compressed archive that contains two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic. For more information, see topic-modeling .

NumberOfTopics -> (integer)

The number of topics to detect supplied when you created the topic detection job. The default is 10.