ScheduledAction - Amazon OpenSearch Service
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

ScheduledAction

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

Contents

Id

The unique identifier of the scheduled action.

Type: String

Required: Yes

ScheduledTime

The time when the change is scheduled to happen.

Type: Long

Required: Yes

Severity

The severity of the action.

Type: String

Valid Values: HIGH | MEDIUM | LOW

Required: Yes

Type

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

Type: String

Valid Values: SERVICE_SOFTWARE_UPDATE | JVM_HEAP_SIZE_TUNING | JVM_YOUNG_GEN_TUNING

Required: Yes

Cancellable

Whether or not the scheduled action is cancellable.

Type: Boolean

Required: No

Description

A description of the action to be taken.

Type: String

Required: No

Mandatory

Whether the action is required or optional.

Type: Boolean

Required: No

ScheduledBy

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

Type: String

Valid Values: CUSTOMER | SYSTEM

Required: No

Status

The current status of the scheduled action.

Type: String

Valid Values: PENDING_UPDATE | IN_PROGRESS | FAILED | COMPLETED | NOT_ELIGIBLE | ELIGIBLE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: