IoTSiteWise / Client / delete_asset_model_composite_model

delete_asset_model_composite_model

IoTSiteWise.Client.delete_asset_model_composite_model(**kwargs)

Deletes a composite model. This action can’t be undone. You must delete all assets created from a composite model before you can delete the model. Also, you can’t delete a composite model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_asset_model_composite_model(
    assetModelId='string',
    assetModelCompositeModelId='string',
    clientToken='string'
)

Parameters:

• assetModelId (string) –

  [REQUIRED]

  The ID of the asset model, in UUID format.

• assetModelCompositeModelId (string) –

  [REQUIRED]

  The ID of a composite model on this asset model.

• clientToken (string) –

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'assetModelStatus': {
        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'PROPAGATING'|'DELETING'|'FAILED',
        'error': {
            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
            'message': 'string',
            'details': [
                {
                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                    'message': 'string'
                },
            ]
        }
    }
}

Response Structure

• (dict) –

  • assetModelStatus (dict) –

    Contains current status information for an asset model. For more information, see Asset and model states in the IoT SiteWise User Guide.

    • state (string) –

      The current state of the asset model.

    • error (dict) –

      Contains associated error information, if any.

      • code (string) –

        The error code.

      • message (string) –

        The error message.

      • details (list) –

        A list of detailed errors.

        • (dict) –

          Contains detailed error information.

          • code (string) –

            The error code.

          • message (string) –

            The error message.

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.ThrottlingException

• IoTSiteWise.Client.exceptions.ConflictingOperationException