OpenSearchService / Client / list_domain_maintenances

list_domain_maintenances#

OpenSearchService.Client.list_domain_maintenances(**kwargs)#

A list of maintenance actions for the domain.

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'
)

Parameters:

DomainName (string) –
[REQUIRED]

The name of the domain.
Action (string) – The name of the action.
Status (string) – The status of the action.
MaxResults (integer) – An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
NextToken (string) – If your initial ListDomainMaintenances operation returns a nextToken, include the returned nextToken in subsequent ListDomainMaintenances operations, which returns results in the next page.

Return type:

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

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