incident.getScheduleRotation

incident 7.0.0, Sep 11 26

Viewing docs for incident 7.0.0
published on Friday, Sep 11, 2026 by incident-io

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  # Useful for pointing an escalation path at one rotation rather than the whole
  # schedule, when the rotation itself isn't managed here.
  platform:
    type: incident:EscalationPath
    properties:
      name: Platform
      path:
        - type: level
          level:
            targets:
              - type: schedule
                id: ${platformIncidentSchedule.id}
                urgency: high
                scheduleMode: all_users_for_rota
                selectedRotaId: ${primary.id}
variables:
  # Look up a rotation by name. Names are unique within a schedule, so this is
  # unambiguous.
  primary:
    fn::invoke:
      function: incident:getScheduleRotation
      arguments:
        scheduleId: ${platformIncidentSchedule.id}
        name: Primary
  # ...or by ID.
  primaryById:
    fn::invoke:
      function: incident:getScheduleRotation
      arguments:
        scheduleId: ${platformIncidentSchedule.id}
        id: 01MNO456PQR789STU012VWX

Example coming soon!

Using getScheduleRotation

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 getScheduleRotation(args: GetScheduleRotationArgs, opts?: InvokeOptions): Promise<GetScheduleRotationResult>
function getScheduleRotationOutput(args: GetScheduleRotationOutputArgs, opts?: InvokeOutputOptions): Output<GetScheduleRotationResult>

