GetHarvestJobCommand

Suggest an Edit

Retrieves the details of a specific harvest job.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MediaPackageV2Client, GetHarvestJobCommand } from "@aws-sdk/client-mediapackagev2"; // ES Modules import
// const { MediaPackageV2Client, GetHarvestJobCommand } = require("@aws-sdk/client-mediapackagev2"); // CommonJS import
const client = new MediaPackageV2Client(config);
const input = { // GetHarvestJobRequest
  ChannelGroupName: "STRING_VALUE", // required
  ChannelName: "STRING_VALUE", // required
  OriginEndpointName: "STRING_VALUE", // required
  HarvestJobName: "STRING_VALUE", // required
};
const command = new GetHarvestJobCommand(input);
const response = await client.send(command);
// { // GetHarvestJobResponse
//   ChannelGroupName: "STRING_VALUE", // required
//   ChannelName: "STRING_VALUE", // required
//   OriginEndpointName: "STRING_VALUE", // required
//   Destination: { // Destination
//     S3Destination: { // S3DestinationConfig
//       BucketName: "STRING_VALUE", // required
//       DestinationPath: "STRING_VALUE", // required
//     },
//   },
//   HarvestJobName: "STRING_VALUE", // required
//   HarvestedManifests: { // HarvestedManifests
//     HlsManifests: [ // HarvestedHlsManifestsList
//       { // HarvestedHlsManifest
//         ManifestName: "STRING_VALUE", // required
//       },
//     ],
//     DashManifests: [ // HarvestedDashManifestsList
//       { // HarvestedDashManifest
//         ManifestName: "STRING_VALUE", // required
//       },
//     ],
//     LowLatencyHlsManifests: [ // HarvestedLowLatencyHlsManifestsList
//       { // HarvestedLowLatencyHlsManifest
//         ManifestName: "STRING_VALUE", // required
//       },
//     ],
//   },
//   Description: "STRING_VALUE",
//   ScheduleConfiguration: { // HarvesterScheduleConfiguration
//     StartTime: new Date("TIMESTAMP"), // required
//     EndTime: new Date("TIMESTAMP"), // required
//   },
//   Arn: "STRING_VALUE", // required
//   CreatedAt: new Date("TIMESTAMP"), // required
//   ModifiedAt: new Date("TIMESTAMP"), // required
//   Status: "QUEUED" || "IN_PROGRESS" || "CANCELLED" || "COMPLETED" || "FAILED", // required
//   ErrorMessage: "STRING_VALUE",
//   ETag: "STRING_VALUE",
//   Tags: { // TagMap
//     "<keys>": "STRING_VALUE",
//   },
// };

Example Usage

 Loading code editor

GetHarvestJobCommand Input

See GetHarvestJobCommandInput for more details

Parameter
Type
Description
ChannelGroupName
Required
string | undefined

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

ChannelName
Required
string | undefined

The name of the channel associated with the harvest job.

HarvestJobName
Required
string | undefined

The name of the harvest job to retrieve.

OriginEndpointName
Required
string | undefined

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

GetHarvestJobCommand Output

See GetHarvestJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
Required
string | undefined

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

ChannelGroupName
Required
string | undefined

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

ChannelName
Required
string | undefined

The name of the channel associated with the harvest job.

CreatedAt
Required
Date | undefined

The date and time when the harvest job was created.

Destination
Required
Destination | undefined

The S3 destination where the harvested content is being placed.

HarvestJobName
Required
string | undefined

The name of the harvest job.

HarvestedManifests
Required
HarvestedManifests | undefined

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

ModifiedAt
Required
Date | undefined

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

OriginEndpointName
Required
string | undefined

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

ScheduleConfiguration
Required
HarvesterScheduleConfiguration | undefined

The configuration for when the harvest job is scheduled to run, including start and end times.

Status
Required
HarvestJobStatus | undefined

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

Description
string | undefined

The description of the harvest job, if provided.

ETag
string | undefined

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

ErrorMessage
string | undefined

An error message if the harvest job encountered any issues.

Tags
Record<string, string> | undefined

A collection of tags associated with the harvest job.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

InternalServerException
server

Indicates that an error from the service occurred while trying to process a request.

ResourceNotFoundException
client

The specified resource doesn't exist.

ThrottlingException
client

The request throughput limit was exceeded.

ValidationException
client

The input failed to meet the constraints specified by the AWS service.

MediaPackageV2ServiceException
Base exception class for all service exceptions from MediaPackageV2 service.