AWS Elemental MediaPackage events - AWS Elemental MediaPackage
Input notification eventsKey provider notification eventsHarvest job notification events

AWS Elemental MediaPackage events

AWS Elemental MediaPackage integrates with Amazon CloudWatch Events to notify you of certain events that affect your channels and endpoints. Each event is represented in JSON (JavaScript Object Notation) and contains the event name, the date and time when the event occurred, the channel or endpoint affected, and more. MediaPackage emits events on a best effort basis. You can use CloudWatch Events to collect these events and set up rules that route them to one or more targets such as AWS Lambda functions, Amazon SNS topics, Amazon SQS queues, streams in Amazon Kinesis Data Streams, or built-in targets.

For more information about using CloudWatch Events with other kinds of events, see the Amazon CloudWatch Events User Guide.

The following topics describe the CloudWatch Events that MediaPackage creates.

Input notification events

You get input notification events for live and video on demand (VOD) content. These events notify you when something happens with MediaPackage ingest. These are the input notification events you might receive:

  • Maximum input streams exceeded

  • Input switch

  • VOD ingest status change

  • VOD playback readiness

The following sections describe each of these events.

Maximum Input Streams Exceeded Event

For live content, a channel in MediaPackage exceeds the quota for the number of input streams. For information about quotas, see Quotas in AWS Elemental MediaPackage.

Example 
{
   "id": "7bf73129-1428-4cd3-a780-95db273d1602",
   "detail-type": "MediaPackage Input Notification",
   "source": "aws.mediapackage",
   "account": "aws_account_id",
   "time": "2015-11-11T21:29:54Z",
   "region": "us-west-2",
   "resources":[
      "arn:aws:mediapackage:us-west-2:aws_account_id:channels/262ff182d46d4b399fcabea1364df682"
   ],
   "detail":{
      "event": "MaxIngestStreamsError",
      "message": "Parent Manifest [%s] has [23] streams, more than [20] allowed: (index_1.m3u8,index_2.m3u8,index_3.m3u8,index_4.m3u8,index_5.m3u8,index_6.m3u8,index_7.m3u8,index_8.m3u8,index_9.m3u8,index_10.m3u8,index_11.m3u8,index_12.m3u8,index_13.m3u8,index_14.m3u8,index_15.m3u8,index_16.m3u8,index_17.m3u8,index_18.m3u8,index_19.m3u8,index_20.m3u8,index_21.m3u8,index_22.m3u8,index_23.m3u8)"
   }
}
Input Switch Event

For live content, MediaPackage switches inputs for one of your endpoints.

One event is sent in a five-minute period. If the input switches multiple times in five minutes (for example, if MediaPackage switches to one input, then back to the other), you receive only one event.

For information about input redundancy and what causes inputs to switch, see Live input redundancy AWS Elemental MediaPackage processing flow.

Example 
{
   "id": "8f9b8e72-0b31-e883-f19c-aec84742f3ce",
   "detail-type": "MediaPackage Input Notification",
   "source": "aws.mediapackage",
   "account": "aws_account_id",
   "time": "2018-07-16T17:29:36Z",
   "region": "us-east-1",
   "resources":[
      "arn:aws:mediapackage:us-east-1:aws_account_id:origin_endpoints/82d6b9bc04cb4612b487963d6c8d0f1a"
   ],
   "detail":{
      "event": "InputSwitchEvent",
      "message": "Origin endpoint experienced an Input Switch Event",
      "EventDetails": {
        "Channel": "channel name",
        "PreviousIngestEndpoint": "endpoint uuid before input switch",
        "CurrentIngestEndpoint": "endpoint uuid after input switch",
      }
   }
}
VOD Ingest Status Event

For video on demand (VOD) content, an asset in MediaPackage changes ingest status. You get notifications for the following events:

  • IngestStart

  • IngestError

  • IngestComplete

Example 
{
   "id": "8f9b8e72-0b31-e883-f19c-aec84742f3ce",
   "detail-type": "MediaPackage Input Notification",
   "source": "aws.mediapackage",
   "account": "aws_account_id",
   "time": "2019-05-03T17:29:36Z",
   "region": "us-west-2",
   "resources":[

      "arn:aws:mediapackage-vod:us-west-2:aws_account_id:assets/asset_name"

   ],
   "detail":{
      "event": "IngestComplete",
      "message": "message text"
   }
}
VOD Playback Event

For VOD content, an asset in MediaPackage is available for playback. There is a period of time between when asset ingest is complete, and when the asset can be played back. The event VodAssetPlayable means that MediaPackage can now fulfill playback requests for the asset.

You get individual VodAssetPlayable events for each packaging configuration in your packaging group. For example, if your packaging group contains one DASH and one HLS packaging configuration, you receive two VodAssetPlayable events—one for your DASH packaging configuration, and one for your HLS packaging configuration.

Example 
{
   "id": "81e896e4-d9e5-ec79-f82a-b4cf3246c567",
   "detail-type": "MediaPackage Input Notification",
   "source": "aws.mediapackage",
   "account": "aws_account_id",
   "time": "2019-11-03T21:46:00Z",
   "region": "us-west-2",
   "resources":[
      "arn:aws:mediapackage-vod:us-west-2:aws_account_id:assets/asset_id",
      "arn:aws:mediapackage-vod:us-west-2:aws_account_id:packaging_configuration/packaging_configuration_id"
   ],
   "detail":{
      "event": "VodAssetPlayable",
      "message": "Asset 'asset_id' is now playable for PackagingConfiguration 'packaging_configuration_id'",
      "packaging_configuration_id": "packaging_configuration_id",
      "manifest_urls":[
         "https://555555555555.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/b9cc115bf7f1a/b848dfb116920772aa69ba/a3c74b1cae6a451c/index.m3u8"
      ]
   }
}

