getWorkflowExecutionHistory method

Future<History> getWorkflowExecutionHistory({ required String domain, required WorkflowExecution execution, int? maximumPageSize, String? nextPageToken, bool? reverseOrder, })

Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call. Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• You cannot use an IAM policy to constrain this action's parameters.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

May throw UnknownResourceFault. May throw OperationNotPermittedFault.

Parameter domain : The name of the domain containing the workflow execution.

Parameter execution : Specifies the workflow execution for which to return the history.

Parameter maximumPageSize : The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

Parameter nextPageToken : If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".

The configured maximumPageSize determines how many results can be returned in a single call.

Parameter reverseOrder : When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

Implementation

Future<History> getWorkflowExecutionHistory({
  required String domain,
  required WorkflowExecution execution,
  int? maximumPageSize,
  String? nextPageToken,
  bool? reverseOrder,
}) async {
  ArgumentError.checkNotNull(domain, 'domain');
  _s.validateStringLength(
    'domain',
    domain,
    1,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(execution, 'execution');
  _s.validateNumRange(
    'maximumPageSize',
    maximumPageSize,
    0,
    1000,
  );
  _s.validateStringLength(
    'nextPageToken',
    nextPageToken,
    0,
    2048,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'SimpleWorkflowService.GetWorkflowExecutionHistory'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'domain': domain,
      'execution': execution,
      if (maximumPageSize != null) 'maximumPageSize': maximumPageSize,
      if (nextPageToken != null) 'nextPageToken': nextPageToken,
      if (reverseOrder != null) 'reverseOrder': reverseOrder,
    },
  );

  return History.fromJson(jsonResponse.body);
}