Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
116 lines (92 sloc) 6.78 KB

ListSentimentDetectionJobs

Gets a list of sentiment detection jobs that you have submitted.

Request Syntax

{
   "[Filter](#comprehend-ListSentimentDetectionJobs-request-Filter)": { 
      "[JobName](API_SentimentDetectionJobFilter.md#comprehend-Type-SentimentDetectionJobFilter-JobName)": "string",
      "[JobStatus](API_SentimentDetectionJobFilter.md#comprehend-Type-SentimentDetectionJobFilter-JobStatus)": "string",
      "[SubmitTimeAfter](API_SentimentDetectionJobFilter.md#comprehend-Type-SentimentDetectionJobFilter-SubmitTimeAfter)": number,
      "[SubmitTimeBefore](API_SentimentDetectionJobFilter.md#comprehend-Type-SentimentDetectionJobFilter-SubmitTimeBefore)": number
   },
   "[MaxResults](#comprehend-ListSentimentDetectionJobs-request-MaxResults)": number,
   "[NextToken](#comprehend-ListSentimentDetectionJobs-request-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. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.
Type: SentimentDetectionJobFilter object
Required: No

** MaxResults ** The maximum number of results to return in each page. The default is 100.
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](#comprehend-ListSentimentDetectionJobs-response-NextToken)": "string",
   "[SentimentDetectionJobPropertiesList](#comprehend-ListSentimentDetectionJobs-response-SentimentDetectionJobPropertiesList)": [ 
      { 
         "[DataAccessRoleArn](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-DataAccessRoleArn)": "string",
         "[EndTime](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-EndTime)": number,
         "[InputDataConfig](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-InputDataConfig)": { 
            "[InputFormat](API_InputDataConfig.md#comprehend-Type-InputDataConfig-InputFormat)": "string",
            "[S3Uri](API_InputDataConfig.md#comprehend-Type-InputDataConfig-S3Uri)": "string"
         },
         "[JobId](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-JobId)": "string",
         "[JobName](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-JobName)": "string",
         "[JobStatus](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-JobStatus)": "string",
         "[LanguageCode](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-LanguageCode)": "string",
         "[Message](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-Message)": "string",
         "[OutputDataConfig](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-OutputDataConfig)": { 
            "[S3Uri](API_OutputDataConfig.md#comprehend-Type-OutputDataConfig-S3Uri)": "string"
         },
         "[SubmitTime](API_SentimentDetectionJobProperties.md#comprehend-Type-SentimentDetectionJobProperties-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.

** SentimentDetectionJobPropertiesList ** A list containing the properties of each job that is returned.
Type: Array of SentimentDetectionJobProperties 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 ListDocumentClassificationJobs 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:

You can’t perform that action at this time.