AWS CLI Command Reference

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 . opensearch ]

update-scheduled-action

Description

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement .

See also: AWS API Documentation

Synopsis

  update-scheduled-action
--domain-name <value>
--action-id <value>
--action-type <value>
--schedule-at <value>
[--desired-start-time <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

--domain-name (string)

The name of the domain to reschedule an action for.

--action-id (string)

The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

--action-type (string)

The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE , JVM_HEAP_SIZE_TUNING , or JVM_YOUNG_GEN_TUNING . To retrieve this value, send a ListScheduledActions request.

Possible values:

  • SERVICE_SOFTWARE_UPDATE
  • JVM_HEAP_SIZE_TUNING
  • JVM_YOUNG_GEN_TUNING

--schedule-at (string)

When to schedule the action.

  • NOW - Immediately schedules the update to happen in the current hour if there's capacity available.
  • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime .
  • OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

Possible values:

  • NOW
  • TIMESTAMP
  • OFF_PEAK_WINDOW

--desired-start-time (long)

The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP .

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

ScheduledAction -> (structure)

Information about the rescheduled action.

Id -> (string)

The unique identifier of the scheduled action.

Type -> (string)

The type of action that will be taken on the domain.

Severity -> (string)

The severity of the action.

ScheduledTime -> (long)

The time when the change is scheduled to happen.

Description -> (string)

A description of the action to be taken.

ScheduledBy -> (string)

Whether the action was scheduled manually (CUSTOMER , or by OpenSearch Service automatically (SYSTEM ).

Status -> (string)

The current status of the scheduled action.

Mandatory -> (boolean)

Whether the action is required or optional.

Cancellable -> (boolean)

Whether or not the scheduled action is cancellable.