OpenSearchService / Client / get_domain_maintenance_status

get_domain_maintenance_status#

OpenSearchService.Client.get_domain_maintenance_status(**kwargs)#

The status of the maintenance action.

Request Syntax

response = client.get_domain_maintenance_status(
    DomainName='string',
    MaintenanceId='string'
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain.
MaintenanceId (string) –
[REQUIRED]

The request ID of the maintenance action.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'TIMED_OUT',
    'StatusMessage': 'string',
    'NodeId': 'string',
    'Action': 'REBOOT_NODE'|'RESTART_SEARCH_PROCESS'|'RESTART_DASHBOARD',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –

The result of a GetDomainMaintenanceStatus request that information about the requested action.
- Status (string) –
  
  The status of the maintenance action.
- StatusMessage (string) –
  
  The status message of the maintenance action.
- NodeId (string) –
  
  The node ID of the maintenance action.
- Action (string) –
  
  The action name.
- CreatedAt (datetime) –
  
  The time at which the action was created.
- UpdatedAt (datetime) –
  
  The time at which the action was updated.

Exceptions

OpenSearchService.Client.exceptions.BaseException
OpenSearchService.Client.exceptions.InternalException
OpenSearchService.Client.exceptions.ResourceNotFoundException
OpenSearchService.Client.exceptions.ValidationException
OpenSearchService.Client.exceptions.DisabledOperationException