openapi: 3.0.0 info: version: 2017-07-25 x-release: v4 title: Amazon Lookout for Metrics ActivateAnomalyDetector DescribeMetricSet API 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 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) security: - hmac: [] tags: - name: DescribeMetricSet paths: /DescribeMetricSet: 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: DescribeMetricSet description:
Describes a dataset.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
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 tags: - DescribeMetricSet components: schemas: AthenaTableName: type: string pattern: '[a-zA-Z0-9_]+' minLength: 1 maxLength: 128 DatabaseHost: type: string pattern: .*\S.* minLength: 1 maxLength: 253 SecurityGroupId: type: string pattern: '[-0-9a-zA-Z]+' minLength: 1 maxLength: 255 SubnetId: type: string pattern: '[\-0-9a-zA-Z]+' maxLength: 255 SubnetIdList: type: array items: $ref: '#/components/schemas/SubnetId' TemplatedPath: type: string pattern: ^s3://[a-zA-Z0-9_\-\/ {}=]+$ maxLength: 1024 ResourceNotFoundException: {} ValidationException: {} Frequency: type: string enum: - P1D - PT1H - PT10M - PT5M RDSDatabaseName: type: string pattern: '[a-zA-Z0-9_.]+' minLength: 1 maxLength: 64 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. 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. 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 theFilterOperation object.
DimensionValue:
type: string
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.
Timezone:
type: string
pattern: .*\S.*
maxLength: 60
MetricSetName:
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
minLength: 1
maxLength: 63
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.
HistoricalDataPathList:
type: array
items:
$ref: '#/components/schemas/HistoricalDataPath'
minItems: 1
maxItems: 1
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.
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.
AthenaS3ResultsPath:
type: string
pattern: ^s3://[a-z0-9].+$
maxLength: 1024
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.
RedshiftClusterIdentifier:
type: string
pattern: ^[a-z](?!.*--)(?!.*-$)[0-9a-z\-]*$
minLength: 1
maxLength: 63
TableName:
type: string
pattern: ^[a-zA-Z][a-zA-Z0-9_.]*$
minLength: 1
maxLength: 100
ColumnName:
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
minLength: 1
maxLength: 63
PoirotSecretManagerArn:
type: string
pattern: arn:([a-z\d-]+):.*:.*:secret:AmazonLookoutMetrics-.+
maxLength: 256
Boolean:
type: boolean
RedshiftDatabaseName:
type: string
pattern: '[a-zA-Z0-9_.]+'
minLength: 1
maxLength: 100
FilterOperation:
type: string
enum:
- EQUALS
AthenaWorkGroupName:
type: string
pattern: '[a-zA-Z0-9._-]{1,128}'
minLength: 1
maxLength: 128
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).
FlowName:
type: string
pattern: '[a-zA-Z0-9][\w!@#.-]+'
maxLength: 256
MetricList:
type: array
items:
$ref: '#/components/schemas/Metric'
minItems: 1
Namespace:
type: string
pattern: '[^:].*'
minLength: 1
maxLength: 255
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.
CSVFileCompression:
type: string
enum:
- NONE
- GZIP
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. '
Charset:
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
maxLength: 63
MetricSetDescription:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 256
QuoteSymbol:
type: string
pattern: '[^\r\n]|^$'
maxLength: 1
Arn:
type: string
pattern: arn:([a-z\d-]+):.*:.*:.*:.+
maxLength: 256
DimensionList:
type: array
items:
$ref: '#/components/schemas/ColumnName'
minItems: 1
Timestamp:
type: string
format: date-time
RDSDatabaseIdentifier:
type: string
pattern: ^[a-zA-Z](?!.*--)(?!.*-$)[0-9a-zA-Z\-]*$
minLength: 1
maxLength: 63
AggregationFunction:
type: string
enum:
- AVG
- SUM
FilterList:
type: array
items:
$ref: '#/components/schemas/Filter'
minItems: 1
DatabasePort:
type: integer
minimum: 1
maximum: 65535
HistoricalDataPath:
type: string
pattern: ^s3://[a-z0-9].+$
maxLength: 1024
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.
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.
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
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.
MetricSetDimensionFilterList:
type: array
items:
$ref: '#/components/schemas/MetricSetDimensionFilter'
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.
AccessDeniedException: {}
TooManyRequestsException: {}
DateTimeFormat:
type: string
pattern: .*\S.*
maxLength: 63
HeaderList:
type: array
items:
$ref: '#/components/schemas/ColumnName'
SecurityGroupIdList:
type: array
items:
$ref: '#/components/schemas/SecurityGroupId'
InternalServerException: {}
Offset:
type: integer
minimum: 0
maximum: 432000
TemplatedPathList:
type: array
items:
$ref: '#/components/schemas/TemplatedPath'
minItems: 1
maxItems: 1
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.
JsonFileCompression:
type: string
enum:
- NONE
- GZIP
Delimiter:
type: string
pattern: '[^\r\n]'
maxLength: 1
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.
parameters:
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
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
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/lookoutmetrics/
x-hasEquivalentPaths: true