AutoScaling / Paginator / DescribeScalingActivities

DescribeScalingActivities#

class AutoScaling.Paginator.DescribeScalingActivities#

paginator = client.get_paginator('describe_scaling_activities')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from AutoScaling.Client.describe_scaling_activities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ActivityIds=[
        'string',
    ],
    AutoScalingGroupName='string',
    IncludeDeletedGroups=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

ActivityIds (list) –
The activity IDs of the desired scaling activities. If you omit this property, 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.

Array Members: Maximum number of 50 IDs.
- (string) –
AutoScalingGroupName (string) – The name of the Auto Scaling group.
IncludeDeletedGroups (boolean) – Indicates whether to include scaling activity from deleted Auto Scaling groups.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Activities': [
        {
            'ActivityId': 'string',
            'AutoScalingGroupName': 'string',
            'Description': 'string',
            'Cause': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'StatusCode': 'PendingSpotBidPlacement'|'WaitingForSpotInstanceRequestId'|'WaitingForSpotInstanceId'|'WaitingForInstanceId'|'PreInService'|'InProgress'|'WaitingForELBConnectionDraining'|'MidLifecycleAction'|'WaitingForInstanceWarmup'|'Successful'|'Failed'|'Cancelled',
            'StatusMessage': 'string',
            'Progress': 123,
            'Details': 'string',
            'AutoScalingGroupState': 'string',
            'AutoScalingGroupARN': 'string'
        },
    ],

}

Response Structure

(dict) –
- Activities (list) –
  
  The scaling activities. Activities are sorted by start time. Activities still in progress are described first.
  - (dict) –
    
    Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.
    - ActivityId (string) –
      
      The ID of the activity.
    - AutoScalingGroupName (string) –
      
      The name of the Auto Scaling group.
    - Description (string) –
      
      A friendly, more verbose description of the activity.
    - Cause (string) –
      
      The reason the activity began.
    - StartTime (datetime) –
      
      The start time of the activity.
    - EndTime (datetime) –
      
      The end time of the activity.
    - StatusCode (string) –
      
      The current status of the activity.
    - StatusMessage (string) –
      
      A friendly, more verbose description of the activity status.
    - Progress (integer) –
      
      A value between 0 and 100 that indicates the progress of the activity.
    - Details (string) –
      
      The details about the activity.
    - AutoScalingGroupState (string) –
      
      The state of the Auto Scaling group, which is either InService or Deleted.
    - AutoScalingGroupARN (string) –
      
      The Amazon Resource Name (ARN) of the Auto Scaling group.