IoTSiteWise / Client / update_asset

update_asset

IoTSiteWise.Client.update_asset(**kwargs)

Updates an asset’s name. For more information, see Updating assets and models in the IoT SiteWise User Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_asset(
    assetId='string',
    assetName='string',
    clientToken='string',
    assetDescription='string'
)

Parameters:

• assetId (string) –

  [REQUIRED]

  The ID of the asset to update.

• assetName (string) –

  [REQUIRED]

  A friendly name for the asset.

• 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.

• assetDescription (string) – A description for the asset.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • assetStatus (dict) –

    The status of the asset, which contains a state ( UPDATING after successfully calling this operation) and any error message.

    • state (string) –

      The current status of the asset.

    • 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.ResourceAlreadyExistsException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.ThrottlingException

• IoTSiteWise.Client.exceptions.ConflictingOperationException