mediapackagev2 / Waiter / HarvestJobFinished

HarvestJobFinished

class mediapackagev2.Waiter.HarvestJobFinished

waiter = client.get_waiter('harvest_job_finished')

wait(**kwargs)

Polls mediapackagev2.Client.get_harvest_job() every 2 seconds until a successful state is reached. An error is raised after 60 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    ChannelGroupName='string',
    ChannelName='string',
    OriginEndpointName='string',
    HarvestJobName='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

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.

• WaiterConfig (dict) –

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) –

    The amount of time in seconds to wait between attempts. Default: 2

  • MaxAttempts (integer) –

    The maximum number of attempts to be made. Default: 60

Returns:

None