Amazon OpenSearch Service

Get the list of the maintenance action.

See also: AWS API Documentation

Request Syntax

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 , you can 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. Contains information about the requested actions.

  • DomainMaintenances (list) --

    List of the submitted maintenance actions.

    • (dict) --

      Container for the domain maintenance details.

      • MaintenanceId (string) --

        Id of the requested action.

      • DomainName (string) --

        The name of the domain.

      • Action (string) --

        The name of the action.

      • NodeId (string) --

        Id of the data node.

      • Status (string) --

        The status of the action.

      • StatusMessage (string) --

        The status message of the action.

      • CreatedAt (datetime) --

        Contains time at which action created.

      • UpdatedAt (datetime) --

        Contains time at which action updated.

  • NextToken (string) --

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

Get the status of the maintenance action.

See also: AWS API Documentation

Request Syntax

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. Contains information about the requested action.

  • Status (string) --

    Contains status of the maintenance action.

  • StatusMessage (string) --

    Contains status message of the maintenance action.

  • NodeId (string) --

    Contains node id of maintenance action.

  • Action (string) --

    Contains action name.

  • CreatedAt (datetime) --

    Contains time at which action created.

  • UpdatedAt (datetime) --

    Contains time at which action updated.

Starts the node maintenance (Node restart, Node reboot, Opensearch/Elasticsearch process restart, Dashboard/kibana restart) on the data node.

See also: AWS API Documentation

Request Syntax

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

type DomainName

string

param DomainName

[REQUIRED]

The name of the domain.

type Action

string

param Action

[REQUIRED]

The name of the action.

type NodeId

string

param NodeId

Id of the data node.

rtype

dict

returns

Response Syntax

{
    'MaintenanceId': 'string'
}

Response Structure

• (dict) --

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

  • MaintenanceId (string) --

    Contains request id of requested action.