domain_maintenances

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

Overview

Name	domain_maintenances
Type	Resource
Id	aws.opensearch.domain_maintenances

Fields

The following fields are returned by SELECT queries:

list_domain_maintenances

Name	Datatype	Description
domain_maintenances	array	A list of the submitted maintenance actions.
next_token	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_domain_maintenances	select	domain_name, region	action, status, maxResults, nextToken	A list of maintenance actions for the domain.

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.
region	string	AWS region (default: us-east-1)
action	string	The name 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.
status	string	The status of the action.

SELECT examples

list_domain_maintenances

A list of maintenance actions for the domain.

SELECT
domain_maintenances,
next_token
FROM aws.opensearch.domain_maintenances
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND action = '{{ action }}'
AND status = '{{ status }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;