describeAutomationStepExecutions method

Future<DescribeAutomationStepExecutionsResult> describeAutomationStepExecutions({ required String automationExecutionId, List<StepExecutionFilter>? filters, int? maxResults, String? nextToken, bool? reverseOrder, })

Information about all active and terminated step executions in an Automation workflow.

May throw AutomationExecutionNotFoundException. May throw InvalidNextToken. May throw InvalidFilterKey. May throw InvalidFilterValue. May throw InternalServerError.

Parameter automationExecutionId : The Automation execution ID for which you want step execution descriptions.

Parameter filters : One or more filters to limit the number of step executions returned by the request.

Parameter maxResults : The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameter nextToken : The token for the next set of items to return. (You received this token from a previous call.)

Parameter reverseOrder : A boolean that indicates whether to list step executions in reverse order by start time. The default value is false.

Implementation

Future<DescribeAutomationStepExecutionsResult>
    describeAutomationStepExecutions({
  required String automationExecutionId,
  List<StepExecutionFilter>? filters,
  int? maxResults,
  String? nextToken,
  bool? reverseOrder,
}) async {
  ArgumentError.checkNotNull(automationExecutionId, 'automationExecutionId');
  _s.validateStringLength(
    'automationExecutionId',
    automationExecutionId,
    36,
    36,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.DescribeAutomationStepExecutions'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'AutomationExecutionId': automationExecutionId,
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (reverseOrder != null) 'ReverseOrder': reverseOrder,
    },
  );

  return DescribeAutomationStepExecutionsResult.fromJson(jsonResponse.body);
}