ElasticLoadBalancing / Waiter / InstanceInService

InstanceInService#

class ElasticLoadBalancing.Waiter.InstanceInService#
waiter = client.get_waiter('instance_in_service')
wait(**kwargs)#

Polls ElasticLoadBalancing.Client.describe_instance_health() every 15 seconds until a successful state is reached. An error is raised after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    LoadBalancerName='string',
    Instances=[
        {
            'InstanceId': 'string'
        },
    ],
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:
  • LoadBalancerName (string) –

    [REQUIRED]

    The name of the load balancer.

  • Instances (list) –

    The IDs of the instances.

    • (dict) –

      The ID of an EC2 instance.

      • InstanceId (string) –

        The instance ID.

  • 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