Amazon MediaLive · JSON Structure

Medialive Api Channel Structure

Placeholder documentation for Channel

Type: object Properties: 18
BroadcastingMedia ProcessingMedia

Channel is a JSON Structure definition published by Amazon MediaLive, describing 18 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Arn CdiInputSpecification ChannelClass Destinations EgressEndpoints EncoderSettings Id InputAttachments InputSpecification LogLevel Maintenance Name PipelineDetails PipelinesRunningCount RoleArn State Tags Vpc

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-medialive/refs/heads/main/json-structure/medialive-api-channel-structure.json",
  "name": "Channel",
  "type": "object",
  "description": "Placeholder documentation for Channel",
  "properties": {
    "Arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "arn"
          },
          "description": "The unique arn of the channel."
        }
      ]
    },
    "CdiInputSpecification": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CdiInputSpecification"
        },
        {
          "xml": {
            "name": "cdiInputSpecification"
          },
          "description": "Specification of CDI inputs for this channel"
        }
      ]
    },
    "ChannelClass": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChannelClass"
        },
        {
          "xml": {
            "name": "channelClass"
          },
          "description": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline."
        }
      ]
    },
    "Destinations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOfOutputDestination"
        },
        {
          "xml": {
            "name": "destinations"
          },
          "description": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.\n"
        }
      ]
    },
    "EgressEndpoints": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOfChannelEgressEndpoint"
        },
        {
          "xml": {
            "name": "egressEndpoints"
          },
          "description": "The endpoints where outgoing connections initiate from"
        }
      ]
    },
    "EncoderSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EncoderSettings"
        },
        {
          "xml": {
            "name": "encoderSettings"
          }
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "id"
          },
          "description": "The unique id of the channel."
        }
      ]
    },
    "InputAttachments": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOfInputAttachment"
        },
        {
          "xml": {
            "name": "inputAttachments"
          },
          "description": "List of input attachments for channel."
        }
      ]
    },
    "InputSpecification": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InputSpecification"
        },
        {
          "xml": {
            "name": "inputSpecification"
          },
          "description": "Specification of network and file inputs for this channel"
        }
      ]
    },
    "LogLevel": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LogLevel"
        },
        {
          "xml": {
            "name": "logLevel"
          },
          "description": "The log level being written to CloudWatch Logs."
        }
      ]
    },
    "Maintenance": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaintenanceStatus"
        },
        {
          "xml": {
            "name": "maintenance"
          },
          "description": "Maintenance settings for this channel."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "name"
          },
          "description": "The name of the channel. (user-mutable)"
        }
      ]
    },
    "PipelineDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOfPipelineDetail"
        },
        {
          "xml": {
            "name": "pipelineDetails"
          },
          "description": "Runtime details for the pipelines of a running channel."
        }
      ]
    },
    "PipelinesRunningCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "pipelinesRunningCount"
          },
          "description": "The number of currently healthy pipelines."
        }
      ]
    },
    "RoleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "roleArn"
          },
          "description": "The Amazon Resource Name (ARN) of the role assumed when running the Channel."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ChannelState"
        },
        {
          "xml": {
            "name": "state"
          }
        }
      ]
    },
    "Tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "xml": {
            "name": "tags"
          },
          "description": "A collection of key-value pairs."
        }
      ]
    },
    "Vpc": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VpcOutputSettingsDescription"
        },
        {
          "xml": {
            "name": "vpc"
          },
          "description": "Settings for VPC output"
        }
      ]
    }
  }
}