def get_schedule_rotation(id: Optional[str] = None,
                          name: Optional[str] = None,
                          schedule_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetScheduleRotationResult
def get_schedule_rotation_output(id: pulumi.Input[Optional[str]] = None,
                          name: pulumi.Input[Optional[str]] = None,
                          schedule_id: pulumi.Input[Optional[str]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetScheduleRotationResult]

func LookupScheduleRotation(ctx *Context, args *LookupScheduleRotationArgs, opts ...InvokeOption) (*LookupScheduleRotationResult, error)
func LookupScheduleRotationOutput(ctx *Context, args *LookupScheduleRotationOutputArgs, opts ...InvokeOption) LookupScheduleRotationResultOutput

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

public static class GetScheduleRotation 
{
    public static Task<GetScheduleRotationResult> InvokeAsync(GetScheduleRotationArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleRotationResult> Invoke(GetScheduleRotationInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleRotationResult> Invoke(GetScheduleRotationInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetScheduleRotationResult> getScheduleRotation(GetScheduleRotationArgs args, InvokeOptions options)
public static Output<GetScheduleRotationResult> getScheduleRotation(GetScheduleRotationArgs args, InvokeOptions options)
public static Output<GetScheduleRotationResult> getScheduleRotation(GetScheduleRotationArgs args, InvokeOutputOptions options)

fn::invoke:
  function: incident:index/getScheduleRotation:getScheduleRotation
  arguments:
    # arguments dictionary

data "incident_get_schedule_rotation" "name" {
    # arguments
}

The following arguments are supported:

ScheduleId string: ID of the schedule this rotation belongs to
Id string: Look up the rotation by ID.
Name string: Look up the rotation by name, which is unique within the schedule.

ScheduleId string: ID of the schedule this rotation belongs to
Id string: Look up the rotation by ID.
Name string: Look up the rotation by name, which is unique within the schedule.

schedule_id string: ID of the schedule this rotation belongs to
id string: Look up the rotation by ID.
name string: Look up the rotation by name, which is unique within the schedule.

scheduleId String: ID of the schedule this rotation belongs to
id String: Look up the rotation by ID.
name String: Look up the rotation by name, which is unique within the schedule.

scheduleId string: ID of the schedule this rotation belongs to
id string: Look up the rotation by ID.
name string: Look up the rotation by name, which is unique within the schedule.

schedule_id str: ID of the schedule this rotation belongs to
id str: Look up the rotation by ID.
name str: Look up the rotation by name, which is unique within the schedule.

scheduleId String: ID of the schedule this rotation belongs to
id String: Look up the rotation by ID.
name String: Look up the rotation by name, which is unique within the schedule.

getScheduleRotation Result

The following output properties are available:

ConcurrentShifts double: How many shifts run at the same time, which is how many people are on call at once
EffectiveFrom string: When this shape of the rotation took over. Unset when the rotation has only ever had one.
FirstIntervalStartsAt string: When the first handover interval starts being counted from, which fixes the time of day and day of week shifts change hands. The dashboard calls this the handover time.
Handovers List<GetScheduleRotationHandover>: The cadence shifts hand over on, applied in turn
Id string: Look up the rotation by ID.
Name string: Look up the rotation by name, which is unique within the schedule.
Rank double: Where this rotation sits in the schedule's running order, lowest first. Unset when it has never been ordered.
ScheduleId string: ID of the schedule this rotation belongs to
SchedulingMode string: How users are allocated across shifts of differing length. Possible values are: fair, sequential.
Users List<string>: IDs of the people in the rotation, in the order they take shifts.
WorkingIntervals List<GetScheduleRotationWorkingInterval>: Weekday intervals the rotation is on call for, if it's restricted to any.

ConcurrentShifts float64: How many shifts run at the same time, which is how many people are on call at once
EffectiveFrom string: When this shape of the rotation took over. Unset when the rotation has only ever had one.
FirstIntervalStartsAt string: When the first handover interval starts being counted from, which fixes the time of day and day of week shifts change hands. The dashboard calls this the handover time.
Handovers []GetScheduleRotationHandover: The cadence shifts hand over on, applied in turn
Id string: Look up the rotation by ID.
Name string: Look up the rotation by name, which is unique within the schedule.
Rank float64: Where this rotation sits in the schedule's running order, lowest first. Unset when it has never been ordered.
ScheduleId string: ID of the schedule this rotation belongs to
SchedulingMode string: How users are allocated across shifts of differing length. Possible values are: fair, sequential.
Users []string: IDs of the people in the rotation, in the order they take shifts.
WorkingIntervals []GetScheduleRotationWorkingInterval: Weekday intervals the rotation is on call for, if it's restricted to any.

concurrent_shifts number: How many shifts run at the same time, which is how many people are on call at once
effective_from string: When this shape of the rotation took over. Unset when the rotation has only ever had one.
first_interval_starts_at string: When the first handover interval starts being counted from, which fixes the time of day and day of week shifts change hands. The dashboard calls this the handover time.
handovers list(object): The cadence shifts hand over on, applied in turn
id string: Look up the rotation by ID.
name string: Look up the rotation by name, which is unique within the schedule.
rank number: Where this rotation sits in the schedule's running order, lowest first. Unset when it has never been ordered.
schedule_id string: ID of the schedule this rotation belongs to
scheduling_mode string: How users are allocated across shifts of differing length. Possible values are: fair, sequential.
users list(string): IDs of the people in the rotation, in the order they take shifts.
working_intervals list(object): Weekday intervals the rotation is on call for, if it's restricted to any.

concurrentShifts Double: How many shifts run at the same time, which is how many people are on call at once
effectiveFrom String: When this shape of the rotation took over. Unset when the rotation has only ever had one.
firstIntervalStartsAt String: When the first handover interval starts being counted from, which fixes the time of day and day of week shifts change hands. The dashboard calls this the handover time.
handovers List<GetScheduleRotationHandover>: The cadence shifts hand over on, applied in turn
id String: Look up the rotation by ID.
name String: Look up the rotation by name, which is unique within the schedule.
rank Double: Where this rotation sits in the schedule's running order, lowest first. Unset when it has never been ordered.
scheduleId String: ID of the schedule this rotation belongs to
schedulingMode String: How users are allocated across shifts of differing length. Possible values are: fair, sequential.
users List<String>: IDs of the people in the rotation, in the order they take shifts.
workingIntervals List<GetScheduleRotationWorkingInterval>: Weekday intervals the rotation is on call for, if it's restricted to any.

concurrentShifts number: How many shifts run at the same time, which is how many people are on call at once
effectiveFrom string: When this shape of the rotation took over. Unset when the rotation has only ever had one.
firstIntervalStartsAt string: When the first handover interval starts being counted from, which fixes the time of day and day of week shifts change hands. The dashboard calls this the handover time.
handovers GetScheduleRotationHandover[]: The cadence shifts hand over on, applied in turn
id string: Look up the rotation by ID.
name string: Look up the rotation by name, which is unique within the schedule.
rank number: Where this rotation sits in the schedule's running order, lowest first. Unset when it has never been ordered.
scheduleId string: ID of the schedule this rotation belongs to
schedulingMode string: How users are allocated across shifts of differing length. Possible values are: fair, sequential.
users string[]: IDs of the people in the rotation, in the order they take shifts.
workingIntervals GetScheduleRotationWorkingInterval[]: Weekday intervals the rotation is on call for, if it's restricted to any.

concurrent_shifts float: How many shifts run at the same time, which is how many people are on call at once
effective_from str: When this shape of the rotation took over. Unset when the rotation has only ever had one.
first_interval_starts_at str: When the first handover interval starts being counted from, which fixes the time of day and day of week shifts change hands. The dashboard calls this the handover time.
handovers Sequence[GetScheduleRotationHandover]: The cadence shifts hand over on, applied in turn
id str: Look up the rotation by ID.
name str: Look up the rotation by name, which is unique within the schedule.
rank float: Where this rotation sits in the schedule's running order, lowest first. Unset when it has never been ordered.
schedule_id str: ID of the schedule this rotation belongs to
scheduling_mode str: How users are allocated across shifts of differing length. Possible values are: fair, sequential.
users Sequence[str]: IDs of the people in the rotation, in the order they take shifts.
working_intervals Sequence[GetScheduleRotationWorkingInterval]: Weekday intervals the rotation is on call for, if it's restricted to any.

concurrentShifts Number: How many shifts run at the same time, which is how many people are on call at once
effectiveFrom String: When this shape of the rotation took over. Unset when the rotation has only ever had one.
firstIntervalStartsAt String: When the first handover interval starts being counted from, which fixes the time of day and day of week shifts change hands. The dashboard calls this the handover time.
handovers List<Property Map>: The cadence shifts hand over on, applied in turn
id String: Look up the rotation by ID.
name String: Look up the rotation by name, which is unique within the schedule.
rank Number: Where this rotation sits in the schedule's running order, lowest first. Unset when it has never been ordered.
scheduleId String: ID of the schedule this rotation belongs to
schedulingMode String: How users are allocated across shifts of differing length. Possible values are: fair, sequential.
users List<String>: IDs of the people in the rotation, in the order they take shifts.
workingIntervals List<Property Map>: Weekday intervals the rotation is on call for, if it's restricted to any.

Supporting Types

GetScheduleRotationHandover

Interval double: How many of the interval type to wait between handovers.
IntervalType string: How often a handover occurs. Possible values are: hourly, daily, weekly.

Interval float64: How many of the interval type to wait between handovers.
IntervalType string: How often a handover occurs. Possible values are: hourly, daily, weekly.

interval number: How many of the interval type to wait between handovers.
interval_type string: How often a handover occurs. Possible values are: hourly, daily, weekly.

interval Double: How many of the interval type to wait between handovers.
intervalType String: How often a handover occurs. Possible values are: hourly, daily, weekly.

interval number: How many of the interval type to wait between handovers.
intervalType string: How often a handover occurs. Possible values are: hourly, daily, weekly.

interval float: How many of the interval type to wait between handovers.
interval_type str: How often a handover occurs. Possible values are: hourly, daily, weekly.

interval Number: How many of the interval type to wait between handovers.
intervalType String: How often a handover occurs. Possible values are: hourly, daily, weekly.

GetScheduleRotationWorkingInterval

EndTime string: Time of day this window closes, as HH:MM.
StartTime string: Time of day this window opens, as HH:MM.
Weekday string: Day of the week, lowercase. Possible values are: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

EndTime string: Time of day this window closes, as HH:MM.
StartTime string: Time of day this window opens, as HH:MM.
Weekday string: Day of the week, lowercase. Possible values are: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

end_time string: Time of day this window closes, as HH:MM.
start_time string: Time of day this window opens, as HH:MM.
weekday string: Day of the week, lowercase. Possible values are: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

endTime String: Time of day this window closes, as HH:MM.
startTime String: Time of day this window opens, as HH:MM.
weekday String: Day of the week, lowercase. Possible values are: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

endTime string: Time of day this window closes, as HH:MM.
startTime string: Time of day this window opens, as HH:MM.
weekday string: Day of the week, lowercase. Possible values are: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

end_time str: Time of day this window closes, as HH:MM.
start_time str: Time of day this window opens, as HH:MM.
weekday str: Day of the week, lowercase. Possible values are: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

endTime String: Time of day this window closes, as HH:MM.
startTime String: Time of day this window opens, as HH:MM.
weekday String: Day of the week, lowercase. Possible values are: monday, tuesday, wednesday, thursday, friday, saturday, sunday.

Package Details

Repository: incident incident-io/terraform-provider-incident
License
Notes: This Pulumi package is based on the incident Terraform Provider.

Viewing docs for incident 7.0.0
published on Friday, Sep 11, 2026 by incident-io

Schema (JSON)

incident-io/terraform-provider-incident

incident.getScheduleRotation

On this page

On this page

Example Usage

Using getScheduleRotation

getScheduleRotation Result

Supporting Types

GetScheduleRotationHandover

GetScheduleRotationWorkingInterval

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

incident.getScheduleRotation

On this page

On this page

Example Usage

Using getScheduleRotation

getScheduleRotation Result

Supporting Types

GetScheduleRotationHandover

GetScheduleRotationWorkingInterval

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.