aws-sdk-prometheusservice 1.62.0 → 1.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b697b6cc911216035d928c1dff41f5ca7e811d9f189cde251d24ceb9e09aa9c
-  data.tar.gz: baa0a8a21fc3d5032d0f829ce50838e4ec58712014e7e28f58f2bab968a0dab4
+  metadata.gz: c813f50173402d78a19064616104f61e3637b5d25c7101d67cda299835600b41
+  data.tar.gz: '06139c65fa0de7918400e723e2f1c86d9af99a4d1943523eae3345ec895624c2'
 SHA512:
-  metadata.gz: cfcb48ebe94773a88b2352d751d5639770bfba632b6c348b82001f4b6fa0f0d00ad3f99f3757173c6104386b319b74b07b18aa85564b8ea49570e80be23383ca
-  data.tar.gz: d6667aca76f6db7b05ea64620ef9a9c22493b8b694cd7698cefb032f9a520a6ff3da0ea687069c44d766c57664fd3168c33a80114ec93fbcdac45fc1a831606e
+  metadata.gz: f1bcd18e9ad24f10b8d3279e3daf1956d1dcd0dea576baa15d0c29fe0f38df61772b642a69ad8d24f2ca5a7ef3f7db84cfdb344ea85953e863eb232072dc5b13
+  data.tar.gz: 6cbf722f7129422366348443f7fc7fedac148425873ad8019b32563ad63041be13f7ccd473c9ac6965f1e588652410bb13ddc303074c03537de1ec6949f98c07

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.63.0 (2025-10-30)
+------------------
+
+* Feature - Add Anomaly Detection APIs for Amazon Managed Prometheus
+
 1.62.0 (2025-10-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.62.0
+1.63.0

data/lib/aws-sdk-prometheusservice/client.rb

@@ -528,6 +528,102 @@ module Aws::PrometheusService
       req.send_request(options)
     end
 
+    # Creates an anomaly detector within a workspace using the Random Cut
+    # Forest algorithm for time-series analysis. The anomaly detector
+    # analyzes Amazon Managed Service for Prometheus metrics to identify
+    # unusual patterns and behaviors.
+    #
+    # @option params [required, String] :workspace_id
+    #   The identifier of the workspace where the anomaly detector will be
+    #   created.
+    #
+    # @option params [required, String] :alias
+    #   A user-friendly name for the anomaly detector.
+    #
+    # @option params [Integer] :evaluation_interval_in_seconds
+    #   The frequency, in seconds, at which the anomaly detector evaluates
+    #   metrics. The default value is 60 seconds.
+    #
+    # @option params [Types::AnomalyDetectorMissingDataAction] :missing_data_action
+    #   Specifies the action to take when data is missing during evaluation.
+    #
+    # @option params [required, Types::AnomalyDetectorConfiguration] :configuration
+    #   The algorithm configuration for the anomaly detector.
+    #
+    # @option params [Hash<String,String>] :labels
+    #   The Amazon Managed Service for Prometheus metric labels to associate
+    #   with the anomaly detector.
+    #
+    # @option params [String] :client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @option params [Hash<String,String>] :tags
+    #   The metadata to apply to the anomaly detector to assist with
+    #   categorization and organization.
+    #
+    # @return [Types::CreateAnomalyDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateAnomalyDetectorResponse#anomaly_detector_id #anomaly_detector_id} => String
+    #   * {Types::CreateAnomalyDetectorResponse#arn #arn} => String
+    #   * {Types::CreateAnomalyDetectorResponse#status #status} => Types::AnomalyDetectorStatus
+    #   * {Types::CreateAnomalyDetectorResponse#tags #tags} => Hash&lt;String,String&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_anomaly_detector({
+    #     workspace_id: "WorkspaceId", # required
+    #     alias: "AnomalyDetectorAlias", # required
+    #     evaluation_interval_in_seconds: 1,
+    #     missing_data_action: {
+    #       mark_as_anomaly: false,
+    #       skip: false,
+    #     },
+    #     configuration: { # required
+    #       random_cut_forest: {
+    #         query: "RandomCutForestQuery", # required
+    #         shingle_size: 1,
+    #         sample_size: 1,
+    #         ignore_near_expected_from_above: {
+    #           amount: 1.0,
+    #           ratio: 1.0,
+    #         },
+    #         ignore_near_expected_from_below: {
+    #           amount: 1.0,
+    #           ratio: 1.0,
+    #         },
+    #       },
+    #     },
+    #     labels: {
+    #       "PrometheusMetricLabelKey" => "PrometheusMetricLabelValue",
+    #     },
+    #     client_token: "IdempotencyToken",
+    #     tags: {
+    #       "TagKey" => "TagValue",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.anomaly_detector_id #=> String
+    #   resp.arn #=> String
+    #   resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
+    #   resp.status.status_reason #=> String
+    #   resp.tags #=> Hash
+    #   resp.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateAnomalyDetector AWS API Documentation
+    #
+    # @overload create_anomaly_detector(params = {})
+    # @param [Hash] params ({})
+    def create_anomaly_detector(params = {}, options = {})
+      req = build_request(:create_anomaly_detector, params)
+      req.send_request(options)
+    end
+
     # The `CreateLoggingConfiguration` operation creates rules and alerting
     # logging configuration for the workspace. Use this operation to set the
     # CloudWatch log group to which the logs will be published to.
@@ -968,6 +1064,42 @@ module Aws::PrometheusService
       req.send_request(options)
     end
 
+    # Removes an anomaly detector from a workspace. This operation is
+    # idempotent.
+    #
+    # @option params [required, String] :workspace_id
+    #   The identifier of the workspace containing the anomaly detector to
+    #   delete.
+    #
+    # @option params [required, String] :anomaly_detector_id
+    #   The identifier of the anomaly detector to delete.
+    #
+    # @option params [String] :client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_anomaly_detector({
+    #     workspace_id: "WorkspaceId", # required
+    #     anomaly_detector_id: "AnomalyDetectorId", # required
+    #     client_token: "IdempotencyToken",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteAnomalyDetector AWS API Documentation
+    #
+    # @overload delete_anomaly_detector(params = {})
+    # @param [Hash] params ({})
+    def delete_anomaly_detector(params = {}, options = {})
+      req = build_request(:delete_anomaly_detector, params)
+      req.send_request(options)
+    end
+
     # Deletes the rules and alerting logging configuration for a workspace.
     #
     # <note markdown="1"> These logging configurations are only for rules and alerting logs.
@@ -1262,6 +1394,65 @@ module Aws::PrometheusService
       req.send_request(options)
     end
 
+    # Retrieves detailed information about a specific anomaly detector,
+    # including its status and configuration.
+    #
+    # @option params [required, String] :workspace_id
+    #   The identifier of the workspace containing the anomaly detector.
+    #
+    # @option params [required, String] :anomaly_detector_id
+    #   The identifier of the anomaly detector to describe.
+    #
+    # @return [Types::DescribeAnomalyDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeAnomalyDetectorResponse#anomaly_detector #anomaly_detector} => Types::AnomalyDetectorDescription
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_anomaly_detector({
+    #     workspace_id: "WorkspaceId", # required
+    #     anomaly_detector_id: "AnomalyDetectorId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.anomaly_detector.arn #=> String
+    #   resp.anomaly_detector.anomaly_detector_id #=> String
+    #   resp.anomaly_detector.alias #=> String
+    #   resp.anomaly_detector.evaluation_interval_in_seconds #=> Integer
+    #   resp.anomaly_detector.missing_data_action.mark_as_anomaly #=> Boolean
+    #   resp.anomaly_detector.missing_data_action.skip #=> Boolean
+    #   resp.anomaly_detector.configuration.random_cut_forest.query #=> String
+    #   resp.anomaly_detector.configuration.random_cut_forest.shingle_size #=> Integer
+    #   resp.anomaly_detector.configuration.random_cut_forest.sample_size #=> Integer
+    #   resp.anomaly_detector.configuration.random_cut_forest.ignore_near_expected_from_above.amount #=> Float
+    #   resp.anomaly_detector.configuration.random_cut_forest.ignore_near_expected_from_above.ratio #=> Float
+    #   resp.anomaly_detector.configuration.random_cut_forest.ignore_near_expected_from_below.amount #=> Float
+    #   resp.anomaly_detector.configuration.random_cut_forest.ignore_near_expected_from_below.ratio #=> Float
+    #   resp.anomaly_detector.labels #=> Hash
+    #   resp.anomaly_detector.labels["PrometheusMetricLabelKey"] #=> String
+    #   resp.anomaly_detector.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
+    #   resp.anomaly_detector.status.status_reason #=> String
+    #   resp.anomaly_detector.created_at #=> Time
+    #   resp.anomaly_detector.modified_at #=> Time
+    #   resp.anomaly_detector.tags #=> Hash
+    #   resp.anomaly_detector.tags["TagKey"] #=> String
+    #
+    #
+    # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
+    #
+    #   * anomaly_detector_active
+    #   * anomaly_detector_deleted
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAnomalyDetector AWS API Documentation
+    #
+    # @overload describe_anomaly_detector(params = {})
+    # @param [Hash] params ({})
+    def describe_anomaly_detector(params = {}, options = {})
+      req = build_request(:describe_anomaly_detector, params)
+      req.send_request(options)
+    end
+
     # Returns complete information about the current rules and alerting
     # logging configuration of the workspace.
     #
@@ -1665,6 +1856,62 @@ module Aws::PrometheusService
       req.send_request(options)
     end
 
+    # Returns a paginated list of anomaly detectors for a workspace with
+    # optional filtering by alias.
+    #
+    # @option params [required, String] :workspace_id
+    #   The identifier of the workspace containing the anomaly detectors to
+    #   list.
+    #
+    # @option params [String] :alias
+    #   Filters the results to anomaly detectors with the specified alias.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of results to return in a single call. Valid range
+    #   is 1 to 1000.
+    #
+    # @option params [String] :next_token
+    #   The pagination token to continue retrieving results.
+    #
+    # @return [Types::ListAnomalyDetectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListAnomalyDetectorsResponse#anomaly_detectors #anomaly_detectors} => Array&lt;Types::AnomalyDetectorSummary&gt;
+    #   * {Types::ListAnomalyDetectorsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_anomaly_detectors({
+    #     workspace_id: "WorkspaceId", # required
+    #     alias: "AnomalyDetectorAlias",
+    #     max_results: 1,
+    #     next_token: "PaginationToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.anomaly_detectors #=> Array
+    #   resp.anomaly_detectors[0].arn #=> String
+    #   resp.anomaly_detectors[0].anomaly_detector_id #=> String
+    #   resp.anomaly_detectors[0].alias #=> String
+    #   resp.anomaly_detectors[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
+    #   resp.anomaly_detectors[0].status.status_reason #=> String
+    #   resp.anomaly_detectors[0].created_at #=> Time
+    #   resp.anomaly_detectors[0].modified_at #=> Time
+    #   resp.anomaly_detectors[0].tags #=> Hash
+    #   resp.anomaly_detectors[0].tags["TagKey"] #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListAnomalyDetectors AWS API Documentation
+    #
+    # @overload list_anomaly_detectors(params = {})
+    # @param [Hash] params ({})
+    def list_anomaly_detectors(params = {}, options = {})
+      req = build_request(:list_anomaly_detectors, params)
+      req.send_request(options)
+    end
+
     # Returns a list of rule groups namespaces in a workspace.
     #
     # @option params [required, String] :workspace_id
@@ -2080,6 +2327,100 @@ module Aws::PrometheusService
       req.send_request(options)
     end
 
+    # When you call `PutAnomalyDetector`, 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.
+    #
+    # @option params [required, String] :workspace_id
+    #   The identifier of the workspace containing the anomaly detector to
+    #   update.
+    #
+    # @option params [required, String] :anomaly_detector_id
+    #   The identifier of the anomaly detector to update.
+    #
+    # @option params [Integer] :evaluation_interval_in_seconds
+    #   The frequency, in seconds, at which the anomaly detector evaluates
+    #   metrics.
+    #
+    # @option params [Types::AnomalyDetectorMissingDataAction] :missing_data_action
+    #   Specifies the action to take when data is missing during evaluation.
+    #
+    # @option params [required, Types::AnomalyDetectorConfiguration] :configuration
+    #   The algorithm configuration for the anomaly detector.
+    #
+    # @option params [Hash<String,String>] :labels
+    #   The Amazon Managed Service for Prometheus metric labels to associate
+    #   with the anomaly detector.
+    #
+    # @option params [String] :client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::PutAnomalyDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::PutAnomalyDetectorResponse#anomaly_detector_id #anomaly_detector_id} => String
+    #   * {Types::PutAnomalyDetectorResponse#arn #arn} => String
+    #   * {Types::PutAnomalyDetectorResponse#status #status} => Types::AnomalyDetectorStatus
+    #   * {Types::PutAnomalyDetectorResponse#tags #tags} => Hash&lt;String,String&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_anomaly_detector({
+    #     workspace_id: "WorkspaceId", # required
+    #     anomaly_detector_id: "AnomalyDetectorId", # required
+    #     evaluation_interval_in_seconds: 1,
+    #     missing_data_action: {
+    #       mark_as_anomaly: false,
+    #       skip: false,
+    #     },
+    #     configuration: { # required
+    #       random_cut_forest: {
+    #         query: "RandomCutForestQuery", # required
+    #         shingle_size: 1,
+    #         sample_size: 1,
+    #         ignore_near_expected_from_above: {
+    #           amount: 1.0,
+    #           ratio: 1.0,
+    #         },
+    #         ignore_near_expected_from_below: {
+    #           amount: 1.0,
+    #           ratio: 1.0,
+    #         },
+    #       },
+    #     },
+    #     labels: {
+    #       "PrometheusMetricLabelKey" => "PrometheusMetricLabelValue",
+    #     },
+    #     client_token: "IdempotencyToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.anomaly_detector_id #=> String
+    #   resp.arn #=> String
+    #   resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
+    #   resp.status.status_reason #=> String
+    #   resp.tags #=> Hash
+    #   resp.tags["TagKey"] #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutAnomalyDetector AWS API Documentation
+    #
+    # @overload put_anomaly_detector(params = {})
+    # @param [Hash] params ({})
+    def put_anomaly_detector(params = {}, options = {})
+      req = build_request(:put_anomaly_detector, params)
+      req.send_request(options)
+    end
+
     # Creates or updates a resource-based policy for an Amazon Managed
     # Service for Prometheus workspace. Use resource-based policies to grant
     # permissions to other AWS accounts or services to access your
@@ -2681,7 +3022,7 @@ module Aws::PrometheusService
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-prometheusservice'
-      context[:gem_version] = '1.62.0'
+      context[:gem_version] = '1.63.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
@@ -2747,12 +3088,14 @@ module Aws::PrometheusService
     # The following table lists the valid waiter names, the operations they call,
     # and the default `:delay` and `:max_attempts` values.
     #
-    # | waiter_name       | params                      | :delay   | :max_attempts |
-    # | ----------------- | --------------------------- | -------- | ------------- |
-    # | scraper_active    | {Client#describe_scraper}   | 2        | 60            |
-    # | scraper_deleted   | {Client#describe_scraper}   | 2        | 60            |
-    # | workspace_active  | {Client#describe_workspace} | 2        | 60            |
-    # | workspace_deleted | {Client#describe_workspace} | 2        | 60            |
+    # | waiter_name              | params                             | :delay   | :max_attempts |
+    # | ------------------------ | ---------------------------------- | -------- | ------------- |
+    # | anomaly_detector_active  | {Client#describe_anomaly_detector} | 2        | 60            |
+    # | anomaly_detector_deleted | {Client#describe_anomaly_detector} | 2        | 60            |
+    # | scraper_active           | {Client#describe_scraper}          | 2        | 60            |
+    # | scraper_deleted          | {Client#describe_scraper}          | 2        | 60            |
+    # | workspace_active         | {Client#describe_workspace}        | 2        | 60            |
+    # | workspace_deleted        | {Client#describe_workspace}        | 2        | 60            |
     #
     # @raise [Errors::FailureStateError] Raised when the waiter terminates
     #   because the waiter has entered a state that it will not transition
@@ -2803,6 +3146,8 @@ module Aws::PrometheusService
 
     def waiters
       {
+        anomaly_detector_active: Waiters::AnomalyDetectorActive,
+        anomaly_detector_deleted: Waiters::AnomalyDetectorDeleted,
         scraper_active: Waiters::ScraperActive,
         scraper_deleted: Waiters::ScraperDeleted,
         workspace_active: Waiters::WorkspaceActive,