openapi: 3.2.0
info:
  version: 2015-05-28
  x-release: v4
  title: AWS IoT Metric Values API
  description: 'IoT

    IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud.'
  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: iot
  x-aws-signingName: iot
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.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://iot.{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 AWS IoT multi-region endpoint
- url: https://iot.{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 AWS IoT multi-region endpoint
- url: http://iot.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
- url: https://iot.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Metric Values
paths:
  /metric-values#thingName&metricName&startTime&endTime:
    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'
    get:
      operationId: ListMetricValues
      description: Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMetricValuesResponse'
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '481':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '482':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '483':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: thingName
        in: query
        required: true
        description: The name of the thing for which security profile metric values are returned.
        schema:
          type: string
          minLength: 1
          maxLength: 128
      - name: metricName
        in: query
        required: true
        description: The name of the security profile metric for which values are returned.
        schema:
          type: string
      - name: dimensionName
        in: query
        required: false
        description: The dimension name.
        schema:
          type: string
          pattern: '[a-zA-Z0-9:_-]+'
          minLength: 1
          maxLength: 128
      - name: dimensionValueOperator
        in: query
        required: false
        description: The dimension value operator.
        schema:
          type: string
          enum:
          - IN
          - NOT_IN
      - name: startTime
        in: query
        required: true
        description: The start of the time period for which metric values are returned.
        schema:
          type: string
          format: date-time
      - name: endTime
        in: query
        required: true
        description: The end of the time period for which metric values are returned.
        schema:
          type: string
          format: date-time
      - name: maxResults
        in: query
        required: false
        description: The maximum number of results to return at one time.
        schema:
          type: integer
          minimum: 1
          maximum: 250
      - name: nextToken
        in: query
        required: false
        description: The token for the next set of results.
        schema:
          type: string
      summary: Amazon IoT Device Management List Metric Values
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Metric Values
components:
  schemas:
    Timestamp:
      type: string
      format: date-time
    InvalidRequestException: {}
    ResourceNotFoundException: {}
    Cidr:
      type: string
      pattern: '[a-fA-F0-9:\.\/]+'
      minLength: 2
      maxLength: 43
    InternalFailureException: {}
    Port:
      type: integer
      minimum: 0
      maximum: 65535
    MetricValue:
      type: object
      properties:
        count:
          allOf:
          - $ref: '#/components/schemas/UnsignedLong'
          - description: If the <code>comparisonOperator</code> calls for a numeric value, use this to specify that numeric value to be compared with the <code>metric</code>.
        cidrs:
          allOf:
          - $ref: '#/components/schemas/Cidrs'
          - description: If the <code>comparisonOperator</code> calls for a set of CIDRs, use this to specify that set to be compared with the <code>metric</code>.
        ports:
          allOf:
          - $ref: '#/components/schemas/Ports'
          - description: If the <code>comparisonOperator</code> calls for a set of ports, use this to specify that set to be compared with the <code>metric</code>.
        number:
          allOf:
          - $ref: '#/components/schemas/Number'
          - description: ' The numeral value of a metric. '
        numbers:
          allOf:
          - $ref: '#/components/schemas/NumberList'
          - description: ' The numeral values of a metric. '
        strings:
          allOf:
          - $ref: '#/components/schemas/StringList'
          - description: ' The string values of a metric. '
      description: The value to be compared with the <code>metric</code>.
    ThrottlingException: {}
    ListMetricValuesResponse:
      type: object
      properties:
        metricDatumList:
          allOf:
          - $ref: '#/components/schemas/MetricDatumList'
          - description: The data the thing reports for the metric during the specified time period.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: A token that can be used to retrieve the next set of results, or <code>null</code> if there are no additional results.
    MetricDatum:
      type: object
      properties:
        timestamp:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time the metric value was reported.
        value:
          allOf:
          - $ref: '#/components/schemas/MetricValue'
          - description: The value reported for the metric.
      description: A metric.
    StringList:
      type: array
      items:
        $ref: '#/components/schemas/stringValue'
    NextToken:
      type: string
    UnsignedLong:
      type: integer
      minimum: 0
    Number:
      type: number
      format: double
    stringValue:
      type: string
    MetricDatumList:
      type: array
      items:
        $ref: '#/components/schemas/MetricDatum'
    NumberList:
      type: array
      items:
        $ref: '#/components/schemas/Number'
    Cidrs:
      type: array
      items:
        $ref: '#/components/schemas/Cidr'
    Ports:
      type: array
      items:
        $ref: '#/components/schemas/Port'
  parameters:
    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
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      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-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      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/iot/
x-hasEquivalentPaths: true