listSentimentDetectionJobs method

Future<ListSentimentDetectionJobsResponse> listSentimentDetectionJobs({ SentimentDetectionJobFilter? filter, int? maxResults, String? nextToken, })

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

May throw InvalidRequestException. May throw TooManyRequestsException. May throw InvalidFilterException. May throw InternalServerException.

Parameter 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.

Parameter maxResults : The maximum number of results to return in each page. The default is 100.

Parameter nextToken : Identifies the next page of results to return.

Implementation

Future<ListSentimentDetectionJobsResponse> listSentimentDetectionJobs({
  SentimentDetectionJobFilter? filter,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    500,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    1152921504606846976,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'Comprehend_20171127.ListSentimentDetectionJobs'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filter != null) 'Filter': filter,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return ListSentimentDetectionJobsResponse.fromJson(jsonResponse.body);
}