IoTSiteWise / Client / batch_associate_project_assets

batch_associate_project_assets#

IoTSiteWise.Client.batch_associate_project_assets(**kwargs)#

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

See also: AWS API Documentation

Request Syntax

response = client.batch_associate_project_assets(
    projectId='string',
    assetIds=[
        'string',
    ],
    clientToken='string'
)
Parameters:
  • projectId (string) –

    [REQUIRED]

    The ID of the project to which to associate the assets.

  • assetIds (list) –

    [REQUIRED]

    The IDs of the assets to be associated to the project.

    • (string) –

  • 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

{
    'errors': [
        {
            'assetId': 'string',
            'code': 'INTERNAL_FAILURE',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • errors (list) –

      A list of associated error information, if any.

      • (dict) –

        Contains error details for the requested associate project asset action.

        • assetId (string) –

          The ID of the asset.

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