describe_alarm `async` ¶

describe_alarm(
    alarm_model_name: AlarmModelName,
    *,
    config_overrides: Optional[AsyncIoTEventsDataClientConfig] = None,
    key_value: Optional[KeyValue] = None,
) -> DescribeAlarmResponse

Retrieves information about an alarm.

Parameters:

alarm_model_name (AlarmModelName) –

The name of the alarm model.
key_value (Optional[KeyValue], default: None ) –

The value of the key used as a filter to select only the alarms associated with the key.

Raises:

InternalFailureException –

An internal failure occurred.
InvalidRequestException –

The request was invalid.
ResourceNotFoundException –

The resource was not found.
ServiceUnavailableException –

The service is currently unavailable.
ThrottlingException –

The request could not be completed due to throttling.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_iot_events_data/_services/async_io_t_events_data.py

async def describe_alarm(
    self,
    alarm_model_name: "capo_iot_events_data.types.alarm_model_name.AlarmModelName",
    *,
    config_overrides: Optional[AsyncIoTEventsDataClientConfig] = None,
    key_value: Optional["capo_iot_events_data.types.key_value.KeyValue"] = None,
) -> "capo_iot_events_data.types.describe_alarm_response.DescribeAlarmResponse":
    """<p>Retrieves information about an alarm.</p>

    Args:
        alarm_model_name: <p>The name of the alarm model.</p>
        key_value: <p>The value of the key used as a filter to select only the alarms associated with the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html#iotevents-CreateAlarmModel-request-key">key</a>.</p>

    Raises:
        capo_iot_events_data.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_iot_events_data.errors.invalid_request_exception.InvalidRequestException: <p>The request was invalid.</p>
        capo_iot_events_data.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</p>
        capo_iot_events_data.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_iot_events_data.errors.throttling_exception.ThrottlingException: <p>The request could not be completed due to throttling.</p>
        capo_iot_events_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iot_events_data.types.describe_alarm_request.DescribeAlarmRequest]",
    ) -> AsyncOperationResponse[
        "capo_iot_events_data.types.describe_alarm_response.DescribeAlarmResponse"
    ]:
        import capo_iot_events_data._operations.iot_columbo_data_service.describe_alarm

        (
            output,
            http_response,
        ) = await capo_iot_events_data._operations.iot_columbo_data_service.describe_alarm.async_describe_alarm(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAlarm")
    )
    input_: capo_iot_events_data.types.describe_alarm_request.DescribeAlarmRequest = {
        "alarm_model_name": alarm_model_name
    }
    if key_value is not None:
        input_["key_value"] = key_value

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

describe_alarm async ¶

describe_alarm `async` ¶