Amazon CloudWatch Amazon CloudWatch API API

The Amazon CloudWatch API API from Amazon CloudWatch — 1 operation(s) for amazon cloudwatch api.

OpenAPI Specification

aws-cloudwatch-amazon-cloudwatch-api-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon CloudWatch Amazon CloudWatch API API
  version: '2010-08-01'
  description: 'Amazon CloudWatch is a monitoring and observability service that collects

    metrics, logs, and events from AWS resources and applications. The

    CloudWatch Query API accepts POST requests to the root path with the

    Action and Version specified as form parameters in the

    application/x-www-form-urlencoded request body. All requests are signed

    with AWS Signature Version 4 (SigV4).


    See https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/Welcome.html

    '
servers:
- url: https://monitoring.{region}.amazonaws.com
  description: Amazon CloudWatch regional endpoint
  variables:
    region:
      default: us-east-1
security:
- SigV4: []
tags:
- name: Amazon CloudWatch API
paths:
  /:
    post:
      summary: CloudWatch Query API entry point
      description: 'All CloudWatch API actions are invoked as POST requests to the root

        path with the Action and Version specified in the

        application/x-www-form-urlencoded request body.

        '
      operationId: invokeAction
      parameters:
      - name: Action
        in: query
        required: true
        schema:
          type: string
          enum:
          - PutMetricData
          - GetMetricData
          - GetMetricStatistics
          - ListMetrics
          - GetMetricWidgetImage
          - PutMetricAlarm
          - PutCompositeAlarm
          - DescribeAlarms
          - DescribeAlarmsForMetric
          - DescribeAlarmHistory
          - DeleteAlarms
          - EnableAlarmActions
          - DisableAlarmActions
          - SetAlarmState
          - PutAnomalyDetector
          - DescribeAnomalyDetectors
          - DeleteAnomalyDetector
          - PutDashboard
          - GetDashboard
          - ListDashboards
          - DeleteDashboards
          - PutInsightRule
          - DescribeInsightRules
          - DeleteInsightRules
          - DisableInsightRules
          - EnableInsightRules
          - GetInsightRuleReport
          - PutMetricStream
          - GetMetricStream
          - ListMetricStreams
          - DeleteMetricStream
          - StartMetricStreams
          - StopMetricStreams
          - TagResource
          - UntagResource
          - ListTagsForResource
      - name: Version
        in: query
        required: true
        schema:
          type: string
          default: '2010-08-01'
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: true
      responses:
        '200':
          description: Successful response (XML)
          content:
            text/xml:
              schema:
                type: object
        '400':
          description: Client error
        '500':
          description: Server error
      tags:
      - Amazon CloudWatch API
components:
  securitySchemes:
    SigV4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4 signed Authorization header