:doc:`OpenSearchService <../../opensearch>` / Client / get_domain_maintenance_status

*****************************
get_domain_maintenance_status
*****************************



.. py:method:: OpenSearchService.Client.get_domain_maintenance_status(**kwargs)

  

  The status of the maintenance action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDomainMaintenanceStatus>`_  


  **Request Syntax**
  ::

    response = client.get_domain_maintenance_status(
        DomainName='string',
        MaintenanceId='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The name of the domain.

    

  
  :type MaintenanceId: string
  :param MaintenanceId: **[REQUIRED]** 

    The request ID of the maintenance action.

    

  
  
  :rtype: 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**
  
  *   :py:class:`OpenSearchService.Client.exceptions.BaseException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.InternalException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.ValidationException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.DisabledOperationException`

  