AutoScaling / Client / batch_put_scheduled_update_group_action

batch_put_scheduled_update_group_action#

AutoScaling.Client.batch_put_scheduled_update_group_action(**kwargs)#

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

See also: AWS API Documentation

Request Syntax

response = client.batch_put_scheduled_update_group_action(
    AutoScalingGroupName='string',
    ScheduledUpdateGroupActions=[
        {
            'ScheduledActionName': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'Recurrence': 'string',
            'MinSize': 123,
            'MaxSize': 123,
            'DesiredCapacity': 123,
            'TimeZone': 'string'
        },
    ]
)
Parameters:

  • AutoScalingGroupName (string) –

    [REQUIRED]

    The name of the Auto Scaling group.

  • ScheduledUpdateGroupActions (list) –

    [REQUIRED]

    One or more scheduled actions. The maximum number allowed is 50.

    • (dict) –

      Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

      • ScheduledActionName (string) – [REQUIRED]

        The name of the scaling action.

      • StartTime (datetime) –

        The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").

        If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

        If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

      • EndTime (datetime) –

        The date and time for the recurring schedule to end, in UTC.

      • Recurrence (string) –

        The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

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

        Cron expressions use Universal Coordinated Time (UTC) by default.

      • 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) –

        Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.

        Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Return type:

dict

Returns:

Response Syntax

{
    'FailedScheduledUpdateGroupActions': [
        {
            'ScheduledActionName': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • FailedScheduledUpdateGroupActions (list) –

      The names of the scheduled actions that could not be created or updated, including an error message.

      • (dict) –

        Describes a scheduled action that could not be created, updated, or deleted.

        • ScheduledActionName (string) –

          The name of the scheduled action.

        • ErrorCode (string) –

          The error code.

        • ErrorMessage (string) –

          The error message accompanying the error code.

Exceptions