Amazon MediaConnect · JSON Structure

Mediaconnect Api Entitlement Structure

The settings for a flow entitlement.

Type: object Properties: 7 Required: 3
BroadcastingLive VideoMediaMedia Transport

Entitlement is a JSON Structure definition published by Amazon MediaConnect, describing 7 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

DataTransferSubscriberFeePercent Description Encryption EntitlementArn EntitlementStatus Name Subscribers

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-mediaconnect/refs/heads/main/json-structure/mediaconnect-api-entitlement-structure.json",
  "name": "Entitlement",
  "type": "object",
  "description": "The settings for a flow entitlement.",
  "properties": {
    "DataTransferSubscriberFeePercent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "dataTransferSubscriberFeePercent"
          },
          "description": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "description"
          },
          "description": "A description of the entitlement."
        }
      ]
    },
    "Encryption": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Encryption"
        },
        {
          "xml": {
            "name": "encryption"
          },
          "description": "The type of encryption that will be used on the output that is associated with this entitlement."
        }
      ]
    },
    "EntitlementArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "entitlementArn"
          },
          "description": "The ARN of the entitlement."
        }
      ]
    },
    "EntitlementStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntitlementStatus"
        },
        {
          "xml": {
            "name": "entitlementStatus"
          },
          "description": "An indication of whether the entitlement is enabled."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "The name of the entitlement."
        }
      ]
    },
    "Subscribers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOf__string"
        },
        {
          "xml": {
            "name": "subscribers"
          },
          "description": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source."
        }
      ]
    }
  },
  "required": [
    "EntitlementArn",
    "Subscribers",
    "Name"
  ]
}