IoTSiteWise / Waiter / PortalActive

PortalActive

class IoTSiteWise.Waiter.PortalActive

waiter = client.get_waiter('portal_active')

wait(**kwargs)

Polls IoTSiteWise.Client.describe_portal() every 3 seconds until a successful state is reached. An error is raised after 20 failed checks.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• portalId (string) –

  [REQUIRED]

  The ID of the portal.

• WaiterConfig (dict) –

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) –

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

  • MaxAttempts (integer) –

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

Returns:

None