Skip to content

get_alert async 

get_alert(
    space_id: SpaceId,
    alert_id: AlertId,
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
) -> GetAlertOutput

Retrieves a single alert by its identifier. Use ListAlerts to enumerate alerts in the space.

Parameters:

  • space_id (SpaceId) –

    The unique ID of the space.

  • alert_id (AlertId) –

    The alert to retrieve.

Raises:

Examples:

Retrieve an alert The following example retrieves an alert by its identifier, including the live evaluation state that CreateAlert does not report. Payloads are shown as JSON; on the wire they are CBOR-encoded.

>>> await client.get_alert(space_id='a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d', alert_id='c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f')
Source code in docs_src/capo_cloudwatchomni/_services/async_cloud_watch_omni.py 
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
async def get_alert(
    self,
    space_id: "capo_cloudwatchomni.types.space_id.SpaceId",
    alert_id: "capo_cloudwatchomni.types.alert_id.AlertId",
    *,
    config_overrides: Optional[AsyncCloudWatchOmniClientConfig] = None,
) -> "capo_cloudwatchomni.types.get_alert_output.GetAlertOutput":
    """Retrieves a single alert by its identifier. Use ListAlerts to enumerate alerts in the space.

    Args:
        space_id: The unique ID of the space.
        alert_id: The alert to retrieve.

    Raises:
        capo_cloudwatchomni.errors.access_denied_exception.AccessDeniedException: The caller is not authorized to perform this action.
        capo_cloudwatchomni.errors.internal_server_exception.InternalServerException: An unexpected error occurred while processing the request.
        capo_cloudwatchomni.errors.resource_not_found_exception.ResourceNotFoundException: The specified resource does not exist.
        capo_cloudwatchomni.errors.throttling_exception.ThrottlingException: The request was throttled due to exceeding the allowed request rate.
        capo_cloudwatchomni.errors.validation_exception.ValidationException: A parameter is specified incorrectly.
        capo_cloudwatchomni.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Retrieve an alert
        The following example retrieves an alert by its identifier, including the live evaluation state that CreateAlert does not report. Payloads are shown as JSON; on the wire they are CBOR-encoded.

        >>> await client.get_alert(space_id='a1b2c3d4-5e6f-4a3b-8c9d-0e1f2a3b4c5d', alert_id='c3d4e5f67a8b4c9d8e0f1a2b3c4d5e6f')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatchomni.types.get_alert_input.GetAlertInput]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatchomni.types.get_alert_output.GetAlertOutput"
    ]:
        import capo_cloudwatchomni._operations.cloud_watch_omni_frontend.get_alert

        (
            output,
            http_response,
        ) = await capo_cloudwatchomni._operations.cloud_watch_omni_frontend.get_alert.async_get_alert(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAlert")
    )
    input_: capo_cloudwatchomni.types.get_alert_input.GetAlertInput = {
        "space_id": space_id,
        "alert_id": alert_id,
    }

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