UpdateOriginEndpointRequest

Configuration parameters used to update an existing OriginEndpoint.

BroadcastingMedia ProcessingMedia

Properties

Name Type Description
Authorization object
CmafPackage object
DashPackage object
Description object
HlsPackage object
ManifestName object
MssPackage object
Origination object
StartoverWindowSeconds object
TimeDelaySeconds object
Whitelist object
View JSON Schema on GitHub

JSON Schema

mediapackage-api-update-origin-endpoint-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediapackage/refs/heads/main/json-schema/mediapackage-api-update-origin-endpoint-request-schema.json",
  "title": "UpdateOriginEndpointRequest",
  "description": "Configuration parameters used to update an existing OriginEndpoint.",
  "type": "object",
  "properties": {
    "Authorization": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Authorization"
        },
        {
          "xml": {
            "name": "authorization"
          }
        }
      ]
    },
    "CmafPackage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CmafPackageCreateOrUpdateParameters"
        },
        {
          "xml": {
            "name": "cmafPackage"
          }
        }
      ]
    },
    "DashPackage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashPackage"
        },
        {
          "xml": {
            "name": "dashPackage"
          }
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "description"
          },
          "description": "A short text description of the OriginEndpoint."
        }
      ]
    },
    "HlsPackage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HlsPackage"
        },
        {
          "xml": {
            "name": "hlsPackage"
          }
        }
      ]
    },
    "ManifestName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "manifestName"
          },
          "description": "A short string that will be appended to the end of the Endpoint URL."
        }
      ]
    },
    "MssPackage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MssPackage"
        },
        {
          "xml": {
            "name": "mssPackage"
          }
        }
      ]
    },
    "Origination": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Origination"
        },
        {
          "xml": {
            "name": "origination"
          },
          "description": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n"
        }
      ]
    },
    "StartoverWindowSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "startoverWindowSeconds"
          },
          "description": "Maximum duration (in seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n"
        }
      ]
    },
    "TimeDelaySeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "timeDelaySeconds"
          },
          "description": "Amount of delay (in seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n"
        }
      ]
    },
    "Whitelist": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOf__string"
        },
        {
          "xml": {
            "name": "whitelist"
          },
          "description": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint."
        }
      ]
    }
  }
}