[ aws . autoscaling ]

batch-put-scheduled-update-group-action

Description

Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  batch-put-scheduled-update-group-action
--auto-scaling-group-name <value>
--scheduled-update-group-actions <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--auto-scaling-group-name (string)

The name of the Auto Scaling group.

--scheduled-update-group-actions (list)

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

(structure)

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

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

ScheduledActionName -> (string)

The name of the scaling action.

StartTime -> (timestamp)

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 -> (timestamp)

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

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.

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.

Shorthand Syntax:

ScheduledActionName=string,StartTime=timestamp,EndTime=timestamp,Recurrence=string,MinSize=integer,MaxSize=integer,DesiredCapacity=integer ...

JSON Syntax:

[
  {
    "ScheduledActionName": "string",
    "StartTime": timestamp,
    "EndTime": timestamp,
    "Recurrence": "string",
    "MinSize": integer,
    "MaxSize": integer,
    "DesiredCapacity": integer
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

FailedScheduledUpdateGroupActions -> (list)

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

(structure)

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.