Harvest_jobs id - AWS Elemental MediaPackage

Harvest_jobs id

HarvestJobs provide details about the video on demand (VOD) assets that you harvested, or extracted, from live content streams.

URI

/prod/harvest_jobs/id

HTTP methods

GET

Operation ID: DescribeHarvestJob

Provides details about a harvestJob.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200HarvestJob

200 OK response

HarvestJob details are returned successfully.

403None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

404None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

422None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

429None

429 Too Many Requests response

Too many requests have been sent in a given amount of time.

500None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

503None

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.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method.

Schemas

Response bodies

{ "createdAt": "string", "s3Destination": { "bucketName": "string", "manifestKey": "string", "roleArn": "string" }, "startTime": "string", "endTime": "string", "id": "string", "originEndpointId": "string", "arn": "string", "channelId": "string", "status": enum }

Properties

HarvestJob

HarvestJob configuration.

PropertyTypeRequiredDescription
arn

string

False

The Amazon Resource Name (ARN) that MediaPackage assigns to the harvestJob.

channelId

string

False

The ID of the channel that the HarvestJob harvests from.

createdAt

string

False

The time that you submitted the HarvestJob.

endTime

string

False

The end time of the window for the live-to-VOD asset.

id

string

False

Unique identifier for this harvestJob. The identifier can't be changed after the harvestJob is created.

originEndpointId

string

False

The endpoint that MediaPackage harvests the live-to-VOD asset from.

s3Destination

S3Destination

False

Parameters that define how MediaPackage accesses and saves the harvested asset to your Amazon S3 bucket.

startTime

string

False

The start time of the window for the live-to-VOD asset.

status

string

Values: IN_PROGRESS | SUCCEEDED | FAILED

False

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.

S3Destination

Defines how and where MediaPackage saves the live-to-VOD asset after it's been harvested from the live stream.

PropertyTypeRequiredDescription
bucketName

string

True

The name of the Amazon S3 bucket where MediaPackage stores the live-to-VOD asset.

manifestKey

string

True

The path within the S3 bucket where MediaPackage stores the parent manifest of the harvested asset.

roleArn

string

True

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.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeHarvestJob