Get channelgroupchannelgroupnameharvestjob — mediapackagev2

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430234217.2 KB

Retrieves a list of harvest jobs that match the specified criteria.

get/channelGroup/{ChannelGroupName}/harvestJob

Path parameters

ChannelGroupNamestring required

The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned.

Query parameters

channelNamestring

The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.

originEndpointNamestring

The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.

includeStatus'QUEUED' | 'IN_PROGRESS' | 'CANCELLED' | 'COMPLETED' | 'FAILED'

The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.

maxResultsinteger

The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.

nextTokenstring

A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.

Response

Success

NextTokenstring

A token used for pagination. Include this value in subsequent requests to retrieve the next set of results. If null, there are no more results to retrieve.