Skip to content

CanaryRunConfigOutput

Source code in docs_src/capo_synthetics/types/canary_run_config_output.py
class CanaryRunConfigOutput(TypedDict, closed=True):
    timeout_in_seconds: NotRequired[
        "capo_synthetics.types.max_fifteen_minutes_in_seconds.MaxFifteenMinutesInSeconds"
    ]
    """<p>How long the canary is allowed to run before it must stop.</p>"""
    memory_in_mb: NotRequired["capo_synthetics.types.max_size3008.MaxSize3008"]
    """<p>The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.</p>"""
    active_tracing: NotRequired[
        "capo_synthetics.types.nullable_boolean.NullableBoolean"
    ]
    """<p>Displays whether this canary run used active X-Ray tracing. </p>"""
    ephemeral_storage: NotRequired[
        "capo_synthetics.types.ephemeral_storage_size.EphemeralStorageSize"
    ]
    """<p>Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.</p>"""

active_tracing instance-attribute

active_tracing: NotRequired[NullableBoolean]

Displays whether this canary run used active X-Ray tracing.

ephemeral_storage instance-attribute

ephemeral_storage: NotRequired[EphemeralStorageSize]

Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

memory_in_mb instance-attribute

memory_in_mb: NotRequired[MaxSize3008]

The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

timeout_in_seconds instance-attribute

timeout_in_seconds: NotRequired[MaxFifteenMinutesInSeconds]

How long the canary is allowed to run before it must stop.