Waylay Alarms Service

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This Python package is automatically generated based on the Waylay Alarms OpenAPI specification (API version: 1.13.1) For more information, please visit the openapi specification.

It consists of two sub-packages that are both plugins for the waylay-sdk-core package.

• The waylay-sdk-alarms sub-package contains the Alarms api methods.
• The waylay-sdk-alarms-types sub-package is an extension that contains the typed model classes for all path params, query params, body params and responses for each of the api methods in waylay-sdk-alarms.

Requirements.

This package requires Python 3.10+.

Installation

Normally this package is installed together with support for other services using the waylay-sdk umbrella package:

• pip install waylay-sdk will install waylay-sdk-alarms together with the SDK api packages for other services.
• pip install waylay-sdk[types-alarms] will additionally install the types package waylay-sdk-alarms-types.
• pip install waylay-sdk[types] will install the types packages for this and all other services.

Alternatively, you can install support for this alarms service only, installing or extending an existing waylay-sdk-core:

• pip install waylay-sdk-alarms to only install api support for alarms.
• pip install waylay-sdk-alarms[types] to additionally install type support for alarms.

Usage

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-alarms-types` is installed
from waylay.services.alarms.models.version_response import VersionResponse

try:
    # Get Service Information
    # calls `GET /alarms/v1`
    api_response = await waylay_client.alarms.about.get()
    print(f"Response: {api_response}")
except ApiError as e:
    print("Exception when calling alarms.about.get: %s\n" % e)

For more information, please visit the Waylay API documentation.

Documentation for API Endpoints

All URIs are relative to https://api.waylay.io

SDK Path	Method	HTTP request	Description
waylay_client.alarms.about	get	GET /alarms/v1	Get Service Information
waylay_client.alarms.alarm_events	get	GET /alarms/v1/events	Alarm Events
waylay_client.alarms.alarms	create	POST /alarms/v1/alarms	Create Alarm
waylay_client.alarms.alarms	delete	DELETE /alarms/v1/alarms/{alarmId}	Delete Alarm
waylay_client.alarms.alarms	get	GET /alarms/v1/alarms/{alarmId}	Get Alarm
waylay_client.alarms.alarms	list	GET /alarms/v1/alarms	Query Multiple Alarms
waylay_client.alarms.alarms	update	PUT /alarms/v1/alarms/{alarmId}	Update Alarm
waylay_client.alarms.alarms_batch_operations	get	GET /alarms/v1/batch/{batchId}	Get Alarms Batch Operation Status
waylay_client.alarms.alarms_batch_operations	start	POST /alarms/v1/batch	Start Alarms Batch Operation

Documentation For Models

• AdditionalQueryParamValue
• AlarmAuditRecord
• AlarmChangeRecord
• AlarmChangeType
• AlarmEntity
• AlarmEvent
• AlarmEventAlarm
• AlarmEventType
• AlarmRaisedEventType
• AlarmSeverity
• AlarmSeverityFilter
• AlarmSourceFilter
• AlarmStatus
• AlarmStatusFilter
• AlarmTimelineInfo
• AlarmTypeFilter
• AlarmUpdate
• AlarmUpdatedEventType
• AlarmsQueryResult
• AlarmsTimelineItem
• BatchAlarm
• BatchAlarmEntity
• BatchAlarmsSpecification
• BatchDeleteAction
• BatchDeleteAlarm
• BatchDeleteQuery
• BatchOperation
• BatchOperationEnqueued
• BatchOperationEnqueuedEntity
• BatchOperationResult
• BatchOperationResults
• BatchOperationSummary
• BatchOperationSummaryAction
• BatchUpdateAction
• BatchUpdateAlarm
• BulkQueryFilter
• BulkQueryIds
• CloudAlarmEvent
• CloudAlarmEventData
• CloudAlarmEventType
• CreateAlarm
• DeprecatedSortOrder
• ErrorResponse
• ErrorResponseWithDetails
• EventOccurredAgainEventType
• EventStreamFormat
• FailureOperationResultValue
• GetBatchOperationResponse
• ISO8601TimestampOrMillis
• IdObject
• ListOrder
• ListSortParameter
• NdJsonResponseStream
• OperationResultObject
• QueuedOperationSummary
• QueuedOperationSummaryAction
• SSEventStream
• SortOrder
• SuccessOperationResultValue
• VersionResponse