GetScheduleOutput ¶

class GetScheduleOutput(TypedDict, closed=True):
    arn: NotRequired["capo_scheduler.types.schedule_arn.ScheduleArn"]
    """<p>The Amazon Resource Name (ARN) of the schedule.</p>"""
    group_name: NotRequired[
        "capo_scheduler.types.schedule_group_name.ScheduleGroupName"
    ]
    """<p>The name of the schedule group associated with this schedule.</p>"""
    name: NotRequired["capo_scheduler.types.name.Name"]
    """<p>The name of the schedule.</p>"""
    schedule_expression: NotRequired[
        "capo_scheduler.types.schedule_expression.ScheduleExpression"
    ]
    """<p> The expression that defines when the schedule runs. The following formats are supported. </p> <ul> <li> <p> <code>at</code> expression - <code>at(yyyy-mm-ddThh:mm:ss)</code> </p> </li> <li> <p> <code>rate</code> expression - <code>rate(value unit)</code> </p> </li> <li> <p> <code>cron</code> expression - <code>cron(fields)</code> </p> </li> </ul> <p> You can use <code>at</code> expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use <code>rate</code> and <code>cron</code> expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. </p> <p> A <code>cron</code> expression consists of six fields separated by white spaces: <code>(minutes hours day_of_month month day_of_week year)</code>. </p> <p> A <code>rate</code> expression consists of a <i>value</i> as a positive integer, and a <i>unit</i> with the following options: <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code> </p> <p> For more information and examples, see <a href="https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html">Schedule types on EventBridge Scheduler</a> in the <i>EventBridge Scheduler User Guide</i>. </p>"""
    start_date: NotRequired["capo_scheduler.types.start_date.StartDate"]
    """<p>The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the <code>StartDate</code> you specify. EventBridge Scheduler ignores <code>StartDate</code> for one-time schedules.</p>"""
    end_date: NotRequired["capo_scheduler.types.end_date.EndDate"]
    """<p>The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the <code>EndDate</code> you specify. EventBridge Scheduler ignores <code>EndDate</code> for one-time schedules.</p>"""
    description: NotRequired["capo_scheduler.types.description.Description"]
    """<p>The description of the schedule.</p>"""
    schedule_expression_timezone: NotRequired[
        "capo_scheduler.types.schedule_expression_timezone.ScheduleExpressionTimezone"
    ]
    """<p>The timezone in which the scheduling expression is evaluated.</p>"""
    state: NotRequired["capo_scheduler.types.schedule_state.ScheduleState"]
    """<p>Specifies whether the schedule is enabled or disabled.</p>"""
    creation_date: NotRequired["capo_scheduler.types.creation_date.CreationDate"]
    """<p>The time at which the schedule was created.</p>"""
    last_modification_date: NotRequired[
        "capo_scheduler.types.last_modification_date.LastModificationDate"
    ]
    """<p>The time at which the schedule was last modified.</p>"""
    kms_key_arn: NotRequired["capo_scheduler.types.kms_key_arn.KmsKeyArn"]
    """<p>The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.</p>"""
    target: NotRequired["capo_scheduler.types.target.Target"]
    """<p>The schedule target.</p>"""
    flexible_time_window: NotRequired[
        "capo_scheduler.types.flexible_time_window.FlexibleTimeWindow"
    ]
    """<p>Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.</p>"""
    action_after_completion: NotRequired[
        "capo_scheduler.types.action_after_completion.ActionAfterCompletion"
    ]
    """<p>Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.</p>"""