

# ListTargetedSentimentDetectionJobs
<a name="API_ListTargetedSentimentDetectionJobs"></a>

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

## Request Syntax
<a name="API_ListTargetedSentimentDetectionJobs_RequestSyntax"></a>

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

## Request Parameters
<a name="API_ListTargetedSentimentDetectionJobs_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Filter](#API_ListTargetedSentimentDetectionJobs_RequestSyntax) **   <a name="comprehend-ListTargetedSentimentDetectionJobs-request-Filter"></a>
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: [TargetedSentimentDetectionJobFilter](API_TargetedSentimentDetectionJobFilter.md) object  
Required: No

 ** [MaxResults](#API_ListTargetedSentimentDetectionJobs_RequestSyntax) **   <a name="comprehend-ListTargetedSentimentDetectionJobs-request-MaxResults"></a>
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](#API_ListTargetedSentimentDetectionJobs_RequestSyntax) **   <a name="comprehend-ListTargetedSentimentDetectionJobs-request-NextToken"></a>
Identifies the next page of results to return.  
Type: String  
Length Constraints: Minimum length of 1.  
Required: No

## Response Syntax
<a name="API_ListTargetedSentimentDetectionJobs_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "TargetedSentimentDetectionJobPropertiesList": [ 
      { 
         "DataAccessRoleArn": "string",
         "EndTime": number,
         "InputDataConfig": { 
            "DocumentReaderConfig": { 
               "DocumentReadAction": "string",
               "DocumentReadMode": "string",
               "FeatureTypes": [ "string" ]
            },
            "InputFormat": "string",
            "S3Uri": "string"
         },
         "JobArn": "string",
         "JobId": "string",
         "JobName": "string",
         "JobStatus": "string",
         "LanguageCode": "string",
         "Message": "string",
         "OutputDataConfig": { 
            "KmsKeyId": "string",
            "S3Uri": "string"
         },
         "SubmitTime": number,
         "VolumeKmsKeyId": "string",
         "VpcConfig": { 
            "SecurityGroupIds": [ "string" ],
            "Subnets": [ "string" ]
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListTargetedSentimentDetectionJobs_ResponseElements"></a>

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](#API_ListTargetedSentimentDetectionJobs_ResponseSyntax) **   <a name="comprehend-ListTargetedSentimentDetectionJobs-response-NextToken"></a>
Identifies the next page of results to return.  
Type: String  
Length Constraints: Minimum length of 1.

 ** [TargetedSentimentDetectionJobPropertiesList](#API_ListTargetedSentimentDetectionJobs_ResponseSyntax) **   <a name="comprehend-ListTargetedSentimentDetectionJobs-response-TargetedSentimentDetectionJobPropertiesList"></a>
A list containing the properties of each job that is returned.  
Type: Array of [TargetedSentimentDetectionJobProperties](API_TargetedSentimentDetectionJobProperties.md) objects

## Errors
<a name="API_ListTargetedSentimentDetectionJobs_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServerException **   
An internal server error occurred. Retry your request.  
HTTP Status Code: 500

 ** InvalidFilterException **   
The filter specified for the operation is invalid. Specify a different filter.  
HTTP Status Code: 400

 ** InvalidRequestException **   
The request is invalid.    
 ** Detail **   
Provides additional detail about why the request failed.
HTTP Status Code: 400

 ** TooManyRequestsException **   
The number of requests exceeds the limit. Resubmit your request later.  
HTTP Status Code: 400

## See Also
<a name="API_ListTargetedSentimentDetectionJobs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/comprehend-2017-11-27/ListTargetedSentimentDetectionJobs) 