{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloudwatch/json-schema/amazon-cloudwatch-put-metric-stream-input-schema.json",
  "title": "PutMetricStreamInput",
  "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/PutMetricStreamInput",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": "If you are creating a new metric stream, this is the name for the new stream. The name must be different than the names of other metric streams in this account and Region. If you are updating a metric stream, specify the name of that stream here. Valid characters are A-Z, a-z, 0-9, \"-\" and \"_\"."
    },
    "IncludeFilters": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MetricStreamFilter"
      },
      "description": "If you specify this parameter, the stream sends only the metrics from the metric namespaces that you specify here. You cannot include IncludeFilters and ExcludeFilters in the same operation."
    },
    "ExcludeFilters": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MetricStreamFilter"
      },
      "description": "If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces that you specify here. You cannot include ExcludeFilters and IncludeFilters in the same operation."
    },
    "FirehoseArn": {
      "type": "string",
      "description": "The ARN of the Amazon Kinesis Data Firehose delivery stream to use for this metric stream. This Amazon Kinesis Data Firehose delivery stream must already exist and must be in the same account as the metric stream."
    },
    "RoleArn": {
      "type": "string",
      "description": "The ARN of an IAM role that this metric stream will use to access Amazon Kinesis Data Firehose resources. This IAM role must already exist and must be in the same account as the metric stream. This IAM role must include the following permissions: firehose:PutRecord firehose:PutRecordBatch"
    },
    "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."
    },
    "Tags": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Tag"
      },
      "description": "A list of key-value pairs to associate with the metric stream. You can associate as many as 50 tags with a metric stream. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags you specify in this parameter are ignored. To change the tags of an existing metric stream, use TagResource or UntagResource."
    },
    "StatisticsConfigurations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/MetricStreamStatisticsConfiguration"
      },
      "description": "By default, a metric stream always sends the MAX, MIN, SUM, and SAMPLECOUNT statistics for each metric that is streamed. You can use this parameter to have the metric stream also send additional statistics in the stream. This array can have up to 100 members. For each entry in this array, you specify one or more metrics and the list of additional statistics to stream for those metrics. The additional statistics that you can stream depend on the stream's OutputFormat. If the OutputFormat is json, you can stream any additional statistic that is supported by CloudWatch, listed in CloudWatch stati"
    },
    "IncludeLinkedAccountsMetrics": {
      "type": "boolean",
      "description": "If you are creating a metric stream in a monitoring account, specify true to include metrics from source accounts in the metric stream."
    }
  },
  "required": [
    "Name",
    "FirehoseArn",
    "RoleArn",
    "OutputFormat"
  ],
  "$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"
      ]
    },
    "Tag": {
      "type": "object",
      "properties": {
        "Key": {
          "type": "string",
          "description": "A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources."
        },
        "Value": {
          "type": "string",
          "description": "The value for the specified tag key."
        }
      },
      "required": [
        "Key",
        "Value"
      ]
    }
  }
}