Class: Aws::LookoutMetrics::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::LookoutMetrics::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb
Overview
An API client for LookoutMetrics. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::LookoutMetrics::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#activate_anomaly_detector(params = {}) ⇒ Struct
Activates an anomaly detector.
-
#back_test_anomaly_detector(params = {}) ⇒ Struct
Runs a backtest for anomaly detection for the specified resource.
-
#create_alert(params = {}) ⇒ Types::CreateAlertResponse
Creates an alert for an anomaly detector.
-
#create_anomaly_detector(params = {}) ⇒ Types::CreateAnomalyDetectorResponse
Creates an anomaly detector.
-
#create_metric_set(params = {}) ⇒ Types::CreateMetricSetResponse
Creates a dataset.
-
#deactivate_anomaly_detector(params = {}) ⇒ Struct
Deactivates an anomaly detector.
-
#delete_alert(params = {}) ⇒ Struct
Deletes an alert.
-
#delete_anomaly_detector(params = {}) ⇒ Struct
Deletes a detector.
-
#describe_alert(params = {}) ⇒ Types::DescribeAlertResponse
Describes an alert.
-
#describe_anomaly_detection_executions(params = {}) ⇒ Types::DescribeAnomalyDetectionExecutionsResponse
Returns information about the status of the specified anomaly detection jobs.
-
#describe_anomaly_detector(params = {}) ⇒ Types::DescribeAnomalyDetectorResponse
Describes a detector.
-
#describe_metric_set(params = {}) ⇒ Types::DescribeMetricSetResponse
Describes a dataset.
-
#detect_metric_set_config(params = {}) ⇒ Types::DetectMetricSetConfigResponse
Detects an Amazon S3 dataset's file format, interval, and offset.
-
#get_anomaly_group(params = {}) ⇒ Types::GetAnomalyGroupResponse
Returns details about a group of anomalous metrics.
-
#get_data_quality_metrics(params = {}) ⇒ Types::GetDataQualityMetricsResponse
Returns details about the requested data quality metrics.
-
#get_feedback(params = {}) ⇒ Types::GetFeedbackResponse
Get feedback for an anomaly group.
-
#get_sample_data(params = {}) ⇒ Types::GetSampleDataResponse
Returns a selection of sample records from an Amazon S3 datasource.
-
#list_alerts(params = {}) ⇒ Types::ListAlertsResponse
Lists the alerts attached to a detector.
-
#list_anomaly_detectors(params = {}) ⇒ Types::ListAnomalyDetectorsResponse
Lists the detectors in the current AWS Region.
-
#list_anomaly_group_related_metrics(params = {}) ⇒ Types::ListAnomalyGroupRelatedMetricsResponse
Returns a list of measures that are potential causes or effects of an anomaly group.
-
#list_anomaly_group_summaries(params = {}) ⇒ Types::ListAnomalyGroupSummariesResponse
Returns a list of anomaly groups.
-
#list_anomaly_group_time_series(params = {}) ⇒ Types::ListAnomalyGroupTimeSeriesResponse
Gets a list of anomalous metrics for a measure in an anomaly group.
-
#list_metric_sets(params = {}) ⇒ Types::ListMetricSetsResponse
Lists the datasets in the current AWS Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of [tags][1] for a detector, dataset, or alert.
-
#put_feedback(params = {}) ⇒ Struct
Add feedback for an anomalous metric.
-
#tag_resource(params = {}) ⇒ Struct
Adds [tags][1] to a detector, dataset, or alert.
-
#untag_resource(params = {}) ⇒ Struct
Removes [tags][1] from a detector, dataset, or alert.
-
#update_alert(params = {}) ⇒ Types::UpdateAlertResponse
Make changes to an existing alert.
-
#update_anomaly_detector(params = {}) ⇒ Types::UpdateAnomalyDetectorResponse
Updates a detector.
-
#update_metric_set(params = {}) ⇒ Types::UpdateMetricSetResponse
Updates a dataset.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
385 386 387 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#activate_anomaly_detector(params = {}) ⇒ Struct
Activates an anomaly detector.
408 409 410 411 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 408 def activate_anomaly_detector(params = {}, = {}) req = build_request(:activate_anomaly_detector, params) req.send_request() end |
#back_test_anomaly_detector(params = {}) ⇒ Struct
Runs a backtest for anomaly detection for the specified resource.
430 431 432 433 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 430 def back_test_anomaly_detector(params = {}, = {}) req = build_request(:back_test_anomaly_detector, params) req.send_request() end |
#create_alert(params = {}) ⇒ Types::CreateAlertResponse
Creates an alert for an anomaly detector.
507 508 509 510 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 507 def create_alert(params = {}, = {}) req = build_request(:create_alert, params) req.send_request() end |
#create_anomaly_detector(params = {}) ⇒ Types::CreateAnomalyDetectorResponse
Creates an anomaly detector.
559 560 561 562 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 559 def create_anomaly_detector(params = {}, = {}) req = build_request(:create_anomaly_detector, params) req.send_request() end |
#create_metric_set(params = {}) ⇒ Types::CreateMetricSetResponse
Creates a dataset.
728 729 730 731 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 728 def create_metric_set(params = {}, = {}) req = build_request(:create_metric_set, params) req.send_request() end |
#deactivate_anomaly_detector(params = {}) ⇒ Struct
Deactivates an anomaly detector.
750 751 752 753 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 750 def deactivate_anomaly_detector(params = {}, = {}) req = build_request(:deactivate_anomaly_detector, params) req.send_request() end |
#delete_alert(params = {}) ⇒ Struct
Deletes an alert.
772 773 774 775 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 772 def delete_alert(params = {}, = {}) req = build_request(:delete_alert, params) req.send_request() end |
#delete_anomaly_detector(params = {}) ⇒ Struct
Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
796 797 798 799 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 796 def delete_anomaly_detector(params = {}, = {}) req = build_request(:delete_anomaly_detector, params) req.send_request() end |
#describe_alert(params = {}) ⇒ Types::DescribeAlertResponse
Describes an alert.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
848 849 850 851 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 848 def describe_alert(params = {}, = {}) req = build_request(:describe_alert, params) req.send_request() end |
#describe_anomaly_detection_executions(params = {}) ⇒ Types::DescribeAnomalyDetectionExecutionsResponse
Returns information about the status of the specified anomaly detection jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
897 898 899 900 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 897 def describe_anomaly_detection_executions(params = {}, = {}) req = build_request(:describe_anomaly_detection_executions, params) req.send_request() end |
#describe_anomaly_detector(params = {}) ⇒ Types::DescribeAnomalyDetectorResponse
Describes a detector.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
948 949 950 951 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 948 def describe_anomaly_detector(params = {}, = {}) req = build_request(:describe_anomaly_detector, params) req.send_request() end |
#describe_metric_set(params = {}) ⇒ Types::DescribeMetricSetResponse
Describes a dataset.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1062 def describe_metric_set(params = {}, = {}) req = build_request(:describe_metric_set, params) req.send_request() end |
#detect_metric_set_config(params = {}) ⇒ Types::DetectMetricSetConfigResponse
Detects an Amazon S3 dataset's file format, interval, and offset.
1128 1129 1130 1131 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1128 def detect_metric_set_config(params = {}, = {}) req = build_request(:detect_metric_set_config, params) req.send_request() end |
#get_anomaly_group(params = {}) ⇒ Types::GetAnomalyGroupResponse
Returns details about a group of anomalous metrics.
1172 1173 1174 1175 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1172 def get_anomaly_group(params = {}, = {}) req = build_request(:get_anomaly_group, params) req.send_request() end |
#get_data_quality_metrics(params = {}) ⇒ Types::GetDataQualityMetricsResponse
Returns details about the requested data quality metrics.
1213 1214 1215 1216 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1213 def get_data_quality_metrics(params = {}, = {}) req = build_request(:get_data_quality_metrics, params) req.send_request() end |
#get_feedback(params = {}) ⇒ Types::GetFeedbackResponse
Get feedback for an anomaly group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1263 1264 1265 1266 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1263 def get_feedback(params = {}, = {}) req = build_request(:get_feedback, params) req.send_request() end |
#get_sample_data(params = {}) ⇒ Types::GetSampleDataResponse
Returns a selection of sample records from an Amazon S3 datasource.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1314 def get_sample_data(params = {}, = {}) req = build_request(:get_sample_data, params) req.send_request() end |
#list_alerts(params = {}) ⇒ Types::ListAlertsResponse
Lists the alerts attached to a detector.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1371 1372 1373 1374 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1371 def list_alerts(params = {}, = {}) req = build_request(:list_alerts, params) req.send_request() end |
#list_anomaly_detectors(params = {}) ⇒ Types::ListAnomalyDetectorsResponse
Lists the detectors in the current AWS Region.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1422 1423 1424 1425 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1422 def list_anomaly_detectors(params = {}, = {}) req = build_request(:list_anomaly_detectors, params) req.send_request() end |
#list_anomaly_group_related_metrics(params = {}) ⇒ Types::ListAnomalyGroupRelatedMetricsResponse
Returns a list of measures that are potential causes or effects of an anomaly group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1478 1479 1480 1481 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1478 def (params = {}, = {}) req = build_request(:list_anomaly_group_related_metrics, params) req.send_request() end |
#list_anomaly_group_summaries(params = {}) ⇒ Types::ListAnomalyGroupSummariesResponse
Returns a list of anomaly groups.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1534 1535 1536 1537 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1534 def list_anomaly_group_summaries(params = {}, = {}) req = build_request(:list_anomaly_group_summaries, params) req.send_request() end |
#list_anomaly_group_time_series(params = {}) ⇒ Types::ListAnomalyGroupTimeSeriesResponse
Gets a list of anomalous metrics for a measure in an anomaly group.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1596 1597 1598 1599 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1596 def list_anomaly_group_time_series(params = {}, = {}) req = build_request(:list_anomaly_group_time_series, params) req.send_request() end |
#list_metric_sets(params = {}) ⇒ Types::ListMetricSetsResponse
Lists the datasets in the current AWS Region.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1651 1652 1653 1654 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1651 def list_metric_sets(params = {}, = {}) req = build_request(:list_metric_sets, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags for a detector, dataset, or alert.
1684 1685 1686 1687 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1684 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_feedback(params = {}) ⇒ Struct
Add feedback for an anomalous metric.
1714 1715 1716 1717 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1714 def put_feedback(params = {}, = {}) req = build_request(:put_feedback, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds tags to a detector, dataset, or alert.
1747 1748 1749 1750 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1747 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a detector, dataset, or alert.
1777 1778 1779 1780 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1777 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_alert(params = {}) ⇒ Types::UpdateAlertResponse
Make changes to an existing alert.
1840 1841 1842 1843 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1840 def update_alert(params = {}, = {}) req = build_request(:update_alert, params) req.send_request() end |
#update_anomaly_detector(params = {}) ⇒ Types::UpdateAnomalyDetectorResponse
Updates a detector. After activation, you can only change a detector's ingestion delay and description.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1884 def update_anomaly_detector(params = {}, = {}) req = build_request(:update_anomaly_detector, params) req.send_request() end |
#update_metric_set(params = {}) ⇒ Types::UpdateMetricSetResponse
Updates a dataset.
2036 2037 2038 2039 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 2036 def update_metric_set(params = {}, = {}) req = build_request(:update_metric_set, params) req.send_request() end |