oci-monitoring 2.76.0 → 2.77.0

package/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Monitoring API
  * Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
-Endpoints vary by operation. For PostMetric, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
+Endpoints vary by operation. For PostMetricData, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
 For more information, see
 [the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
 
@@ -11,7 +11,7 @@ For more information, see
  * NOTE: This class is auto generated by OracleSDKGenerator.
  * Do not edit the class manually.
  *
- * Copyright (c) 2020, 2023, Oracle and/or its affiliates.  All rights reserved.
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
  * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
  */
 import * as requests from "./lib/request";

package/index.js

@@ -2,7 +2,7 @@
 /**
  * Monitoring API
  * Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
-Endpoints vary by operation. For PostMetric, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
+Endpoints vary by operation. For PostMetricData, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
 For more information, see
 [the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
 
@@ -12,7 +12,7 @@ For more information, see
  * NOTE: This class is auto generated by OracleSDKGenerator.
  * Do not edit the class manually.
  *
- * Copyright (c) 2020, 2023, Oracle and/or its affiliates.  All rights reserved.
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
  * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
  */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {

package/lib/client.d.ts

@@ -1,7 +1,7 @@
 /**
  * Monitoring API
  * Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources.
-Endpoints vary by operation. For PostMetric, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
+Endpoints vary by operation. For PostMetricData, use the `telemetry-ingestion` endpoints; for all other operations, use the `telemetry` endpoints.
 For more information, see
 [the Monitoring documentation](/iaas/Content/Monitoring/home.htm).
 
@@ -11,7 +11,7 @@ For more information, see
  * NOTE: This class is auto generated by OracleSDKGenerator.
  * Do not edit the class manually.
  *
- * Copyright (c) 2020, 2023, Oracle and/or its affiliates.  All rights reserved.
+ * Copyright (c) 2020, 2024, Oracle and/or its affiliates.  All rights reserved.
  * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
  */
 import common = require("oci-common");
@@ -94,7 +94,7 @@ export declare class MonitoringClient {
      * @param ChangeAlarmCompartmentRequest
      * @return ChangeAlarmCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/ChangeAlarmCompartment.ts.html |here} to see how to use ChangeAlarmCompartment API.
      */
     changeAlarmCompartment(changeAlarmCompartmentRequest: requests.ChangeAlarmCompartmentRequest): Promise<responses.ChangeAlarmCompartmentResponse>;
     /**
@@ -112,9 +112,26 @@ export declare class MonitoringClient {
        * @param CreateAlarmRequest
        * @return CreateAlarmResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/CreateAlarm.ts.html |here} to see how to use CreateAlarm API.
        */
     createAlarm(createAlarmRequest: requests.CreateAlarmRequest): Promise<responses.CreateAlarmResponse>;
+    /**
+       * Creates a dimension-specific suppression for an alarm.
+  * <p>
+  For important limits information, see
+  * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
+  * <p>
+  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
+  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
+  * or transactions, per second (TPS) for a given tenancy.
+  *
+       * This operation does not retry by default if the user has not defined a retry configuration.
+       * @param CreateAlarmSuppressionRequest
+       * @return CreateAlarmSuppressionResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/CreateAlarmSuppression.ts.html |here} to see how to use CreateAlarmSuppression API.
+       */
+    createAlarmSuppression(createAlarmSuppressionRequest: requests.CreateAlarmSuppressionRequest): Promise<responses.CreateAlarmSuppressionResponse>;
     /**
        * Deletes the specified alarm.
   * For more information, see
@@ -130,9 +147,26 @@ export declare class MonitoringClient {
        * @param DeleteAlarmRequest
        * @return DeleteAlarmResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/DeleteAlarm.ts.html |here} to see how to use DeleteAlarm API.
        */
     deleteAlarm(deleteAlarmRequest: requests.DeleteAlarmRequest): Promise<responses.DeleteAlarmResponse>;
+    /**
+       * Deletes the specified alarm suppression.
+  * <p>
+  For important limits information, see
+  * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
+  * <p>
+  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
+  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
+  * or transactions, per second (TPS) for a given tenancy.
+  *
+       * This operation does not retry by default if the user has not defined a retry configuration.
+       * @param DeleteAlarmSuppressionRequest
+       * @return DeleteAlarmSuppressionResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/DeleteAlarmSuppression.ts.html |here} to see how to use DeleteAlarmSuppression API.
+       */
+    deleteAlarmSuppression(deleteAlarmSuppressionRequest: requests.DeleteAlarmSuppressionRequest): Promise<responses.DeleteAlarmSuppressionResponse>;
     /**
        * Gets the specified alarm.
   * For more information, see
@@ -148,7 +182,7 @@ export declare class MonitoringClient {
        * @param GetAlarmRequest
        * @return GetAlarmResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/GetAlarm.ts.html |here} to see how to use GetAlarm API.
        */
     getAlarm(getAlarmRequest: requests.GetAlarmRequest): Promise<responses.GetAlarmResponse>;
     /**
@@ -166,9 +200,44 @@ export declare class MonitoringClient {
        * @param GetAlarmHistoryRequest
        * @return GetAlarmHistoryResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/GetAlarmHistory.ts.html |here} to see how to use GetAlarmHistory API.
        */
     getAlarmHistory(getAlarmHistoryRequest: requests.GetAlarmHistoryRequest): Promise<responses.GetAlarmHistoryResponse>;
+    /**
+       * Gets the specified alarm suppression.
+  * <p>
+  For important limits information, see
+  * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
+  * <p>
+  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
+  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
+  * or transactions, per second (TPS) for a given tenancy.
+  *
+       * This operation does not retry by default if the user has not defined a retry configuration.
+       * @param GetAlarmSuppressionRequest
+       * @return GetAlarmSuppressionResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/GetAlarmSuppression.ts.html |here} to see how to use GetAlarmSuppression API.
+       */
+    getAlarmSuppression(getAlarmSuppressionRequest: requests.GetAlarmSuppressionRequest): Promise<responses.GetAlarmSuppressionResponse>;
+    /**
+       * Lists alarm suppressions for the specified alarm.
+  * Only dimension-level suppressions are listed. Alarm-level suppressions are not listed.
+  * <p>
+  For important limits information, see
+  * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
+  * <p>
+  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
+  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
+  * or transactions, per second (TPS) for a given tenancy.
+  *
+       * This operation does not retry by default if the user has not defined a retry configuration.
+       * @param ListAlarmSuppressionsRequest
+       * @return ListAlarmSuppressionsResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/ListAlarmSuppressions.ts.html |here} to see how to use ListAlarmSuppressions API.
+       */
+    listAlarmSuppressions(listAlarmSuppressionsRequest: requests.ListAlarmSuppressionsRequest): Promise<responses.ListAlarmSuppressionsResponse>;
     /**
        * Lists the alarms for the specified compartment.
   * For more information, see
@@ -184,7 +253,7 @@ export declare class MonitoringClient {
        * @param ListAlarmsRequest
        * @return ListAlarmsResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/ListAlarms.ts.html |here} to see how to use ListAlarms API.
        */
     listAlarms(listAlarmsRequest: requests.ListAlarmsRequest): Promise<responses.ListAlarmsResponse>;
     /**
@@ -223,6 +292,7 @@ export declare class MonitoringClient {
        * List the status of each alarm in the specified compartment.
   * Status is collective, across all metric streams in the alarm.
   * To list alarm status for each metric stream, use {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}.
+  * Optionally filter by resource or status value.
   * For more information, see
   * [Listing Alarm Statuses](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/list-alarm-status.htm).
   * For important limits information, see
@@ -236,7 +306,7 @@ export declare class MonitoringClient {
        * @param ListAlarmsStatusRequest
        * @return ListAlarmsStatusResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/ListAlarmsStatus.ts.html |here} to see how to use ListAlarmsStatus API.
        */
     listAlarmsStatus(listAlarmsStatusRequest: requests.ListAlarmsStatusRequest): Promise<responses.ListAlarmsStatusResponse>;
     /**
@@ -286,7 +356,7 @@ export declare class MonitoringClient {
        * @param ListMetricsRequest
        * @return ListMetricsResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/ListMetrics.ts.html |here} to see how to use ListMetrics API.
        */
     listMetrics(listMetricsRequest: requests.ListMetricsRequest): Promise<responses.ListMetricsResponse>;
     /**
@@ -356,7 +426,7 @@ export declare class MonitoringClient {
        * @param PostMetricDataRequest
        * @return PostMetricDataResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/PostMetricData.ts.html |here} to see how to use PostMetricData API.
        */
     postMetricData(postMetricDataRequest: requests.PostMetricDataRequest): Promise<responses.PostMetricDataResponse>;
     /**
@@ -374,7 +444,7 @@ export declare class MonitoringClient {
        * @param RemoveAlarmSuppressionRequest
        * @return RemoveAlarmSuppressionResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/RemoveAlarmSuppression.ts.html |here} to see how to use RemoveAlarmSuppression API.
        */
     removeAlarmSuppression(removeAlarmSuppressionRequest: requests.RemoveAlarmSuppressionRequest): Promise<responses.RemoveAlarmSuppressionResponse>;
     /**
@@ -394,9 +464,26 @@ export declare class MonitoringClient {
        * @param RetrieveDimensionStatesRequest
        * @return RetrieveDimensionStatesResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStates API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/RetrieveDimensionStates.ts.html |here} to see how to use RetrieveDimensionStates API.
        */
     retrieveDimensionStates(retrieveDimensionStatesRequest: requests.RetrieveDimensionStatesRequest): Promise<responses.RetrieveDimensionStatesResponse>;
+    /**
+       * Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions.
+  * <p>
+  For important limits information, see
+  * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits).
+  * <p>
+  This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.
+  * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,
+  * or transactions, per second (TPS) for a given tenancy.
+  *
+       * This operation does not retry by default if the user has not defined a retry configuration.
+       * @param SummarizeAlarmSuppressionHistoryRequest
+       * @return SummarizeAlarmSuppressionHistoryResponse
+       * @throws OciError when an error occurs
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/SummarizeAlarmSuppressionHistory.ts.html |here} to see how to use SummarizeAlarmSuppressionHistory API.
+       */
+    summarizeAlarmSuppressionHistory(summarizeAlarmSuppressionHistoryRequest: requests.SummarizeAlarmSuppressionHistoryRequest): Promise<responses.SummarizeAlarmSuppressionHistoryResponse>;
     /**
        * Returns aggregated data that match the criteria specified in the request. Compartment OCID required.
   * For more information, see
@@ -412,7 +499,7 @@ export declare class MonitoringClient {
        * @param SummarizeMetricsDataRequest
        * @return SummarizeMetricsDataResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/SummarizeMetricsData.ts.html |here} to see how to use SummarizeMetricsData API.
        */
     summarizeMetricsData(summarizeMetricsDataRequest: requests.SummarizeMetricsDataRequest): Promise<responses.SummarizeMetricsDataResponse>;
     /**
@@ -430,7 +517,7 @@ export declare class MonitoringClient {
        * @param UpdateAlarmRequest
        * @return UpdateAlarmResponse
        * @throws OciError when an error occurs
-       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API.
+       * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.0/monitoring/UpdateAlarm.ts.html |here} to see how to use UpdateAlarm API.
        */
     updateAlarm(updateAlarmRequest: requests.UpdateAlarmRequest): Promise<responses.UpdateAlarmResponse>;
 }