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

Inherits:

Struct

• Object
• Struct
• Aws::MediaPackage::Types::HarvestJob

Defined in:

gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb

Overview

A HarvestJob resource configuration

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #channel_id ⇒ String

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

• #created_at ⇒ String

  The time the HarvestJob was submitted.

• #end_time ⇒ String

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

• #id ⇒ String

  The ID of the HarvestJob.

• #origin_endpoint_id ⇒ 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.

• #start_time ⇒ String

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

• #status ⇒ String

  The current status of the HarvestJob.

Instance Attribute Details

#arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#channel_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ String

The time the HarvestJob was submitted

Returns:

• (String)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#s3_destination ⇒ Types::S3Destination

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

Returns:

• (Types::S3Destination)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-mediapackage/lib/aws-sdk-mediapackage/types.rb', line 1427

class HarvestJob < Struct.new(
  :arn,
  :channel_id,
  :created_at,
  :end_time,
  :id,
  :origin_endpoint_id,
  :s3_destination,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end