computing / Waiter / CustomerGatewayStopped

CustomerGatewayStopped

class computing.Waiter.CustomerGatewayStopped
waiter = client.get_waiter('customer_gateway_stopped')
wait(**kwargs)

Polls computing.Client.describe_customer_gateways() every 20 seconds until a successful state is reached. An error is returned after 40 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    CustomerGatewayId=[
        'string',
    ],
    Filter=[
        {
            'ListOfRequestValue': [
                'string',
            ],
            'Name': 'customer-gateway-id'|'nifty-customer-gateway-name'|'ip-address'|'state'|'nifty-customer-gateway-description'
        },
    ],
    NiftyCustomerGatewayName=[
        'string',
    ],
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:
  • CustomerGatewayId (list) –

    • (string) –

  • Filter (list) –

    • (dict) –

      • ListOfRequestValue (list) –

        • (string) –

      • Name (string) –

  • NiftyCustomerGatewayName (list) –

    • (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: 20

    • MaxAttempts (integer) –

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

Returns:

None