mediapackagev2 / Client / get_harvest_job

get_harvest_job

mediapackagev2.Client.get_harvest_job(**kwargs)

Retrieves the details of a specific harvest job.

See also: AWS API Documentation

Request Syntax

response = client.get_harvest_job(
    ChannelGroupName='string',
    ChannelName='string',
    OriginEndpointName='string',
    HarvestJobName='string'
)

Parameters:

• ChannelGroupName (string) –

  [REQUIRED]

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

• ChannelName (string) –

  [REQUIRED]

  The name of the channel associated with the harvest job.

• OriginEndpointName (string) –

  [REQUIRED]

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

• HarvestJobName (string) –

  [REQUIRED]

  The name of the harvest job to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelGroupName': 'string',
    'ChannelName': 'string',
    'OriginEndpointName': 'string',
    'Destination': {
        'S3Destination': {
            'BucketName': 'string',
            'DestinationPath': 'string'
        }
    },
    'HarvestJobName': 'string',
    'HarvestedManifests': {
        'HlsManifests': [
            {
                'ManifestName': 'string'
            },
        ],
        'DashManifests': [
            {
                'ManifestName': 'string'
            },
        ],
        'LowLatencyHlsManifests': [
            {
                'ManifestName': 'string'
            },
        ]
    },
    'Description': 'string',
    'ScheduleConfiguration': {
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1)
    },
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'ModifiedAt': datetime(2015, 1, 1),
    'Status': 'QUEUED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED',
    'ErrorMessage': 'string',
    'ETag': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  The response object containing the details of the requested harvest job.

  • ChannelGroupName (string) –

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

  • ChannelName (string) –

    The name of the channel associated with the harvest job.

  • OriginEndpointName (string) –

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

  • Destination (dict) –

    The S3 destination where the harvested content is being placed.

    • S3Destination (dict) –

      The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket.

      • BucketName (string) –

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

      • DestinationPath (string) –

        The path within the specified S3 bucket where the harvested content will be placed.

  • HarvestJobName (string) –

    The name of the harvest job.

  • HarvestedManifests (dict) –

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

    • HlsManifests (list) –

      A list of harvested HLS manifests.

      • (dict) –

        Information about a harvested HLS manifest.

        • ManifestName (string) –

          The name of the harvested HLS manifest.

    • DashManifests (list) –

      A list of harvested DASH manifests.

      • (dict) –

        Information about a harvested DASH manifest.

        • ManifestName (string) –

          The name of the harvested DASH manifest.

    • LowLatencyHlsManifests (list) –

      A list of harvested Low-Latency HLS manifests.

      • (dict) –

        Information about a harvested Low-Latency HLS manifest.

        • ManifestName (string) –

          The name of the harvested Low-Latency HLS manifest.

  • Description (string) –

    The description of the harvest job, if provided.

  • ScheduleConfiguration (dict) –

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

    • StartTime (datetime) –

      The start time for the harvest job.

    • EndTime (datetime) –

      The end time for the harvest job.

  • Arn (string) –

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

  • CreatedAt (datetime) –

    The date and time when the harvest job was created.

  • ModifiedAt (datetime) –

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

  • Status (string) –

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

  • ErrorMessage (string) –

    An error message if the harvest job encountered any issues.

  • ETag (string) –

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

  • Tags (dict) –

    A collection of tags associated with the harvest job.

    • (string) –

      • (string) –

Exceptions

• mediapackagev2.Client.exceptions.ThrottlingException

• mediapackagev2.Client.exceptions.InternalServerException

• mediapackagev2.Client.exceptions.AccessDeniedException

• mediapackagev2.Client.exceptions.ValidationException

• mediapackagev2.Client.exceptions.ResourceNotFoundException