describeAssociationExecutions method

Future<DescribeAssociationExecutionsResult> describeAssociationExecutions({ required String associationId, List<AssociationExecutionFilter>? filters, int? maxResults, String? nextToken, })

Use this API action to view all executions for a specific association ID.

May throw InternalServerError. May throw AssociationDoesNotExist. May throw InvalidNextToken.

Parameter associationId : The association ID for which you want to view execution history details.

Parameter filters : Filters for the request. You can specify the following filters and values.

ExecutionId (EQUAL)

Status (EQUAL)

CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

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 : A token to start the list. Use this token to get the next set of results.

Implementation

Future<DescribeAssociationExecutionsResult> describeAssociationExecutions({
  required String associationId,
  List<AssociationExecutionFilter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(associationId, 'associationId');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.DescribeAssociationExecutions'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'AssociationId': associationId,
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return DescribeAssociationExecutionsResult.fromJson(jsonResponse.body);
}