openapi: 3.0.0 info: version: 2017-07-25 x-release: v4 title: Amazon Lookout for Metrics ActivateAnomalyDetector ListMetricSets 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: ListMetricSets paths: /ListMetricSets: 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: ListMetricSets description:
Lists the datasets in the current AWS Region.
Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
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 aNextToken. 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
tags:
- ListMetricSets
components:
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
schemas:
ValidationException: {}
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. '
ResourceNotFoundException: {}
MetricSetName:
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]*
minLength: 1
maxLength: 63
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.
MetricSetSummaryList:
type: array
items:
$ref: '#/components/schemas/MetricSetSummary'
NextToken:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 3000
MetricSetDescription:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 256
Arn:
type: string
pattern: arn:([a-z\d-]+):.*:.*:.*:.+
maxLength: 256
Timestamp:
type: string
format: date-time
TagMap:
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
AccessDeniedException: {}
TooManyRequestsException: {}
TagValue:
type: string
maxLength: 256
InternalServerException: {}
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