Interface StartSentimentDetectionJobCommandOutput

The output of StartSentimentDetectionJobCommand.

interface StartSentimentDetectionJobCommandOutput {
    $metadata: ResponseMetadata;
    JobArn?: string;
    JobId?: string;
    JobStatus?: string;
}

Hierarchy (view full)

Properties

$metadata JobArn? JobId? JobStatus?

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional JobArn

JobArn?: string

The Amazon Resource Name (ARN) of the sentiment detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn::comprehend:::sentiment-detection-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

Optional JobId

JobId?: string

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

Optional JobStatus

JobStatus?: string

The status of the job.

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. To get details, use the operation.

Settings

Member Visibility

Theme

On This Page