domain_maintenance_status

Creates, updates, deletes, gets or lists a domain_maintenance_status resource.

Overview

Name	domain_maintenance_status
Type	Resource
Id	aws.opensearch.domain_maintenance_status

Fields

The following fields are returned by SELECT queries:

get_domain_maintenance_status

Name	Datatype	Description
action	string	The action name. (REBOOT_NODE, RESTART_SEARCH_PROCESS, RESTART_DASHBOARD)
created_at	string (date-time)	The time at which the action was created.
node_id	string	The node ID of the maintenance action.
status	string	The status of the maintenance action. (PENDING, IN_PROGRESS, COMPLETED, FAILED, TIMED_OUT)
status_message	string	The status message of the maintenance action. (pattern: <code>^([\s\S]*)$</code>)
updated_at	string (date-time)	The time at which the action was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_domain_maintenance_status	select	domain_name, maintenanceId, region		The status of the maintenance action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_name	string	The name of the domain.
maintenanceId	string	The request ID of the maintenance action.
region	string	AWS region (default: us-east-1)

SELECT examples

get_domain_maintenance_status

The status of the maintenance action.

SELECT
action,
created_at,
node_id,
status,
status_message,
updated_at
FROM aws.opensearch.domain_maintenance_status
WHERE domain_name = '{{ domain_name }}' -- required
AND maintenanceId = '{{ maintenanceId }}' -- required
AND region = '{{ region }}' -- required
;