mediapackagev2 / Client / list_harvest_jobs

list_harvest_jobs#

mediapackagev2.Client.list_harvest_jobs(**kwargs)#

Retrieves a list of harvest jobs that match the specified criteria.

Request Syntax

response = client.list_harvest_jobs(
    ChannelGroupName='string',
    ChannelName='string',
    OriginEndpointName='string',
    Status='QUEUED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED',
    MaxResults=123,
    NextToken='string'
)

Parameters:

ChannelGroupName (string) –
[REQUIRED]

The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned.
ChannelName (string) – The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned.
OriginEndpointName (string) – The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned.
Status (string) – The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned.
MaxResults (integer) – The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used.
NextToken (string) – A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

The response object containing the list of harvest jobs that match the specified criteria.
- Items (list) –
  
  An array of harvest job objects that match the specified criteria.
  - (dict) –
    
    Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket.
    - ChannelGroupName (string) –
      
      The name of the channel group containing the channel associated with this harvest job.
    - ChannelName (string) –
      
      The name of the channel associated with this harvest job.
    - OriginEndpointName (string) –
      
      The name of the origin endpoint associated with this harvest job.
    - Destination (dict) –
      
      The S3 destination where the harvested content will be 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) –
      
      An optional description of the harvest job.
    - ScheduleConfiguration (dict) –
      
      The configuration for when the harvest job is scheduled to run.
      - 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.
- NextToken (string) –
  
  A token used for pagination. Include this value in subsequent requests to retrieve the next set of results. If null, there are no more results to retrieve.

list_harvest_jobs#

Request Syntax

Response Syntax

Response Structure

Exceptions