IoTSiteWise / Waiter / AssetModelActive

AssetModelActive#

class IoTSiteWise.Waiter.AssetModelActive#
waiter = client.get_waiter('asset_model_active')
wait(**kwargs)#

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

  • assetModelId (string) –

    [REQUIRED]

    The ID of the asset model. 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 model properties from the response.

  • assetModelVersion (string) – The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the IoT SiteWise User Guide.

  • 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