Module Values.HarvestJobSource

Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket.

Sourcetype nonrec t = {
  1. channelGroupName : ResourceName.t option;
    (*

    The name of the channel group containing the channel associated with this harvest job.

    *)
  2. channelName : ResourceName.t option;
    (*

    The name of the channel associated with this harvest job.

    *)
  3. originEndpointName : ResourceName.t option;
    (*

    The name of the origin endpoint associated with this harvest job.

    *)
  4. destination : Destination.t option;
    (*

    The S3 destination where the harvested content will be placed.

    *)
  5. harvestJobName : ResourceName.t option;
    (*

    The name of the harvest job.

    *)
  6. harvestedManifests : HarvestedManifests.t option;
    (*

    A list of manifests that are being or have been harvested.

    *)
  7. description : ResourceDescription.t option;
    (*

    An optional description of the harvest job.

    *)
  8. scheduleConfiguration : HarvesterScheduleConfiguration.t option;
    (*

    The configuration for when the harvest job is scheduled to run.

    *)
  9. arn : String_.t option;
    (*

    The Amazon Resource Name (ARN) of the harvest job.

    *)
  10. createdAt : Timestamp.t option;
    (*

    The date and time when the harvest job was created.

    *)
  11. modifiedAt : Timestamp.t option;
    (*

    The date and time when the harvest job was last modified.

    *)
  12. status : HarvestJobStatus.t option;
    (*

    The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).

    *)
  13. errorMessage : String_.t option;
    (*

    An error message if the harvest job encountered any issues.

    *)
  14. eTag : EntityTag.t option;
    (*

    The current version of the harvest job. Used for concurrency control.

    *)
}
Sourceval make : ?channelGroupName:ResourceName.t -> ?channelName:ResourceName.t -> ?originEndpointName:ResourceName.t -> ?destination:Destination.t -> ?harvestJobName:ResourceName.t -> ?harvestedManifests:HarvestedManifests.t -> ?description:ResourceDescription.t -> ?scheduleConfiguration:HarvesterScheduleConfiguration.t -> ?arn:String_.t -> ?createdAt:Timestamp.t -> ?modifiedAt:Timestamp.t -> ?status:HarvestJobStatus.t -> ?errorMessage:String_.t -> ?eTag:EntityTag.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `String of ResourceName.t | `Structure of (string * [> `List of [> `Structure of (string * [> `String of ResourceName.t ]) list ] list | `Structure of (string * [> `String of S3BucketName.t ]) list | `Timestamp of Timestamp.t ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t