POST

/harvest_jobs

http://mediapackage.{region}.amazonaws.com/harvest_jobs

Creates a new HarvestJob record.

Access Token Required: API Key

Body Params

idstringrequired

The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted

endTimestringrequired

The end of the time-window which will be harvested

startTimestringrequired

The start of the time-window which will be harvested

s3Destinationobjectrequired

Configuration parameters for where in an S3 bucket to place the harvested content

originEndpointIdstringrequired

The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://mediapackage.{region}.amazonaws.com/harvest_jobs' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}