v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141996119.8 KB

Gets details about an existing HarvestJob.

get/harvest_jobs/{id}

Path parameters

idstring required

The ID of the HarvestJob.

Response

Success

Arnstring

The Amazon Resource Name (ARN) assigned to the HarvestJob.

ChannelIdstring

The ID of the Channel that the HarvestJob will harvest from.

CreatedAtstring

The date and time the HarvestJob was submitted.

EndTimestring

The end of the time-window which will be harvested.

Idstring

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

OriginEndpointIdstring

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

StartTimestring

The start of the time-window which will be harvested.

Status'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED'

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.