Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . autoscaling ]

batch-put-scheduled-update-group-action

Description

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

See also: AWS API Documentation

Synopsis

  batch-put-scheduled-update-group-action
--auto-scaling-group-name <value>
--scheduled-update-group-actions <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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.

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, 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 .

Shorthand Syntax:

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

JSON Syntax:

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.