Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

A list of maintenance actions for the domain.

get/2021-01-01/opensearch/domain/{DomainName}/domainMaintenances

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

action'REBOOT_NODE' | 'RESTART_SEARCH_PROCESS' | 'RESTART_DASHBOARD'

The name of the action.

status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT'

The status of the action.

maxResultsinteger

An optional parameter that specifies the maximum number of results to return for a given request.

An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.

nextTokenstring

When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

If your initial <code>ListDomainMaintenances</code> operation returns a <code>nextToken</code>, include the returned <code>nextToken</code> in subsequent <code>ListDomainMaintenances</code> operations, which returns results in the next page.

Response

Success

NextTokenstring

When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.