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.
410 411 412 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 410 def initialize(*args) super end |
Instance Method Details
#activate_anomaly_detector(params = {}) ⇒ Struct
Activates an anomaly detector.
433 434 435 436 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 433 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.
455 456 457 458 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 455 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.
532 533 534 535 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 532 def create_alert(params = {}, = {}) req = build_request(:create_alert, params) req.send_request() end |
#create_anomaly_detector(params = {}) ⇒ Types::CreateAnomalyDetectorResponse
Creates an anomaly detector.
584 585 586 587 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 584 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.
753 754 755 756 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 753 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.
775 776 777 778 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 775 def deactivate_anomaly_detector(params = {}, = {}) req = build_request(:deactivate_anomaly_detector, params) req.send_request() end |
#delete_alert(params = {}) ⇒ Struct
Deletes an alert.
797 798 799 800 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 797 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.
821 822 823 824 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 821 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.
873 874 875 876 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 873 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.
922 923 924 925 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 922 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.
973 974 975 976 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 973 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.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1087 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.
1153 1154 1155 1156 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1153 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.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1197 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.
1238 1239 1240 1241 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1238 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.
1288 1289 1290 1291 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1288 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.
1339 1340 1341 1342 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1339 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.
1396 1397 1398 1399 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1396 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.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1447 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.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1503 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.
1559 1560 1561 1562 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1559 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.
1621 1622 1623 1624 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1621 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.
1676 1677 1678 1679 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1676 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.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1709 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_feedback(params = {}) ⇒ Struct
Add feedback for an anomalous metric.
1739 1740 1741 1742 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1739 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.
1772 1773 1774 1775 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1772 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.
1802 1803 1804 1805 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1802 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.
1865 1866 1867 1868 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1865 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.
1909 1910 1911 1912 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 1909 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.
2061 2062 2063 2064 |
# File 'gems/aws-sdk-lookoutmetrics/lib/aws-sdk-lookoutmetrics/client.rb', line 2061 def update_metric_set(params = {}, = {}) req = build_request(:update_metric_set, params) req.send_request() end |