scheduled_actions

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

Overview

Name	scheduled_actions
Type	Resource
Id	aws.opensearch.scheduled_actions

Fields

The following fields are returned by SELECT queries:

list_scheduled_actions

Name	Datatype	Description
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.
scheduled_actions	array	A list of actions that are scheduled for the domain.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_scheduled_actions	select	domain_name, region	maxResults, nextToken	Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.
update_scheduled_action	update	domain_name, region, ActionID, ActionType, ScheduleAt		Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

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 to reschedule an action for.
region	string	AWS region (default: us-east-1)
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 ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

SELECT examples

list_scheduled_actions

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

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

UPDATE examples

update_scheduled_action

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

UPDATE aws.opensearch.scheduled_actions
SET 
ActionID = '{{ ActionID }}',
ActionType = '{{ ActionType }}',
ScheduleAt = '{{ ScheduleAt }}',
DesiredStartTime = {{ DesiredStartTime }}
WHERE 
domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
AND ActionID = '{{ ActionID }}' --required
AND ActionType = '{{ ActionType }}' --required
AND ScheduleAt = '{{ ScheduleAt }}' --required
RETURNING
scheduled_action;