{
    "id": "91e896e4-d9e5-ab80-f82a-b4cf3246c568",
    "detail-type": "MediaPackage Input Notification",
    "source": "aws.mediapackage",
    "account": "aws_account_id",
    "time": "2019-11-03T21:47:00Z",
    "region": "us-west-2",
    "resources":[
      "arn:aws:mediapackage-vod:us-west-2:aws_account_id:assets/asset_id",
      "arn:aws:mediapackage-vod:us-west-2:aws_account_id:packaging_configuration/packaging_configuration_id"
    ],
    "detail":{
      "event": "VodAssetPlayable",
      "message": "Asset 'asset_id' is now playable for PackagingConfiguration 'packaging_configuration_id'",
      "packaging_configuration_id": "packaging_configuration_id",
      "manifest_urls":[
          "https://111122223333.egress.mediapackage-vod.us-west-2.amazonaws.com/out/v1/1234567890abc/021345abcdef6789012345/abcdef0123456789/index.mpd"
      ]
    }
}

Key provider notification events

You get key provider notification events when you're using content encryption on an endpoint and MediaPackage can't reach the key provider. For information about DRM and encryption, see https://docs.aws.amazon.com/speke/latest/documentation/.

Example Live key provider notification event
{
   "id": "7bf73129-1428-4cd3-a780-98ds273d1602",
   "detail-type": "MediaPackage Key Provider Notification",
   "source": "aws.mediapackage",
   "account": "aws_account_id",
   "time": "2015-11-11T21:29:54Z",
   "region": "us-west-2",
   "resources":[
      "arn:aws:mediapackage:us-west-2:aws_account_id:origin_endpoints/endpoint_id"
   ],
   "detail":{
      "event": "KeyProviderError",
      "message": "message-text"
   }
}
Example VOD key provider notification event
{
   "id": "7bf73129-1428-4cd3-a780-98ds273d1602",
   "detail-type": "MediaPackage Key Provider Notification",
   "source": "aws.mediapackage",
   "account": "aws_account_id",
   "time": "2015-11-11T21:29:54Z",
   "region": "us-west-2",
   "resources":[
      "arn:aws:mediapackage-vod:us-west-2:aws_account_id:packaging_configurations/packaging_group_name"
   ],
   "detail":{
      "event": "KeyProviderError",
      "message": "message-text"
   }
}

Harvest job notification events

You get harvest job status events when you export a clip from a live stream to create a live-to-VOD asset. MediaPackage creates notifications when the harvest job succeeds or fails. For information about harvest jobs and live-to-VOD assets, see Creating live-to-VOD assets with AWS Elemental MediaPackage.

Example Successful harvest job event
{
   "id": "8f9b8e72-0b31-e883-f19c-aec84742f3ce",
   "detail-type": "MediaPackage HarvestJob Notification",
   "source": "aws.mediapackage",
   "account": "aws_account_id",
   "time": "2019-07-16T17:29:36Z",
   "region": "us-east-1",
   "resources":[
      "arn:aws:mediapackage:us-east-1:aws_account_id:harvest_jobs/harvest_job_id"
   ],
   "detail":{
      "harvest_job": {
          "id": "harvest_job_id",
          "arn": "arn:aws:mediapackage-vod:us-east-1:aws_account_id:harvest_jobs/harvest_job_id",
          "status": "SUCCEEDED",
          "origin_endpoint_id": "endpoint_id",
          "start_time": "2019-06-26T20:30:00-08:00",
          "end_time": "2019-06-26T21:00:00-08:00",
          "s3_destination": {
              "bucket_name": "s3_bucket_name",
              "manifest_key": "path/and/manifest_name/index.m3u8",
              "role_arn": "arn:aws:iam::aws_account_id:role/S3Access_role",
          },
          "created_at": "2019-06-26T21:03:12-08:00"
      }
   }
}
Example Failed harvest job event
{
   "id": "8f9b8e72-0b31-e883-f19c-aec84742f3ce",
   "detail-type": "MediaPackage HarvestJob Notification",
   "source": "aws.mediapackage",
   "account": "aws_account_id",
   "time": "2019-07-16T17:29:36Z",
   "region": "us-east-1",
   "resources":[
      "arn:aws:mediapackage:us-east-1:aws_account_id:harvest_jobs/harvest_job_id"
   ],
   "detail":{
      "harvest_job": {
          "id": "harvest_job_id",
          "arn": "arn:aws:mediapackage-vod:us-east-1:aws_account_id:harvest_jobs/harvest_job_id",
          "status": "FAILED",
          "origin_endpoint_id": "endpoint_id",
          "start_time": "2019-06-26T20:30:00-08:00",
          "end_time": "2019-06-26T21:00:00-08:00",
          "s3_destination": {
              "bucket_name": "s3_bucket_name",
              "manifest_key": "path/and/manifest_name/index.m3u8",
              "role_arn": "arn:aws:iam::aws_account_id:role/S3Access_role",
          },
          "created_at": "2019-06-26T21:03:12-08:00"
      },
      "message": "Message text"
   }
}