Skip to content

list_alarm_model_versions 

list_alarm_model_versions(
    alarm_model_name: AlarmModelName,
    *,
    config_overrides: Optional[IoTEventsClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListAlarmModelVersionsResponse

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

Parameters:

  • alarm_model_name (AlarmModelName) –

    The name of the alarm model.

  • next_token (Optional[NextToken], default: None ) –

    The token that you can use to return the next set of results.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of results to be returned per request.

Raises:

Source code in docs_src/capo_iot_events/_services/io_t_events.py 
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
def list_alarm_model_versions(
    self,
    alarm_model_name: "capo_iot_events.types.alarm_model_name.AlarmModelName",
    *,
    config_overrides: Optional[IoTEventsClientConfig] = None,
    next_token: Optional["capo_iot_events.types.next_token.NextToken"] = None,
    max_results: Optional["capo_iot_events.types.max_results.MaxResults"] = None,
) -> "capo_iot_events.types.list_alarm_model_versions_response.ListAlarmModelVersionsResponse":
    """<p>Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.</p>

    Args:
        alarm_model_name: <p>The name of the alarm model.</p>
        next_token: <p>The token that you can use to return the next set of results.</p>
        max_results: <p>The maximum number of results to be returned per request.</p>

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

    def _handler(
        req: "OperationRequest[capo_iot_events.types.list_alarm_model_versions_request.ListAlarmModelVersionsRequest]",
    ) -> OperationResponse[
        "capo_iot_events.types.list_alarm_model_versions_response.ListAlarmModelVersionsResponse"
    ]:
        import capo_iot_events._operations.iot_columbo_service.list_alarm_model_versions

        output, http_response = (
            capo_iot_events._operations.iot_columbo_service.list_alarm_model_versions.list_alarm_model_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAlarmModelVersions")
    )
    input_: capo_iot_events.types.list_alarm_model_versions_request.ListAlarmModelVersionsRequest = {
        "alarm_model_name": alarm_model_name
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output