Retrieves the details of a specific harvest job.
Request Syntax
GET /channelGroup/ChannelGroupName/channel/ChannelName/originEndpoint/OriginEndpointName/harvestJob/HarvestJobName HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ChannelGroupName
-
The name of the channel group containing the channel associated with the harvest job.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- ChannelName
-
The name of the channel associated with the harvest job.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- HarvestJobName
-
The name of the harvest job to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- OriginEndpointName
-
The name of the origin endpoint associated with the harvest job.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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",
"Tags": {
"string" : "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.
- Arn
-
The Amazon Resource Name (ARN) of the harvest job.
Type: String
- ChannelGroupName
-
The name of the channel group containing the channel associated with the harvest job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+ - ChannelName
-
The name of the channel associated with the harvest job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+ - CreatedAt
-
The date and time when the harvest job was created.
Type: Timestamp
- Description
-
The description of the harvest job, if provided.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- Destination
-
The S3 destination where the harvested content is being placed.
Type: Destination object
- ErrorMessage
-
An error message if the harvest job encountered any issues.
Type: String
- ETag
-
The current version of the harvest job. Used for concurrency control.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\S]+ - HarvestedManifests
-
A list of manifests that are being or have been harvested.
Type: HarvestedManifests object
- HarvestJobName
-
The name of the harvest job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+ - ModifiedAt
-
The date and time when the harvest job was last modified.
Type: Timestamp
- OriginEndpointName
-
The name of the origin endpoint associated with the harvest job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+ - ScheduleConfiguration
-
The configuration for when the harvest job is scheduled to run, including start and end times.
Type: HarvesterScheduleConfiguration object
- Status
-
The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
Type: String
Valid Values:
QUEUED | IN_PROGRESS | CANCELLED | COMPLETED | FAILED - Tags
-
A collection of tags associated with the harvest job.
Type: String to string map
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
