IoTSiteWise / Client / delete_asset_model_interface_relationship

delete_asset_model_interface_relationship

IoTSiteWise.Client.delete_asset_model_interface_relationship(**kwargs)

Deletes an interface relationship between an asset model and an interface asset model.

See also: AWS API Documentation

Request Syntax

response = client.delete_asset_model_interface_relationship(
    assetModelId='string',
    interfaceAssetModelId='string',
    clientToken='string'
)
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.

  • interfaceAssetModelId (string) –

    [REQUIRED]

    The ID of the interface asset model. This can be either the actual ID in UUID format, or else externalId: followed by the external ID.

  • 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

{
    'assetModelId': 'string',
    'interfaceAssetModelId': 'string',
    'assetModelArn': 'string',
    '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) –

    • assetModelId (string) –

      The ID of the asset model.

    • interfaceAssetModelId (string) –

      The ID of the interface asset model.

    • assetModelArn (string) –

      The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

    • 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