Skip to content

CanaryScheduleOutput

Source code in docs_src/capo_synthetics/types/canary_schedule_output.py 
13
14
15
16
17
18
19
20
21
22
23
class CanaryScheduleOutput(TypedDict, closed=True):
    expression: NotRequired["capo_synthetics.types.string.String"]
    """<p>A <code>rate</code> expression or a <code>cron</code> expression that defines how often the canary is to run.</p> <p>For a rate expression, The syntax is <code>rate(<i>number unit</i>)</code>. <i>unit</i> can be <code>minute</code>, <code>minutes</code>, or <code>hour</code>. </p> <p>For example, <code>rate(1 minute)</code> runs the canary once a minute, <code>rate(10 minutes)</code> runs it once every 10 minutes, and <code>rate(1 hour)</code> runs it once every hour. You can specify a frequency between <code>rate(1 minute)</code> and <code>rate(1 hour)</code>.</p> <p>Specifying <code>rate(0 minute)</code> or <code>rate(0 hour)</code> is a special value that causes the canary to run only once when it is started.</p> <p>Use <code>cron(<i>expression</i>)</code> to specify a cron expression. For information about the syntax for cron expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html"> Scheduling canary runs using cron</a>.</p>"""
    duration_in_seconds: NotRequired[
        "capo_synthetics.types.max_one_year_in_seconds.MaxOneYearInSeconds"
    ]
    """<p>How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the <code>Expression</code> value.</p>"""
    retry_config: NotRequired[
        "capo_synthetics.types.retry_config_output.RetryConfigOutput"
    ]
    """<p>A structure that contains the retry configuration for a canary</p>"""

duration_in_seconds instance-attribute 

duration_in_seconds: NotRequired[MaxOneYearInSeconds]

How long, in seconds, for the canary to continue making regular runs after it was created. The runs are performed according to the schedule in the Expression value.

expression instance-attribute 

expression: NotRequired[String]

A rate expression or a cron expression that defines how often the canary is to run.

For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.

For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).

Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

Use cron(expression) to specify a cron expression. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

retry_config instance-attribute 

retry_config: NotRequired[RetryConfigOutput]

A structure that contains the retry configuration for a canary