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

************************
list_domain_maintenances
************************



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

  

  A list of maintenance actions for the domain.

  

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


  **Request Syntax**
  ::

    response = client.list_domain_maintenances(
        DomainName='string',
        Action='REBOOT_NODE'|'RESTART_SEARCH_PROCESS'|'RESTART_DASHBOARD',
        Status='PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'TIMED_OUT',
        MaxResults=123,
        NextToken='string'
    )
    
  :type DomainName: string
  :param DomainName: **[REQUIRED]** 

    The name of the domain.

    

  
  :type Action: string
  :param Action: 

    The name of the action.

    

  
  :type Status: string
  :param Status: 

    The status of the action.

    

  
  :type MaxResults: integer
  :param MaxResults: 

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

    

  
  :type NextToken: string
  :param NextToken: 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'DomainMaintenances': [
              {
                  'MaintenanceId': 'string',
                  'DomainName': 'string',
                  'Action': 'REBOOT_NODE'|'RESTART_SEARCH_PROCESS'|'RESTART_DASHBOARD',
                  'NodeId': 'string',
                  'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'TIMED_OUT',
                  'StatusMessage': 'string',
                  'CreatedAt': datetime(2015, 1, 1),
                  'UpdatedAt': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The result of a ``ListDomainMaintenances`` request that contains information about the requested actions.

      
      

      - **DomainMaintenances** *(list) --* 

        A list of the submitted maintenance actions.

        
        

        - *(dict) --* 

          Container for the domain maintenance details.

          
          

          - **MaintenanceId** *(string) --* 

            The ID of the requested action.

            
          

          - **DomainName** *(string) --* 

            The name of the domain.

            
          

          - **Action** *(string) --* 

            The name of the action.

            
          

          - **NodeId** *(string) --* 

            The ID of the data node.

            
          

          - **Status** *(string) --* 

            The status of the action.

            
          

          - **StatusMessage** *(string) --* 

            The status message for the action.

            
          

          - **CreatedAt** *(datetime) --* 

            The time at which the action was created.

            
          

          - **UpdatedAt** *(datetime) --* 

            The time at which the action was updated.

            
      
    
      

      - **NextToken** *(string) --* 

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

        
  
  **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`

  