{ "smithy": "1.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.lookoutmetrics#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.lookoutmetrics#Message", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

You do not have sufficient permissions to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.lookoutmetrics#Action": { "type": "structure", "members": { "SNSConfiguration": { "target": "com.amazonaws.lookoutmetrics#SNSConfiguration", "traits": { "smithy.api#documentation": "

A configuration for an Amazon SNS channel.

" } }, "LambdaConfiguration": { "target": "com.amazonaws.lookoutmetrics#LambdaConfiguration", "traits": { "smithy.api#documentation": "

A configuration for an AWS Lambda channel.

" } } }, "traits": { "smithy.api#documentation": "

A configuration that specifies the action to perform when anomalies are detected.

" } }, "com.amazonaws.lookoutmetrics#ActivateAnomalyDetector": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#ActivateAnomalyDetectorRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#ActivateAnomalyDetectorResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#ConflictException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Activates an anomaly detector.

", "smithy.api#http": { "method": "POST", "uri": "/ActivateAnomalyDetector", "code": 200 } } }, "com.amazonaws.lookoutmetrics#ActivateAnomalyDetectorRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the anomaly detector.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#ActivateAnomalyDetectorResponse": { "type": "structure", "members": {} }, "com.amazonaws.lookoutmetrics#AggregationFunction": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "AVG", "name": "AVG" }, { "value": "SUM", "name": "SUM" } ] } }, "com.amazonaws.lookoutmetrics#Alert": { "type": "structure", "members": { "Action": { "target": "com.amazonaws.lookoutmetrics#Action", "traits": { "smithy.api#documentation": "

Action that will be triggered when there is an alert.

" } }, "AlertDescription": { "target": "com.amazonaws.lookoutmetrics#AlertDescription", "traits": { "smithy.api#documentation": "

A description of the alert.

" } }, "AlertArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the alert.

" } }, "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector to which the alert is attached.

" } }, "AlertName": { "target": "com.amazonaws.lookoutmetrics#AlertName", "traits": { "smithy.api#documentation": "

The name of the alert.

" } }, "AlertSensitivityThreshold": { "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", "traits": { "smithy.api#documentation": "

The minimum severity for an anomaly to trigger the alert.

" } }, "AlertType": { "target": "com.amazonaws.lookoutmetrics#AlertType", "traits": { "smithy.api#documentation": "

The type of the alert.

" } }, "AlertStatus": { "target": "com.amazonaws.lookoutmetrics#AlertStatus", "traits": { "smithy.api#documentation": "

The status of the alert.

" } }, "LastModificationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the alert was last modified.

" } }, "CreationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the alert was created.

" } } }, "traits": { "smithy.api#documentation": "

A configuration for Amazon SNS-integrated notifications.

" } }, "com.amazonaws.lookoutmetrics#AlertDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#AlertName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" } }, "com.amazonaws.lookoutmetrics#AlertStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "INACTIVE", "name": "INACTIVE" } ] } }, "com.amazonaws.lookoutmetrics#AlertSummary": { "type": "structure", "members": { "AlertArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the alert.

" } }, "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector to which the alert is attached.

" } }, "AlertName": { "target": "com.amazonaws.lookoutmetrics#AlertName", "traits": { "smithy.api#documentation": "

The name of the alert.

" } }, "AlertSensitivityThreshold": { "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", "traits": { "smithy.api#documentation": "

The minimum severity for an anomaly to trigger the alert.

" } }, "AlertType": { "target": "com.amazonaws.lookoutmetrics#AlertType", "traits": { "smithy.api#documentation": "

The type of the alert.

" } }, "AlertStatus": { "target": "com.amazonaws.lookoutmetrics#AlertStatus", "traits": { "smithy.api#documentation": "

The status of the alert.

" } }, "LastModificationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the alert was last modified.

" } }, "CreationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the alert was created.

" } }, "Tags": { "target": "com.amazonaws.lookoutmetrics#TagMap", "traits": { "smithy.api#documentation": "

The alert's tags.

" } } }, "traits": { "smithy.api#documentation": "

Provides a summary of an alert's configuration.

" } }, "com.amazonaws.lookoutmetrics#AlertSummaryList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#AlertSummary" } }, "com.amazonaws.lookoutmetrics#AlertType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SNS", "name": "SNS" }, { "value": "LAMBDA", "name": "LAMBDA" } ] } }, "com.amazonaws.lookoutmetrics#AnomalyDetectionTaskStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PENDING", "name": "PENDING" }, { "value": "IN_PROGRESS", "name": "IN_PROGRESS" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "FAILED", "name": "FAILED" }, { "value": "FAILED_TO_SCHEDULE", "name": "FAILED_TO_SCHEDULE" } ] } }, "com.amazonaws.lookoutmetrics#AnomalyDetectionTaskStatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#AnomalyDetectorConfig": { "type": "structure", "members": { "AnomalyDetectorFrequency": { "target": "com.amazonaws.lookoutmetrics#Frequency", "traits": { "smithy.api#documentation": "

The frequency at which the detector analyzes its source data.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a detector's configuration.

" } }, "com.amazonaws.lookoutmetrics#AnomalyDetectorConfigSummary": { "type": "structure", "members": { "AnomalyDetectorFrequency": { "target": "com.amazonaws.lookoutmetrics#Frequency", "traits": { "smithy.api#documentation": "

The interval at which the detector analyzes its source data.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a detector's configuration.

" } }, "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#AnomalyDetectorName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" } }, "com.amazonaws.lookoutmetrics#AnomalyDetectorStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "ACTIVATING", "name": "ACTIVATING" }, { "value": "DELETING", "name": "DELETING" }, { "value": "FAILED", "name": "FAILED" }, { "value": "INACTIVE", "name": "INACTIVE" }, { "value": "BACK_TEST_ACTIVATING", "name": "BACK_TEST_ACTIVATING" }, { "value": "BACK_TEST_ACTIVE", "name": "BACK_TEST_ACTIVE" }, { "value": "BACK_TEST_COMPLETE", "name": "BACK_TEST_COMPLETE" } ] } }, "com.amazonaws.lookoutmetrics#AnomalyDetectorSummary": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector.

" } }, "AnomalyDetectorName": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorName", "traits": { "smithy.api#documentation": "

The name of the detector.

" } }, "AnomalyDetectorDescription": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription", "traits": { "smithy.api#documentation": "

A description of the detector.

" } }, "CreationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the detector was created.

" } }, "LastModificationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the detector was last modified.

" } }, "Status": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorStatus", "traits": { "smithy.api#documentation": "

The status of detector.

" } }, "Tags": { "target": "com.amazonaws.lookoutmetrics#TagMap", "traits": { "smithy.api#documentation": "

The detector's tags.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about an an anomaly detector.

" } }, "com.amazonaws.lookoutmetrics#AnomalyDetectorSummaryList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorSummary" } }, "com.amazonaws.lookoutmetrics#AnomalyGroup": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.lookoutmetrics#TimestampString", "traits": { "smithy.api#documentation": "

The start time for the group.

" } }, "EndTime": { "target": "com.amazonaws.lookoutmetrics#TimestampString", "traits": { "smithy.api#documentation": "

The end time for the group.

" } }, "AnomalyGroupId": { "target": "com.amazonaws.lookoutmetrics#UUID", "traits": { "smithy.api#documentation": "

The ID of the anomaly group.

" } }, "AnomalyGroupScore": { "target": "com.amazonaws.lookoutmetrics#Score", "traits": { "smithy.api#documentation": "

The severity score of the group.

" } }, "PrimaryMetricName": { "target": "com.amazonaws.lookoutmetrics#MetricName", "traits": { "smithy.api#documentation": "

The name of the primary affected measure for the group.

" } }, "MetricLevelImpactList": { "target": "com.amazonaws.lookoutmetrics#MetricLevelImpactList", "traits": { "smithy.api#documentation": "

A list of measures affected by the anomaly.

" } } }, "traits": { "smithy.api#documentation": "

A group of anomalous metrics

" } }, "com.amazonaws.lookoutmetrics#AnomalyGroupStatistics": { "type": "structure", "members": { "EvaluationStartDate": { "target": "com.amazonaws.lookoutmetrics#TimestampString", "traits": { "smithy.api#documentation": "

The start of the time range that was searched.

" } }, "TotalCount": { "target": "com.amazonaws.lookoutmetrics#Integer", "traits": { "smithy.api#documentation": "

The number of groups found.

" } }, "ItemizedMetricStatsList": { "target": "com.amazonaws.lookoutmetrics#ItemizedMetricStatsList", "traits": { "smithy.api#documentation": "

Statistics for individual metrics within the group.

" } } }, "traits": { "smithy.api#documentation": "

Aggregated statistics for a group of anomalous metrics.

" } }, "com.amazonaws.lookoutmetrics#AnomalyGroupSummary": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.lookoutmetrics#TimestampString", "traits": { "smithy.api#documentation": "

The start time for the group.

" } }, "EndTime": { "target": "com.amazonaws.lookoutmetrics#TimestampString", "traits": { "smithy.api#documentation": "

The end time for the group.

" } }, "AnomalyGroupId": { "target": "com.amazonaws.lookoutmetrics#UUID", "traits": { "smithy.api#documentation": "

The ID of the anomaly group.

" } }, "AnomalyGroupScore": { "target": "com.amazonaws.lookoutmetrics#Score", "traits": { "smithy.api#documentation": "

The severity score of the group.

" } }, "PrimaryMetricName": { "target": "com.amazonaws.lookoutmetrics#MetricName", "traits": { "smithy.api#documentation": "

The name of the primary affected measure for the group.

" } } }, "traits": { "smithy.api#documentation": "

Details about a group of anomalous metrics.

" } }, "com.amazonaws.lookoutmetrics#AnomalyGroupSummaryList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#AnomalyGroupSummary" } }, "com.amazonaws.lookoutmetrics#AnomalyGroupTimeSeries": { "type": "structure", "members": { "AnomalyGroupId": { "target": "com.amazonaws.lookoutmetrics#UUID", "traits": { "smithy.api#documentation": "

The ID of the anomaly group.

", "smithy.api#required": {} } }, "TimeSeriesId": { "target": "com.amazonaws.lookoutmetrics#TimeSeriesId", "traits": { "smithy.api#documentation": "

The ID of the metric.

" } } }, "traits": { "smithy.api#documentation": "

An anomalous metric in an anomaly group.

" } }, "com.amazonaws.lookoutmetrics#AnomalyGroupTimeSeriesFeedback": { "type": "structure", "members": { "AnomalyGroupId": { "target": "com.amazonaws.lookoutmetrics#UUID", "traits": { "smithy.api#documentation": "

The ID of the anomaly group.

", "smithy.api#required": {} } }, "TimeSeriesId": { "target": "com.amazonaws.lookoutmetrics#TimeSeriesId", "traits": { "smithy.api#documentation": "

The ID of the metric.

", "smithy.api#required": {} } }, "IsAnomaly": { "target": "com.amazonaws.lookoutmetrics#Boolean", "traits": { "smithy.api#documentation": "

Feedback on whether the metric is a legitimate anomaly.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Feedback for an anomalous metric.

" } }, "com.amazonaws.lookoutmetrics#AppFlowConfig": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

", "smithy.api#required": {} } }, "FlowName": { "target": "com.amazonaws.lookoutmetrics#FlowName", "traits": { "smithy.api#documentation": "

name of the flow.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details about an Amazon AppFlow flow datasource.

" } }, "com.amazonaws.lookoutmetrics#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:([a-z\\d-]+):.*:.*:.*:.+" } }, "com.amazonaws.lookoutmetrics#BackTestAnomalyDetector": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#BackTestAnomalyDetectorRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#BackTestAnomalyDetectorResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Runs a backtest for anomaly detection for the specified resource.

", "smithy.api#http": { "method": "POST", "uri": "/BackTestAnomalyDetector", "code": 200 } } }, "com.amazonaws.lookoutmetrics#BackTestAnomalyDetectorRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#BackTestAnomalyDetectorResponse": { "type": "structure", "members": {} }, "com.amazonaws.lookoutmetrics#Boolean": { "type": "boolean", "traits": { "smithy.api#box": {} } }, "com.amazonaws.lookoutmetrics#CSVFileCompression": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NONE", "name": "NONE" }, { "value": "GZIP", "name": "GZIP" } ] } }, "com.amazonaws.lookoutmetrics#Charset": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" } }, "com.amazonaws.lookoutmetrics#CloudWatchConfig": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details about an Amazon CloudWatch datasource.

" } }, "com.amazonaws.lookoutmetrics#ColumnName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" } }, "com.amazonaws.lookoutmetrics#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.lookoutmetrics#Message", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.lookoutmetrics#ResourceId", "traits": { "smithy.api#documentation": "

The ID of the resource.

" } }, "ResourceType": { "target": "com.amazonaws.lookoutmetrics#ResourceType", "traits": { "smithy.api#documentation": "

The type of the resource.

" } } }, "traits": { "smithy.api#documentation": "

There was a conflict processing the request. Try your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.lookoutmetrics#ContributionMatrix": { "type": "structure", "members": { "DimensionContributionList": { "target": "com.amazonaws.lookoutmetrics#DimensionContributionList", "traits": { "smithy.api#documentation": "

A list of contributing dimensions.

" } } }, "traits": { "smithy.api#documentation": "

Details about dimensions that contributed to an anomaly.

" } }, "com.amazonaws.lookoutmetrics#CreateAlert": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#CreateAlertRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#CreateAlertResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#ConflictException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an alert for an anomaly detector.

", "smithy.api#http": { "method": "POST", "uri": "/CreateAlert", "code": 200 } } }, "com.amazonaws.lookoutmetrics#CreateAlertRequest": { "type": "structure", "members": { "AlertName": { "target": "com.amazonaws.lookoutmetrics#AlertName", "traits": { "smithy.api#documentation": "

The name of the alert.

", "smithy.api#required": {} } }, "AlertSensitivityThreshold": { "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", "traits": { "smithy.api#documentation": "

An integer from 0 to 100 specifying the alert sensitivity threshold.

", "smithy.api#required": {} } }, "AlertDescription": { "target": "com.amazonaws.lookoutmetrics#AlertDescription", "traits": { "smithy.api#documentation": "

A description of the alert.

" } }, "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector to which the alert is attached.

", "smithy.api#required": {} } }, "Action": { "target": "com.amazonaws.lookoutmetrics#Action", "traits": { "smithy.api#documentation": "

Action that will be triggered when there is an alert.

", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.lookoutmetrics#TagMap", "traits": { "smithy.api#documentation": "

A list of tags to apply to the alert.

" } } } }, "com.amazonaws.lookoutmetrics#CreateAlertResponse": { "type": "structure", "members": { "AlertArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the alert.

" } } } }, "com.amazonaws.lookoutmetrics#CreateAnomalyDetector": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#CreateAnomalyDetectorRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#CreateAnomalyDetectorResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#ConflictException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an anomaly detector.

", "smithy.api#http": { "method": "POST", "uri": "/CreateAnomalyDetector", "code": 200 } } }, "com.amazonaws.lookoutmetrics#CreateAnomalyDetectorRequest": { "type": "structure", "members": { "AnomalyDetectorName": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorName", "traits": { "smithy.api#documentation": "

The name of the detector.

", "smithy.api#required": {} } }, "AnomalyDetectorDescription": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription", "traits": { "smithy.api#documentation": "

A description of the detector.

" } }, "AnomalyDetectorConfig": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorConfig", "traits": { "smithy.api#documentation": "

Contains information about the configuration of the anomaly detector.

", "smithy.api#required": {} } }, "KmsKeyArn": { "target": "com.amazonaws.lookoutmetrics#KmsKeyArn", "traits": { "smithy.api#documentation": "

The ARN of the KMS key to use to encrypt your data.

" } }, "Tags": { "target": "com.amazonaws.lookoutmetrics#TagMap", "traits": { "smithy.api#documentation": "

A list of tags to apply to the anomaly detector.

" } } } }, "com.amazonaws.lookoutmetrics#CreateAnomalyDetectorResponse": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector.

" } } } }, "com.amazonaws.lookoutmetrics#CreateMetricSet": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#CreateMetricSetRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#CreateMetricSetResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#ConflictException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a dataset.

", "smithy.api#http": { "method": "POST", "uri": "/CreateMetricSet", "code": 200 } } }, "com.amazonaws.lookoutmetrics#CreateMetricSetRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the anomaly detector that will use the dataset.

", "smithy.api#required": {} } }, "MetricSetName": { "target": "com.amazonaws.lookoutmetrics#MetricSetName", "traits": { "smithy.api#documentation": "

The name of the dataset.

", "smithy.api#required": {} } }, "MetricSetDescription": { "target": "com.amazonaws.lookoutmetrics#MetricSetDescription", "traits": { "smithy.api#documentation": "

A description of the dataset you are creating.

" } }, "MetricList": { "target": "com.amazonaws.lookoutmetrics#MetricList", "traits": { "smithy.api#documentation": "

A list of metrics that the dataset will contain.

", "smithy.api#required": {} } }, "Offset": { "target": "com.amazonaws.lookoutmetrics#Offset", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

After an interval ends, the amount of time that the detector waits before importing data.

" } }, "TimestampColumn": { "target": "com.amazonaws.lookoutmetrics#TimestampColumn", "traits": { "smithy.api#documentation": "

Contains information about the column used for tracking time in your source data.

" } }, "DimensionList": { "target": "com.amazonaws.lookoutmetrics#DimensionList", "traits": { "smithy.api#documentation": "

A list of the fields you want to treat as dimensions.

" } }, "MetricSetFrequency": { "target": "com.amazonaws.lookoutmetrics#Frequency", "traits": { "smithy.api#documentation": "

The frequency with which the source data will be analyzed for anomalies.

" } }, "MetricSource": { "target": "com.amazonaws.lookoutmetrics#MetricSource", "traits": { "smithy.api#documentation": "

Contains information about how the source data should be interpreted.

", "smithy.api#required": {} } }, "Timezone": { "target": "com.amazonaws.lookoutmetrics#Timezone", "traits": { "smithy.api#documentation": "

The time zone in which your source data was recorded.

" } }, "Tags": { "target": "com.amazonaws.lookoutmetrics#TagMap", "traits": { "smithy.api#documentation": "

A list of tags to apply to the dataset.

" } } } }, "com.amazonaws.lookoutmetrics#CreateMetricSetResponse": { "type": "structure", "members": { "MetricSetArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset.

" } } } }, "com.amazonaws.lookoutmetrics#CsvFormatDescriptor": { "type": "structure", "members": { "FileCompression": { "target": "com.amazonaws.lookoutmetrics#CSVFileCompression", "traits": { "smithy.api#documentation": "

The level of compression of the source CSV file.

" } }, "Charset": { "target": "com.amazonaws.lookoutmetrics#Charset", "traits": { "smithy.api#documentation": "

The character set in which the source CSV file is written.

" } }, "ContainsHeader": { "target": "com.amazonaws.lookoutmetrics#Boolean", "traits": { "smithy.api#documentation": "

Whether or not the source CSV file contains a header.

" } }, "Delimiter": { "target": "com.amazonaws.lookoutmetrics#Delimiter", "traits": { "smithy.api#documentation": "

The character used to delimit the source CSV file.

" } }, "HeaderList": { "target": "com.amazonaws.lookoutmetrics#HeaderList", "traits": { "smithy.api#documentation": "

A list of the source CSV file's headers, if any.

" } }, "QuoteSymbol": { "target": "com.amazonaws.lookoutmetrics#QuoteSymbol", "traits": { "smithy.api#documentation": "

The character used as a quote character.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about how a source CSV data file should be analyzed.

" } }, "com.amazonaws.lookoutmetrics#DataItem": { "type": "string" }, "com.amazonaws.lookoutmetrics#DatabaseHost": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 253 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#DatabasePort": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 65535 } } }, "com.amazonaws.lookoutmetrics#DateTimeFormat": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#DeleteAlert": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#DeleteAlertRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#DeleteAlertResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an alert.

", "smithy.api#http": { "method": "POST", "uri": "/DeleteAlert", "code": 200 } } }, "com.amazonaws.lookoutmetrics#DeleteAlertRequest": { "type": "structure", "members": { "AlertArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the alert to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#DeleteAlertResponse": { "type": "structure", "members": {} }, "com.amazonaws.lookoutmetrics#DeleteAnomalyDetector": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#DeleteAnomalyDetectorRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#DeleteAnomalyDetectorResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#ConflictException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any\n configured datasets and alerts.

", "smithy.api#http": { "method": "POST", "uri": "/DeleteAnomalyDetector", "code": 200 } } }, "com.amazonaws.lookoutmetrics#DeleteAnomalyDetectorRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector to delete.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#DeleteAnomalyDetectorResponse": { "type": "structure", "members": {} }, "com.amazonaws.lookoutmetrics#Delimiter": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1 }, "smithy.api#pattern": "[^\\r\\n]" } }, "com.amazonaws.lookoutmetrics#DescribeAlert": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#DescribeAlertRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#DescribeAlertResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes an alert.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", "smithy.api#http": { "method": "POST", "uri": "/DescribeAlert", "code": 200 } } }, "com.amazonaws.lookoutmetrics#DescribeAlertRequest": { "type": "structure", "members": { "AlertArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the alert to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#DescribeAlertResponse": { "type": "structure", "members": { "Alert": { "target": "com.amazonaws.lookoutmetrics#Alert", "traits": { "smithy.api#documentation": "

Contains information about an alert.

" } } } }, "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutions": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutionsRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutionsResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about the status of the specified anomaly detection jobs.

", "smithy.api#http": { "method": "POST", "uri": "/DescribeAnomalyDetectionExecutions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutionsRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", "smithy.api#required": {} } }, "Timestamp": { "target": "com.amazonaws.lookoutmetrics#TimestampString", "traits": { "smithy.api#documentation": "

The timestamp of the anomaly detection job.

" } }, "MaxResults": { "target": "com.amazonaws.lookoutmetrics#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The number of items to return in the response.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

" } } } }, "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutionsResponse": { "type": "structure", "members": { "ExecutionList": { "target": "com.amazonaws.lookoutmetrics#ExecutionList", "traits": { "smithy.api#documentation": "

A list of detection jobs.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

The pagination token that's included if more results are available.

" } } } }, "com.amazonaws.lookoutmetrics#DescribeAnomalyDetector": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectorRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectorResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes a detector.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", "smithy.api#http": { "method": "POST", "uri": "/DescribeAnomalyDetector", "code": 200 } } }, "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectorRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector to describe.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectorResponse": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector.

" } }, "AnomalyDetectorName": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorName", "traits": { "smithy.api#documentation": "

The name of the detector.

" } }, "AnomalyDetectorDescription": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription", "traits": { "smithy.api#documentation": "

A description of the detector.

" } }, "AnomalyDetectorConfig": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorConfigSummary", "traits": { "smithy.api#documentation": "

Contains information about the detector's configuration.

" } }, "CreationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the detector was created.

" } }, "LastModificationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the detector was last modified.

" } }, "Status": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorStatus", "traits": { "smithy.api#documentation": "

The status of the detector.

" } }, "FailureReason": { "target": "com.amazonaws.lookoutmetrics#ErrorMessage", "traits": { "smithy.api#documentation": "

The reason that the detector failed, if any.

" } }, "KmsKeyArn": { "target": "com.amazonaws.lookoutmetrics#KmsKeyArn", "traits": { "smithy.api#documentation": "

The ARN of the KMS key to use to encrypt your data.

" } } } }, "com.amazonaws.lookoutmetrics#DescribeMetricSet": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#DescribeMetricSetRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#DescribeMetricSetResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Describes a dataset.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", "smithy.api#http": { "method": "POST", "uri": "/DescribeMetricSet", "code": 200 } } }, "com.amazonaws.lookoutmetrics#DescribeMetricSetRequest": { "type": "structure", "members": { "MetricSetArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#DescribeMetricSetResponse": { "type": "structure", "members": { "MetricSetArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset.

" } }, "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector that contains the dataset.

" } }, "MetricSetName": { "target": "com.amazonaws.lookoutmetrics#MetricSetName", "traits": { "smithy.api#documentation": "

The name of the dataset.

" } }, "MetricSetDescription": { "target": "com.amazonaws.lookoutmetrics#MetricSetDescription", "traits": { "smithy.api#documentation": "

The dataset's description.

" } }, "CreationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the dataset was created.

" } }, "LastModificationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the dataset was last modified.

" } }, "Offset": { "target": "com.amazonaws.lookoutmetrics#Offset", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The offset for the dataset.

" } }, "MetricList": { "target": "com.amazonaws.lookoutmetrics#MetricList", "traits": { "smithy.api#documentation": "

A list of the metrics defined by the dataset.

" } }, "TimestampColumn": { "target": "com.amazonaws.lookoutmetrics#TimestampColumn", "traits": { "smithy.api#documentation": "

Contains information about the column used for tracking time in your source data.

" } }, "DimensionList": { "target": "com.amazonaws.lookoutmetrics#DimensionList", "traits": { "smithy.api#documentation": "

A list of the dimensions chosen for analysis.

" } }, "MetricSetFrequency": { "target": "com.amazonaws.lookoutmetrics#Frequency", "traits": { "smithy.api#documentation": "

The interval at which the data will be analyzed for anomalies.

" } }, "Timezone": { "target": "com.amazonaws.lookoutmetrics#Timezone", "traits": { "smithy.api#documentation": "

The time zone in which the dataset's data was recorded.

" } }, "MetricSource": { "target": "com.amazonaws.lookoutmetrics#MetricSource", "traits": { "smithy.api#documentation": "

Contains information about the dataset's source data.

" } } } }, "com.amazonaws.lookoutmetrics#DimensionContribution": { "type": "structure", "members": { "DimensionName": { "target": "com.amazonaws.lookoutmetrics#ColumnName", "traits": { "smithy.api#documentation": "

The name of the dimension.

" } }, "DimensionValueContributionList": { "target": "com.amazonaws.lookoutmetrics#DimensionValueContributionList", "traits": { "smithy.api#documentation": "

A list of dimension values that contributed to the anomaly.

" } } }, "traits": { "smithy.api#documentation": "

Details about a dimension that contributed to an anomaly.

" } }, "com.amazonaws.lookoutmetrics#DimensionContributionList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#DimensionContribution" } }, "com.amazonaws.lookoutmetrics#DimensionList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#ColumnName" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.lookoutmetrics#DimensionNameValue": { "type": "structure", "members": { "DimensionName": { "target": "com.amazonaws.lookoutmetrics#ColumnName", "traits": { "smithy.api#documentation": "

The name of the dimension.

", "smithy.api#required": {} } }, "DimensionValue": { "target": "com.amazonaws.lookoutmetrics#DimensionValue", "traits": { "smithy.api#documentation": "

The value of the dimension.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A dimension name and value.

" } }, "com.amazonaws.lookoutmetrics#DimensionNameValueList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#DimensionNameValue" } }, "com.amazonaws.lookoutmetrics#DimensionValue": { "type": "string" }, "com.amazonaws.lookoutmetrics#DimensionValueContribution": { "type": "structure", "members": { "DimensionValue": { "target": "com.amazonaws.lookoutmetrics#DimensionValue", "traits": { "smithy.api#documentation": "

The value of the dimension.

" } }, "ContributionScore": { "target": "com.amazonaws.lookoutmetrics#Score", "traits": { "smithy.api#documentation": "

The severity score of the value.

" } } }, "traits": { "smithy.api#documentation": "

The severity of a value of a dimension that contributed to an anomaly.

" } }, "com.amazonaws.lookoutmetrics#DimensionValueContributionList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#DimensionValueContribution" } }, "com.amazonaws.lookoutmetrics#ErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.lookoutmetrics#ExecutionList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#ExecutionStatus" } }, "com.amazonaws.lookoutmetrics#ExecutionStatus": { "type": "structure", "members": { "Timestamp": { "target": "com.amazonaws.lookoutmetrics#TimestampString", "traits": { "smithy.api#documentation": "

The run's timestamp.

" } }, "Status": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectionTaskStatus", "traits": { "smithy.api#documentation": "

The run's status.

" } }, "FailureReason": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectionTaskStatusMessage", "traits": { "smithy.api#documentation": "

The reason that the run failed, if applicable.

" } } }, "traits": { "smithy.api#documentation": "

The status of an anomaly detector run.

" } }, "com.amazonaws.lookoutmetrics#FieldName": { "type": "string" }, "com.amazonaws.lookoutmetrics#FileFormatDescriptor": { "type": "structure", "members": { "CsvFormatDescriptor": { "target": "com.amazonaws.lookoutmetrics#CsvFormatDescriptor", "traits": { "smithy.api#documentation": "

Contains information about how a source CSV data file should be analyzed.

" } }, "JsonFormatDescriptor": { "target": "com.amazonaws.lookoutmetrics#JsonFormatDescriptor", "traits": { "smithy.api#documentation": "

Contains information about how a source JSON data file should be analyzed.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a source file's formatting.

" } }, "com.amazonaws.lookoutmetrics#FlowName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "[a-zA-Z0-9][\\w!@#.-]+" } }, "com.amazonaws.lookoutmetrics#Frequency": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "P1D", "name": "P1D" }, { "value": "PT1H", "name": "PT1H" }, { "value": "PT10M", "name": "PT10M" }, { "value": "PT5M", "name": "PT5M" } ] } }, "com.amazonaws.lookoutmetrics#GetAnomalyGroup": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#GetAnomalyGroupRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#GetAnomalyGroupResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns details about a group of anomalous metrics.

", "smithy.api#http": { "method": "POST", "uri": "/GetAnomalyGroup", "code": 200 } } }, "com.amazonaws.lookoutmetrics#GetAnomalyGroupRequest": { "type": "structure", "members": { "AnomalyGroupId": { "target": "com.amazonaws.lookoutmetrics#UUID", "traits": { "smithy.api#documentation": "

The ID of the anomaly group.

", "smithy.api#required": {} } }, "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#GetAnomalyGroupResponse": { "type": "structure", "members": { "AnomalyGroup": { "target": "com.amazonaws.lookoutmetrics#AnomalyGroup", "traits": { "smithy.api#documentation": "

Details about the anomaly group.

" } } } }, "com.amazonaws.lookoutmetrics#GetFeedback": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#GetFeedbackRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#GetFeedbackResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get feedback for an anomaly group.

", "smithy.api#http": { "method": "POST", "uri": "/GetFeedback", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.lookoutmetrics#GetFeedbackRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", "smithy.api#required": {} } }, "AnomalyGroupTimeSeriesFeedback": { "target": "com.amazonaws.lookoutmetrics#AnomalyGroupTimeSeries", "traits": { "smithy.api#documentation": "

The anomalous metric and group ID.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.lookoutmetrics#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximum number of results to return.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

" } } } }, "com.amazonaws.lookoutmetrics#GetFeedbackResponse": { "type": "structure", "members": { "AnomalyGroupTimeSeriesFeedback": { "target": "com.amazonaws.lookoutmetrics#TimeSeriesFeedbackList", "traits": { "smithy.api#documentation": "

Feedback for an anomalous metric.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

The pagination token that's included if more results are available.

" } } } }, "com.amazonaws.lookoutmetrics#GetSampleData": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#GetSampleDataRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#GetSampleDataResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a selection of sample records from an Amazon S3 datasource.

", "smithy.api#http": { "method": "POST", "uri": "/GetSampleData", "code": 200 } } }, "com.amazonaws.lookoutmetrics#GetSampleDataRequest": { "type": "structure", "members": { "S3SourceConfig": { "target": "com.amazonaws.lookoutmetrics#SampleDataS3SourceConfig", "traits": { "smithy.api#documentation": "

A datasource bucket in Amazon S3.

" } } } }, "com.amazonaws.lookoutmetrics#GetSampleDataResponse": { "type": "structure", "members": { "HeaderValues": { "target": "com.amazonaws.lookoutmetrics#HeaderValueList", "traits": { "smithy.api#documentation": "

A list of header labels for the records.

" } }, "SampleRows": { "target": "com.amazonaws.lookoutmetrics#SampleRows", "traits": { "smithy.api#documentation": "

A list of records.

" } } } }, "com.amazonaws.lookoutmetrics#HeaderList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#ColumnName" } }, "com.amazonaws.lookoutmetrics#HeaderValue": { "type": "string" }, "com.amazonaws.lookoutmetrics#HeaderValueList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#HeaderValue" } }, "com.amazonaws.lookoutmetrics#HistoricalDataPath": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^s3://[a-z0-9].+$" } }, "com.amazonaws.lookoutmetrics#HistoricalDataPathList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#HistoricalDataPath" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.lookoutmetrics#Integer": { "type": "integer" }, "com.amazonaws.lookoutmetrics#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.lookoutmetrics#Message", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception, or failure.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.lookoutmetrics#ItemizedMetricStats": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.lookoutmetrics#ColumnName", "traits": { "smithy.api#documentation": "

The name of the measure.

" } }, "OccurrenceCount": { "target": "com.amazonaws.lookoutmetrics#Integer", "traits": { "smithy.api#documentation": "

The number of times that the measure appears.

" } } }, "traits": { "smithy.api#documentation": "

Aggregated statistics about a measure affected by an anomaly.

" } }, "com.amazonaws.lookoutmetrics#ItemizedMetricStatsList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#ItemizedMetricStats" } }, "com.amazonaws.lookoutmetrics#JsonFileCompression": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "NONE", "name": "NONE" }, { "value": "GZIP", "name": "GZIP" } ] } }, "com.amazonaws.lookoutmetrics#JsonFormatDescriptor": { "type": "structure", "members": { "FileCompression": { "target": "com.amazonaws.lookoutmetrics#JsonFileCompression", "traits": { "smithy.api#documentation": "

The level of compression of the source CSV file.

" } }, "Charset": { "target": "com.amazonaws.lookoutmetrics#Charset", "traits": { "smithy.api#documentation": "

The character set in which the source JSON file is written.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about how a source JSON data file should be analyzed.

" } }, "com.amazonaws.lookoutmetrics#KmsKeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "arn:aws.*:kms:.*:[0-9]{12}:key/[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" } }, "com.amazonaws.lookoutmetrics#LambdaConfiguration": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of an IAM role that has permission to invoke the Lambda function.

", "smithy.api#required": {} } }, "LambdaArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the Lambda function.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about a Lambda configuration.

" } }, "com.amazonaws.lookoutmetrics#ListAlerts": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#ListAlertsRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#ListAlertsResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the alerts attached to a detector.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", "smithy.api#http": { "method": "POST", "uri": "/ListAlerts", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.lookoutmetrics#ListAlertsRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the alert's detector.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

If the result of the previous request is truncated, the response includes a NextToken. To\n retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" } }, "MaxResults": { "target": "com.amazonaws.lookoutmetrics#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximum number of results that will be displayed by the request.

" } } } }, "com.amazonaws.lookoutmetrics#ListAlertsResponse": { "type": "structure", "members": { "AlertSummaryList": { "target": "com.amazonaws.lookoutmetrics#AlertSummaryList", "traits": { "smithy.api#documentation": "

Contains information about an alert.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

If the response is truncated, the service returns this token. To retrieve the next set of results, use this\n token in the next request.

" } } } }, "com.amazonaws.lookoutmetrics#ListAnomalyDetectors": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#ListAnomalyDetectorsRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#ListAnomalyDetectorsResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the detectors in the current AWS Region.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", "smithy.api#http": { "method": "POST", "uri": "/ListAnomalyDetectors", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.lookoutmetrics#ListAnomalyDetectorsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.lookoutmetrics#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximum number of results to return.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a NextToken. To\n retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" } } } }, "com.amazonaws.lookoutmetrics#ListAnomalyDetectorsResponse": { "type": "structure", "members": { "AnomalyDetectorSummaryList": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorSummaryList", "traits": { "smithy.api#documentation": "

A list of anomaly detectors in the account in the current region.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

If the response is truncated, the service returns this token. To retrieve the next set of results, use the\n token in the next request.

" } } } }, "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummaries": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummariesRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummariesResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns a list of anomaly groups.

", "smithy.api#http": { "method": "POST", "uri": "/ListAnomalyGroupSummaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummariesRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", "smithy.api#required": {} } }, "SensitivityThreshold": { "target": "com.amazonaws.lookoutmetrics#SensitivityThreshold", "traits": { "smithy.api#documentation": "

The minimum severity score for inclusion in the output.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.lookoutmetrics#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximum number of results to return.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

" } } } }, "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummariesResponse": { "type": "structure", "members": { "AnomalyGroupSummaryList": { "target": "com.amazonaws.lookoutmetrics#AnomalyGroupSummaryList", "traits": { "smithy.api#documentation": "

A list of anomaly group summaries.

" } }, "AnomalyGroupStatistics": { "target": "com.amazonaws.lookoutmetrics#AnomalyGroupStatistics", "traits": { "smithy.api#documentation": "

Aggregated details about the anomaly groups.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

The pagination token that's included if more results are available.

" } } } }, "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeries": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeriesRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeriesResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets a list of anomalous metrics for a measure in an anomaly group.

", "smithy.api#http": { "method": "POST", "uri": "/ListAnomalyGroupTimeSeries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeriesRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", "smithy.api#required": {} } }, "AnomalyGroupId": { "target": "com.amazonaws.lookoutmetrics#UUID", "traits": { "smithy.api#documentation": "

The ID of the anomaly group.

", "smithy.api#required": {} } }, "MetricName": { "target": "com.amazonaws.lookoutmetrics#MetricName", "traits": { "smithy.api#documentation": "

The name of the measure field.

", "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.lookoutmetrics#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximum number of results to return.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

" } } } }, "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeriesResponse": { "type": "structure", "members": { "AnomalyGroupId": { "target": "com.amazonaws.lookoutmetrics#UUID", "traits": { "smithy.api#documentation": "

The ID of the anomaly group.

" } }, "MetricName": { "target": "com.amazonaws.lookoutmetrics#MetricName", "traits": { "smithy.api#documentation": "

The name of the measure field.

" } }, "TimestampList": { "target": "com.amazonaws.lookoutmetrics#TimestampList", "traits": { "smithy.api#documentation": "

Timestamps for the anomalous metrics.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

The pagination token that's included if more results are available.

" } }, "TimeSeriesList": { "target": "com.amazonaws.lookoutmetrics#TimeSeriesList", "traits": { "smithy.api#documentation": "

A list of anomalous metrics.

" } } } }, "com.amazonaws.lookoutmetrics#ListMetricSets": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#ListMetricSetsRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#ListMetricSetsResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists the datasets in the current AWS Region.

\n

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource\n immediately after creating or modifying it, use retries to allow time for the write operation to complete.

", "smithy.api#http": { "method": "POST", "uri": "/ListMetricSets", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.lookoutmetrics#ListMetricSetsRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the anomaly detector containing the metrics sets to list.

" } }, "MaxResults": { "target": "com.amazonaws.lookoutmetrics#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The maximum number of results to return.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

If the result of the previous request was truncated, the response includes a NextToken. To\n retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" } } } }, "com.amazonaws.lookoutmetrics#ListMetricSetsResponse": { "type": "structure", "members": { "MetricSetSummaryList": { "target": "com.amazonaws.lookoutmetrics#MetricSetSummaryList", "traits": { "smithy.api#documentation": "

A list of the datasets in the AWS Region, with configuration details for each.

" } }, "NextToken": { "target": "com.amazonaws.lookoutmetrics#NextToken", "traits": { "smithy.api#documentation": "

If the response is truncated, the list call returns this token. To retrieve the next set of results, use the\n token in the next list request.

" } } } }, "com.amazonaws.lookoutmetrics#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Gets a list of tags for a detector, dataset, or alert.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{ResourceArn}", "code": 200 } } }, "com.amazonaws.lookoutmetrics#ListTagsForResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#jsonName": "resourceArn", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.lookoutmetrics#TagMap", "traits": { "smithy.api#documentation": "

The resource's tags.

", "smithy.api#jsonName": "Tags" } } } }, "com.amazonaws.lookoutmetrics#LookoutMetrics": { "type": "service", "version": "2017-07-25", "operations": [ { "target": "com.amazonaws.lookoutmetrics#ActivateAnomalyDetector" }, { "target": "com.amazonaws.lookoutmetrics#BackTestAnomalyDetector" }, { "target": "com.amazonaws.lookoutmetrics#CreateAlert" }, { "target": "com.amazonaws.lookoutmetrics#CreateAnomalyDetector" }, { "target": "com.amazonaws.lookoutmetrics#CreateMetricSet" }, { "target": "com.amazonaws.lookoutmetrics#DeleteAlert" }, { "target": "com.amazonaws.lookoutmetrics#DeleteAnomalyDetector" }, { "target": "com.amazonaws.lookoutmetrics#DescribeAlert" }, { "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetectionExecutions" }, { "target": "com.amazonaws.lookoutmetrics#DescribeAnomalyDetector" }, { "target": "com.amazonaws.lookoutmetrics#DescribeMetricSet" }, { "target": "com.amazonaws.lookoutmetrics#GetAnomalyGroup" }, { "target": "com.amazonaws.lookoutmetrics#GetFeedback" }, { "target": "com.amazonaws.lookoutmetrics#GetSampleData" }, { "target": "com.amazonaws.lookoutmetrics#ListAlerts" }, { "target": "com.amazonaws.lookoutmetrics#ListAnomalyDetectors" }, { "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummaries" }, { "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupTimeSeries" }, { "target": "com.amazonaws.lookoutmetrics#ListMetricSets" }, { "target": "com.amazonaws.lookoutmetrics#ListTagsForResource" }, { "target": "com.amazonaws.lookoutmetrics#PutFeedback" }, { "target": "com.amazonaws.lookoutmetrics#TagResource" }, { "target": "com.amazonaws.lookoutmetrics#UntagResource" }, { "target": "com.amazonaws.lookoutmetrics#UpdateAnomalyDetector" }, { "target": "com.amazonaws.lookoutmetrics#UpdateMetricSet" } ], "traits": { "aws.api#service": { "sdkId": "LookoutMetrics", "arnNamespace": "lookoutmetrics", "cloudFormationName": "LookoutMetrics", "cloudTrailEventSource": "lookoutmetrics.amazonaws.com", "endpointPrefix": "lookoutmetrics" }, "aws.auth#sigv4": { "name": "lookoutmetrics" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "

This is the Amazon Lookout for Metrics API Reference. For an introduction to the service\n with tutorials for getting started, visit Amazon\n Lookout for Metrics Developer Guide.

", "smithy.api#title": "Amazon Lookout for Metrics" } }, "com.amazonaws.lookoutmetrics#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.lookoutmetrics#Message": { "type": "string" }, "com.amazonaws.lookoutmetrics#Metric": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.lookoutmetrics#ColumnName", "traits": { "smithy.api#documentation": "

The name of the metric.

", "smithy.api#required": {} } }, "AggregationFunction": { "target": "com.amazonaws.lookoutmetrics#AggregationFunction", "traits": { "smithy.api#documentation": "

The function with which the metric is calculated.

", "smithy.api#required": {} } }, "Namespace": { "target": "com.amazonaws.lookoutmetrics#Namespace", "traits": { "smithy.api#documentation": "

The namespace for the metric.

" } } }, "traits": { "smithy.api#documentation": "

A calculation made by contrasting a measure and a dimension from your source data.

" } }, "com.amazonaws.lookoutmetrics#MetricLevelImpact": { "type": "structure", "members": { "MetricName": { "target": "com.amazonaws.lookoutmetrics#MetricName", "traits": { "smithy.api#documentation": "

The name of the measure.

" } }, "NumTimeSeries": { "target": "com.amazonaws.lookoutmetrics#Integer", "traits": { "smithy.api#documentation": "

The number of anomalous metrics for the measure.

" } }, "ContributionMatrix": { "target": "com.amazonaws.lookoutmetrics#ContributionMatrix", "traits": { "smithy.api#documentation": "

Details about the dimensions that contributed to the anomaly.

" } } }, "traits": { "smithy.api#documentation": "

Details about a measure affected by an anomaly.

" } }, "com.amazonaws.lookoutmetrics#MetricLevelImpactList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#MetricLevelImpact" } }, "com.amazonaws.lookoutmetrics#MetricList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#Metric" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.lookoutmetrics#MetricName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" } }, "com.amazonaws.lookoutmetrics#MetricSetDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#MetricSetName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" } }, "com.amazonaws.lookoutmetrics#MetricSetSummary": { "type": "structure", "members": { "MetricSetArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset.

" } }, "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector to which the dataset belongs.

" } }, "MetricSetDescription": { "target": "com.amazonaws.lookoutmetrics#MetricSetDescription", "traits": { "smithy.api#documentation": "

The description of the dataset.

" } }, "MetricSetName": { "target": "com.amazonaws.lookoutmetrics#MetricSetName", "traits": { "smithy.api#documentation": "

The name of the dataset.

" } }, "CreationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the dataset was created.

" } }, "LastModificationTime": { "target": "com.amazonaws.lookoutmetrics#Timestamp", "traits": { "smithy.api#documentation": "

The time at which the dataset was last modified.

" } }, "Tags": { "target": "com.amazonaws.lookoutmetrics#TagMap", "traits": { "smithy.api#documentation": "

The dataset's tags.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about a dataset.

" } }, "com.amazonaws.lookoutmetrics#MetricSetSummaryList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#MetricSetSummary" } }, "com.amazonaws.lookoutmetrics#MetricSource": { "type": "structure", "members": { "S3SourceConfig": { "target": "com.amazonaws.lookoutmetrics#S3SourceConfig" }, "AppFlowConfig": { "target": "com.amazonaws.lookoutmetrics#AppFlowConfig", "traits": { "smithy.api#documentation": "

An object containing information about the AppFlow configuration.

" } }, "CloudWatchConfig": { "target": "com.amazonaws.lookoutmetrics#CloudWatchConfig", "traits": { "smithy.api#documentation": "

An object containing information about the Amazon CloudWatch monitoring configuration.

" } }, "RDSSourceConfig": { "target": "com.amazonaws.lookoutmetrics#RDSSourceConfig", "traits": { "smithy.api#documentation": "

An object containing information about the Amazon Relational Database Service (RDS) configuration.

" } }, "RedshiftSourceConfig": { "target": "com.amazonaws.lookoutmetrics#RedshiftSourceConfig", "traits": { "smithy.api#documentation": "

An object containing information about the Amazon Redshift database configuration.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about source data used to generate a metric.

" } }, "com.amazonaws.lookoutmetrics#MetricValue": { "type": "double", "traits": { "smithy.api#box": {} } }, "com.amazonaws.lookoutmetrics#MetricValueList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#MetricValue" } }, "com.amazonaws.lookoutmetrics#Namespace": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[^:].*" } }, "com.amazonaws.lookoutmetrics#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 3000 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#Offset": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 432000 } } }, "com.amazonaws.lookoutmetrics#PoirotSecretManagerArn": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "arn:([a-z\\d-]+):.*:.*:secret:AmazonLookoutMetrics-.+" } }, "com.amazonaws.lookoutmetrics#PutFeedback": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#PutFeedbackRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#PutFeedbackResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Add feedback for an anomalous metric.

", "smithy.api#http": { "method": "POST", "uri": "/PutFeedback", "code": 200 } } }, "com.amazonaws.lookoutmetrics#PutFeedbackRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the anomaly detector.

", "smithy.api#required": {} } }, "AnomalyGroupTimeSeriesFeedback": { "target": "com.amazonaws.lookoutmetrics#AnomalyGroupTimeSeriesFeedback", "traits": { "smithy.api#documentation": "

Feedback for an anomalous metric.

", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#PutFeedbackResponse": { "type": "structure", "members": {} }, "com.amazonaws.lookoutmetrics#QuotaCode": { "type": "string" }, "com.amazonaws.lookoutmetrics#QuoteSymbol": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1 }, "smithy.api#pattern": "[^\\r\\n]|^$" } }, "com.amazonaws.lookoutmetrics#RDSDatabaseIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-zA-Z](?!.*--)(?!.*-$)[0-9a-zA-Z\\-]*$" } }, "com.amazonaws.lookoutmetrics#RDSDatabaseName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "[a-zA-Z0-9_.]+" } }, "com.amazonaws.lookoutmetrics#RDSSourceConfig": { "type": "structure", "members": { "DBInstanceIdentifier": { "target": "com.amazonaws.lookoutmetrics#RDSDatabaseIdentifier", "traits": { "smithy.api#documentation": "

A string identifying the database instance.

", "smithy.api#required": {} } }, "DatabaseHost": { "target": "com.amazonaws.lookoutmetrics#DatabaseHost", "traits": { "smithy.api#documentation": "

The host name of the database.

", "smithy.api#required": {} } }, "DatabasePort": { "target": "com.amazonaws.lookoutmetrics#DatabasePort", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The port number where the database can be accessed.

", "smithy.api#required": {} } }, "SecretManagerArn": { "target": "com.amazonaws.lookoutmetrics#PoirotSecretManagerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

", "smithy.api#required": {} } }, "DatabaseName": { "target": "com.amazonaws.lookoutmetrics#RDSDatabaseName", "traits": { "smithy.api#documentation": "

The name of the RDS database.

", "smithy.api#required": {} } }, "TableName": { "target": "com.amazonaws.lookoutmetrics#TableName", "traits": { "smithy.api#documentation": "

The name of the table in the database.

", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role.

", "smithy.api#required": {} } }, "VpcConfiguration": { "target": "com.amazonaws.lookoutmetrics#VpcConfiguration", "traits": { "smithy.api#documentation": "

An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about the Amazon Relational Database Service (RDS) configuration.

" } }, "com.amazonaws.lookoutmetrics#RedshiftClusterIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#pattern": "^[a-z](?!.*--)(?!.*-$)[0-9a-z\\-]*$" } }, "com.amazonaws.lookoutmetrics#RedshiftDatabaseName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "[a-zA-Z0-9_.]+" } }, "com.amazonaws.lookoutmetrics#RedshiftSourceConfig": { "type": "structure", "members": { "ClusterIdentifier": { "target": "com.amazonaws.lookoutmetrics#RedshiftClusterIdentifier", "traits": { "smithy.api#documentation": "

A string identifying the Redshift cluster.

", "smithy.api#required": {} } }, "DatabaseHost": { "target": "com.amazonaws.lookoutmetrics#DatabaseHost", "traits": { "smithy.api#documentation": "

The name of the database host.

", "smithy.api#required": {} } }, "DatabasePort": { "target": "com.amazonaws.lookoutmetrics#DatabasePort", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

The port number where the database can be accessed.

", "smithy.api#required": {} } }, "SecretManagerArn": { "target": "com.amazonaws.lookoutmetrics#PoirotSecretManagerArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

", "smithy.api#required": {} } }, "DatabaseName": { "target": "com.amazonaws.lookoutmetrics#RedshiftDatabaseName", "traits": { "smithy.api#documentation": "

The Redshift database name.

", "smithy.api#required": {} } }, "TableName": { "target": "com.amazonaws.lookoutmetrics#TableName", "traits": { "smithy.api#documentation": "

The table name of the Redshift database.

", "smithy.api#required": {} } }, "RoleArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role providing access to the database.

", "smithy.api#required": {} } }, "VpcConfiguration": { "target": "com.amazonaws.lookoutmetrics#VpcConfiguration", "traits": { "smithy.api#documentation": "

Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Provides information about the Amazon Redshift database configuration.

" } }, "com.amazonaws.lookoutmetrics#ResourceId": { "type": "string" }, "com.amazonaws.lookoutmetrics#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.lookoutmetrics#Message", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.lookoutmetrics#ResourceId", "traits": { "smithy.api#documentation": "

The ID of the resource.

" } }, "ResourceType": { "target": "com.amazonaws.lookoutmetrics#ResourceType", "traits": { "smithy.api#documentation": "

The type of the resource.

" } } }, "traits": { "smithy.api#documentation": "

The specified resource cannot be found. Check the ARN of the resource and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.lookoutmetrics#ResourceType": { "type": "string" }, "com.amazonaws.lookoutmetrics#S3SourceConfig": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

", "smithy.api#required": {} } }, "TemplatedPathList": { "target": "com.amazonaws.lookoutmetrics#TemplatedPathList", "traits": { "smithy.api#documentation": "

A list of templated paths to the source files.

" } }, "HistoricalDataPathList": { "target": "com.amazonaws.lookoutmetrics#HistoricalDataPathList", "traits": { "smithy.api#documentation": "

A list of paths to the historical data files.

" } }, "FileFormatDescriptor": { "target": "com.amazonaws.lookoutmetrics#FileFormatDescriptor", "traits": { "smithy.api#documentation": "

Contains information about a source file's formatting.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the configuration of the S3 bucket that contains source files.

" } }, "com.amazonaws.lookoutmetrics#SNSConfiguration": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the IAM role that has access to the target SNS topic.

", "smithy.api#required": {} } }, "SnsTopicArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the target SNS topic.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about the SNS topic to which you want to send your alerts and the IAM role that has\n access to that topic.

" } }, "com.amazonaws.lookoutmetrics#SampleDataS3SourceConfig": { "type": "structure", "members": { "RoleArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the role.

", "smithy.api#required": {} } }, "TemplatedPathList": { "target": "com.amazonaws.lookoutmetrics#TemplatedPathList", "traits": { "smithy.api#documentation": "

An array of strings containing the list of templated paths.

" } }, "HistoricalDataPathList": { "target": "com.amazonaws.lookoutmetrics#HistoricalDataPathList", "traits": { "smithy.api#documentation": "

An array of strings containing the historical set of data paths.

" } }, "FileFormatDescriptor": { "target": "com.amazonaws.lookoutmetrics#FileFormatDescriptor", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about the source configuration in Amazon S3.

" } }, "com.amazonaws.lookoutmetrics#SampleRow": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#DataItem" } }, "com.amazonaws.lookoutmetrics#SampleRows": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#SampleRow" } }, "com.amazonaws.lookoutmetrics#Score": { "type": "double", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 0.0, "max": 100.0 } } }, "com.amazonaws.lookoutmetrics#SecurityGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "[-0-9a-zA-Z]+" } }, "com.amazonaws.lookoutmetrics#SecurityGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#SecurityGroupId" } }, "com.amazonaws.lookoutmetrics#SensitivityThreshold": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.lookoutmetrics#ServiceCode": { "type": "string" }, "com.amazonaws.lookoutmetrics#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.lookoutmetrics#Message", "traits": { "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.lookoutmetrics#ResourceId", "traits": { "smithy.api#documentation": "

The ID of the resource.

" } }, "ResourceType": { "target": "com.amazonaws.lookoutmetrics#ResourceType", "traits": { "smithy.api#documentation": "

The type of the resource.

" } }, "QuotaCode": { "target": "com.amazonaws.lookoutmetrics#QuotaCode", "traits": { "smithy.api#documentation": "

The quota code.

" } }, "ServiceCode": { "target": "com.amazonaws.lookoutmetrics#ServiceCode", "traits": { "smithy.api#documentation": "

The service code.

" } } }, "traits": { "smithy.api#documentation": "

The request exceeded the service's quotas. Check the service quotas and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.lookoutmetrics#SubnetId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "[\\-0-9a-zA-Z]+" } }, "com.amazonaws.lookoutmetrics#SubnetIdList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#SubnetId" } }, "com.amazonaws.lookoutmetrics#TableName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" } }, "com.amazonaws.lookoutmetrics#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.lookoutmetrics#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.lookoutmetrics#TagMap": { "type": "map", "key": { "target": "com.amazonaws.lookoutmetrics#TagKey" }, "value": { "target": "com.amazonaws.lookoutmetrics#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.lookoutmetrics#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#TagResourceRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds tags to a detector, dataset, or alert.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{ResourceArn}", "code": 204 } } }, "com.amazonaws.lookoutmetrics#TagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#jsonName": "resourceArn", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.lookoutmetrics#TagMap", "traits": { "smithy.api#documentation": "

Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following\n symbols: _.:/=+@-\n

", "smithy.api#jsonName": "tags", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.lookoutmetrics#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.lookoutmetrics#TemplatedPath": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1024 }, "smithy.api#pattern": "^s3://[a-zA-Z0-9_\\-\\/ {}=]+$" } }, "com.amazonaws.lookoutmetrics#TemplatedPathList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#TemplatedPath" }, "traits": { "smithy.api#length": { "min": 1, "max": 1 } } }, "com.amazonaws.lookoutmetrics#TimeSeries": { "type": "structure", "members": { "TimeSeriesId": { "target": "com.amazonaws.lookoutmetrics#TimeSeriesId", "traits": { "smithy.api#documentation": "

The ID of the metric.

", "smithy.api#required": {} } }, "DimensionList": { "target": "com.amazonaws.lookoutmetrics#DimensionNameValueList", "traits": { "smithy.api#documentation": "

The dimensions of the metric.

", "smithy.api#required": {} } }, "MetricValueList": { "target": "com.amazonaws.lookoutmetrics#MetricValueList", "traits": { "smithy.api#documentation": "

The values for the metric.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as\n availability in the us-east-1 Region.

" } }, "com.amazonaws.lookoutmetrics#TimeSeriesFeedback": { "type": "structure", "members": { "TimeSeriesId": { "target": "com.amazonaws.lookoutmetrics#TimeSeriesId", "traits": { "smithy.api#documentation": "

The ID of the metric.

" } }, "IsAnomaly": { "target": "com.amazonaws.lookoutmetrics#Boolean", "traits": { "smithy.api#documentation": "

Feedback on whether the metric is a legitimate anomaly.

" } } }, "traits": { "smithy.api#documentation": "

Details about feedback submitted for an anomalous metric.

" } }, "com.amazonaws.lookoutmetrics#TimeSeriesFeedbackList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#TimeSeriesFeedback" } }, "com.amazonaws.lookoutmetrics#TimeSeriesId": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 520 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#TimeSeriesList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#TimeSeries" } }, "com.amazonaws.lookoutmetrics#Timestamp": { "type": "timestamp" }, "com.amazonaws.lookoutmetrics#TimestampColumn": { "type": "structure", "members": { "ColumnName": { "target": "com.amazonaws.lookoutmetrics#ColumnName", "traits": { "smithy.api#documentation": "

The name of the timestamp column.

" } }, "ColumnFormat": { "target": "com.amazonaws.lookoutmetrics#DateTimeFormat", "traits": { "smithy.api#documentation": "

The format of the timestamp column.

" } } }, "traits": { "smithy.api#documentation": "

Contains information about the column used to track time in a source data file.

" } }, "com.amazonaws.lookoutmetrics#TimestampList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#TimestampString" } }, "com.amazonaws.lookoutmetrics#TimestampString": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 60 }, "smithy.api#pattern": "^([12]\\d{3})-(1[0-2]|0[1-9])-(0[1-9]|[12]\\d|3[01])T([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)(Z|(\\+|\\-)(0\\d|1[0-2]):([0-5]\\d)(\\[[[:alnum:]\\/\\_]+\\])?)$" } }, "com.amazonaws.lookoutmetrics#Timezone": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 60 }, "smithy.api#pattern": ".*\\S.*" } }, "com.amazonaws.lookoutmetrics#TooManyRequestsException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.lookoutmetrics#Message", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The request was denied due to too many requests being submitted at the same time.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.lookoutmetrics#UUID": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 63 }, "smithy.api#pattern": "[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" } }, "com.amazonaws.lookoutmetrics#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#UntagResourceRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes tags from a detector, dataset, or alert.

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{ResourceArn}", "code": 204 } } }, "com.amazonaws.lookoutmetrics#UntagResourceRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The resource's Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#jsonName": "resourceArn", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.lookoutmetrics#TagKeyList", "traits": { "smithy.api#documentation": "

Keys to remove from the resource's tags.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#jsonName": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.lookoutmetrics#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.lookoutmetrics#UpdateAnomalyDetector": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#UpdateAnomalyDetectorRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#UpdateAnomalyDetectorResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a detector. After activation, you can only change a detector's ingestion delay and description.

", "smithy.api#http": { "method": "POST", "uri": "/UpdateAnomalyDetector", "code": 200 } } }, "com.amazonaws.lookoutmetrics#UpdateAnomalyDetectorRequest": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the detector to update.

", "smithy.api#required": {} } }, "KmsKeyArn": { "target": "com.amazonaws.lookoutmetrics#KmsKeyArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an AWS KMS encryption key.

" } }, "AnomalyDetectorDescription": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorDescription", "traits": { "smithy.api#documentation": "

The updated detector description.

" } }, "AnomalyDetectorConfig": { "target": "com.amazonaws.lookoutmetrics#AnomalyDetectorConfig", "traits": { "smithy.api#documentation": "

Contains information about the configuration to which the detector will be updated.

" } } } }, "com.amazonaws.lookoutmetrics#UpdateAnomalyDetectorResponse": { "type": "structure", "members": { "AnomalyDetectorArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the updated detector.

" } } } }, "com.amazonaws.lookoutmetrics#UpdateMetricSet": { "type": "operation", "input": { "target": "com.amazonaws.lookoutmetrics#UpdateMetricSetRequest" }, "output": { "target": "com.amazonaws.lookoutmetrics#UpdateMetricSetResponse" }, "errors": [ { "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" }, { "target": "com.amazonaws.lookoutmetrics#InternalServerException" }, { "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" }, { "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" }, { "target": "com.amazonaws.lookoutmetrics#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates a dataset.

", "smithy.api#http": { "method": "POST", "uri": "/UpdateMetricSet", "code": 200 } } }, "com.amazonaws.lookoutmetrics#UpdateMetricSetRequest": { "type": "structure", "members": { "MetricSetArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset to update.

", "smithy.api#required": {} } }, "MetricSetDescription": { "target": "com.amazonaws.lookoutmetrics#MetricSetDescription", "traits": { "smithy.api#documentation": "

The dataset's description.

" } }, "MetricList": { "target": "com.amazonaws.lookoutmetrics#MetricList", "traits": { "smithy.api#documentation": "

The metric list.

" } }, "Offset": { "target": "com.amazonaws.lookoutmetrics#Offset", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "

After an interval ends, the amount of time that the detector waits before importing data.

" } }, "TimestampColumn": { "target": "com.amazonaws.lookoutmetrics#TimestampColumn", "traits": { "smithy.api#documentation": "

The timestamp column.

" } }, "DimensionList": { "target": "com.amazonaws.lookoutmetrics#DimensionList", "traits": { "smithy.api#documentation": "

The dimension list.

" } }, "MetricSetFrequency": { "target": "com.amazonaws.lookoutmetrics#Frequency", "traits": { "smithy.api#documentation": "

The dataset's interval.

" } }, "MetricSource": { "target": "com.amazonaws.lookoutmetrics#MetricSource" } } }, "com.amazonaws.lookoutmetrics#UpdateMetricSetResponse": { "type": "structure", "members": { "MetricSetArn": { "target": "com.amazonaws.lookoutmetrics#Arn", "traits": { "smithy.api#documentation": "

The ARN of the dataset.

" } } } }, "com.amazonaws.lookoutmetrics#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.lookoutmetrics#Message", "traits": { "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.lookoutmetrics#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

The reason that validation failed.

" } }, "Fields": { "target": "com.amazonaws.lookoutmetrics#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "

Fields that failed validation.

" } } }, "traits": { "smithy.api#documentation": "

The input fails to satisfy the constraints specified by the AWS service. Check your input values and try\n again.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.lookoutmetrics#ValidationExceptionField": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.lookoutmetrics#FieldName", "traits": { "smithy.api#documentation": "

The name of the field.

", "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.lookoutmetrics#Message", "traits": { "smithy.api#documentation": "

The message with more information about the validation exception.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about a a field in a validation exception.

" } }, "com.amazonaws.lookoutmetrics#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.lookoutmetrics#ValidationExceptionField" } }, "com.amazonaws.lookoutmetrics#ValidationExceptionReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "UNKNOWN_OPERATION", "name": "UNKNOWN_OPERATION" }, { "value": "CANNOT_PARSE", "name": "CANNOT_PARSE" }, { "value": "FIELD_VALIDATION_FAILED", "name": "FIELD_VALIDATION_FAILED" }, { "value": "OTHER", "name": "OTHER" } ] } }, "com.amazonaws.lookoutmetrics#VpcConfiguration": { "type": "structure", "members": { "SubnetIdList": { "target": "com.amazonaws.lookoutmetrics#SubnetIdList", "traits": { "smithy.api#documentation": "

An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

", "smithy.api#required": {} } }, "SecurityGroupIdList": { "target": "com.amazonaws.lookoutmetrics#SecurityGroupIdList", "traits": { "smithy.api#documentation": "

An array of strings containing the list of security groups.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains configuration information about the Amazon Virtual Private Cloud (VPC).

" } } } }