The UpdateScheduledSearch datatype includes various settings.

Table: UpdateScheduledSearch

ParameterTypeRequired[a]DefaultDescription
viewNamestringyes Name of the view of the scheduled search.
tttstringyes The unique identifier of the scheduled search.
namestringyes The name of the scheduled search.
descriptionstring  Description of the scheduled search.
queryStringstringyes The LogScale query to execute.
queryStartstringyes The start of the relative time interval for the query.
queryEndstringyes The end of the relative time interval for the query.
schedulestringyes The cron pattern describing the schedule on which to execute the query.
timeZonestringyes Time zone of the schedule. Currently this field only supports UTC offsets like 'UTC', 'UTC-01' or 'UTC+12:45'.
backfillLimitintegeryes User-defined limit, which caps the number of missed searches to backfill, e.g. in the event of a shutdown.
enabledbooleanyes Flag indicating whether the scheduled search is enabled.
actions[string]yes List of unique identifier for actions to execute on query result.
labels[string]yes Labels attached to the scheduled search.
runAsUserIdstringyes The scheduled search or alert will run as the user with this id. If not specified, the calling user will be used. It requires a special permission to set the run as user to a different user than the calling user.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.