HarvestJob
Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket.
Contents
- Arn
-
The Amazon Resource Name (ARN) of the harvest job.
Type: String
Required: Yes
- ChannelGroupName
-
The name of the channel group containing the channel associated with this harvest job.
Type: String
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 this harvest job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- CreatedAt
-
The date and time when the harvest job was created.
Type: Timestamp
Required: Yes
- Destination
-
The S3 destination where the harvested content will be placed.
Type: Destination object
Required: Yes
- HarvestedManifests
-
A list of manifests that are being or have been harvested.
Type: HarvestedManifests object
Required: Yes
- HarvestJobName
-
The name of the harvest job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- ModifiedAt
-
The date and time when the harvest job was last modified.
Type: Timestamp
Required: Yes
- OriginEndpointName
-
The name of the origin endpoint associated with this harvest job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9_-]+Required: Yes
- ScheduleConfiguration
-
The configuration for when the harvest job is scheduled to run.
Type: HarvesterScheduleConfiguration object
Required: Yes
- 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 | FAILEDRequired: Yes
- Description
-
An optional description of the harvest job.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- ErrorMessage
-
An error message if the harvest job encountered any issues.
Type: String
Required: No
- 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]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
