DeadlineCloud / Waiter / FleetActive

FleetActive

class DeadlineCloud.Waiter.FleetActive

waiter = client.get_waiter('fleet_active')

wait(**kwargs)

Polls DeadlineCloud.Client.get_fleet() every 5 seconds until a successful state is reached. An error is returned after 180 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    farmId='string',
    fleetId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

• farmId (string) –

  [REQUIRED]

  The farm ID of the farm in the fleet.

• fleetId (string) –

  [REQUIRED]

  The fleet ID of the fleet to get.

• WaiterConfig (dict) –

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) –

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

  • MaxAttempts (integer) –

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

Returns:

None