v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

The status of the maintenance action.

get/2021-01-01/opensearch/domain/{DomainName}/domainMaintenance#maintenanceId

Path parameters

DomainNamestring required

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

The name of the domain.

Query parameters

maintenanceIdstring required

The request ID of the maintenance action.

Response

Success

Status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT'

The status of the maintenance action.

StatusMessagestring

The status message of the maintenance action.

NodeIdstring

The node ID of the maintenance action.

Action'REBOOT_NODE' | 'RESTART_SEARCH_PROCESS' | 'RESTART_DASHBOARD'

The action name.

CreatedAtstring date-time

The time at which the action was created.

UpdatedAtstring date-time

The time at which the action was updated.