openapi: 3.0.0 info: version: 2017-07-25 x-release: v4 title: Amazon Lookout for Metrics description: This is the Amazon Lookout for Metrics API Reference. For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide. x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: "#FFFFFF" termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: lookoutmetrics x-aws-signingName: lookoutmetrics x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/lookoutmetrics-2017-07-25.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/lookoutmetrics/ servers: - url: http://lookoutmetrics.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The LookoutMetrics multi-region endpoint - url: https://lookoutmetrics.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The LookoutMetrics multi-region endpoint - url: http://lookoutmetrics.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The LookoutMetrics endpoint for China (Beijing) and China (Ningxia) - url: https://lookoutmetrics.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The LookoutMetrics endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /ActivateAnomalyDetector: post: operationId: ActivateAnomalyDetector description: Activates an anomaly detector. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ActivateAnomalyDetectorResponse" "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "485": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn properties: AnomalyDetectorArn: description: The ARN of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Activate Anomaly Detector parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /BackTestAnomalyDetector: post: operationId: BackTestAnomalyDetector description: Runs a backtest for anomaly detection for the specified resource. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/BackTestAnomalyDetectorResponse" "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Back Test Anomaly Detector parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /CreateAlert: post: operationId: CreateAlert description: Creates an alert for an anomaly detector. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateAlertResponse" "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "485": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "486": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AlertName - AnomalyDetectorArn - Action properties: AlertName: description: The name of the alert. type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* minLength: 1 maxLength: 63 AlertSensitivityThreshold: description: An integer from 0 to 100 specifying the alert sensitivity threshold. type: integer minimum: 0 maximum: 100 AlertDescription: description: A description of the alert. type: string pattern: .*\S.* maxLength: 256 AnomalyDetectorArn: description: The ARN of the detector to which the alert is attached. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 Action: description: A configuration that specifies the action to perform when anomalies are detected. type: object properties: SNSConfiguration: allOf: - $ref: "#/components/schemas/SNSConfiguration" - description: A configuration for an Amazon SNS channel. LambdaConfiguration: allOf: - $ref: "#/components/schemas/LambdaConfiguration" - description: A configuration for an AWS Lambda channel. Tags: description: A list of tags to apply to the alert. type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: "#/components/schemas/TagValue" AlertFilters: description: The configuration of the alert filters. type: object properties: MetricList: allOf: - $ref: "#/components/schemas/MetricNameList" - description: The list of measures that you want to get alerts for. DimensionFilterList: allOf: - $ref: "#/components/schemas/DimensionFilterList" - description: The list of DimensionFilter objects that are used for dimension-based filtering. summary: Amazon Lookout for Metrics Create Alert parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /CreateAnomalyDetector: post: operationId: CreateAnomalyDetector description: Creates an anomaly detector. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateAnomalyDetectorResponse" "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" "483": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" "484": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "486": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorName - AnomalyDetectorConfig properties: AnomalyDetectorName: description: The name of the detector. type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* minLength: 1 maxLength: 63 AnomalyDetectorDescription: description: A description of the detector. type: string pattern: .*\S.* minLength: 1 maxLength: 256 AnomalyDetectorConfig: description: Contains information about a detector's configuration. type: object properties: AnomalyDetectorFrequency: allOf: - $ref: "#/components/schemas/Frequency" - description: The frequency at which the detector analyzes its source data. KmsKeyArn: description: The ARN of the KMS key to use to encrypt your data. type: string 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} minLength: 20 maxLength: 2048 Tags: description: A list of tags to apply to the anomaly detector. type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: "#/components/schemas/TagValue" summary: Amazon Lookout for Metrics Create Anomaly Detector parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /CreateMetricSet: post: operationId: CreateMetricSet description: Creates a dataset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateMetricSetResponse" "480": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" "484": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "485": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "486": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn - MetricSetName - MetricList - MetricSource properties: AnomalyDetectorArn: description: The ARN of the anomaly detector that will use the dataset. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 MetricSetName: description: The name of the dataset. type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* minLength: 1 maxLength: 63 MetricSetDescription: description: A description of the dataset you are creating. type: string pattern: .*\S.* minLength: 1 maxLength: 256 MetricList: description: A list of metrics that the dataset will contain. type: array items: $ref: "#/components/schemas/Metric" minItems: 1 Offset: description: After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources. type: integer minimum: 0 maximum: 432000 TimestampColumn: description: Contains information about the column used to track time in a source data file. type: object properties: ColumnName: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of the timestamp column. ColumnFormat: allOf: - $ref: "#/components/schemas/DateTimeFormat" - description: The format of the timestamp column. DimensionList: description: A list of the fields you want to treat as dimensions. type: array items: $ref: "#/components/schemas/ColumnName" minItems: 1 MetricSetFrequency: description: The frequency with which the source data will be analyzed for anomalies. type: string enum: - P1D - PT1H - PT10M - PT5M MetricSource: description: Contains information about source data used to generate metrics. type: object properties: S3SourceConfig: $ref: "#/components/schemas/S3SourceConfig" AppFlowConfig: allOf: - $ref: "#/components/schemas/AppFlowConfig" - description: Details about an AppFlow datasource. CloudWatchConfig: allOf: - $ref: "#/components/schemas/CloudWatchConfig" - description: Details about an Amazon CloudWatch monitoring datasource. RDSSourceConfig: allOf: - $ref: "#/components/schemas/RDSSourceConfig" - description: Details about an Amazon Relational Database Service (RDS) datasource. RedshiftSourceConfig: allOf: - $ref: "#/components/schemas/RedshiftSourceConfig" - description: Details about an Amazon Redshift database datasource. AthenaSourceConfig: allOf: - $ref: "#/components/schemas/AthenaSourceConfig" - description: Details about an Amazon Athena datasource. Timezone: description: The time zone in which your source data was recorded. type: string pattern: .*\S.* maxLength: 60 Tags: description: A list of tags to apply to the dataset. type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: "#/components/schemas/TagValue" DimensionFilterList: description: A list of filters that specify which data is kept for anomaly detection. type: array items: $ref: "#/components/schemas/MetricSetDimensionFilter" summary: Amazon Lookout for Metrics Create Metric Set parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /DeactivateAnomalyDetector: post: operationId: DeactivateAnomalyDetector description: Deactivates an anomaly detector. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeactivateAnomalyDetectorResponse" "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "481": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "485": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Deactivate Anomaly Detector parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /DeleteAlert: post: operationId: DeleteAlert description: Deletes an alert. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteAlertResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AlertArn properties: AlertArn: description: The ARN of the alert to delete. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Delete Alert parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /DeleteAnomalyDetector: post: operationId: DeleteAnomalyDetector description: Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteAnomalyDetectorResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "485": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn properties: AnomalyDetectorArn: description: The ARN of the detector to delete. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Delete Anomaly Detector parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /DescribeAlert: post: operationId: DescribeAlert description:

Describes an alert.

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

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAlertResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AlertArn properties: AlertArn: description: The ARN of the alert to describe. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Describe Alert parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /DescribeAnomalyDetectionExecutions: post: operationId: DescribeAnomalyDetectionExecutions description: Returns information about the status of the specified anomaly detection jobs. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAnomalyDetectionExecutionsResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 Timestamp: description: The timestamp of the anomaly detection job. type: string 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:]\/\_]+\])?)$ maxLength: 60 MaxResults: description: The number of items to return in the response. type: integer minimum: 1 maximum: 100 NextToken: description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. type: string pattern: .*\S.* minLength: 1 maxLength: 3000 summary: Amazon Lookout for Metrics Describe Anomaly Detection Executions parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /DescribeAnomalyDetector: post: operationId: DescribeAnomalyDetector description:

Describes a detector.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeAnomalyDetectorResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn properties: AnomalyDetectorArn: description: The ARN of the detector to describe. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Describe Anomaly Detector parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /DescribeMetricSet: post: operationId: DescribeMetricSet description:

