Skip to content

get_probe async

get_probe(
    monitor_name: ResourceName,
    probe_id: ProbeId,
    *,
    config_overrides: Optional[AsyncNetworkMonitorClientConfig] = None,
) -> GetProbeOutput

Returns the details about a probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

Parameters:

  • monitor_name (ResourceName) –

    The name of the monitor associated with the probe. Run ListMonitors to get a list of monitor names.

  • probe_id (ProbeId) –

    The ID of the probe to get information about. Run GetMonitor action to get a list of probes and probe IDs for the monitor.

Raises:

Source code in docs_src/capo_networkmonitor/_services/async_network_monitor.py
async def get_probe(
    self,
    monitor_name: "capo_networkmonitor.types.resource_name.ResourceName",
    probe_id: "capo_networkmonitor.types.probe_id.ProbeId",
    *,
    config_overrides: Optional[AsyncNetworkMonitorClientConfig] = None,
) -> "capo_networkmonitor.types.get_probe_output.GetProbeOutput":
    """<p>Returns the details about a probe. This action requires both the <code>monitorName</code> and <code>probeId</code> parameters. Run <code>ListMonitors</code> to get a list of monitor names. Run <code>GetMonitor</code> to get a list of probes and probe IDs. </p>

    Args:
        monitor_name: <p>The name of the monitor associated with the probe. Run <code>ListMonitors</code> to get a list of monitor names.</p>
        probe_id: <p>The ID of the probe to get information about. Run <code>GetMonitor</code> action to get a list of probes and probe IDs for the monitor.</p>

    Raises:
        capo_networkmonitor.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_networkmonitor.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_networkmonitor.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_networkmonitor.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling</p>
        capo_networkmonitor.errors.validation_exception.ValidationException: <p>One of the parameters for the request is not valid.</p>
        capo_networkmonitor.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_networkmonitor.types.get_probe_input.GetProbeInput]",
    ) -> AsyncOperationResponse[
        "capo_networkmonitor.types.get_probe_output.GetProbeOutput"
    ]:
        import capo_networkmonitor._operations.network_monitor.get_probe

        (
            output,
            http_response,
        ) = await capo_networkmonitor._operations.network_monitor.get_probe.async_get_probe(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetProbe")
    )
    input_: capo_networkmonitor.types.get_probe_input.GetProbeInput = {
        "monitor_name": monitor_name,
        "probe_id": probe_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output