Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateHarvestJob

Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.

Request Syntax


POST /channelGroup/ChannelGroupName/channel/ChannelName/originEndpoint/OriginEndpointName/harvestJob HTTP/1.1
x-amzn-client-token: ClientToken
Content-type: application/json

{
   "Description": "string",
   "Destination": { 
      "S3Destination": { 
         "BucketName": "string",
         "DestinationPath": "string"
      }
   },
   "HarvestedManifests": { 
      "DashManifests": [ 
         { 
            "ManifestName": "string"
         }
      ],
      "HlsManifests": [ 
         { 
            "ManifestName": "string"
         }
      ],
      "LowLatencyHlsManifests": [ 
         { 
            "ManifestName": "string"
         }
      ]
   },
   "HarvestJobName": "string",
   "ScheduleConfiguration": { 
      "EndTime": number,
      "StartTime": number
   },
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

ChannelGroupName

The name of the channel group containing the channel from which to harvest content.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

ChannelName

The name of the channel from which to harvest content.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\S]+

OriginEndpointName

The name of the origin endpoint from which to harvest content.

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

An optional description for the harvest job.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

Destination

The S3 destination where the harvested content will be placed.

Type: Destination object

Required: Yes

HarvestedManifests

A list of manifests to be harvested.

Type: HarvestedManifests object

Required: Yes

HarvestJobName

A name for the harvest job. This name must be unique within the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

Required: No

ScheduleConfiguration

The configuration for when the harvest job should run, including start and end times.

Type: HarvesterScheduleConfiguration object

Required: Yes

Tags

A collection of tags associated with the harvest job.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "ChannelGroupName": "string",
   "ChannelName": "string",
   "CreatedAt": number,
   "Description": "string",
   "Destination": { 
      "S3Destination": { 
         "BucketName": "string",
         "DestinationPath": "string"
      }
   },
   "ErrorMessage": "string",
   "ETag": "string",
   "HarvestedManifests": { 
      "DashManifests": [ 
         { 
            "ManifestName": "string"
         }
      ],
      "HlsManifests": [ 
         { 
            "ManifestName": "string"
         }
      ],
      "LowLatencyHlsManifests": [ 
         { 
            "ManifestName": "string"
         }
      ]
   },
   "HarvestJobName": "string",
   "ModifiedAt": number,
   "OriginEndpointName": "string",
   "ScheduleConfiguration": { 
      "EndTime": number,
      "StartTime": number
   },
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the created harvest job.

Type: String

ChannelGroupName

The name of the channel group containing the channel from which content is being harvested.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

ChannelName

The name of the channel from which content is being harvested.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

CreatedAt

The date and time the harvest job was created.

Type: Timestamp

Description

The description of the harvest job, if provided.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Destination

The S3 destination where the harvested content will be placed.

Type: Destination object

ErrorMessage

An error message if the harvest job creation failed.

Type: String

ETag

The current version of the harvest job. Used for concurrency control.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\S]+

HarvestedManifests

A list of manifests that will be harvested.

Type: HarvestedManifests object

HarvestJobName

The name of the created harvest job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

ModifiedAt

The date and time the harvest job was last modified.

Type: Timestamp

OriginEndpointName

The name of the origin endpoint from which content is being harvested.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9_-]+

ScheduleConfiguration

The configuration for when the harvest job will run, including start and end times.

Type: HarvesterScheduleConfiguration object

Status

The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED).

Type: String

Valid Values: QUEUED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED

Tags

A collection of tags associated with the harvest job.

Type: String to string map

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

HTTP Status Code: 403

ConflictException

Updating or deleting this resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

Indicates that an error from the service occurred while trying to process a request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

HTTP Status Code: 402

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

The input failed to meet the constraints specified by the AWS service.

HTTP Status Code: 400