Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . mediapackage ]

describe-harvest-job

Description

Gets details about an existing HarvestJob.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-harvest-job
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string) The ID of the HarvestJob.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Arn -> (string)

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

ChannelId -> (string)

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

CreatedAt -> (string)

The time the HarvestJob was submitted

EndTime -> (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.

OriginEndpointId -> (string)

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

S3Destination -> (structure)

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

BucketName -> (string)

The name of an S3 bucket within which harvested content will be exported

ManifestKey -> (string)

The key in the specified S3 bucket where the harvested top-level manifest will be placed.

RoleArn -> (string)

The IAM role used to write to the specified S3 bucket

StartTime -> (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.