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 | LOWRequired: 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_TUNINGRequired: 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 | SYSTEMRequired: No
- Status
-
The current status of the scheduled action.
Type: String
Valid Values:
PENDING_UPDATE | IN_PROGRESS | FAILED | COMPLETED | NOT_ELIGIBLE | ELIGIBLERequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
