IoTSiteWise / Waiter / AssetActive

AssetActive#

class IoTSiteWise.Waiter.AssetActive#
waiter = client.get_waiter('asset_active')
wait(**kwargs)#

Polls IoTSiteWise.Client.describe_asset() 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(
    assetId='string',
    excludeProperties=True|False,
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • assetId (string) –

    [REQUIRED]

    The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide.

  • excludeProperties (boolean) – Whether or not to exclude asset properties from the response.

  • 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