Menu
Amazon Comprehend
Developer Guide

ListTopicsDetectionJobs

Gets a list of the topic detection jobs that you have submitted.

Request Syntax

{
   "Filter": { 
      "JobName": "string",
      "JobStatus": "string",
      "SubmitTimeAfter": number,
      "SubmitTimeBefore": number
   },
   "MaxResults": number,
   "NextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Filter

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.

Type: TopicsDetectionJobFilter object

Required: No

MaxResults

The maximum number of results to return in each page.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

Required: No

Response Syntax

{
   "NextToken": "string",
   "TopicsDetectionJobPropertiesList": [ 
      { 
         "EndTime": number,
         "InputDataConfig": { 
            "InputFormat": "string",
            "S3Uri": "string"
         },
         "JobId": "string",
         "JobName": "string",
         "JobStatus": "string",
         "Message": "string",
         "NumberOfTopics": number,
         "OutputDataConfig": { 
            "S3Uri": "string"
         },
         "SubmitTime": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Identifies the next page of results to return.

Type: String

Length Constraints: Minimum length of 1.

TopicsDetectionJobPropertiesList

A list containing the properties of each job that is returned.

Type: Array of TopicsDetectionJobProperties objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

InvalidFilterException

The filter specified for the ListTopicDetectionJobs operation is invalid. Specify a different filter.

HTTP Status Code: 400

InvalidRequestException

The request is invalid.

HTTP Status Code: 400

TooManyRequestsException

The number of requests exceeds the limit. Resubmit your request later.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: