describeInstanceRefreshes method

Future<DescribeInstanceRefreshesAnswer> describeInstanceRefreshes({
  1. required String autoScalingGroupName,
  2. List<String>? instanceRefreshIds,
  3. int? maxRecords,
  4. String? nextToken,
})

Describes one or more instance refreshes.

You can determine the status of a request by looking at the Status parameter. The following are the possible statuses:

  • Pending - The request was created, but the operation has not started.
  • InProgress - The operation is in progress.
  • Successful - The operation completed successfully.
  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
  • Cancelled - The operation is cancelled.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

May throw InvalidNextToken. May throw ResourceContentionFault.

Parameter autoScalingGroupName : The name of the Auto Scaling group.

Parameter instanceRefreshIds : One or more instance refresh IDs.

Parameter maxRecords : The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

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

Implementation

Future<DescribeInstanceRefreshesAnswer> describeInstanceRefreshes({
  required String autoScalingGroupName,
  List<String>? instanceRefreshIds,
  int? maxRecords,
  String? nextToken,
}) async {
  ArgumentError.checkNotNull(autoScalingGroupName, 'autoScalingGroupName');
  _s.validateStringLength(
    'autoScalingGroupName',
    autoScalingGroupName,
    1,
    255,
    isRequired: true,
  );
  final $request = <String, dynamic>{};
  $request['AutoScalingGroupName'] = autoScalingGroupName;
  instanceRefreshIds?.also((arg) => $request['InstanceRefreshIds'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeInstanceRefreshes',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeInstanceRefreshesType'],
    shapes: shapes,
    resultWrapper: 'DescribeInstanceRefreshesResult',
  );
  return DescribeInstanceRefreshesAnswer.fromXml($result);
}