UpdateScheduledReportInput is used to input data for updating a scheduled report.

Table: UpdateScheduledReportInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Feb 26, 2025
dashboardIdstring  Long-TermThe unique identifier of the dashboard for which the report was created.
descriptionstring  Long-TermDescription of the scheduled report.
enabledbooleanyes Long-TermFlag indicating whether the scheduled report is enabled.
idstringyes Long-TermThe unique identifier of the scheduled report.
labels[string]yes Long-TermLabels attached to the scheduled report.
layoutUpdateScheduledReportLayoutInput  Long-TermLayout of the scheduled report. See UpdateScheduledReportLayoutInput.
namestring  Long-TermThe name of the scheduled report.
parameters[UpdateScheduledReportParameterValueInput]yes Long-TermA list of parameter value configurations. See UpdateScheduledReportParameterValueInput.
passwordstring  Long-TermThe password used to protect any generated reports.
recipients[string]  Long-TermA list of recipients who should receive an email with the generated report.
scheduleUpdateScheduledReportScheduleInput  Long-TermThe schedule by which to run the report. See UpdateScheduledReportScheduleInput.
timeIntervalFromstring  Long-TermThe start of the relative time interval for the dashboard.
viewNamestringyes Long-TermThe name of the view of the scheduled report.