1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ResourceScheduler
  5. getSchedule
Viewing docs for Oracle Cloud Infrastructure v4.4.0
published on Thursday, Mar 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.ResourceScheduler.getSchedule

oci logo
Viewing docs for Oracle Cloud Infrastructure v4.4.0
published on Thursday, Mar 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Schedule resource in Oracle Cloud Infrastructure Resource Scheduler service.

    This API gets information about a schedule.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSchedule = oci.ResourceScheduler.getSchedule({
    scheduleId: testScheduleOciResourceSchedulerSchedule.id,
});

    import pulumi
import pulumi_oci as oci

test_schedule = oci.ResourceScheduler.get_schedule(schedule_id=test_schedule_oci_resource_scheduler_schedule["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v4/go/oci/resourcescheduler"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcescheduler.GetSchedule(ctx, &resourcescheduler.GetScheduleArgs{
			ScheduleId: testScheduleOciResourceSchedulerSchedule.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSchedule = Oci.ResourceScheduler.GetSchedule.Invoke(new()
    {
        ScheduleId = testScheduleOciResourceSchedulerSchedule.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ResourceScheduler.ResourceSchedulerFunctions;
import com.pulumi.oci.ResourceScheduler.inputs.GetScheduleArgs;
import java.util.List;
import java.util.ArrayList;
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 testSchedule = ResourceSchedulerFunctions.getSchedule(GetScheduleArgs.builder()
            .scheduleId(testScheduleOciResourceSchedulerSchedule.id())
            .build());

    }
}

    variables:
  testSchedule:
    fn::invoke:
      function: oci:ResourceScheduler:getSchedule
      arguments:
        scheduleId: ${testScheduleOciResourceSchedulerSchedule.id}

    Using getSchedule

    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 getSchedule(args: GetScheduleArgs, opts?: InvokeOptions): Promise<GetScheduleResult>
function getScheduleOutput(args: GetScheduleOutputArgs, opts?: InvokeOptions): Output<GetScheduleResult>
    def get_schedule(schedule_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetScheduleResult
def get_schedule_output(schedule_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetScheduleResult]
    func LookupSchedule(ctx *Context, args *LookupScheduleArgs, opts ...InvokeOption) (*LookupScheduleResult, error)
func LookupScheduleOutput(ctx *Context, args *LookupScheduleOutputArgs, opts ...InvokeOption) LookupScheduleResultOutput

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

    public static class GetSchedule 
{
    public static Task<GetScheduleResult> InvokeAsync(GetScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleResult> Invoke(GetScheduleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
public static Output<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:ResourceScheduler/getSchedule:getSchedule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ScheduleId string
    This is the OCID of the schedule.
    ScheduleId string
    This is the OCID of the schedule.
    scheduleId String
    This is the OCID of the schedule.
    scheduleId string
    This is the OCID of the schedule.
    schedule_id str
    This is the OCID of the schedule.
    scheduleId String
    This is the OCID of the schedule.

    getSchedule Result

    The following output properties are available:

    Action string
    This is the action that will be executed by the schedule.
    CompartmentId string
    The OCID of the compartment in which the schedule is created
    DefinedTags Dictionary<string, string>
    These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    This is the description of the schedule.
    DisplayName string
    This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
    FreeformTags Dictionary<string, string>
    These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    This is the resource OCID.
    LastRunStatus string
    This is the status of the last work request.
    RecurrenceDetails string
    This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
    RecurrenceType string
    Type of recurrence of a schedule
    ResourceFilters List<GetScheduleResourceFilter>
    This is a list of resources filters. The schedule will be applied to resources matching all of them.
    Resources List<GetScheduleResource>
    This is the list of resources to which the scheduled operation is applied.
    ScheduleId string
    State string
    This is the current state of a schedule.
    SystemTags Dictionary<string, string>
    These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    This is the date and time the schedule was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeEnds string
    This is the date and time the schedule ends, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeLastRun string
    This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeNextRun string
    This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeStarts string
    This is the date and time the schedule starts, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    This is the date and time the schedule was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    Action string
    This is the action that will be executed by the schedule.
    CompartmentId string
    The OCID of the compartment in which the schedule is created
    DefinedTags map[string]string
    These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    This is the description of the schedule.
    DisplayName string
    This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
    FreeformTags map[string]string
    These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    This is the resource OCID.
    LastRunStatus string
    This is the status of the last work request.
    RecurrenceDetails string
    This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
    RecurrenceType string
    Type of recurrence of a schedule
    ResourceFilters []GetScheduleResourceFilter
    This is a list of resources filters. The schedule will be applied to resources matching all of them.
    Resources []GetScheduleResource
    This is the list of resources to which the scheduled operation is applied.
    ScheduleId string
    State string
    This is the current state of a schedule.
    SystemTags map[string]string
    These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    This is the date and time the schedule was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeEnds string
    This is the date and time the schedule ends, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeLastRun string
    This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeNextRun string
    This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    TimeStarts string
    This is the date and time the schedule starts, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    This is the date and time the schedule was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    action String
    This is the action that will be executed by the schedule.
    compartmentId String
    The OCID of the compartment in which the schedule is created
    definedTags Map<String,String>
    These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    This is the description of the schedule.
    displayName String
    This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
    freeformTags Map<String,String>
    These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    This is the resource OCID.
    lastRunStatus String
    This is the status of the last work request.
    recurrenceDetails String
    This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
    recurrenceType String
    Type of recurrence of a schedule
    resourceFilters List<GetScheduleResourceFilter>
    This is a list of resources filters. The schedule will be applied to resources matching all of them.
    resources List<GetScheduleResource>
    This is the list of resources to which the scheduled operation is applied.
    scheduleId String
    state String
    This is the current state of a schedule.
    systemTags Map<String,String>
    These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    This is the date and time the schedule was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeEnds String
    This is the date and time the schedule ends, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeLastRun String
    This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeNextRun String
    This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeStarts String
    This is the date and time the schedule starts, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    This is the date and time the schedule was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    action string
    This is the action that will be executed by the schedule.
    compartmentId string
    The OCID of the compartment in which the schedule is created
    definedTags {[key: string]: string}
    These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    This is the description of the schedule.
    displayName string
    This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
    freeformTags {[key: string]: string}
    These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    This is the resource OCID.
    lastRunStatus string
    This is the status of the last work request.
    recurrenceDetails string
    This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
    recurrenceType string
    Type of recurrence of a schedule
    resourceFilters GetScheduleResourceFilter[]
    This is a list of resources filters. The schedule will be applied to resources matching all of them.
    resources GetScheduleResource[]
    This is the list of resources to which the scheduled operation is applied.
    scheduleId string
    state string
    This is the current state of a schedule.
    systemTags {[key: string]: string}
    These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    This is the date and time the schedule was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeEnds string
    This is the date and time the schedule ends, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeLastRun string
    This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeNextRun string
    This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeStarts string
    This is the date and time the schedule starts, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    This is the date and time the schedule was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    action str
    This is the action that will be executed by the schedule.
    compartment_id str
    The OCID of the compartment in which the schedule is created
    defined_tags Mapping[str, str]
    These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    This is the description of the schedule.
    display_name str
    This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
    freeform_tags Mapping[str, str]
    These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    This is the resource OCID.
    last_run_status str
    This is the status of the last work request.
    recurrence_details str
    This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
    recurrence_type str
    Type of recurrence of a schedule
    resource_filters Sequence[GetScheduleResourceFilter]
    This is a list of resources filters. The schedule will be applied to resources matching all of them.
    resources Sequence[GetScheduleResource]
    This is the list of resources to which the scheduled operation is applied.
    schedule_id str
    state str
    This is the current state of a schedule.
    system_tags Mapping[str, str]
    These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    This is the date and time the schedule was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_ends str
    This is the date and time the schedule ends, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    time_last_run str
    This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_next_run str
    This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    time_starts str
    This is the date and time the schedule starts, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    time_updated str
    This is the date and time the schedule was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    action String
    This is the action that will be executed by the schedule.
    compartmentId String
    The OCID of the compartment in which the schedule is created
    definedTags Map<String>
    These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    This is the description of the schedule.
    displayName String
    This is a user-friendly name for the schedule. It does not have to be unique, and it's changeable.
    freeformTags Map<String>
    These are free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    This is the resource OCID.
    lastRunStatus String
    This is the status of the last work request.
    recurrenceDetails String
    This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field.
    recurrenceType String
    Type of recurrence of a schedule
    resourceFilters List<Property Map>
    This is a list of resources filters. The schedule will be applied to resources matching all of them.
    resources List<Property Map>
    This is the list of resources to which the scheduled operation is applied.
    scheduleId String
    state String
    This is the current state of a schedule.
    systemTags Map<String>
    These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    This is the date and time the schedule was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeEnds String
    This is the date and time the schedule ends, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeLastRun String
    This is the date and time the schedule runs last time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeNextRun String
    This is the date and time the schedule run the next time, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z
    timeStarts String
    This is the date and time the schedule starts, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    This is the date and time the schedule was updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    GetScheduleResource

    Id string
    This is the resource OCID.
    Metadata Dictionary<string, string>
    This is additional information that helps to identity the resource for the schedule.
    Parameters List<GetScheduleResourceParameter>
    This is the user input parameters to use when acting on the resource.
    Id string
    This is the resource OCID.
    Metadata map[string]string
    This is additional information that helps to identity the resource for the schedule.
    Parameters []GetScheduleResourceParameter
    This is the user input parameters to use when acting on the resource.
    id String
    This is the resource OCID.
    metadata Map<String,String>
    This is additional information that helps to identity the resource for the schedule.
    parameters List<GetScheduleResourceParameter>
    This is the user input parameters to use when acting on the resource.
    id string
    This is the resource OCID.
    metadata {[key: string]: string}
    This is additional information that helps to identity the resource for the schedule.
    parameters GetScheduleResourceParameter[]
    This is the user input parameters to use when acting on the resource.
    id str
    This is the resource OCID.
    metadata Mapping[str, str]
    This is additional information that helps to identity the resource for the schedule.
    parameters Sequence[GetScheduleResourceParameter]
    This is the user input parameters to use when acting on the resource.
    id String
    This is the resource OCID.
    metadata Map<String>
    This is additional information that helps to identity the resource for the schedule.
    parameters List<Property Map>
    This is the user input parameters to use when acting on the resource.

    GetScheduleResourceFilter

    Attribute string
    This is the resource attribute on which the threshold is defined.
    Condition string
    This is the condition for the filter in comparison to its creation time.
    ShouldIncludeChildCompartments bool
    This sets whether to include child compartments.
    Values List<GetScheduleResourceFilterValue>
    This is the HTTP request header value.
    Attribute string
    This is the resource attribute on which the threshold is defined.
    Condition string
    This is the condition for the filter in comparison to its creation time.
    ShouldIncludeChildCompartments bool
    This sets whether to include child compartments.
    Values []GetScheduleResourceFilterValue
    This is the HTTP request header value.
    attribute String
    This is the resource attribute on which the threshold is defined.
    condition String
    This is the condition for the filter in comparison to its creation time.
    shouldIncludeChildCompartments Boolean
    This sets whether to include child compartments.
    values List<GetScheduleResourceFilterValue>
    This is the HTTP request header value.
    attribute string
    This is the resource attribute on which the threshold is defined.
    condition string
    This is the condition for the filter in comparison to its creation time.
    shouldIncludeChildCompartments boolean
    This sets whether to include child compartments.
    values GetScheduleResourceFilterValue[]
    This is the HTTP request header value.
    attribute str
    This is the resource attribute on which the threshold is defined.
    condition str
    This is the condition for the filter in comparison to its creation time.
    should_include_child_compartments bool
    This sets whether to include child compartments.
    values Sequence[GetScheduleResourceFilterValue]
    This is the HTTP request header value.
    attribute String
    This is the resource attribute on which the threshold is defined.
    condition String
    This is the condition for the filter in comparison to its creation time.
    shouldIncludeChildCompartments Boolean
    This sets whether to include child compartments.
    values List<Property Map>
    This is the HTTP request header value.

    GetScheduleResourceFilterValue

    Namespace string
    This is the namespace of the defined tag.
    TagKey string
    This is the key of the defined tag.
    Value string
    This is the HTTP request header value.
    Namespace string
    This is the namespace of the defined tag.
    TagKey string
    This is the key of the defined tag.
    Value string
    This is the HTTP request header value.
    namespace String
    This is the namespace of the defined tag.
    tagKey String
    This is the key of the defined tag.
    value String
    This is the HTTP request header value.
    namespace string
    This is the namespace of the defined tag.
    tagKey string
    This is the key of the defined tag.
    value string
    This is the HTTP request header value.
    namespace str
    This is the namespace of the defined tag.
    tag_key str
    This is the key of the defined tag.
    value str
    This is the HTTP request header value.
    namespace String
    This is the namespace of the defined tag.
    tagKey String
    This is the key of the defined tag.
    value String
    This is the HTTP request header value.

    GetScheduleResourceParameter

    ParameterType string
    This is the parameter type on which the input parameter is defined
    Values List<string>
    This is the HTTP request header value.
    ParameterType string
    This is the parameter type on which the input parameter is defined
    Values []string
    This is the HTTP request header value.
    parameterType String
    This is the parameter type on which the input parameter is defined
    values List<String>
    This is the HTTP request header value.
    parameterType string
    This is the parameter type on which the input parameter is defined
    values string[]
    This is the HTTP request header value.
    parameter_type str
    This is the parameter type on which the input parameter is defined
    values Sequence[str]
    This is the HTTP request header value.
    parameterType String
    This is the parameter type on which the input parameter is defined
    values List<String>
    This is the HTTP request header value.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Viewing docs for Oracle Cloud Infrastructure v4.4.0
    published on Thursday, Mar 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.