@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonLookoutMetricsClient extends AmazonWebServiceClient implements AmazonLookoutMetrics
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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AmazonLookoutMetricsClientBuilder builder()
public ActivateAnomalyDetectorResult activateAnomalyDetector(ActivateAnomalyDetectorRequest request)
Activates an anomaly detector.
activateAnomalyDetector in interface AmazonLookoutMetricsactivateAnomalyDetectorRequest - ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ConflictException - There was a conflict processing the request. Try your request again.public BackTestAnomalyDetectorResult backTestAnomalyDetector(BackTestAnomalyDetectorRequest request)
Runs a backtest for anomaly detection for the specified resource.
backTestAnomalyDetector in interface AmazonLookoutMetricsbackTestAnomalyDetectorRequest - ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public CreateAlertResult createAlert(CreateAlertRequest request)
Creates an alert for an anomaly detector.
createAlert in interface AmazonLookoutMetricscreateAlertRequest - ConflictException - There was a conflict processing the request. Try your request again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ServiceQuotaExceededException - The request exceeded the service's quotas. Check the service quotas and try again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public CreateAnomalyDetectorResult createAnomalyDetector(CreateAnomalyDetectorRequest request)
Creates an anomaly detector.
createAnomalyDetector in interface AmazonLookoutMetricscreateAnomalyDetectorRequest - ConflictException - There was a conflict processing the request. Try your request again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ServiceQuotaExceededException - The request exceeded the service's quotas. Check the service quotas and try again.ConflictException - There was a conflict processing the request. Try your request again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public CreateMetricSetResult createMetricSet(CreateMetricSetRequest request)
Creates a dataset.
createMetricSet in interface AmazonLookoutMetricscreateMetricSetRequest - ConflictException - There was a conflict processing the request. Try your request again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ServiceQuotaExceededException - The request exceeded the service's quotas. Check the service quotas and try again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public DeactivateAnomalyDetectorResult deactivateAnomalyDetector(DeactivateAnomalyDetectorRequest request)
Deactivates an anomaly detector.
deactivateAnomalyDetector in interface AmazonLookoutMetricsdeactivateAnomalyDetectorRequest - ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ConflictException - There was a conflict processing the request. Try your request again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public DeleteAlertResult deleteAlert(DeleteAlertRequest request)
Deletes an alert.
deleteAlert in interface AmazonLookoutMetricsdeleteAlertRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public DeleteAnomalyDetectorResult deleteAnomalyDetector(DeleteAnomalyDetectorRequest request)
Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
deleteAnomalyDetector in interface AmazonLookoutMetricsdeleteAnomalyDetectorRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ConflictException - There was a conflict processing the request. Try your request again.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public DescribeAlertResult describeAlert(DescribeAlertRequest request)
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.
describeAlert in interface AmazonLookoutMetricsdescribeAlertRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public DescribeAnomalyDetectionExecutionsResult describeAnomalyDetectionExecutions(DescribeAnomalyDetectionExecutionsRequest request)
Returns information about the status of the specified anomaly detection jobs.
describeAnomalyDetectionExecutions in interface AmazonLookoutMetricsdescribeAnomalyDetectionExecutionsRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public DescribeAnomalyDetectorResult describeAnomalyDetector(DescribeAnomalyDetectorRequest request)
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.
describeAnomalyDetector in interface AmazonLookoutMetricsdescribeAnomalyDetectorRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public DescribeMetricSetResult describeMetricSet(DescribeMetricSetRequest request)
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.
describeMetricSet in interface AmazonLookoutMetricsdescribeMetricSetRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public DetectMetricSetConfigResult detectMetricSetConfig(DetectMetricSetConfigRequest request)
Detects an Amazon S3 dataset's file format, interval, and offset.
detectMetricSetConfig in interface AmazonLookoutMetricsdetectMetricSetConfigRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public GetAnomalyGroupResult getAnomalyGroup(GetAnomalyGroupRequest request)
Returns details about a group of anomalous metrics.
getAnomalyGroup in interface AmazonLookoutMetricsgetAnomalyGroupRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public GetDataQualityMetricsResult getDataQualityMetrics(GetDataQualityMetricsRequest request)
Returns details about the requested data quality metrics.
getDataQualityMetrics in interface AmazonLookoutMetricsgetDataQualityMetricsRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public GetFeedbackResult getFeedback(GetFeedbackRequest request)
Get feedback for an anomaly group.
getFeedback in interface AmazonLookoutMetricsgetFeedbackRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public GetSampleDataResult getSampleData(GetSampleDataRequest request)
Returns a selection of sample records from an Amazon S3 datasource.
getSampleData in interface AmazonLookoutMetricsgetSampleDataRequest - ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public ListAlertsResult listAlerts(ListAlertsRequest request)
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.
listAlerts in interface AmazonLookoutMetricslistAlertsRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.public ListAnomalyDetectorsResult listAnomalyDetectors(ListAnomalyDetectorsRequest request)
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.
listAnomalyDetectors in interface AmazonLookoutMetricslistAnomalyDetectorsRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public ListAnomalyGroupRelatedMetricsResult listAnomalyGroupRelatedMetrics(ListAnomalyGroupRelatedMetricsRequest request)
Returns a list of measures that are potential causes or effects of an anomaly group.
listAnomalyGroupRelatedMetrics in interface AmazonLookoutMetricslistAnomalyGroupRelatedMetricsRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public ListAnomalyGroupSummariesResult listAnomalyGroupSummaries(ListAnomalyGroupSummariesRequest request)
Returns a list of anomaly groups.
listAnomalyGroupSummaries in interface AmazonLookoutMetricslistAnomalyGroupSummariesRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public ListAnomalyGroupTimeSeriesResult listAnomalyGroupTimeSeries(ListAnomalyGroupTimeSeriesRequest request)
Gets a list of anomalous metrics for a measure in an anomaly group.
listAnomalyGroupTimeSeries in interface AmazonLookoutMetricslistAnomalyGroupTimeSeriesRequest - InternalServerException - The request processing has failed because of an unknown error, exception, or failure.AccessDeniedException - You do not have sufficient permissions to perform this action.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public ListMetricSetsResult listMetricSets(ListMetricSetsRequest request)
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.
listMetricSets in interface AmazonLookoutMetricslistMetricSetsRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Gets a list of tags for a detector, dataset, or alert.
listTagsForResource in interface AmazonLookoutMetricslistTagsForResourceRequest - InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.public PutFeedbackResult putFeedback(PutFeedbackRequest request)
Add feedback for an anomalous metric.
putFeedback in interface AmazonLookoutMetricsputFeedbackRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.AccessDeniedException - You do not have sufficient permissions to perform this action.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public TagResourceResult tagResource(TagResourceRequest request)
Adds tags to a detector, dataset, or alert.
tagResource in interface AmazonLookoutMetricstagResourceRequest - InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from a detector, dataset, or alert.
untagResource in interface AmazonLookoutMetricsuntagResourceRequest - InternalServerException - The request processing has failed because of an unknown error, exception, or failure.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.public UpdateAlertResult updateAlert(UpdateAlertRequest request)
Make changes to an existing alert.
updateAlert in interface AmazonLookoutMetricsupdateAlertRequest - ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public UpdateAnomalyDetectorResult updateAnomalyDetector(UpdateAnomalyDetectorRequest request)
Updates a detector. After activation, you can only change a detector's ingestion delay and description.
updateAnomalyDetector in interface AmazonLookoutMetricsupdateAnomalyDetectorRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.public UpdateMetricSetResult updateMetricSet(UpdateMetricSetRequest request)
Updates a dataset.
updateMetricSet in interface AmazonLookoutMetricsupdateMetricSetRequest - ResourceNotFoundException - The specified resource cannot be found. Check the ARN of the resource and try again.ValidationException - The input fails to satisfy the constraints specified by the AWS service. Check your input values and try
again.InternalServerException - The request processing has failed because of an unknown error, exception, or failure.AccessDeniedException - You do not have sufficient permissions to perform this action.TooManyRequestsException - The request was denied due to too many requests being submitted at the same time.ServiceQuotaExceededException - The request exceeded the service's quotas. Check the service quotas and try again.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata in interface AmazonLookoutMetricsrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AmazonLookoutMetricsshutdown in class AmazonWebServiceClient