Skip to content

CanaryRun

Source code in docs_src/capo_synthetics/types/canary_run.py
class CanaryRun(TypedDict, closed=True):
    id: NotRequired["capo_synthetics.types.uuid.UUID"]
    """<p>A unique ID that identifies this canary run.</p>"""
    scheduled_run_id: NotRequired["capo_synthetics.types.uuid.UUID"]
    """<p>The ID of the scheduled canary run.</p>"""
    retry_attempt: NotRequired["capo_synthetics.types.retry_attempt.RetryAttempt"]
    """<p>The count in number of the retry attempt.</p>"""
    name: NotRequired["capo_synthetics.types.canary_name.CanaryName"]
    """<p>The name of the canary.</p>"""
    status: NotRequired["capo_synthetics.types.canary_run_status.CanaryRunStatus"]
    """<p>The status of this run.</p>"""
    timeline: NotRequired["capo_synthetics.types.canary_run_timeline.CanaryRunTimeline"]
    """<p>A structure that contains the start and end times of this run.</p>"""
    artifact_s3_location: NotRequired["capo_synthetics.types.string.String"]
    """<p>The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.</p>"""
    dry_run_config: NotRequired[
        "capo_synthetics.types.canary_dry_run_config_output.CanaryDryRunConfigOutput"
    ]
    """<p>Returns the dry run configurations for a canary.</p>"""
    browser_type: NotRequired["capo_synthetics.types.browser_type.BrowserType"]
    """<p>The browser type associated with this canary run.</p>"""
    location: NotRequired["capo_synthetics.types.location.Location"]
    """<p>The Amazon Web Services Region where this canary run was executed.</p>"""

artifact_s3_location instance-attribute

artifact_s3_location: NotRequired[String]

The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

browser_type instance-attribute

browser_type: NotRequired[BrowserType]

The browser type associated with this canary run.

dry_run_config instance-attribute

dry_run_config: NotRequired[CanaryDryRunConfigOutput]

Returns the dry run configurations for a canary.

id instance-attribute

id: NotRequired[UUID]

A unique ID that identifies this canary run.

location instance-attribute

location: NotRequired[Location]

The Amazon Web Services Region where this canary run was executed.

name instance-attribute

name: NotRequired[CanaryName]

The name of the canary.

retry_attempt instance-attribute

retry_attempt: NotRequired[RetryAttempt]

The count in number of the retry attempt.

scheduled_run_id instance-attribute

scheduled_run_id: NotRequired[UUID]

The ID of the scheduled canary run.

status instance-attribute

status: NotRequired[CanaryRunStatus]

The status of this run.

timeline instance-attribute

timeline: NotRequired[CanaryRunTimeline]

A structure that contains the start and end times of this run.