listStackInstances method

Future<ListStackInstancesOutput> listStackInstances({ required String stackSetName, List<StackInstanceFilter>? filters, int? maxResults, String? nextToken, String? stackInstanceAccount, String? stackInstanceRegion, })

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region, or that have a specific status.

May throw StackSetNotFoundException.

Parameter stackSetName : The name or unique ID of the stack set that you want to list stack instances for.

Parameter filters : The status that stack instances are filtered by.

Parameter maxResults : The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Parameter nextToken : If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

Parameter stackInstanceAccount : The name of the AWS account that you want to list stack instances for.

Parameter stackInstanceRegion : The name of the Region where you want to list stack instances.

Implementation

Future<ListStackInstancesOutput> listStackInstances({
  required String stackSetName,
  List<StackInstanceFilter>? filters,
  int? maxResults,
  String? nextToken,
  String? stackInstanceAccount,
  String? stackInstanceRegion,
}) async {
  ArgumentError.checkNotNull(stackSetName, 'stackSetName');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    1024,
  );
  final $request = <String, dynamic>{};
  $request['StackSetName'] = stackSetName;
  filters?.also((arg) => $request['Filters'] = arg);
  maxResults?.also((arg) => $request['MaxResults'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  stackInstanceAccount?.also((arg) => $request['StackInstanceAccount'] = arg);
  stackInstanceRegion?.also((arg) => $request['StackInstanceRegion'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ListStackInstances',
    version: '2010-05-15',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ListStackInstancesInput'],
    shapes: shapes,
    resultWrapper: 'ListStackInstancesResult',
  );
  return ListStackInstancesOutput.fromXml($result);
}