Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getScheduledExport
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.getScheduledExport

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A Scheduled Export defines a recurring schedule for generating one of the built-in CSV exports and e-mailing it to a Site Admin recipient.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleScheduledExport = filescom.getScheduledExport({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_scheduled_export = filescom.get_scheduled_export(id=1)

    package main

import (
	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filescom.GetScheduledExport(ctx, &filescom.LookupScheduledExportArgs{
			Id: 1,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;

return await Deployment.RunAsync(() => 
{
    var exampleScheduledExport = Filescom.GetScheduledExport.Invoke(new()
    {
        Id = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FilescomFunctions;
import com.pulumi.filescom.inputs.GetScheduledExportArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleScheduledExport = FilescomFunctions.getScheduledExport(GetScheduledExportArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  exampleScheduledExport:
    fn::invoke:
      function: filescom:getScheduledExport
      arguments:
        id: 1

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

data "filescom_getscheduledexport" "exampleScheduledExport" {
  id = 1
}

    Using getScheduledExport

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getScheduledExport(args: GetScheduledExportArgs, opts?: InvokeOptions): Promise<GetScheduledExportResult>
function getScheduledExportOutput(args: GetScheduledExportOutputArgs, opts?: InvokeOutputOptions): Output<GetScheduledExportResult>
    def get_scheduled_export(id: Optional[int] = None,
                         opts: Optional[InvokeOptions] = None) -> GetScheduledExportResult
def get_scheduled_export_output(id: pulumi.Input[Optional[int]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetScheduledExportResult]
    func LookupScheduledExport(ctx *Context, args *LookupScheduledExportArgs, opts ...InvokeOption) (*LookupScheduledExportResult, error)
func LookupScheduledExportOutput(ctx *Context, args *LookupScheduledExportOutputArgs, opts ...InvokeOption) LookupScheduledExportResultOutput

    > Note: This function is named LookupScheduledExport in the Go SDK.

    public static class GetScheduledExport 
{
    public static Task<GetScheduledExportResult> InvokeAsync(GetScheduledExportArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledExportResult> Invoke(GetScheduledExportInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledExportResult> Invoke(GetScheduledExportInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetScheduledExportResult> getScheduledExport(GetScheduledExportArgs args, InvokeOptions options)
public static Output<GetScheduledExportResult> getScheduledExport(GetScheduledExportArgs args, InvokeOptions options)
public static Output<GetScheduledExportResult> getScheduledExport(GetScheduledExportArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getScheduledExport:getScheduledExport
  arguments:
    # arguments dictionary
    data "filescom_get_scheduled_export" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    Scheduled Export ID
    Id int
    Scheduled Export ID
    id number
    Scheduled Export ID
    id Integer
    Scheduled Export ID
    id number
    Scheduled Export ID
    id int
    Scheduled Export ID
    id Number
    Scheduled Export ID

    getScheduledExport Result

    The following output properties are available:

    CreatedAt string
    Creation time.
    Disabled bool
    If true, this scheduled export will not run.
    ExportOptions object
    Report-specific options. permissionAudit supports groupBy with user or path.
    ExportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    HolidayRegion string
    Optional holiday region used by the scheduled export schedule.
    HumanReadableSchedule string
    Human-readable schedule description.
    Id int
    Scheduled Export ID
    Interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    LastExportId int
    Most recent Export ID created by this schedule.
    LastRunAt string
    Most recent scheduled run time.
    Name string
    Name for this scheduled export.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays List<int>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ReportName string
    Human-readable report name.
    ScheduleDaysOfWeeks List<int>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    ScheduleTimeZone string
    Time zone used by the scheduled export schedule.
    ScheduleTimesOfDays List<string>
    Times of day in HH:MM format for the scheduled export schedule.
    Trigger string
    Schedule trigger type: daily or customSchedule.
    UpdatedAt string
    Last update time.
    UserId int
    Site Admin user who receives the completed export e-mail.
    CreatedAt string
    Creation time.
    Disabled bool
    If true, this scheduled export will not run.
    ExportOptions interface{}
    Report-specific options. permissionAudit supports groupBy with user or path.
    ExportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    HolidayRegion string
    Optional holiday region used by the scheduled export schedule.
    HumanReadableSchedule string
    Human-readable schedule description.
    Id int
    Scheduled Export ID
    Interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    LastExportId int
    Most recent Export ID created by this schedule.
    LastRunAt string
    Most recent scheduled run time.
    Name string
    Name for this scheduled export.
    RecurringDay int
    If trigger is daily, this selects the day number inside the chosen interval.
    RecurringDays []int
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    ReportName string
    Human-readable report name.
    ScheduleDaysOfWeeks []int
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    ScheduleId int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    ScheduleTimeZone string
    Time zone used by the scheduled export schedule.
    ScheduleTimesOfDays []string
    Times of day in HH:MM format for the scheduled export schedule.
    Trigger string
    Schedule trigger type: daily or customSchedule.
    UpdatedAt string
    Last update time.
    UserId int
    Site Admin user who receives the completed export e-mail.
    created_at string
    Creation time.
    disabled bool
    If true, this scheduled export will not run.
    export_options any
    Report-specific options. permissionAudit supports groupBy with user or path.
    export_type string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holiday_region string
    Optional holiday region used by the scheduled export schedule.
    human_readable_schedule string
    Human-readable schedule description.
    id number
    Scheduled Export ID
    interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    last_export_id number
    Most recent Export ID created by this schedule.
    last_run_at string
    Most recent scheduled run time.
    name string
    Name for this scheduled export.
    recurring_day number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days list(number)
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    report_name string
    Human-readable report name.
    schedule_days_of_weeks list(number)
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    schedule_time_zone string
    Time zone used by the scheduled export schedule.
    schedule_times_of_days list(string)
    Times of day in HH:MM format for the scheduled export schedule.
    trigger string
    Schedule trigger type: daily or customSchedule.
    updated_at string
    Last update time.
    user_id number
    Site Admin user who receives the completed export e-mail.
    createdAt String
    Creation time.
    disabled Boolean
    If true, this scheduled export will not run.
    exportOptions Object
    Report-specific options. permissionAudit supports groupBy with user or path.
    exportType String
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holidayRegion String
    Optional holiday region used by the scheduled export schedule.
    humanReadableSchedule String
    Human-readable schedule description.
    id Integer
    Scheduled Export ID
    interval String
    If trigger is daily, this specifies how often to run the scheduled export.
    lastExportId Integer
    Most recent Export ID created by this schedule.
    lastRunAt String
    Most recent scheduled run time.
    name String
    Name for this scheduled export.
    recurringDay Integer
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Integer>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    reportName String
    Human-readable report name.
    scheduleDaysOfWeeks List<Integer>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Integer
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone String
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the scheduled export schedule.
    trigger String
    Schedule trigger type: daily or customSchedule.
    updatedAt String
    Last update time.
    userId Integer
    Site Admin user who receives the completed export e-mail.
    createdAt string
    Creation time.
    disabled boolean
    If true, this scheduled export will not run.
    exportOptions any
    Report-specific options. permissionAudit supports groupBy with user or path.
    exportType string
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holidayRegion string
    Optional holiday region used by the scheduled export schedule.
    humanReadableSchedule string
    Human-readable schedule description.
    id number
    Scheduled Export ID
    interval string
    If trigger is daily, this specifies how often to run the scheduled export.
    lastExportId number
    Most recent Export ID created by this schedule.
    lastRunAt string
    Most recent scheduled run time.
    name string
    Name for this scheduled export.
    recurringDay number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays number[]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    reportName string
    Human-readable report name.
    scheduleDaysOfWeeks number[]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone string
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays string[]
    Times of day in HH:MM format for the scheduled export schedule.
    trigger string
    Schedule trigger type: daily or customSchedule.
    updatedAt string
    Last update time.
    userId number
    Site Admin user who receives the completed export e-mail.
    created_at str
    Creation time.
    disabled bool
    If true, this scheduled export will not run.
    export_options Any
    Report-specific options. permissionAudit supports groupBy with user or path.
    export_type str
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holiday_region str
    Optional holiday region used by the scheduled export schedule.
    human_readable_schedule str
    Human-readable schedule description.
    id int
    Scheduled Export ID
    interval str
    If trigger is daily, this specifies how often to run the scheduled export.
    last_export_id int
    Most recent Export ID created by this schedule.
    last_run_at str
    Most recent scheduled run time.
    name str
    Name for this scheduled export.
    recurring_day int
    If trigger is daily, this selects the day number inside the chosen interval.
    recurring_days Sequence[int]
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    report_name str
    Human-readable report name.
    schedule_days_of_weeks Sequence[int]
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    schedule_id int
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    schedule_time_zone str
    Time zone used by the scheduled export schedule.
    schedule_times_of_days Sequence[str]
    Times of day in HH:MM format for the scheduled export schedule.
    trigger str
    Schedule trigger type: daily or customSchedule.
    updated_at str
    Last update time.
    user_id int
    Site Admin user who receives the completed export e-mail.
    createdAt String
    Creation time.
    disabled Boolean
    If true, this scheduled export will not run.
    exportOptions Any
    Report-specific options. permissionAudit supports groupBy with user or path.
    exportType String
    Export report type. Valid values: foldersizeaudit, groupmembershipaudit, permissionaudit, sharelink_audit
    holidayRegion String
    Optional holiday region used by the scheduled export schedule.
    humanReadableSchedule String
    Human-readable schedule description.
    id Number
    Scheduled Export ID
    interval String
    If trigger is daily, this specifies how often to run the scheduled export.
    lastExportId Number
    Most recent Export ID created by this schedule.
    lastRunAt String
    Most recent scheduled run time.
    name String
    Name for this scheduled export.
    recurringDay Number
    If trigger is daily, this selects the day number inside the chosen interval.
    recurringDays List<Number>
    If trigger is daily, this selects one or more day numbers inside a week, month, quarter, or year interval.
    reportName String
    Human-readable report name.
    scheduleDaysOfWeeks List<Number>
    If trigger is customSchedule, the 0-based weekdays used by the schedule.
    scheduleId Number
    If trigger is customSchedule, the reusable Schedule used instead of the scheduled export's schedule fields.
    scheduleTimeZone String
    Time zone used by the scheduled export schedule.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format for the scheduled export schedule.
    trigger String
    Schedule trigger type: daily or customSchedule.
    updatedAt String
    Last update time.
    userId Number
    Site Admin user who receives the completed export e-mail.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial