Skip to content

GetCanaryRequest

Source code in docs_src/capo_synthetics/types/get_canary_request.py
class GetCanaryRequest(TypedDict, closed=True):
    name: "capo_synthetics.types.canary_name.CanaryName"
    """<p>The name of the canary that you want details for.</p>"""
    dry_run_id: NotRequired["capo_synthetics.types.uuid.UUID"]
    """<p>The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.</p>"""

dry_run_id instance-attribute

dry_run_id: NotRequired[UUID]

The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.

name instance-attribute

name: CanaryName

The name of the canary that you want details for.