InstanceOnline

class OpsWorks.Waiter.InstanceOnline

waiter = client.get_waiter('instance_online')

wait(**kwargs)

Polls OpsWorks.Client.describe_instances() every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    StackId='string',
    LayerId='string',
    InstanceIds=[
        'string',
    ],
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters

• StackId (string) -- A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.
• LayerId (string) -- A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.
• InstanceIds (list) --

  An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

  • (string) --
• WaiterConfig (dict) --

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) --

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

  • MaxAttempts (integer) --

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

Returns

None