@aws-sdk/client-amp 3.920.0 → 3.921.0

package/dist-types/commands/ListAnomalyDetectorsCommand.d.ts

@@ -0,0 +1,108 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { AmpClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmpClient";
+import { ListAnomalyDetectorsRequest, ListAnomalyDetectorsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListAnomalyDetectorsCommand}.
+ */
+export interface ListAnomalyDetectorsCommandInput extends ListAnomalyDetectorsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListAnomalyDetectorsCommand}.
+ */
+export interface ListAnomalyDetectorsCommandOutput extends ListAnomalyDetectorsResponse, __MetadataBearer {
+}
+declare const ListAnomalyDetectorsCommand_base: {
+    new (input: ListAnomalyDetectorsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAnomalyDetectorsCommandInput, ListAnomalyDetectorsCommandOutput, AmpClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: ListAnomalyDetectorsCommandInput): import("@smithy/smithy-client").CommandImpl<ListAnomalyDetectorsCommandInput, ListAnomalyDetectorsCommandOutput, AmpClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns a paginated list of anomaly detectors for a workspace with optional filtering by alias.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AmpClient, ListAnomalyDetectorsCommand } from "@aws-sdk/client-amp"; // ES Modules import
+ * // const { AmpClient, ListAnomalyDetectorsCommand } = require("@aws-sdk/client-amp"); // CommonJS import
+ * // import type { AmpClientConfig } from "@aws-sdk/client-amp";
+ * const config = {}; // type is AmpClientConfig
+ * const client = new AmpClient(config);
+ * const input = { // ListAnomalyDetectorsRequest
+ *   workspaceId: "STRING_VALUE", // required
+ *   alias: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ *   nextToken: "STRING_VALUE",
+ * };
+ * const command = new ListAnomalyDetectorsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListAnomalyDetectorsResponse
+ * //   anomalyDetectors: [ // AnomalyDetectorSummaryList // required
+ * //     { // AnomalyDetectorSummary
+ * //       arn: "STRING_VALUE", // required
+ * //       anomalyDetectorId: "STRING_VALUE", // required
+ * //       alias: "STRING_VALUE", // required
+ * //       status: { // AnomalyDetectorStatus
+ * //         statusCode: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATION_FAILED" || "UPDATE_FAILED" || "DELETION_FAILED", // required
+ * //         statusReason: "STRING_VALUE",
+ * //       },
+ * //       createdAt: new Date("TIMESTAMP"), // required
+ * //       modifiedAt: new Date("TIMESTAMP"), // required
+ * //       tags: { // TagMap
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListAnomalyDetectorsCommandInput - {@link ListAnomalyDetectorsCommandInput}
+ * @returns {@link ListAnomalyDetectorsCommandOutput}
+ * @see {@link ListAnomalyDetectorsCommandInput} for command's `input` shape.
+ * @see {@link ListAnomalyDetectorsCommandOutput} for command's `response` shape.
+ * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred during the processing of the request.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The request references a resources that doesn't exist.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link AmpServiceException}
+ * <p>Base exception class for all service exceptions from Amp service.</p>
+ *
+ *
+ * @public
+ */
+export declare class ListAnomalyDetectorsCommand extends ListAnomalyDetectorsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: ListAnomalyDetectorsRequest;
+            output: ListAnomalyDetectorsResponse;
+        };
+        sdk: {
+            input: ListAnomalyDetectorsCommandInput;
+            output: ListAnomalyDetectorsCommandOutput;
+        };
+    };
+}

package/dist-types/commands/PutAnomalyDetectorCommand.d.ts

