GetMetricStreamOutput

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-get-metric-stream-output-schema.json",
  "title": "GetMetricStreamOutput",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloudwatch-metric-stream-api-openapi.yml#/components/schemas/GetMetricStreamOutput",
  "type": "object",
  "properties": {
    "Arn": {
      "type": "string",
      "description": "The ARN of the metric stream."
    },
    "Name": {
      "type": "string",
      "description": "The name of the metric stream."
    },
    "IncludeFilters": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MetricStreamFilter"
      },
      "description": "If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are streamed by this metric stream."
    },
    "ExcludeFilters": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MetricStreamFilter"
      },
      "description": "If this array of metric namespaces is present, then these namespaces are the only metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in the account are streamed by this metric stream."
    },
    "FirehoseArn": {
      "type": "string",
      "description": "The ARN of the Amazon Kinesis Data Firehose delivery stream that is used by this metric stream."
    },
    "RoleArn": {
      "type": "string",
      "description": "The ARN of the IAM role that is used by this metric stream."
    },
    "State": {
      "type": "string",
      "description": "The state of the metric stream. The possible values are running and stopped."
    },
    "CreationDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date that the metric stream was created."
    },
    "LastUpdateDate": {
      "type": "string",
      "format": "date-time",
      "description": "The date of the most recent update to the metric stream's configuration."
    },
    "OutputFormat": {
      "type": "string",
      "enum": [
        "json",
        "opentelemetry0.7",
        "opentelemetry1.0"
      ],
      "description": "The output format for the stream. Valid values are json, opentelemetry1.0, and opentelemetry0.7. For more information about metric stream output formats, see Metric streams output formats."
    },
    "StatisticsConfigurations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MetricStreamStatisticsConfiguration"
      },
      "description": "Each entry in this array displays information about one or more metrics that include additional statistics in the metric stream. For more information about the additional statistics, see CloudWatch statistics definitions."
    },
    "IncludeLinkedAccountsMetrics": {
      "type": "boolean",
      "description": "If this is true and this metric stream is in a monitoring account, then the stream includes metrics from source accounts that the monitoring account is linked to."
    }
  },
  "$defs": {
    "MetricStreamFilter": {
      "type": "object",
      "properties": {
        "Namespace": {
          "type": "string",
          "description": "The name of the metric namespace for this filter. The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character."
        },
        "MetricNames": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The names of the metrics to either include or exclude from the metric stream. If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter. Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character."
        }
      }
    },
    "MetricStreamStatisticsConfiguration": {
      "type": "object",
      "properties": {
        "IncludeMetrics": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/MetricStreamStatisticsMetric"
          },
          "description": "An array of metric name and namespace pairs that stream the additional statistics listed in the value of the AdditionalStatistics parameter. There can be as many as 100 pairs in the array. All metrics that match the combination of metric name and namespace will be streamed with the additional statistics, no matter their dimensions."
        },
        "AdditionalStatistics": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The list of additional statistics that are to be streamed for the metrics listed in the IncludeMetrics array in this structure. This list can include as many as 20 statistics. If the OutputFormat for the stream is opentelemetry1.0 or opentelemetry0.7, the only valid values are p?? percentile statistics such as p90, p99 and so on. If the OutputFormat for the stream is json, the valid values include the abbreviations for all of the statistics listed in CloudWatch statistics definitions. For example, this includes tm98, wm90, PR(:300), and so on."
        }
      },
      "required": [
        "IncludeMetrics",
        "AdditionalStatistics"
      ]
    },
    "MetricStreamStatisticsMetric": {
      "type": "object",
      "properties": {
        "Namespace": {
          "type": "string",
          "description": "The namespace of the metric."
        },
        "MetricName": {
          "type": "string",
          "description": "The name of the metric."
        }
      },
      "required": [
        "Namespace",
        "MetricName"
      ]
    }
  }
}