describeScalingActivities method

Future<ActivitiesType> describeScalingActivities({ List<String>? activityIds, String? autoScalingGroupName, int? maxRecords, String? nextToken, })

Describes one or more scaling activities for the specified Auto Scaling group.

May throw InvalidNextToken. May throw ResourceContentionFault.

Parameter activityIds : The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.

Parameter autoScalingGroupName : The name of the Auto Scaling group.

Parameter maxRecords : The maximum number of items to return with this call. The default value is 100 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<ActivitiesType> describeScalingActivities({
  List<String>? activityIds,
  String? autoScalingGroupName,
  int? maxRecords,
  String? nextToken,
}) async {
  _s.validateStringLength(
    'autoScalingGroupName',
    autoScalingGroupName,
    1,
    255,
  );
  final $request = <String, dynamic>{};
  activityIds?.also((arg) => $request['ActivityIds'] = arg);
  autoScalingGroupName?.also((arg) => $request['AutoScalingGroupName'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  nextToken?.also((arg) => $request['NextToken'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeScalingActivities',
    version: '2011-01-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeScalingActivitiesType'],
    shapes: shapes,
    resultWrapper: 'DescribeScalingActivitiesResult',
  );
  return ActivitiesType.fromXml($result);
}