@@ -0,0 +1,125 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { AmpClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmpClient";
+import { PutAnomalyDetectorRequest, PutAnomalyDetectorResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutAnomalyDetectorCommand}.
+ */
+export interface PutAnomalyDetectorCommandInput extends PutAnomalyDetectorRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutAnomalyDetectorCommand}.
+ */
+export interface PutAnomalyDetectorCommandOutput extends PutAnomalyDetectorResponse, __MetadataBearer {
+}
+declare const PutAnomalyDetectorCommand_base: {
+    new (input: PutAnomalyDetectorCommandInput): import("@smithy/smithy-client").CommandImpl<PutAnomalyDetectorCommandInput, PutAnomalyDetectorCommandOutput, AmpClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: PutAnomalyDetectorCommandInput): import("@smithy/smithy-client").CommandImpl<PutAnomalyDetectorCommandInput, PutAnomalyDetectorCommandOutput, AmpClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>When you call <code>PutAnomalyDetector</code>, the operation creates a new anomaly detector if one doesn't exist, or updates an existing one. Each call to this operation triggers a complete retraining of the detector, which includes querying the minimum required samples and backfilling the detector with historical data. This process occurs regardless of whether you're making a minor change like updating the evaluation interval or making more substantial modifications. The operation serves as the single method for creating, updating, and retraining anomaly detectors.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AmpClient, PutAnomalyDetectorCommand } from "@aws-sdk/client-amp"; // ES Modules import
+ * // const { AmpClient, PutAnomalyDetectorCommand } = require("@aws-sdk/client-amp"); // CommonJS import
+ * // import type { AmpClientConfig } from "@aws-sdk/client-amp";
+ * const config = {}; // type is AmpClientConfig
+ * const client = new AmpClient(config);
+ * const input = { // PutAnomalyDetectorRequest
+ *   workspaceId: "STRING_VALUE", // required
+ *   anomalyDetectorId: "STRING_VALUE", // required
+ *   evaluationIntervalInSeconds: Number("int"),
+ *   missingDataAction: { // AnomalyDetectorMissingDataAction Union: only one key present
+ *     markAsAnomaly: true || false,
+ *     skip: true || false,
+ *   },
+ *   configuration: { // AnomalyDetectorConfiguration Union: only one key present
+ *     randomCutForest: { // RandomCutForestConfiguration
+ *       query: "STRING_VALUE", // required
+ *       shingleSize: Number("int"),
+ *       sampleSize: Number("int"),
+ *       ignoreNearExpectedFromAbove: { // IgnoreNearExpected Union: only one key present
+ *         amount: Number("double"),
+ *         ratio: Number("double"),
+ *       },
+ *       ignoreNearExpectedFromBelow: {//  Union: only one key present
+ *         amount: Number("double"),
+ *         ratio: Number("double"),
+ *       },
+ *     },
+ *   },
+ *   labels: { // PrometheusMetricLabelMap
+ *     "<keys>": "STRING_VALUE",
+ *   },
+ *   clientToken: "STRING_VALUE",
+ * };
+ * const command = new PutAnomalyDetectorCommand(input);
+ * const response = await client.send(command);
+ * // { // PutAnomalyDetectorResponse
+ * //   anomalyDetectorId: "STRING_VALUE", // required
+ * //   arn: "STRING_VALUE", // required
+ * //   status: { // AnomalyDetectorStatus
+ * //     statusCode: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "CREATION_FAILED" || "UPDATE_FAILED" || "DELETION_FAILED", // required
+ * //     statusReason: "STRING_VALUE",
+ * //   },
+ * //   tags: { // TagMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param PutAnomalyDetectorCommandInput - {@link PutAnomalyDetectorCommandInput}
+ * @returns {@link PutAnomalyDetectorCommandOutput}
+ * @see {@link PutAnomalyDetectorCommandInput} for command's `input` shape.
+ * @see {@link PutAnomalyDetectorCommandOutput} for command's `response` shape.
+ * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request would cause an inconsistent state.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An unexpected error occurred during the processing of the request.</p>
+ *
+ * @throws {@link ServiceQuotaExceededException} (client fault)
+ *  <p>Completing the request would cause a service quota to be exceeded.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link AmpServiceException}
+ * <p>Base exception class for all service exceptions from Amp service.</p>
+ *
+ *
+ * @public
+ */
+export declare class PutAnomalyDetectorCommand extends PutAnomalyDetectorCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutAnomalyDetectorRequest;
+            output: PutAnomalyDetectorResponse;
+        };
+        sdk: {
+            input: PutAnomalyDetectorCommandInput;
+            output: PutAnomalyDetectorCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,10 +1,12 @@
 export * from "./CreateAlertManagerDefinitionCommand";
+export * from "./CreateAnomalyDetectorCommand";
 export * from "./CreateLoggingConfigurationCommand";
 export * from "./CreateQueryLoggingConfigurationCommand";
 export * from "./CreateRuleGroupsNamespaceCommand";
 export * from "./CreateScraperCommand";
 export * from "./CreateWorkspaceCommand";
 export * from "./DeleteAlertManagerDefinitionCommand";
+export * from "./DeleteAnomalyDetectorCommand";
 export * from "./DeleteLoggingConfigurationCommand";
 export * from "./DeleteQueryLoggingConfigurationCommand";
 export * from "./DeleteResourcePolicyCommand";
@@ -13,6 +15,7 @@ export * from "./DeleteScraperCommand";
 export * from "./DeleteScraperLoggingConfigurationCommand";
 export * from "./DeleteWorkspaceCommand";
 export * from "./DescribeAlertManagerDefinitionCommand";
+export * from "./DescribeAnomalyDetectorCommand";
 export * from "./DescribeLoggingConfigurationCommand";
 export * from "./DescribeQueryLoggingConfigurationCommand";
 export * from "./DescribeResourcePolicyCommand";
@@ -22,11 +25,13 @@ export * from "./DescribeScraperLoggingConfigurationCommand";
 export * from "./DescribeWorkspaceCommand";
 export * from "./DescribeWorkspaceConfigurationCommand";
 export * from "./GetDefaultScraperConfigurationCommand";
+export * from "./ListAnomalyDetectorsCommand";
 export * from "./ListRuleGroupsNamespacesCommand";
 export * from "./ListScrapersCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./ListWorkspacesCommand";
 export * from "./PutAlertManagerDefinitionCommand";
+export * from "./PutAnomalyDetectorCommand";
 export * from "./PutResourcePolicyCommand";
 export * from "./PutRuleGroupsNamespaceCommand";
 export * from "./TagResourceCommand";