describeWorkflowExecution method

Future<WorkflowExecutionDetail> describeWorkflowExecution({ required String domain, required WorkflowExecution execution, })

Returns information about the specified workflow execution including its type and some statistics. 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 : The workflow execution to describe.

Implementation

Future<WorkflowExecutionDetail> describeWorkflowExecution({
  required String domain,
  required WorkflowExecution execution,
}) async {
  ArgumentError.checkNotNull(domain, 'domain');
  _s.validateStringLength(
    'domain',
    domain,
    1,
    256,
    isRequired: true,
  );
  ArgumentError.checkNotNull(execution, 'execution');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'SimpleWorkflowService.DescribeWorkflowExecution'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'domain': domain,
      'execution': execution,
    },
  );

  return WorkflowExecutionDetail.fromJson(jsonResponse.body);
}