listFlowExecutionMessages method

Future<ListFlowExecutionMessagesResponse> listFlowExecutionMessages({ required String flowExecutionId, int? maxResults, String? nextToken, })

Returns a list of objects that contain information about events in a flow execution.

May throw InvalidRequestException. May throw ThrottlingException. May throw InternalFailureException. May throw ResourceNotFoundException.

Parameter flowExecutionId : The ID of the flow execution.

Parameter maxResults : The maximum number of results to return in the response.

Parameter nextToken : The string that specifies the next page of results. Use this when you're paginating results.

Implementation

Future<ListFlowExecutionMessagesResponse> listFlowExecutionMessages({
  required String flowExecutionId,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(flowExecutionId, 'flowExecutionId');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    250,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'IotThingsGraphFrontEndService.ListFlowExecutionMessages'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'flowExecutionId': flowExecutionId,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return ListFlowExecutionMessagesResponse.fromJson(jsonResponse.body);
}