Name Type Required Description
includeStatus String False Limits results to
harvestJobs with the given status.
Valid values are IN_PROGRESS, SUCCEEDED, and FAILED.
nextToken String False Pagination token from
the GET list request.
HTTP methods
Name Type Required Description
Use the token to fetch the next page of results.
maxResults String False Upper bound on
number of records to return.
includeChannelId String False Limits results to
harvestJobs associated with the given channel ID.
Responses
Status code Response model Description
200 HarvestJobList (p. 38) 200 OK response
The list of harvestJobs is returned successfully.
403 None 403 Forbidden response
AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.
404 None 404 Not Found response
AWS Elemental MediaPackage did not find a representation of the target resource.
422 None 422 Unprocessable Entity
response
AWS Elemental MediaPackage could not process the
instructions in the body of the request.
429 None 429 Too Many Requests
response
Too many requests have been sent in a given amount of time.
500 None 500 Internal Server Error
response
An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.
503 None Service unavailable
response
HTTP methods
Status code Response model Description
AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.
POST
Operation ID: CreateHarvestJob
Creates a harvestJob to extract a video on demand (VOD) clip from the live stream.
Responses
Status code Response model Description
200 HarvestJob (p. 39) 200 OK response
The harvestJob is created successfully.
403 None 403 Forbidden response
AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.
404 None 404 Not Found response
AWS Elemental MediaPackage did not find a representation of the target resource.
422 None 422 Unprocessable Entity
response
AWS Elemental MediaPackage could not process the
instructions in the body of the request.
429 None 429 Too Many Requests
response
Too many requests have been sent in a given amount of time.
500 None 500 Internal Server Error
response
An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.
Schemas
Status code Response model Description
503 None Service unavailable
response
AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.
OPTIONS
Enable CORS by returning correct headers.
Responses
Status code Response model Description
200 None Default response for CORS
method.
Schemas
Request bodies
POST schema
{ "s3Destination": { "bucketName": "string", "roleArn": "string", "manifestKey": "string"
}, "startTime": "string", "endTime": "string", "id": "string",
"originEndpointId": "string"
}
Response bodies
HarvestJobList schema
{ "harvestJobs": [ {
"s3Destination": { "bucketName": "string", "roleArn": "string", "manifestKey": "string"
},
"createdAt": "string", "startTime": "string",
Properties
"originEndpointId": "string", "endTime": "string",
"id": "string", "arn": "string", "channelId": "string", "status": enum
}
], "nextToken": "string"
}
HarvestJob schema
{ "s3Destination": { "bucketName": "string", "roleArn": "string", "manifestKey": "string"
}, "createdAt": "string", "startTime": "string",
"originEndpointId": "string", "endTime": "string",
"id": "string", "arn": "string", "channelId": "string", "status": enum
}
Properties
HarvestJob
HarvestJob configuration.
s3Destination
Parameters that define how MediaPackage accesses and saves the harvested asset to your Amazon S3 bucket.
Type: S3Destination (p. 42) Required: False
createdAt
The time that you submitted the HarvestJob.
Type: string Required: False
startTime
The start time of the window for the live-to-VOD asset.
Type: string Required: False
Properties
originEndpointId
The endpoint that MediaPackage harvests the live-to-VOD asset from.
Type: string Required: False
endTime
The end time of the window for the live-to-VOD asset.
Type: string Required: False
id
Unique identifier for this harvestJob. The identifier can't be changed after the harvestJob is created.
Type: string Required: False
arn
The Amazon Resource Name (ARN) that MediaPackage assigns to the harvestJob.
Type: string Required: False
channelId
The ID of the channel that the HarvestJob harvests from.
Type: string Required: False
status
The current status of the harvestJob.
We recommend that you configure a CloudWatch Event to notify you as harvestJobs complete or fail.
For any failures, the CloudWatch Event explains why the harvestJob failed. For more information about CloudWatch Events, see Monitoring AWS Elemental MediaPackage with Amazon CloudWatch Events.
Type: string Required: False
Values: IN_PROGRESS | SUCCEEDED | FAILED
HarvestJobCreateParameters
HarvestJob configuration.
s3Destination
Parameters that define how MediaPackage accesses and saves the harvested asset to your Amazon S3 bucket.
Properties
Type: S3Destination (p. 42) Required: True
startTime
The start time of the window for the live-to-VOD asset. This time must be at the same time or after the live event started, and must be within the startover window on the endpoint. If the endpoint has a startover window of five hours and the asset's start time is six hours ago, the harvestJob fails.
Type: string Required: True
endTime
The end time of the window for the live-to-VOD asset. The length of the asset can't exceed the startover window on the endpoint. If the startover window is five hours, the asset's end time can't be more than five hours from the asset's start time.
Type: string Required: True
id
Unique identifier for this harvestJob. The identifier can't be changed after the harvestJob is created.
Type: string Required: True
originEndpointId
The endpoint that MediaPackage harvests the live-to-VOD asset from.
Type: string Required: True
HarvestJobList
Lists harvestJobs that match a set of filters that you define.
harvestJobs
List of harvestJobs that you created on this account. MediaPackage runs each harvestJob only once.
After that, MediaPackage keeps a record of the job on your account for 90 days, for reference purposes only.
Type: Array of type HarvestJob (p. 39) Required: False
nextToken
Pagination token from the GET list request. Use the token to fetch the next page of results.
Type: string Required: False
See also
S3Destination
Defines how and where MediaPackage saves the live-to-VOD asset after it's been harvested from the live stream.
bucketName
The name of the Amazon S3 bucket where MediaPackage stores the live-to-VOD asset.
Type: string Required: True
roleArn
The Amazon Resource Name (ARN) for the IAM role that provides MediaPackage access to read and write to the Amazon S3 bucket where the harvested live-to-VOD asset is stored. For more information about this role, see Allowing AWS Elemental MediaPackage to Access Amazon S3.
Type: string Required: True
manifestKey
The path within the S3 bucket where MediaPackage stores the parent manifest of the harvested asset.
Type: string Required: True
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
ListHarvestJobs
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateHarvestJob
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++