Describes a dataset.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeMetricSetResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - MetricSetArn properties: MetricSetArn: description: The ARN of the dataset. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Describe Metric Set parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /DetectMetricSetConfig: post: operationId: DetectMetricSetConfig description: Detects an Amazon S3 dataset's file format, interval, and offset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DetectMetricSetConfigResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn - AutoDetectionMetricSource properties: AnomalyDetectorArn: description: An anomaly detector ARN. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 AutoDetectionMetricSource: description: An auto detection metric source. type: object properties: S3SourceConfig: allOf: - $ref: "#/components/schemas/AutoDetectionS3SourceConfig" - description: The source's source config. summary: Amazon Lookout for Metrics Detect Metric Set Config parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /GetAnomalyGroup: post: operationId: GetAnomalyGroup description: Returns details about a group of anomalous metrics. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetAnomalyGroupResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyGroupId - AnomalyDetectorArn properties: AnomalyGroupId: description: The ID of the anomaly group. type: string pattern: "[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" maxLength: 63 AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Get Anomaly Group parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /GetDataQualityMetrics: post: operationId: GetDataQualityMetrics description: Returns details about the requested data quality metrics. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetDataQualityMetricsResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 MetricSetArn: description: The Amazon Resource Name (ARN) of a specific data quality metric set. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics Get Data Quality Metrics parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /GetFeedback: post: operationId: GetFeedback description: Get feedback for an anomaly group. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetFeedbackResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn - AnomalyGroupTimeSeriesFeedback properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 AnomalyGroupTimeSeriesFeedback: description: An anomalous metric in an anomaly group. type: object properties: AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. TimeSeriesId: allOf: - $ref: "#/components/schemas/TimeSeriesId" - description: The ID of the metric. MaxResults: description: The maximum number of results to return. type: integer minimum: 1 maximum: 100 NextToken: description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. type: string pattern: .*\S.* minLength: 1 maxLength: 3000 summary: Amazon Lookout for Metrics Get Feedback parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /GetSampleData: post: operationId: GetSampleData description: Returns a selection of sample records from an Amazon S3 datasource. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetSampleDataResponse" "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: [] requestBody: required: true content: application/json: schema: type: object properties: S3SourceConfig: description: Contains information about the source configuration in Amazon S3. type: object properties: RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the role. TemplatedPathList: allOf: - $ref: "#/components/schemas/TemplatedPathList" - description: An array of strings containing the list of templated paths. HistoricalDataPathList: allOf: - $ref: "#/components/schemas/HistoricalDataPathList" - description: An array of strings containing the historical set of data paths. FileFormatDescriptor: $ref: "#/components/schemas/FileFormatDescriptor" summary: Amazon Lookout for Metrics Get Sample Data parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /ListAlerts: post: operationId: ListAlerts description:

Lists the alerts attached to a detector.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAlertsResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: AnomalyDetectorArn: description: The ARN of the alert's detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 NextToken: description: If the result of the previous request is truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours. type: string pattern: .*\S.* minLength: 1 maxLength: 3000 MaxResults: description: The maximum number of results that will be displayed by the request. type: integer minimum: 1 maximum: 100 summary: Amazon Lookout for Metrics List Alerts parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /ListAnomalyDetectors: post: operationId: ListAnomalyDetectors description:

