The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see IoT SiteWise Monitor availability change.
Associates a group (batch) of assets with an IoT SiteWise Monitor project.
Parameters:
-
project_id
(ID)
–
The ID of the project to which to associate the assets.
-
asset_ids
(IDs)
–
The IDs of the assets to be associated to the project.
-
client_token
(Optional[ClientToken], default:
None
)
–
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.
Raises:
-
InternalFailureException
–
IoT SiteWise can't process your request right now. Try again later.
-
InvalidRequestException
–
The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
-
LimitExceededException
–
You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.
For more information, see Quotas in the IoT SiteWise User Guide.
-
ResourceNotFoundException
–
The requested resource can't be found.
-
ThrottlingException
–
Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.
For more information, see Quotas in the IoT SiteWise User Guide.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_iotsitewise/_services/io_t_site_wise.py
| def batch_associate_project_assets(
self,
project_id: "capo_iotsitewise.types.id.ID",
asset_ids: "capo_iotsitewise.types.i_ds.IDs",
*,
config_overrides: Optional[IoTSiteWiseClientConfig] = None,
client_token: Optional[
"capo_iotsitewise.types.client_token.ClientToken"
] = None,
) -> "capo_iotsitewise.types.batch_associate_project_assets_response.BatchAssociateProjectAssetsResponse":
"""<important> <p>The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/appguide/iotsitewise-monitor-availability-change.html">IoT SiteWise Monitor availability change</a>.</p> </important> <p>Associates a group (batch) of assets with an IoT SiteWise Monitor project.</p>
Args:
project_id: <p>The ID of the project to which to associate the assets.</p>
asset_ids: <p>The IDs of the assets to be associated to the project.</p>
client_token: <p>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.</p>
Raises:
capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
capo_iotsitewise.errors.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_iotsitewise.types.batch_associate_project_assets_request.BatchAssociateProjectAssetsRequest]",
) -> OperationResponse[
"capo_iotsitewise.types.batch_associate_project_assets_response.BatchAssociateProjectAssetsResponse"
]:
import capo_iotsitewise._operations.aws_io_t_site_wise.batch_associate_project_assets
output, http_response = (
capo_iotsitewise._operations.aws_io_t_site_wise.batch_associate_project_assets.batch_associate_project_assets(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("BatchAssociateProjectAssets")
)
input_: capo_iotsitewise.types.batch_associate_project_assets_request.BatchAssociateProjectAssetsRequest = {
"project_id": project_id,
"asset_ids": asset_ids,
}
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|