You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaPackage::Types::HarvestJob

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

A HarvestJob resource configuration

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) assigned to the HarvestJob.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) assigned to the HarvestJob.

#channel_id ⇒ String

The ID of the Channel that the HarvestJob will harvest from.

Returns:

  • (String) —

    The ID of the Channel that the HarvestJob will harvest from.

#created_at ⇒ String

The time the HarvestJob was submitted

Returns:

  • (String) —

    The time the HarvestJob was submitted.

#end_time ⇒ String

The end of the time-window which will be harvested.

Returns:

  • (String) —

    The end of the time-window which will be harvested.

#id ⇒ String

The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.

Returns:

  • (String) —

    The ID of the HarvestJob.

#origin_endpoint_id ⇒ String

The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.

Returns:

  • (String) —

    The ID of the OriginEndpoint that the HarvestJob will harvest from.

#s3_destination ⇒ Types::S3Destination

Configuration parameters for where in an S3 bucket to place the harvested content

Returns:

  • (Types::S3Destination) —

    Configuration parameters for where in an S3 bucket to place the harvested content.

#start_time ⇒ String

The start of the time-window which will be harvested.

Returns:

  • (String) —

    The start of the time-window which will be harvested.

#status ⇒ String

The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

Possible values:

  • IN_PROGRESS
  • SUCCEEDED
  • FAILED

Returns:

  • (String) —

    The current status of the HarvestJob.