Lists the detectors in the current AWS Region.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAnomalyDetectorsResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: MaxResults: description: The maximum number of results to return. type: integer minimum: 1 maximum: 100 NextToken: description: If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours. type: string pattern: .*\S.* minLength: 1 maxLength: 3000 summary: Amazon Lookout for Metrics List Anomaly Detectors parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /ListAnomalyGroupRelatedMetrics: post: operationId: ListAnomalyGroupRelatedMetrics description: Returns a list of measures that are potential causes or effects of an anomaly group. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAnomalyGroupRelatedMetricsResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn - AnomalyGroupId properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 AnomalyGroupId: description: The ID of the anomaly group. type: string pattern: "[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" maxLength: 63 RelationshipTypeFilter: description: Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group. type: string enum: - CAUSE_OF_INPUT_ANOMALY_GROUP - EFFECT_OF_INPUT_ANOMALY_GROUP MaxResults: description: The maximum number of results to return. type: integer minimum: 1 maximum: 100 NextToken: description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. type: string pattern: .*\S.* minLength: 1 maxLength: 3000 summary: Amazon Lookout for Metrics List Anomaly Group Related Metrics parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /ListAnomalyGroupSummaries: post: operationId: ListAnomalyGroupSummaries description: Returns a list of anomaly groups. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAnomalyGroupSummariesResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn - SensitivityThreshold properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 SensitivityThreshold: description: The minimum severity score for inclusion in the output. type: integer minimum: 0 maximum: 100 MaxResults: description: The maximum number of results to return. type: integer minimum: 1 maximum: 100 NextToken: description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. type: string pattern: .*\S.* minLength: 1 maxLength: 3000 summary: Amazon Lookout for Metrics List Anomaly Group Summaries parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /ListAnomalyGroupTimeSeries: post: operationId: ListAnomalyGroupTimeSeries description: Gets a list of anomalous metrics for a measure in an anomaly group. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListAnomalyGroupTimeSeriesResponse" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "482": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn - AnomalyGroupId - MetricName properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 AnomalyGroupId: description: The ID of the anomaly group. type: string pattern: "[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" maxLength: 63 MetricName: description: The name of the measure field. type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* maxLength: 256 MaxResults: description: The maximum number of results to return. type: integer minimum: 1 maximum: 100 NextToken: description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. type: string pattern: .*\S.* minLength: 1 maxLength: 3000 summary: Amazon Lookout for Metrics List Anomaly Group Time Series parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /ListMetricSets: post: operationId: ListMetricSets description:

Lists the datasets in the current AWS Region.

responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListMetricSetsResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "484": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object properties: AnomalyDetectorArn: description: The ARN of the anomaly detector containing the metrics sets to list. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 MaxResults: description: The maximum number of results to return. type: integer minimum: 1 maximum: 100 NextToken: description: If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours. type: string pattern: .*\S.* minLength: 1 maxLength: 3000 summary: Amazon Lookout for Metrics List Metric Sets parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/tags/{resourceArn}": get: operationId: ListTagsForResource description: Gets a list of tags for a detector, dataset, or alert. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/ListTagsForResourceResponse" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: resourceArn in: path required: true description: The resource's Amazon Resource Name (ARN). schema: type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 summary: Amazon Lookout for Metrics List Tags for Resource parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" post: operationId: TagResource description: Adds tags to a detector, dataset, or alert. responses: "204": description: Success content: application/json: schema: $ref: "#/components/schemas/TagResourceResponse" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: resourceArn in: path required: true description: The resource's Amazon Resource Name (ARN). schema: type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 requestBody: required: true content: application/json: schema: type: object required: - tags properties: tags: description: "Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@- " type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: "#/components/schemas/TagValue" summary: Amazon Lookout for Metrics Tag Resource /PutFeedback: post: operationId: PutFeedback description: Add feedback for an anomalous metric. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/PutFeedbackResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "483": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn - AnomalyGroupTimeSeriesFeedback properties: AnomalyDetectorArn: description: The Amazon Resource Name (ARN) of the anomaly detector. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 AnomalyGroupTimeSeriesFeedback: description: Feedback for an anomalous metric. type: object properties: AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. TimeSeriesId: allOf: - $ref: "#/components/schemas/TimeSeriesId" - description: The ID of the metric. IsAnomaly: allOf: - $ref: "#/components/schemas/Boolean" - description: Feedback on whether the metric is a legitimate anomaly. summary: Amazon Lookout for Metrics Put Feedback parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" "/tags/{resourceArn}#tagKeys": delete: operationId: UntagResource description: Removes tags from a detector, dataset, or alert. responses: "204": description: Success content: application/json: schema: $ref: "#/components/schemas/UntagResourceResponse" "480": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" parameters: - name: resourceArn in: path required: true description: The resource's Amazon Resource Name (ARN). schema: type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 - name: tagKeys in: query required: true description: Keys to remove from the resource's tags. schema: type: array items: $ref: "#/components/schemas/TagKey" minItems: 1 maxItems: 50 summary: Amazon Lookout for Metrics Untag Resource parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /UpdateAlert: post: operationId: UpdateAlert description: Make changes to an existing alert. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateAlertResponse" "480": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "481": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AlertArn properties: AlertArn: description: The ARN of the alert to update. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 AlertDescription: description: A description of the alert. type: string pattern: .*\S.* maxLength: 256 AlertSensitivityThreshold: description: An integer from 0 to 100 specifying the alert sensitivity threshold. type: integer minimum: 0 maximum: 100 Action: description: A configuration that specifies the action to perform when anomalies are detected. type: object properties: SNSConfiguration: allOf: - $ref: "#/components/schemas/SNSConfiguration" - description: A configuration for an Amazon SNS channel. LambdaConfiguration: allOf: - $ref: "#/components/schemas/LambdaConfiguration" - description: A configuration for an AWS Lambda channel. AlertFilters: description: The configuration of the alert filters. type: object properties: MetricList: allOf: - $ref: "#/components/schemas/MetricNameList" - description: The list of measures that you want to get alerts for. DimensionFilterList: allOf: - $ref: "#/components/schemas/DimensionFilterList" - description: The list of DimensionFilter objects that are used for dimension-based filtering. summary: Amazon Lookout for Metrics Update Alert parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /UpdateAnomalyDetector: post: operationId: UpdateAnomalyDetector description: Updates a detector. After activation, you can only change a detector's ingestion delay and description. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateAnomalyDetectorResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - AnomalyDetectorArn properties: AnomalyDetectorArn: description: The ARN of the detector to update. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 KmsKeyArn: description: The Amazon Resource Name (ARN) of an AWS KMS encryption key. type: string 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} minLength: 20 maxLength: 2048 AnomalyDetectorDescription: description: The updated detector description. type: string pattern: .*\S.* minLength: 1 maxLength: 256 AnomalyDetectorConfig: description: Contains information about a detector's configuration. type: object properties: AnomalyDetectorFrequency: allOf: - $ref: "#/components/schemas/Frequency" - description: The frequency at which the detector analyzes its source data. summary: Amazon Lookout for Metrics Update Anomaly Detector parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" /UpdateMetricSet: post: operationId: UpdateMetricSet description: Updates a dataset. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateMetricSetResponse" "480": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "481": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "484": description: TooManyRequestsException content: application/json: schema: $ref: "#/components/schemas/TooManyRequestsException" "485": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - MetricSetArn properties: MetricSetArn: description: The ARN of the dataset to update. type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 MetricSetDescription: description: The dataset's description. type: string pattern: .*\S.* minLength: 1 maxLength: 256 MetricList: description: The metric list. type: array items: $ref: "#/components/schemas/Metric" minItems: 1 Offset: description: After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources. type: integer minimum: 0 maximum: 432000 TimestampColumn: description: Contains information about the column used to track time in a source data file. type: object properties: ColumnName: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of the timestamp column. ColumnFormat: allOf: - $ref: "#/components/schemas/DateTimeFormat" - description: The format of the timestamp column. DimensionList: description: The dimension list. type: array items: $ref: "#/components/schemas/ColumnName" minItems: 1 MetricSetFrequency: description: The dataset's interval. type: string enum: - P1D - PT1H - PT10M - PT5M MetricSource: description: Contains information about source data used to generate metrics. type: object properties: S3SourceConfig: $ref: "#/components/schemas/S3SourceConfig" AppFlowConfig: allOf: - $ref: "#/components/schemas/AppFlowConfig" - description: Details about an AppFlow datasource. CloudWatchConfig: allOf: - $ref: "#/components/schemas/CloudWatchConfig" - description: Details about an Amazon CloudWatch monitoring datasource. RDSSourceConfig: allOf: - $ref: "#/components/schemas/RDSSourceConfig" - description: Details about an Amazon Relational Database Service (RDS) datasource. RedshiftSourceConfig: allOf: - $ref: "#/components/schemas/RedshiftSourceConfig" - description: Details about an Amazon Redshift database datasource. AthenaSourceConfig: allOf: - $ref: "#/components/schemas/AthenaSourceConfig" - description: Details about an Amazon Athena datasource. DimensionFilterList: description: Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation. type: array items: $ref: "#/components/schemas/MetricSetDimensionFilter" summary: Amazon Lookout for Metrics Update Metric Set parameters: - $ref: "#/components/parameters/X-Amz-Content-Sha256" - $ref: "#/components/parameters/X-Amz-Date" - $ref: "#/components/parameters/X-Amz-Algorithm" - $ref: "#/components/parameters/X-Amz-Credential" - $ref: "#/components/parameters/X-Amz-Security-Token" - $ref: "#/components/parameters/X-Amz-Signature" - $ref: "#/components/parameters/X-Amz-SignedHeaders" components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: ActivateAnomalyDetectorResponse: type: object properties: {} ValidationException: {} ResourceNotFoundException: {} AccessDeniedException: {} TooManyRequestsException: {} InternalServerException: {} ConflictException: {} BackTestAnomalyDetectorResponse: type: object properties: {} CreateAlertResponse: type: object properties: AlertArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the alert. SNSConfiguration: type: object required: - RoleArn - SnsTopicArn properties: RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the IAM role that has access to the target SNS topic. SnsTopicArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the target SNS topic. SnsFormat: allOf: - $ref: "#/components/schemas/SnsFormat" - description:

The format of the SNS topic.

JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.
LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.
SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.

description: Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic. LambdaConfiguration: type: object required: - RoleArn - LambdaArn properties: RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of an IAM role that has permission to invoke the Lambda function. LambdaArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the Lambda function. description: Contains information about a Lambda configuration. TagValue: type: string maxLength: 256 MetricNameList: type: array items: $ref: "#/components/schemas/MetricName" minItems: 1 maxItems: 5 DimensionFilterList: type: array items: $ref: "#/components/schemas/DimensionFilter" minItems: 1 maxItems: 5 ServiceQuotaExceededException: {} CreateAnomalyDetectorResponse: type: object properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector. Frequency: type: string enum: - P1D - PT1H - PT10M - PT5M CreateMetricSetResponse: type: object properties: MetricSetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the dataset. Metric: type: object required: - MetricName - AggregationFunction properties: MetricName: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of the metric. AggregationFunction: allOf: - $ref: "#/components/schemas/AggregationFunction" - description: The function with which the metric is calculated. Namespace: allOf: - $ref: "#/components/schemas/Namespace" - description: The namespace for the metric. description: A calculation made by contrasting a measure and a dimension from your source data. ColumnName: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* minLength: 1 maxLength: 63 DateTimeFormat: type: string pattern: .*\S.* maxLength: 63 S3SourceConfig: type: object properties: RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of an IAM role that has read and write access permissions to the source S3 bucket. TemplatedPathList: allOf: - $ref: "#/components/schemas/TemplatedPathList" - description: A list of templated paths to the source files. HistoricalDataPathList: allOf: - $ref: "#/components/schemas/HistoricalDataPathList" - description: A list of paths to the historical data files. FileFormatDescriptor: allOf: - $ref: "#/components/schemas/FileFormatDescriptor" - description: Contains information about a source file's formatting. description: Contains information about the configuration of the S3 bucket that contains source files. AppFlowConfig: type: object properties: RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: An IAM role that gives Amazon Lookout for Metrics permission to access the flow. FlowName: allOf: - $ref: "#/components/schemas/FlowName" - description: " name of the flow." description: Details about an Amazon AppFlow flow datasource. CloudWatchConfig: type: object properties: RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch. BackTestConfiguration: allOf: - $ref: "#/components/schemas/BackTestConfiguration" - description: Settings for backtest mode. description: Details about an Amazon CloudWatch datasource. RDSSourceConfig: type: object properties: DBInstanceIdentifier: allOf: - $ref: "#/components/schemas/RDSDatabaseIdentifier" - description: A string identifying the database instance. DatabaseHost: allOf: - $ref: "#/components/schemas/DatabaseHost" - description: The host name of the database. DatabasePort: allOf: - $ref: "#/components/schemas/DatabasePort" - description: The port number where the database can be accessed. SecretManagerArn: allOf: - $ref: "#/components/schemas/PoirotSecretManagerArn" - description: The Amazon Resource Name (ARN) of the AWS Secrets Manager role. DatabaseName: allOf: - $ref: "#/components/schemas/RDSDatabaseName" - description: The name of the RDS database. TableName: allOf: - $ref: "#/components/schemas/TableName" - description: The name of the table in the database. RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the role. VpcConfiguration: allOf: - $ref: "#/components/schemas/VpcConfiguration" - description: An object containing information about the Amazon Virtual Private Cloud (VPC) configuration. description: Contains information about the Amazon Relational Database Service (RDS) configuration. RedshiftSourceConfig: type: object properties: ClusterIdentifier: allOf: - $ref: "#/components/schemas/RedshiftClusterIdentifier" - description: A string identifying the Redshift cluster. DatabaseHost: allOf: - $ref: "#/components/schemas/DatabaseHost" - description: The name of the database host. DatabasePort: allOf: - $ref: "#/components/schemas/DatabasePort" - description: The port number where the database can be accessed. SecretManagerArn: allOf: - $ref: "#/components/schemas/PoirotSecretManagerArn" - description: The Amazon Resource Name (ARN) of the AWS Secrets Manager role. DatabaseName: allOf: - $ref: "#/components/schemas/RedshiftDatabaseName" - description: The Redshift database name. TableName: allOf: - $ref: "#/components/schemas/TableName" - description: The table name of the Redshift database. RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the role providing access to the database. VpcConfiguration: allOf: - $ref: "#/components/schemas/VpcConfiguration" - description: Contains information about the Amazon Virtual Private Cloud (VPC) configuration. description: Provides information about the Amazon Redshift database configuration. AthenaSourceConfig: type: object properties: RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: An IAM role that gives Amazon Lookout for Metrics permission to access the data. DatabaseName: allOf: - $ref: "#/components/schemas/AthenaDatabaseName" - description: The database's name. DataCatalog: allOf: - $ref: "#/components/schemas/AthenaDataCatalog" - description: The database's data catalog. TableName: allOf: - $ref: "#/components/schemas/AthenaTableName" - description: The database's table name. WorkGroupName: allOf: - $ref: "#/components/schemas/AthenaWorkGroupName" - description: The database's work group name. S3ResultsPath: allOf: - $ref: "#/components/schemas/AthenaS3ResultsPath" - description: The database's results path. BackTestConfiguration: allOf: - $ref: "#/components/schemas/BackTestConfiguration" - description: Settings for backtest mode. description: Details about an Amazon Athena datasource. MetricSetDimensionFilter: type: object properties: Name: allOf: - $ref: "#/components/schemas/ColumnName" - description: The dimension that you want to filter on. FilterList: allOf: - $ref: "#/components/schemas/FilterList" - description: The list of filters that you are applying. description: "Describes a list of filters for choosing a subset of dimension values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation. " DeactivateAnomalyDetectorResponse: type: object properties: {} DeleteAlertResponse: type: object properties: {} DeleteAnomalyDetectorResponse: type: object properties: {} DescribeAlertResponse: type: object properties: Alert: allOf: - $ref: "#/components/schemas/Alert" - description: Contains information about an alert. DescribeAnomalyDetectionExecutionsResponse: type: object properties: ExecutionList: allOf: - $ref: "#/components/schemas/ExecutionList" - description: A list of detection jobs. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: The pagination token that's included if more results are available. DescribeAnomalyDetectorResponse: type: object properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector. AnomalyDetectorName: allOf: - $ref: "#/components/schemas/AnomalyDetectorName" - description: The name of the detector. AnomalyDetectorDescription: allOf: - $ref: "#/components/schemas/AnomalyDetectorDescription" - description: A description of the detector. AnomalyDetectorConfig: allOf: - $ref: "#/components/schemas/AnomalyDetectorConfigSummary" - description: Contains information about the detector's configuration. CreationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the detector was created. LastModificationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the detector was last modified. Status: allOf: - $ref: "#/components/schemas/AnomalyDetectorStatus" - description: The status of the detector. FailureReason: allOf: - $ref: "#/components/schemas/ErrorMessage" - description: The reason that the detector failed. KmsKeyArn: allOf: - $ref: "#/components/schemas/KmsKeyArn" - description: The ARN of the KMS key to use to encrypt your data. FailureType: allOf: - $ref: "#/components/schemas/AnomalyDetectorFailureType" - description: The process that caused the detector to fail. DescribeMetricSetResponse: type: object properties: MetricSetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the dataset. AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector that contains the dataset. MetricSetName: allOf: - $ref: "#/components/schemas/MetricSetName" - description: The name of the dataset. MetricSetDescription: allOf: - $ref: "#/components/schemas/MetricSetDescription" - description: The dataset's description. CreationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the dataset was created. LastModificationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the dataset was last modified. Offset: allOf: - $ref: "#/components/schemas/Offset" - description: After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources. MetricList: allOf: - $ref: "#/components/schemas/MetricList" - description: A list of the metrics defined by the dataset. TimestampColumn: allOf: - $ref: "#/components/schemas/TimestampColumn" - description: Contains information about the column used for tracking time in your source data. DimensionList: allOf: - $ref: "#/components/schemas/DimensionList" - description: A list of the dimensions chosen for analysis. MetricSetFrequency: allOf: - $ref: "#/components/schemas/Frequency" - description: The interval at which the data will be analyzed for anomalies. Timezone: allOf: - $ref: "#/components/schemas/Timezone" - description: The time zone in which the dataset's data was recorded. MetricSource: allOf: - $ref: "#/components/schemas/MetricSource" - description: Contains information about the dataset's source data. DimensionFilterList: allOf: - $ref: "#/components/schemas/MetricSetDimensionFilterList" - description: The dimensions and their values that were used to filter the dataset. DetectMetricSetConfigResponse: type: object properties: DetectedMetricSetConfig: allOf: - $ref: "#/components/schemas/DetectedMetricSetConfig" - description: The inferred dataset configuration for the datasource. AutoDetectionS3SourceConfig: type: object properties: TemplatedPathList: allOf: - $ref: "#/components/schemas/TemplatedPathList" - description: The config's templated path list. HistoricalDataPathList: allOf: - $ref: "#/components/schemas/HistoricalDataPathList" - description: The config's historical data path list. description: An auto detection source config. GetAnomalyGroupResponse: type: object properties: AnomalyGroup: allOf: - $ref: "#/components/schemas/AnomalyGroup" - description: Details about the anomaly group. GetDataQualityMetricsResponse: type: object properties: AnomalyDetectorDataQualityMetricList: allOf: - $ref: "#/components/schemas/AnomalyDetectorDataQualityMetricList" - description: A list of the data quality metrics for the AnomalyDetectorArn that you requested. GetFeedbackResponse: type: object properties: AnomalyGroupTimeSeriesFeedback: allOf: - $ref: "#/components/schemas/TimeSeriesFeedbackList" - description: Feedback for an anomalous metric. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: The pagination token that's included if more results are available. UUID: type: string pattern: "[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}" maxLength: 63 TimeSeriesId: type: string pattern: .*\S.* maxLength: 520 GetSampleDataResponse: type: object properties: HeaderValues: allOf: - $ref: "#/components/schemas/HeaderValueList" - description: A list of header labels for the records. SampleRows: allOf: - $ref: "#/components/schemas/SampleRows" - description: A list of records. Arn: type: string pattern: arn:([a-z\d-]+):.*:.*:.*:.+ maxLength: 256 TemplatedPathList: type: array items: $ref: "#/components/schemas/TemplatedPath" minItems: 1 maxItems: 1 HistoricalDataPathList: type: array items: $ref: "#/components/schemas/HistoricalDataPath" minItems: 1 maxItems: 1 FileFormatDescriptor: type: object properties: CsvFormatDescriptor: allOf: - $ref: "#/components/schemas/CsvFormatDescriptor" - description: Contains information about how a source CSV data file should be analyzed. JsonFormatDescriptor: allOf: - $ref: "#/components/schemas/JsonFormatDescriptor" - description: Contains information about how a source JSON data file should be analyzed. description: Contains information about a source file's formatting. ListAlertsResponse: type: object properties: AlertSummaryList: allOf: - $ref: "#/components/schemas/AlertSummaryList" - description: Contains information about an alert. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request. ListAnomalyDetectorsResponse: type: object properties: AnomalyDetectorSummaryList: allOf: - $ref: "#/components/schemas/AnomalyDetectorSummaryList" - description: A list of anomaly detectors in the account in the current region. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request. ListAnomalyGroupRelatedMetricsResponse: type: object properties: InterMetricImpactList: allOf: - $ref: "#/components/schemas/InterMetricImpactList" - description: Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: The pagination token that's included if more results are available. ListAnomalyGroupSummariesResponse: type: object properties: AnomalyGroupSummaryList: allOf: - $ref: "#/components/schemas/AnomalyGroupSummaryList" - description: A list of anomaly group summaries. AnomalyGroupStatistics: allOf: - $ref: "#/components/schemas/AnomalyGroupStatistics" - description: Aggregated details about the anomaly groups. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: The pagination token that's included if more results are available. ListAnomalyGroupTimeSeriesResponse: type: object properties: AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. MetricName: allOf: - $ref: "#/components/schemas/MetricName" - description: The name of the measure field. TimestampList: allOf: - $ref: "#/components/schemas/TimestampList" - description: Timestamps for the anomalous metrics. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: The pagination token that's included if more results are available. TimeSeriesList: allOf: - $ref: "#/components/schemas/TimeSeriesList" - description: A list of anomalous metrics. ListMetricSetsResponse: type: object properties: MetricSetSummaryList: allOf: - $ref: "#/components/schemas/MetricSetSummaryList" - description: A list of the datasets in the AWS Region, with configuration details for each. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: "If the response is truncated, the list call returns this token. To retrieve the next set of results, use the token in the next list request. " ListTagsForResourceResponse: type: object properties: Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: The resource's tags. PutFeedbackResponse: type: object properties: {} Boolean: type: boolean TagResourceResponse: type: object properties: {} UntagResourceResponse: type: object properties: {} TagKey: type: string minLength: 1 maxLength: 128 UpdateAlertResponse: type: object properties: AlertArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the updated alert. UpdateAnomalyDetectorResponse: type: object properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the updated detector. UpdateMetricSetResponse: type: object properties: MetricSetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the dataset. Action: type: object properties: SNSConfiguration: allOf: - $ref: "#/components/schemas/SNSConfiguration" - description: A configuration for an Amazon SNS channel. LambdaConfiguration: allOf: - $ref: "#/components/schemas/LambdaConfiguration" - description: A configuration for an AWS Lambda channel. description: A configuration that specifies the action to perform when anomalies are detected. ActivateAnomalyDetectorRequest: type: object required: - AnomalyDetectorArn title: ActivateAnomalyDetectorRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the anomaly detector. AggregationFunction: type: string enum: - AVG - SUM AlertDescription: type: string pattern: .*\S.* maxLength: 256 AlertName: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* minLength: 1 maxLength: 63 SensitivityThreshold: type: integer minimum: 0 maximum: 100 AlertType: type: string enum: - SNS - LAMBDA AlertStatus: type: string enum: - ACTIVE - INACTIVE Timestamp: type: string format: date-time AlertFilters: type: object properties: MetricList: allOf: - $ref: "#/components/schemas/MetricNameList" - description: The list of measures that you want to get alerts for. DimensionFilterList: allOf: - $ref: "#/components/schemas/DimensionFilterList" - description: The list of DimensionFilter objects that are used for dimension-based filtering. description: The configuration of the alert filters. Alert: type: object properties: Action: allOf: - $ref: "#/components/schemas/Action" - description: Action that will be triggered when there is an alert. AlertDescription: allOf: - $ref: "#/components/schemas/AlertDescription" - description: A description of the alert. AlertArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the alert. AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector to which the alert is attached. AlertName: allOf: - $ref: "#/components/schemas/AlertName" - description: The name of the alert. AlertSensitivityThreshold: allOf: - $ref: "#/components/schemas/SensitivityThreshold" - description: The minimum severity for an anomaly to trigger the alert. AlertType: allOf: - $ref: "#/components/schemas/AlertType" - description: The type of the alert. AlertStatus: allOf: - $ref: "#/components/schemas/AlertStatus" - description: The status of the alert. LastModificationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the alert was last modified. CreationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the alert was created. AlertFilters: allOf: - $ref: "#/components/schemas/AlertFilters" - description: The configuration of the alert filters, containing MetricList and DimensionFilter. description: A configuration for Amazon SNS-integrated notifications. TagMap: type: object minProperties: 1 maxProperties: 50 additionalProperties: $ref: "#/components/schemas/TagValue" AlertSummary: type: object properties: AlertArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the alert. AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector to which the alert is attached. AlertName: allOf: - $ref: "#/components/schemas/AlertName" - description: The name of the alert. AlertSensitivityThreshold: allOf: - $ref: "#/components/schemas/SensitivityThreshold" - description: The minimum severity for an anomaly to trigger the alert. AlertType: allOf: - $ref: "#/components/schemas/AlertType" - description: The type of the alert. AlertStatus: allOf: - $ref: "#/components/schemas/AlertStatus" - description: The status of the alert. LastModificationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the alert was last modified. CreationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the alert was created. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: The alert's tags. description: Provides a summary of an alert's configuration. AlertSummaryList: type: array items: $ref: "#/components/schemas/AlertSummary" AnomalyDetectionTaskStatus: type: string enum: - PENDING - IN_PROGRESS - COMPLETED - FAILED - FAILED_TO_SCHEDULE AnomalyDetectionTaskStatusMessage: type: string pattern: .*\S.* minLength: 1 maxLength: 256 AnomalyDetectorConfig: type: object properties: AnomalyDetectorFrequency: allOf: - $ref: "#/components/schemas/Frequency" - description: The frequency at which the detector analyzes its source data. description: Contains information about a detector's configuration. AnomalyDetectorConfigSummary: type: object properties: AnomalyDetectorFrequency: allOf: - $ref: "#/components/schemas/Frequency" - description: The interval at which the detector analyzes its source data. description: Contains information about a detector's configuration. MetricSetDataQualityMetricList: type: array items: $ref: "#/components/schemas/MetricSetDataQualityMetric" AnomalyDetectorDataQualityMetric: type: object properties: StartTimestamp: allOf: - $ref: "#/components/schemas/Timestamp" - description: The start time for the data quality metrics collection. MetricSetDataQualityMetricList: allOf: - $ref: "#/components/schemas/MetricSetDataQualityMetricList" - description: An array of DataQualityMetricList objects. Each object in the array contains information about a data quality metric. description: Aggregated details about the data quality metrics collected for the AnomalyDetectorArn provided in the GetDataQualityMetrics object. AnomalyDetectorDataQualityMetricList: type: array items: $ref: "#/components/schemas/AnomalyDetectorDataQualityMetric" AnomalyDetectorDescription: type: string pattern: .*\S.* minLength: 1 maxLength: 256 AnomalyDetectorFailureType: type: string enum: - ACTIVATION_FAILURE - BACK_TEST_ACTIVATION_FAILURE - DELETION_FAILURE - DEACTIVATION_FAILURE AnomalyDetectorName: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* minLength: 1 maxLength: 63 AnomalyDetectorStatus: type: string enum: - ACTIVE - ACTIVATING - DELETING - FAILED - INACTIVE - LEARNING - BACK_TEST_ACTIVATING - BACK_TEST_ACTIVE - BACK_TEST_COMPLETE - DEACTIVATED - DEACTIVATING AnomalyDetectorSummary: type: object properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector. AnomalyDetectorName: allOf: - $ref: "#/components/schemas/AnomalyDetectorName" - description: The name of the detector. AnomalyDetectorDescription: allOf: - $ref: "#/components/schemas/AnomalyDetectorDescription" - description: A description of the detector. CreationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the detector was created. LastModificationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the detector was last modified. Status: allOf: - $ref: "#/components/schemas/AnomalyDetectorStatus" - description: The status of detector. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: The detector's tags. description: Contains information about an an anomaly detector. AnomalyDetectorSummaryList: type: array items: $ref: "#/components/schemas/AnomalyDetectorSummary" TimestampString: type: string 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:]\/\_]+\])?)$ maxLength: 60 Score: type: number format: double minimum: 0 maximum: 100 MetricName: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* maxLength: 256 MetricLevelImpactList: type: array items: $ref: "#/components/schemas/MetricLevelImpact" AnomalyGroup: type: object properties: StartTime: allOf: - $ref: "#/components/schemas/TimestampString" - description: The start time for the group. EndTime: allOf: - $ref: "#/components/schemas/TimestampString" - description: The end time for the group. AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. AnomalyGroupScore: allOf: - $ref: "#/components/schemas/Score" - description: The severity score of the group. PrimaryMetricName: allOf: - $ref: "#/components/schemas/MetricName" - description: The name of the primary affected measure for the group. MetricLevelImpactList: allOf: - $ref: "#/components/schemas/MetricLevelImpactList" - description: A list of measures affected by the anomaly. description: A group of anomalous metrics Integer: type: integer ItemizedMetricStatsList: type: array items: $ref: "#/components/schemas/ItemizedMetricStats" AnomalyGroupStatistics: type: object properties: EvaluationStartDate: allOf: - $ref: "#/components/schemas/TimestampString" - description: The start of the time range that was searched. TotalCount: allOf: - $ref: "#/components/schemas/Integer" - description: The number of groups found. ItemizedMetricStatsList: allOf: - $ref: "#/components/schemas/ItemizedMetricStatsList" - description: Statistics for individual metrics within the group. description: Aggregated statistics for a group of anomalous metrics. AnomalyGroupSummary: type: object properties: StartTime: allOf: - $ref: "#/components/schemas/TimestampString" - description: The start time for the group. EndTime: allOf: - $ref: "#/components/schemas/TimestampString" - description: The end time for the group. AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. AnomalyGroupScore: allOf: - $ref: "#/components/schemas/Score" - description: The severity score of the group. PrimaryMetricName: allOf: - $ref: "#/components/schemas/MetricName" - description: The name of the primary affected measure for the group. description: Details about a group of anomalous metrics. AnomalyGroupSummaryList: type: array items: $ref: "#/components/schemas/AnomalyGroupSummary" AnomalyGroupTimeSeries: type: object required: - AnomalyGroupId properties: AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. TimeSeriesId: allOf: - $ref: "#/components/schemas/TimeSeriesId" - description: The ID of the metric. description: An anomalous metric in an anomaly group. AnomalyGroupTimeSeriesFeedback: type: object required: - AnomalyGroupId - TimeSeriesId - IsAnomaly properties: AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. TimeSeriesId: allOf: - $ref: "#/components/schemas/TimeSeriesId" - description: The ID of the metric. IsAnomaly: allOf: - $ref: "#/components/schemas/Boolean" - description: Feedback on whether the metric is a legitimate anomaly. description: Feedback for an anomalous metric. FlowName: type: string pattern: "[a-zA-Z0-9][\\w!@#.-]+" maxLength: 256 AthenaDataCatalog: type: string minLength: 1 maxLength: 256 x-pattern: "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" AthenaDatabaseName: type: string pattern: "[a-zA-Z0-9_]+" minLength: 1 maxLength: 255 AthenaS3ResultsPath: type: string pattern: ^s3://[a-z0-9].+$ maxLength: 1024 AthenaTableName: type: string pattern: "[a-zA-Z0-9_]+" minLength: 1 maxLength: 128 AthenaWorkGroupName: type: string pattern: "[a-zA-Z0-9._-]{1,128}" minLength: 1 maxLength: 128 BackTestConfiguration: type: object required: - RunBackTestMode properties: RunBackTestMode: allOf: - $ref: "#/components/schemas/Boolean" - description: Run a backtest instead of monitoring new data. description: Settings for backtest mode. StringAttributeValue: type: string NumberAttributeValue: type: string BinaryAttributeValue: type: string StringListAttributeValue: type: array items: $ref: "#/components/schemas/StringAttributeValue" NumberListAttributeValue: type: array items: $ref: "#/components/schemas/NumberAttributeValue" BinaryListAttributeValue: type: array items: $ref: "#/components/schemas/BinaryAttributeValue" AttributeValue: type: object properties: S: allOf: - $ref: "#/components/schemas/StringAttributeValue" - description: A string. N: allOf: - $ref: "#/components/schemas/NumberAttributeValue" - description: A number. B: allOf: - $ref: "#/components/schemas/BinaryAttributeValue" - description: A binary value. SS: allOf: - $ref: "#/components/schemas/StringListAttributeValue" - description: A list of strings. NS: allOf: - $ref: "#/components/schemas/NumberListAttributeValue" - description: A list of numbers. BS: allOf: - $ref: "#/components/schemas/BinaryListAttributeValue" - description: A list of binary values. description: An attribute value. AutoDetectionMetricSource: type: object properties: S3SourceConfig: allOf: - $ref: "#/components/schemas/AutoDetectionS3SourceConfig" - description: The source's source config. description: An auto detection metric source. BackTestAnomalyDetectorRequest: type: object required: - AnomalyDetectorArn title: BackTestAnomalyDetectorRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. CSVFileCompression: type: string enum: - NONE - GZIP Charset: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* maxLength: 63 Confidence: type: string enum: - HIGH - LOW - NONE DimensionContributionList: type: array items: $ref: "#/components/schemas/DimensionContribution" ContributionMatrix: type: object properties: DimensionContributionList: allOf: - $ref: "#/components/schemas/DimensionContributionList" - description: A list of contributing dimensions. description: Details about dimensions that contributed to an anomaly. CreateAlertRequest: type: object required: - AlertName - AnomalyDetectorArn - Action title: CreateAlertRequest properties: AlertName: allOf: - $ref: "#/components/schemas/AlertName" - description: The name of the alert. AlertSensitivityThreshold: allOf: - $ref: "#/components/schemas/SensitivityThreshold" - description: An integer from 0 to 100 specifying the alert sensitivity threshold. AlertDescription: allOf: - $ref: "#/components/schemas/AlertDescription" - description: A description of the alert. AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector to which the alert is attached. Action: allOf: - $ref: "#/components/schemas/Action" - description: Action that will be triggered when there is an alert. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: A list of tags to apply to the alert. AlertFilters: allOf: - $ref: "#/components/schemas/AlertFilters" - description: The configuration of the alert filters, containing MetricList and DimensionFilterList. KmsKeyArn: type: string 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} minLength: 20 maxLength: 2048 CreateAnomalyDetectorRequest: type: object required: - AnomalyDetectorName - AnomalyDetectorConfig title: CreateAnomalyDetectorRequest properties: AnomalyDetectorName: allOf: - $ref: "#/components/schemas/AnomalyDetectorName" - description: The name of the detector. AnomalyDetectorDescription: allOf: - $ref: "#/components/schemas/AnomalyDetectorDescription" - description: A description of the detector. AnomalyDetectorConfig: allOf: - $ref: "#/components/schemas/AnomalyDetectorConfig" - description: Contains information about the configuration of the anomaly detector. KmsKeyArn: allOf: - $ref: "#/components/schemas/KmsKeyArn" - description: The ARN of the KMS key to use to encrypt your data. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: A list of tags to apply to the anomaly detector. MetricSetName: type: string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]* minLength: 1 maxLength: 63 MetricSetDescription: type: string pattern: .*\S.* minLength: 1 maxLength: 256 MetricList: type: array items: $ref: "#/components/schemas/Metric" minItems: 1 Offset: type: integer minimum: 0 maximum: 432000 TimestampColumn: type: object properties: ColumnName: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of the timestamp column. ColumnFormat: allOf: - $ref: "#/components/schemas/DateTimeFormat" - description: The format of the timestamp column. description: Contains information about the column used to track time in a source data file. DimensionList: type: array items: $ref: "#/components/schemas/ColumnName" minItems: 1 MetricSource: type: object properties: S3SourceConfig: $ref: "#/components/schemas/S3SourceConfig" AppFlowConfig: allOf: - $ref: "#/components/schemas/AppFlowConfig" - description: Details about an AppFlow datasource. CloudWatchConfig: allOf: - $ref: "#/components/schemas/CloudWatchConfig" - description: Details about an Amazon CloudWatch monitoring datasource. RDSSourceConfig: allOf: - $ref: "#/components/schemas/RDSSourceConfig" - description: Details about an Amazon Relational Database Service (RDS) datasource. RedshiftSourceConfig: allOf: - $ref: "#/components/schemas/RedshiftSourceConfig" - description: Details about an Amazon Redshift database datasource. AthenaSourceConfig: allOf: - $ref: "#/components/schemas/AthenaSourceConfig" - description: Details about an Amazon Athena datasource. description: Contains information about source data used to generate metrics. Timezone: type: string pattern: .*\S.* maxLength: 60 MetricSetDimensionFilterList: type: array items: $ref: "#/components/schemas/MetricSetDimensionFilter" CreateMetricSetRequest: type: object required: - AnomalyDetectorArn - MetricSetName - MetricList - MetricSource title: CreateMetricSetRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the anomaly detector that will use the dataset. MetricSetName: allOf: - $ref: "#/components/schemas/MetricSetName" - description: The name of the dataset. MetricSetDescription: allOf: - $ref: "#/components/schemas/MetricSetDescription" - description: A description of the dataset you are creating. MetricList: allOf: - $ref: "#/components/schemas/MetricList" - description: A list of metrics that the dataset will contain. Offset: allOf: - $ref: "#/components/schemas/Offset" - description: After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources. TimestampColumn: allOf: - $ref: "#/components/schemas/TimestampColumn" - description: Contains information about the column used for tracking time in your source data. DimensionList: allOf: - $ref: "#/components/schemas/DimensionList" - description: A list of the fields you want to treat as dimensions. MetricSetFrequency: allOf: - $ref: "#/components/schemas/Frequency" - description: The frequency with which the source data will be analyzed for anomalies. MetricSource: allOf: - $ref: "#/components/schemas/MetricSource" - description: Contains information about how the source data should be interpreted. Timezone: allOf: - $ref: "#/components/schemas/Timezone" - description: The time zone in which your source data was recorded. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: A list of tags to apply to the dataset. DimensionFilterList: allOf: - $ref: "#/components/schemas/MetricSetDimensionFilterList" - description: A list of filters that specify which data is kept for anomaly detection. Delimiter: type: string pattern: "[^\\r\\n]" maxLength: 1 HeaderList: type: array items: $ref: "#/components/schemas/ColumnName" QuoteSymbol: type: string pattern: "[^\\r\\n]|^$" maxLength: 1 CsvFormatDescriptor: type: object properties: FileCompression: allOf: - $ref: "#/components/schemas/CSVFileCompression" - description: The level of compression of the source CSV file. Charset: allOf: - $ref: "#/components/schemas/Charset" - description: The character set in which the source CSV file is written. ContainsHeader: allOf: - $ref: "#/components/schemas/Boolean" - description: Whether or not the source CSV file contains a header. Delimiter: allOf: - $ref: "#/components/schemas/Delimiter" - description: The character used to delimit the source CSV file. HeaderList: allOf: - $ref: "#/components/schemas/HeaderList" - description: A list of the source CSV file's headers, if any. QuoteSymbol: allOf: - $ref: "#/components/schemas/QuoteSymbol" - description: The character used as a quote character. description: Contains information about how a source CSV data file should be analyzed. DataItem: type: string DataQualityMetricType: type: string enum: - COLUMN_COMPLETENESS - DIMENSION_UNIQUENESS - TIME_SERIES_COUNT - ROWS_PROCESSED - ROWS_PARTIAL_COMPLIANCE - INVALID_ROWS_COMPLIANCE - BACKTEST_TRAINING_DATA_START_TIME_STAMP - BACKTEST_TRAINING_DATA_END_TIME_STAMP - BACKTEST_INFERENCE_DATA_START_TIME_STAMP - BACKTEST_INFERENCE_DATA_END_TIME_STAMP DataQualityMetricDescription: type: string pattern: .*\S.* minLength: 1 maxLength: 256 RelatedColumnName: type: string pattern: .*\S.* minLength: 1 maxLength: 256 Double: type: number format: double DataQualityMetric: type: object properties: MetricType: allOf: - $ref: "#/components/schemas/DataQualityMetricType" - description: The name of the data quality metric. MetricDescription: allOf: - $ref: "#/components/schemas/DataQualityMetricDescription" - description: A description of the data quality metric. RelatedColumnName: allOf: - $ref: "#/components/schemas/RelatedColumnName" - description: The column that is being monitored. MetricValue: allOf: - $ref: "#/components/schemas/Double" - description: The value of the data quality metric. description: An array that describes a data quality metric. Each DataQualityMetric object contains the data quality metric name, its value, a description of the metric, and the affected column. DataQualityMetricList: type: array items: $ref: "#/components/schemas/DataQualityMetric" DatabaseHost: type: string pattern: .*\S.* minLength: 1 maxLength: 253 DatabasePort: type: integer minimum: 1 maximum: 65535 DeactivateAnomalyDetectorRequest: type: object required: - AnomalyDetectorArn title: DeactivateAnomalyDetectorRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. DeleteAlertRequest: type: object required: - AlertArn title: DeleteAlertRequest properties: AlertArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the alert to delete. DeleteAnomalyDetectorRequest: type: object required: - AnomalyDetectorArn title: DeleteAnomalyDetectorRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector to delete. DescribeAlertRequest: type: object required: - AlertArn title: DescribeAlertRequest properties: AlertArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the alert to describe. MaxResults: type: integer minimum: 1 maximum: 100 NextToken: type: string pattern: .*\S.* minLength: 1 maxLength: 3000 DescribeAnomalyDetectionExecutionsRequest: type: object required: - AnomalyDetectorArn title: DescribeAnomalyDetectionExecutionsRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. Timestamp: allOf: - $ref: "#/components/schemas/TimestampString" - description: The timestamp of the anomaly detection job. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: The number of items to return in the response. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. ExecutionList: type: array items: $ref: "#/components/schemas/ExecutionStatus" DescribeAnomalyDetectorRequest: type: object required: - AnomalyDetectorArn title: DescribeAnomalyDetectorRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector to describe. ErrorMessage: type: string maxLength: 256 DescribeMetricSetRequest: type: object required: - MetricSetArn title: DescribeMetricSetRequest properties: MetricSetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the dataset. DetectMetricSetConfigRequest: type: object required: - AnomalyDetectorArn - AutoDetectionMetricSource title: DetectMetricSetConfigRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: An anomaly detector ARN. AutoDetectionMetricSource: allOf: - $ref: "#/components/schemas/AutoDetectionMetricSource" - description: A data source. DetectedMetricSetConfig: type: object properties: Offset: allOf: - $ref: "#/components/schemas/DetectedField" - description: The dataset's offset. MetricSetFrequency: allOf: - $ref: "#/components/schemas/DetectedField" - description: The dataset's interval. MetricSource: allOf: - $ref: "#/components/schemas/DetectedMetricSource" - description: The dataset's data source. description: An inferred dataset configuration. DetectedField: type: object properties: Value: allOf: - $ref: "#/components/schemas/AttributeValue" - description: The field's value. Confidence: allOf: - $ref: "#/components/schemas/Confidence" - description: The field's confidence. Message: allOf: - $ref: "#/components/schemas/Message" - description: The field's message. description: An inferred field. DetectedCsvFormatDescriptor: type: object properties: FileCompression: allOf: - $ref: "#/components/schemas/DetectedField" - description: The format's file compression. Charset: allOf: - $ref: "#/components/schemas/DetectedField" - description: The format's charset. ContainsHeader: allOf: - $ref: "#/components/schemas/DetectedField" - description: Whether the format includes a header. Delimiter: allOf: - $ref: "#/components/schemas/DetectedField" - description: The format's delimiter. HeaderList: allOf: - $ref: "#/components/schemas/DetectedField" - description: The format's header list. QuoteSymbol: allOf: - $ref: "#/components/schemas/DetectedField" - description: The format's quote symbol. description: Properties of an inferred CSV format. Message: type: string DetectedJsonFormatDescriptor: type: object properties: FileCompression: allOf: - $ref: "#/components/schemas/DetectedField" - description: The format's file compression. Charset: allOf: - $ref: "#/components/schemas/DetectedField" - description: The format's character set. description: A detected JSON format descriptor. DetectedFileFormatDescriptor: type: object properties: CsvFormatDescriptor: allOf: - $ref: "#/components/schemas/DetectedCsvFormatDescriptor" - description: Details about a CSV format. JsonFormatDescriptor: allOf: - $ref: "#/components/schemas/DetectedJsonFormatDescriptor" - description: Details about a JSON format. description: Properties of an inferred data format. DetectedMetricSource: type: object properties: S3SourceConfig: allOf: - $ref: "#/components/schemas/DetectedS3SourceConfig" - description: The data source's source configuration. description: An inferred data source. DetectedS3SourceConfig: type: object properties: FileFormatDescriptor: allOf: - $ref: "#/components/schemas/DetectedFileFormatDescriptor" - description: The source's file format descriptor. description: An inferred source configuration. DimensionValueContributionList: type: array items: $ref: "#/components/schemas/DimensionValueContribution" DimensionContribution: type: object properties: DimensionName: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of the dimension. DimensionValueContributionList: allOf: - $ref: "#/components/schemas/DimensionValueContributionList" - description: A list of dimension values that contributed to the anomaly. description: Details about a dimension that contributed to an anomaly. DimensionValueList: type: array items: $ref: "#/components/schemas/DimensionValue" minItems: 1 maxItems: 10 DimensionFilter: type: object properties: DimensionName: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of the dimension to filter on. DimensionValueList: allOf: - $ref: "#/components/schemas/DimensionValueList" - description: The list of values for the dimension specified in DimensionName that you want to filter on. description: The dimension filter, containing DimensionName and DimensionValueList. DimensionValue: type: string DimensionNameValue: type: object required: - DimensionName - DimensionValue properties: DimensionName: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of the dimension. DimensionValue: allOf: - $ref: "#/components/schemas/DimensionValue" - description: The value of the dimension. description: A dimension name and value. DimensionNameValueList: type: array items: $ref: "#/components/schemas/DimensionNameValue" DimensionValueContribution: type: object properties: DimensionValue: allOf: - $ref: "#/components/schemas/DimensionValue" - description: The value of the dimension. ContributionScore: allOf: - $ref: "#/components/schemas/Score" - description: The severity score of the value. description: The severity of a value of a dimension that contributed to an anomaly. ExecutionStatus: type: object properties: Timestamp: allOf: - $ref: "#/components/schemas/TimestampString" - description: The run's timestamp. Status: allOf: - $ref: "#/components/schemas/AnomalyDetectionTaskStatus" - description: The run's status. FailureReason: allOf: - $ref: "#/components/schemas/AnomalyDetectionTaskStatusMessage" - description: The reason that the run failed, if applicable. description: The status of an anomaly detector run. JsonFormatDescriptor: type: object properties: FileCompression: allOf: - $ref: "#/components/schemas/JsonFileCompression" - description: The level of compression of the source CSV file. Charset: allOf: - $ref: "#/components/schemas/Charset" - description: The character set in which the source JSON file is written. description: Contains information about how a source JSON data file should be analyzed. FilterOperation: type: string enum: - EQUALS Filter: type: object properties: DimensionValue: allOf: - $ref: "#/components/schemas/DimensionValue" - description: The value that you want to include in the filter. FilterOperation: allOf: - $ref: "#/components/schemas/FilterOperation" - description: The condition to apply. description: Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation object. FilterList: type: array items: $ref: "#/components/schemas/Filter" minItems: 1 GetAnomalyGroupRequest: type: object required: - AnomalyGroupId - AnomalyDetectorArn title: GetAnomalyGroupRequest properties: AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. GetDataQualityMetricsRequest: type: object required: - AnomalyDetectorArn title: GetDataQualityMetricsRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate. MetricSetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of a specific data quality metric set. GetFeedbackRequest: type: object required: - AnomalyDetectorArn - AnomalyGroupTimeSeriesFeedback title: GetFeedbackRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. AnomalyGroupTimeSeriesFeedback: allOf: - $ref: "#/components/schemas/AnomalyGroupTimeSeries" - description: The anomalous metric and group ID. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to return. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. TimeSeriesFeedbackList: type: array items: $ref: "#/components/schemas/TimeSeriesFeedback" SampleDataS3SourceConfig: type: object required: - RoleArn - FileFormatDescriptor properties: RoleArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the role. TemplatedPathList: allOf: - $ref: "#/components/schemas/TemplatedPathList" - description: An array of strings containing the list of templated paths. HistoricalDataPathList: allOf: - $ref: "#/components/schemas/HistoricalDataPathList" - description: An array of strings containing the historical set of data paths. FileFormatDescriptor: $ref: "#/components/schemas/FileFormatDescriptor" description: Contains information about the source configuration in Amazon S3. GetSampleDataRequest: type: object title: GetSampleDataRequest properties: S3SourceConfig: allOf: - $ref: "#/components/schemas/SampleDataS3SourceConfig" - description: A datasource bucket in Amazon S3. HeaderValueList: type: array items: $ref: "#/components/schemas/HeaderValue" SampleRows: type: array items: $ref: "#/components/schemas/SampleRow" HeaderValue: type: string HistoricalDataPath: type: string pattern: ^s3://[a-z0-9].+$ maxLength: 1024 RelationshipType: type: string enum: - CAUSE_OF_INPUT_ANOMALY_GROUP - EFFECT_OF_INPUT_ANOMALY_GROUP MetricChangePercentage: type: number format: double minimum: 0 maximum: 100 InterMetricImpactDetails: type: object properties: MetricName: allOf: - $ref: "#/components/schemas/MetricName" - description: The name of the measure. AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. RelationshipType: allOf: - $ref: "#/components/schemas/RelationshipType" - description: Whether a measure is a potential cause of the anomaly group (CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP). ContributionPercentage: allOf: - $ref: "#/components/schemas/MetricChangePercentage" - description: For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage contribution the measure has in causing the anomalies. description:

Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

