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

ListHarvestJobs

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

Request Syntax


GET /channelGroup/ChannelGroupName/harvestJob?channelName=ChannelName&includeStatus=Status&maxResults=MaxResults&nextToken=NextToken&originEndpointName=OriginEndpointName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ChannelGroupName

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.

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

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

Required: Yes

ChannelName

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

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

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

MaxResults

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

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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

OriginEndpointName

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.

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

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

Status

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

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "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"
      }
   ],
   "NextToken": "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.

Items

An array of harvest job objects that match the specified criteria.

Type: Array of HarvestJob objects

NextToken

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.

Type: String

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

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

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