Amazon MediaStore · JSON Structure

Mediastore Api Metric Policy Structure

The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.

To view examples of how to construct a metric policy for your use case, see Example Metric Policies.

Type: object Properties: 2 Required: 1
BroadcastingMedia ProcessingMedia

MetricPolicy is a JSON Structure definition published by Amazon MediaStore, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ContainerLevelMetrics MetricPolicyRules

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediastore/refs/heads/main/json-structure/mediastore-api-metric-policy-structure.json",
  "name": "MetricPolicy",
  "type": "object",
  "description": "<p>The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.</p> <p>To view examples of how to construct a metric policy for your use case, see <a href=\"https://docs.aws.amazon.com/mediastore/latest/ug/policies-metric-examples.html\">Example Metric Policies</a>.</p>",
  "properties": {
    "ContainerLevelMetrics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ContainerLevelMetrics"
        },
        {
          "description": "A setting to enable or disable metrics at the container level."
        }
      ]
    },
    "MetricPolicyRules": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricPolicyRules"
        },
        {
          "description": "A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also <a href=\"https://console.aws.amazon.com/servicequotas/home?region=us-east-1#!/services/mediastore/quotas\">request a quota increase</a> to allow up to 300 rules per policy."
        }
      ]
    }
  },
  "required": [
    "ContainerLevelMetrics"
  ]
}