InterMetricImpactList: type: array items: $ref: "#/components/schemas/InterMetricImpactDetails" ItemizedMetricStats: type: object properties: MetricName: allOf: - $ref: "#/components/schemas/ColumnName" - description: The name of the measure. OccurrenceCount: allOf: - $ref: "#/components/schemas/Integer" - description: The number of times that the measure appears. description: Aggregated statistics about a measure affected by an anomaly. JsonFileCompression: type: string enum: - NONE - GZIP ListAlertsRequest: type: object title: ListAlertsRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the alert's detector. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: If the result of the previous request is truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results that will be displayed by the request. ListAnomalyDetectorsRequest: type: object title: ListAnomalyDetectorsRequest properties: MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to return. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours. ListAnomalyGroupRelatedMetricsRequest: type: object required: - AnomalyDetectorArn - AnomalyGroupId title: ListAnomalyGroupRelatedMetricsRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. RelationshipTypeFilter: allOf: - $ref: "#/components/schemas/RelationshipType" - description: Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to return. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. ListAnomalyGroupSummariesRequest: type: object required: - AnomalyDetectorArn - SensitivityThreshold title: ListAnomalyGroupSummariesRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. SensitivityThreshold: allOf: - $ref: "#/components/schemas/SensitivityThreshold" - description: The minimum severity score for inclusion in the output. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to return. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. ListAnomalyGroupTimeSeriesRequest: type: object required: - AnomalyDetectorArn - AnomalyGroupId - MetricName title: ListAnomalyGroupTimeSeriesRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. AnomalyGroupId: allOf: - $ref: "#/components/schemas/UUID" - description: The ID of the anomaly group. MetricName: allOf: - $ref: "#/components/schemas/MetricName" - description: The name of the measure field. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to return. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: Specify the pagination token that's returned by a previous request to retrieve the next page of results. TimestampList: type: array items: $ref: "#/components/schemas/TimestampString" TimeSeriesList: type: array items: $ref: "#/components/schemas/TimeSeries" ListMetricSetsRequest: type: object title: ListMetricSetsRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the anomaly detector containing the metrics sets to list. MaxResults: allOf: - $ref: "#/components/schemas/MaxResults" - description: The maximum number of results to return. NextToken: allOf: - $ref: "#/components/schemas/NextToken" - description: If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours. MetricSetSummaryList: type: array items: $ref: "#/components/schemas/MetricSetSummary" ListTagsForResourceRequest: type: object title: ListTagsForResourceRequest properties: {} Namespace: type: string pattern: "[^:].*" minLength: 1 maxLength: 255 MetricLevelImpact: type: object properties: MetricName: allOf: - $ref: "#/components/schemas/MetricName" - description: The name of the measure. NumTimeSeries: allOf: - $ref: "#/components/schemas/Integer" - description: The number of anomalous metrics for the measure. ContributionMatrix: allOf: - $ref: "#/components/schemas/ContributionMatrix" - description: Details about the dimensions that contributed to the anomaly. description: Details about a measure affected by an anomaly. MetricSetDataQualityMetric: type: object properties: MetricSetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the data quality metric array. DataQualityMetricList: allOf: - $ref: "#/components/schemas/DataQualityMetricList" - description: The array of data quality metrics contained in the data quality metric set. description: An array of DataQualityMetric objects that describes one or more data quality metrics. MetricSetSummary: type: object properties: MetricSetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the dataset. AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector to which the dataset belongs. MetricSetDescription: allOf: - $ref: "#/components/schemas/MetricSetDescription" - description: The description of the dataset. MetricSetName: allOf: - $ref: "#/components/schemas/MetricSetName" - description: The name of the dataset. CreationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the dataset was created. LastModificationTime: allOf: - $ref: "#/components/schemas/Timestamp" - description: The time at which the dataset was last modified. Tags: allOf: - $ref: "#/components/schemas/TagMap" - description: The dataset's tags. description: Contains information about a dataset. MetricValue: type: number format: double MetricValueList: type: array items: $ref: "#/components/schemas/MetricValue" PoirotSecretManagerArn: type: string pattern: arn:([a-z\d-]+):.*:.*:secret:AmazonLookoutMetrics-.+ maxLength: 256 PutFeedbackRequest: type: object required: - AnomalyDetectorArn - AnomalyGroupTimeSeriesFeedback title: PutFeedbackRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The Amazon Resource Name (ARN) of the anomaly detector. AnomalyGroupTimeSeriesFeedback: allOf: - $ref: "#/components/schemas/AnomalyGroupTimeSeriesFeedback" - description: Feedback for an anomalous metric. RDSDatabaseIdentifier: type: string pattern: ^[a-zA-Z](?!.*--)(?!.*-$)[0-9a-zA-Z\-]*$ minLength: 1 maxLength: 63 RDSDatabaseName: type: string pattern: "[a-zA-Z0-9_.]+" minLength: 1 maxLength: 64 TableName: type: string pattern: ^[a-zA-Z][a-zA-Z0-9_.]*$ minLength: 1 maxLength: 100 VpcConfiguration: type: object required: - SubnetIdList - SecurityGroupIdList properties: SubnetIdList: allOf: - $ref: "#/components/schemas/SubnetIdList" - description: An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE. SecurityGroupIdList: allOf: - $ref: "#/components/schemas/SecurityGroupIdList" - description: An array of strings containing the list of security groups. description: Contains configuration information about the Amazon Virtual Private Cloud (VPC). RedshiftClusterIdentifier: type: string pattern: ^[a-z](?!.*--)(?!.*-$)[0-9a-z\-]*$ minLength: 1 maxLength: 63 RedshiftDatabaseName: type: string pattern: "[a-zA-Z0-9_.]+" minLength: 1 maxLength: 100 SnsFormat: type: string enum: - LONG_TEXT - SHORT_TEXT - JSON SampleRow: type: array items: $ref: "#/components/schemas/DataItem" SecurityGroupId: type: string pattern: "[-0-9a-zA-Z]+" minLength: 1 maxLength: 255 SecurityGroupIdList: type: array items: $ref: "#/components/schemas/SecurityGroupId" SubnetId: type: string pattern: "[\\-0-9a-zA-Z]+" maxLength: 255 SubnetIdList: type: array items: $ref: "#/components/schemas/SubnetId" TagKeyList: type: array items: $ref: "#/components/schemas/TagKey" minItems: 1 maxItems: 50 TagResourceRequest: type: object required: - Tags title: TagResourceRequest properties: Tags: allOf: - $ref: "#/components/schemas/TagMap" - xml: name: tags description: "Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@- " TemplatedPath: type: string pattern: ^s3://[a-zA-Z0-9_\-\/ {}=]+$ maxLength: 1024 TimeSeries: type: object required: - TimeSeriesId - DimensionList - MetricValueList properties: TimeSeriesId: allOf: - $ref: "#/components/schemas/TimeSeriesId" - description: The ID of the metric. DimensionList: allOf: - $ref: "#/components/schemas/DimensionNameValueList" - description: The dimensions of the metric. MetricValueList: allOf: - $ref: "#/components/schemas/MetricValueList" - description: The values for the metric. description: Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region. TimeSeriesFeedback: type: object properties: TimeSeriesId: allOf: - $ref: "#/components/schemas/TimeSeriesId" - description: The ID of the metric. IsAnomaly: allOf: - $ref: "#/components/schemas/Boolean" - description: Feedback on whether the metric is a legitimate anomaly. description: Details about feedback submitted for an anomalous metric. UntagResourceRequest: type: object title: UntagResourceRequest properties: {} UpdateAlertRequest: type: object required: - AlertArn title: UpdateAlertRequest properties: AlertArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the alert to update. AlertDescription: allOf: - $ref: "#/components/schemas/AlertDescription" - description: A description of the alert. AlertSensitivityThreshold: allOf: - $ref: "#/components/schemas/SensitivityThreshold" - description: An integer from 0 to 100 specifying the alert sensitivity threshold. Action: allOf: - $ref: "#/components/schemas/Action" - description: Action that will be triggered when there is an alert. AlertFilters: allOf: - $ref: "#/components/schemas/AlertFilters" - description: The configuration of the alert filters, containing MetricList and DimensionFilterList. UpdateAnomalyDetectorRequest: type: object required: - AnomalyDetectorArn title: UpdateAnomalyDetectorRequest properties: AnomalyDetectorArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the detector to update. KmsKeyArn: allOf: - $ref: "#/components/schemas/KmsKeyArn" - description: The Amazon Resource Name (ARN) of an AWS KMS encryption key. AnomalyDetectorDescription: allOf: - $ref: "#/components/schemas/AnomalyDetectorDescription" - description: The updated detector description. AnomalyDetectorConfig: allOf: - $ref: "#/components/schemas/AnomalyDetectorConfig" - description: Contains information about the configuration to which the detector will be updated. UpdateMetricSetRequest: type: object required: - MetricSetArn title: UpdateMetricSetRequest properties: MetricSetArn: allOf: - $ref: "#/components/schemas/Arn" - description: The ARN of the dataset to update. MetricSetDescription: allOf: - $ref: "#/components/schemas/MetricSetDescription" - description: The dataset's description. MetricList: allOf: - $ref: "#/components/schemas/MetricList" - description: The metric list. Offset: allOf: - $ref: "#/components/schemas/Offset" - description: After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources. TimestampColumn: allOf: - $ref: "#/components/schemas/TimestampColumn" - description: The timestamp column. DimensionList: allOf: - $ref: "#/components/schemas/DimensionList" - description: The dimension list. MetricSetFrequency: allOf: - $ref: "#/components/schemas/Frequency" - description: The dataset's interval. MetricSource: $ref: "#/components/schemas/MetricSource" DimensionFilterList: allOf: - $ref: "#/components/schemas/MetricSetDimensionFilterList" - description: Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation. security: - hmac: []