Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430234217.2 KB

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

post/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/harvestJob

Path parameters

ChannelGroupNamestring required

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

ChannelNamestring required

The name of the channel from which to harvest content.

OriginEndpointNamestring required

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

Headers

x-amzn-client-tokenstring

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

Request body

Descriptionstring

An optional description for the harvest job.

HarvestJobNamestring

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

Tagsobject

A collection of tags associated with the harvest job.

Response

Success

ChannelGroupNamestring required

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

ChannelNamestring required

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

OriginEndpointNamestring required

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

HarvestJobNamestring required

The name of the created harvest job.

Descriptionstring

The description of the harvest job, if provided.

Arnstring required

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

CreatedAtstring date-time required

The date and time the harvest job was created.

ModifiedAtstring date-time required

The date and time the harvest job was last modified.

Status'QUEUED' | 'IN_PROGRESS' | 'CANCELLED' | 'COMPLETED' | 'FAILED' required

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

ErrorMessagestring

An error message if the harvest job creation failed.

ETagstring

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

Tagsobject

A collection of tags associated with the harvest job.