AutoScaling / Paginator / DescribeScheduledActions

DescribeScheduledActions#

class AutoScaling.Paginator.DescribeScheduledActions#
paginator = client.get_paginator('describe_scheduled_actions')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AutoScalingGroupName='string',
    ScheduledActionNames=[
        'string',
    ],
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • AutoScalingGroupName (string) – The name of the Auto Scaling group.

  • ScheduledActionNames (list) –

    The names of one or more scheduled actions. If you omit this property, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

    Array Members: Maximum number of 50 actions.

    • (string) –

  • StartTime (datetime) – The earliest scheduled start time to return. If scheduled action names are provided, this property is ignored.

  • EndTime (datetime) – The latest scheduled start time to return. If scheduled action names are provided, this property is ignored.

  • 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

{
    'ScheduledUpdateGroupActions': [
        {
            'AutoScalingGroupName': 'string',
            'ScheduledActionName': 'string',
            'ScheduledActionARN': 'string',
            'Time': datetime(2015, 1, 1),
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Recurrence': 'string',
            'MinSize': 123,
            'MaxSize': 123,
            'DesiredCapacity': 123,
            'TimeZone': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • ScheduledUpdateGroupActions (list) –

      The scheduled actions.

      • (dict) –

        Describes a scheduled scaling action.

        • AutoScalingGroupName (string) –

          The name of the Auto Scaling group.

        • ScheduledActionName (string) –

          The name of the scheduled action.

        • ScheduledActionARN (string) –

          The Amazon Resource Name (ARN) of the scheduled action.

        • Time (datetime) –

          This property is no longer used.

        • StartTime (datetime) –

          The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z".

        • EndTime (datetime) –

          The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z".

        • Recurrence (string) –

          The recurring schedule for the action, in Unix cron syntax format.

          When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

        • MinSize (integer) –

          The minimum size of the Auto Scaling group.

        • MaxSize (integer) –

          The maximum size of the Auto Scaling group.

        • DesiredCapacity (integer) –

          The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

        • TimeZone (string) –

          The time zone for the cron expression.