MediaPackage / Client / list_harvest_jobs

list_harvest_jobs#

MediaPackage.Client.list_harvest_jobs(**kwargs)#

Returns a collection of HarvestJob records.

See also: AWS API Documentation

Request Syntax

response = client.list_harvest_jobs(
    IncludeChannelId='string',
    IncludeStatus='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • IncludeChannelId (string) – When specified, the request will return only HarvestJobs associated with the given Channel ID.

  • IncludeStatus (string) – When specified, the request will return only HarvestJobs in the given status.

  • MaxResults (integer) – The upper bound on the number of records to return.

  • NextToken (string) – A token used to resume pagination from the end of a previous request.

Return type:

dict

Returns:

Response Syntax

{
    'HarvestJobs': [
        {
            'Arn': 'string',
            'ChannelId': 'string',
            'CreatedAt': 'string',
            'EndTime': 'string',
            'Id': 'string',
            'OriginEndpointId': 'string',
            'S3Destination': {
                'BucketName': 'string',
                'ManifestKey': 'string',
                'RoleArn': 'string'
            },
            'StartTime': 'string',
            'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) – A collection of HarvestJob records.

    • HarvestJobs (list) – A list of HarvestJob records.

      • (dict) – A HarvestJob resource configuration

        • 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 date and 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 (dict) – 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.

    • NextToken (string) – A token that can be used to resume pagination from the end of the collection.

Exceptions

  • MediaPackage.Client.exceptions.UnprocessableEntityException

  • MediaPackage.Client.exceptions.InternalServerErrorException

  • MediaPackage.Client.exceptions.ForbiddenException

  • MediaPackage.Client.exceptions.NotFoundException

  • MediaPackage.Client.exceptions.ServiceUnavailableException

  • MediaPackage.Client.exceptions.TooManyRequestsException