OpenSearchService / Client / start_domain_maintenance

start_domain_maintenance#

OpenSearchService.Client.start_domain_maintenance(**kwargs)#

Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

See also: AWS API Documentation

Request Syntax

response = client.start_domain_maintenance(
    DomainName='string',
    Action='REBOOT_NODE'|'RESTART_SEARCH_PROCESS'|'RESTART_DASHBOARD',
    NodeId='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of the domain.

  • Action (string) –

    [REQUIRED]

    The name of the action.

  • NodeId (string) – The ID of the data node.

Return type:

dict

Returns:

Response Syntax

{
    'MaintenanceId': 'string'
}

Response Structure

  • (dict) –

    The result of a StartDomainMaintenance request that information about the requested action.

    • MaintenanceId (string) –

      The request ID of requested action.

Exceptions

  • OpenSearchService.Client.exceptions.BaseException

  • OpenSearchService.Client.exceptions.InternalException

  • OpenSearchService.Client.exceptions.ResourceNotFoundException

  • OpenSearchService.Client.exceptions.ValidationException

  • OpenSearchService.Client.exceptions.DisabledOperationException