Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1430234217.2 KB

Retrieves the details of a specific harvest job.

get/channelGroup/{ChannelGroupName}/channel/{ChannelName}/originEndpoint/{OriginEndpointName}/harvestJob/{HarvestJobName}

Path parameters

ChannelGroupNamestring required

The name of the channel group containing the channel associated with the harvest job.

ChannelNamestring required

The name of the channel associated with the harvest job.

OriginEndpointNamestring required

The name of the origin endpoint associated with the harvest job.

HarvestJobNamestring required

The name of the harvest job to retrieve.

Response

Success

ChannelGroupNamestring required

The name of the channel group containing the channel associated with the harvest job.

ChannelNamestring required

The name of the channel associated with the harvest job.

OriginEndpointNamestring required

The name of the origin endpoint associated with the harvest job.

HarvestJobNamestring required

The name of the harvest job.

Descriptionstring

The description of the harvest job, if provided.

Arnstring required

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

CreatedAtstring date-time required

The date and time when the harvest job was created.

ModifiedAtstring date-time required

The date and time when the harvest job was last modified.

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

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

ErrorMessagestring

An error message if the harvest job encountered any issues.

ETagstring

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

Tagsobject

A collection of tags associated with the harvest job.