com.amazonaws.services.lookoutmetrics.AmazonLookoutMetrics Maven / Gradle / Ivy
Show all versions of aws-java-sdk-lookoutmetrics Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.lookoutmetrics;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.lookoutmetrics.model.*;
/**
* Interface for accessing LookoutMetrics.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.lookoutmetrics.AbstractAmazonLookoutMetrics} instead.
*
*
*
* This is the Amazon Lookout for Metrics API Reference. For an introduction to the service with tutorials for
* getting started, visit Amazon Lookout for Metrics
* Developer Guide.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonLookoutMetrics {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "lookoutmetrics";
/**
*
* Activates an anomaly detector.
*
*
* @param activateAnomalyDetectorRequest
* @return Result of the ActivateAnomalyDetector operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ConflictException
* There was a conflict processing the request. Try your request again.
* @sample AmazonLookoutMetrics.ActivateAnomalyDetector
* @see AWS API Documentation
*/
ActivateAnomalyDetectorResult activateAnomalyDetector(ActivateAnomalyDetectorRequest activateAnomalyDetectorRequest);
/**
*
* Runs a backtest for anomaly detection for the specified resource.
*
*
* @param backTestAnomalyDetectorRequest
* @return Result of the BackTestAnomalyDetector operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.BackTestAnomalyDetector
* @see AWS API Documentation
*/
BackTestAnomalyDetectorResult backTestAnomalyDetector(BackTestAnomalyDetectorRequest backTestAnomalyDetectorRequest);
/**
*
* Creates an alert for an anomaly detector.
*
*
* @param createAlertRequest
* @return Result of the CreateAlert operation returned by the service.
* @throws ConflictException
* There was a conflict processing the request. Try your request again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ServiceQuotaExceededException
* The request exceeded the service's quotas. Check the service quotas and try again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.CreateAlert
* @see AWS API
* Documentation
*/
CreateAlertResult createAlert(CreateAlertRequest createAlertRequest);
/**
*
* Creates an anomaly detector.
*
*
* @param createAnomalyDetectorRequest
* @return Result of the CreateAnomalyDetector operation returned by the service.
* @throws ConflictException
* There was a conflict processing the request. Try your request again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ServiceQuotaExceededException
* The request exceeded the service's quotas. Check the service quotas and try again.
* @throws ConflictException
* There was a conflict processing the request. Try your request again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.CreateAnomalyDetector
* @see AWS API Documentation
*/
CreateAnomalyDetectorResult createAnomalyDetector(CreateAnomalyDetectorRequest createAnomalyDetectorRequest);
/**
*
* Creates a dataset.
*
*
* @param createMetricSetRequest
* @return Result of the CreateMetricSet operation returned by the service.
* @throws ConflictException
* There was a conflict processing the request. Try your request again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ServiceQuotaExceededException
* The request exceeded the service's quotas. Check the service quotas and try again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.CreateMetricSet
* @see AWS
* API Documentation
*/
CreateMetricSetResult createMetricSet(CreateMetricSetRequest createMetricSetRequest);
/**
*
* Deactivates an anomaly detector.
*
*
* @param deactivateAnomalyDetectorRequest
* @return Result of the DeactivateAnomalyDetector operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ConflictException
* There was a conflict processing the request. Try your request again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.DeactivateAnomalyDetector
* @see AWS API Documentation
*/
DeactivateAnomalyDetectorResult deactivateAnomalyDetector(DeactivateAnomalyDetectorRequest deactivateAnomalyDetectorRequest);
/**
*
* Deletes an alert.
*
*
* @param deleteAlertRequest
* @return Result of the DeleteAlert operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.DeleteAlert
* @see AWS API
* Documentation
*/
DeleteAlertResult deleteAlert(DeleteAlertRequest deleteAlertRequest);
/**
*
* Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any
* configured datasets and alerts.
*
*
* @param deleteAnomalyDetectorRequest
* @return Result of the DeleteAnomalyDetector operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ConflictException
* There was a conflict processing the request. Try your request again.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.DeleteAnomalyDetector
* @see AWS API Documentation
*/
DeleteAnomalyDetectorResult deleteAnomalyDetector(DeleteAnomalyDetectorRequest deleteAnomalyDetectorRequest);
/**
*
* 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.
*
*
* @param describeAlertRequest
* @return Result of the DescribeAlert operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.DescribeAlert
* @see AWS
* API Documentation
*/
DescribeAlertResult describeAlert(DescribeAlertRequest describeAlertRequest);
/**
*
* Returns information about the status of the specified anomaly detection jobs.
*
*
* @param describeAnomalyDetectionExecutionsRequest
* @return Result of the DescribeAnomalyDetectionExecutions operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.DescribeAnomalyDetectionExecutions
* @see AWS API Documentation
*/
DescribeAnomalyDetectionExecutionsResult describeAnomalyDetectionExecutions(
DescribeAnomalyDetectionExecutionsRequest describeAnomalyDetectionExecutionsRequest);
/**
*
* 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.
*
*
* @param describeAnomalyDetectorRequest
* @return Result of the DescribeAnomalyDetector operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.DescribeAnomalyDetector
* @see AWS API Documentation
*/
DescribeAnomalyDetectorResult describeAnomalyDetector(DescribeAnomalyDetectorRequest describeAnomalyDetectorRequest);
/**
*
* 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.
*
*
* @param describeMetricSetRequest
* @return Result of the DescribeMetricSet operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.DescribeMetricSet
* @see AWS API Documentation
*/
DescribeMetricSetResult describeMetricSet(DescribeMetricSetRequest describeMetricSetRequest);
/**
*
* Detects an Amazon S3 dataset's file format, interval, and offset.
*
*
* @param detectMetricSetConfigRequest
* @return Result of the DetectMetricSetConfig operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.DetectMetricSetConfig
* @see AWS API Documentation
*/
DetectMetricSetConfigResult detectMetricSetConfig(DetectMetricSetConfigRequest detectMetricSetConfigRequest);
/**
*
* Returns details about a group of anomalous metrics.
*
*
* @param getAnomalyGroupRequest
* @return Result of the GetAnomalyGroup operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.GetAnomalyGroup
* @see AWS
* API Documentation
*/
GetAnomalyGroupResult getAnomalyGroup(GetAnomalyGroupRequest getAnomalyGroupRequest);
/**
*
* Returns details about the requested data quality metrics.
*
*
* @param getDataQualityMetricsRequest
* @return Result of the GetDataQualityMetrics operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.GetDataQualityMetrics
* @see AWS API Documentation
*/
GetDataQualityMetricsResult getDataQualityMetrics(GetDataQualityMetricsRequest getDataQualityMetricsRequest);
/**
*
* Get feedback for an anomaly group.
*
*
* @param getFeedbackRequest
* @return Result of the GetFeedback operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.GetFeedback
* @see AWS API
* Documentation
*/
GetFeedbackResult getFeedback(GetFeedbackRequest getFeedbackRequest);
/**
*
* Returns a selection of sample records from an Amazon S3 datasource.
*
*
* @param getSampleDataRequest
* @return Result of the GetSampleData operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.GetSampleData
* @see AWS
* API Documentation
*/
GetSampleDataResult getSampleData(GetSampleDataRequest getSampleDataRequest);
/**
*
* 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.
*
*
* @param listAlertsRequest
* @return Result of the ListAlerts operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @sample AmazonLookoutMetrics.ListAlerts
* @see AWS API
* Documentation
*/
ListAlertsResult listAlerts(ListAlertsRequest listAlertsRequest);
/**
*
* 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.
*
*
* @param listAnomalyDetectorsRequest
* @return Result of the ListAnomalyDetectors operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.ListAnomalyDetectors
* @see AWS API Documentation
*/
ListAnomalyDetectorsResult listAnomalyDetectors(ListAnomalyDetectorsRequest listAnomalyDetectorsRequest);
/**
*
* Returns a list of measures that are potential causes or effects of an anomaly group.
*
*
* @param listAnomalyGroupRelatedMetricsRequest
* @return Result of the ListAnomalyGroupRelatedMetrics operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.ListAnomalyGroupRelatedMetrics
* @see AWS API Documentation
*/
ListAnomalyGroupRelatedMetricsResult listAnomalyGroupRelatedMetrics(ListAnomalyGroupRelatedMetricsRequest listAnomalyGroupRelatedMetricsRequest);
/**
*
* Returns a list of anomaly groups.
*
*
* @param listAnomalyGroupSummariesRequest
* @return Result of the ListAnomalyGroupSummaries operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.ListAnomalyGroupSummaries
* @see AWS API Documentation
*/
ListAnomalyGroupSummariesResult listAnomalyGroupSummaries(ListAnomalyGroupSummariesRequest listAnomalyGroupSummariesRequest);
/**
*
* Gets a list of anomalous metrics for a measure in an anomaly group.
*
*
* @param listAnomalyGroupTimeSeriesRequest
* @return Result of the ListAnomalyGroupTimeSeries operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.ListAnomalyGroupTimeSeries
* @see AWS API Documentation
*/
ListAnomalyGroupTimeSeriesResult listAnomalyGroupTimeSeries(ListAnomalyGroupTimeSeriesRequest listAnomalyGroupTimeSeriesRequest);
/**
*
* 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.
*
*
* @param listMetricSetsRequest
* @return Result of the ListMetricSets operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @sample AmazonLookoutMetrics.ListMetricSets
* @see AWS
* API Documentation
*/
ListMetricSetsResult listMetricSets(ListMetricSetsRequest listMetricSetsRequest);
/**
*
* Gets a list of tags for a
* detector, dataset, or alert.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @sample AmazonLookoutMetrics.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Add feedback for an anomalous metric.
*
*
* @param putFeedbackRequest
* @return Result of the PutFeedback operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.PutFeedback
* @see AWS API
* Documentation
*/
PutFeedbackResult putFeedback(PutFeedbackRequest putFeedbackRequest);
/**
*
* Adds tags to a detector,
* dataset, or alert.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @sample AmazonLookoutMetrics.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes tags from a
* detector, dataset, or alert.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @sample AmazonLookoutMetrics.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Make changes to an existing alert.
*
*
* @param updateAlertRequest
* @return Result of the UpdateAlert operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.UpdateAlert
* @see AWS API
* Documentation
*/
UpdateAlertResult updateAlert(UpdateAlertRequest updateAlertRequest);
/**
*
* Updates a detector. After activation, you can only change a detector's ingestion delay and description.
*
*
* @param updateAnomalyDetectorRequest
* @return Result of the UpdateAnomalyDetector operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @sample AmazonLookoutMetrics.UpdateAnomalyDetector
* @see AWS API Documentation
*/
UpdateAnomalyDetectorResult updateAnomalyDetector(UpdateAnomalyDetectorRequest updateAnomalyDetectorRequest);
/**
*
* Updates a dataset.
*
*
* @param updateMetricSetRequest
* @return Result of the UpdateMetricSet operation returned by the service.
* @throws ResourceNotFoundException
* The specified resource cannot be found. Check the ARN of the resource and try again.
* @throws ValidationException
* The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
* again.
* @throws InternalServerException
* The request processing has failed because of an unknown error, exception, or failure.
* @throws AccessDeniedException
* You do not have sufficient permissions to perform this action.
* @throws TooManyRequestsException
* The request was denied due to too many requests being submitted at the same time.
* @throws ServiceQuotaExceededException
* The request exceeded the service's quotas. Check the service quotas and try again.
* @sample AmazonLookoutMetrics.UpdateMetricSet
* @see AWS
* API Documentation
*/
UpdateMetricSetResult updateMetricSet(UpdateMetricSetRequest updateMetricSetRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}