Skip to content

batch_disassociate_project_assets

batch_disassociate_project_assets(
    project_id: ID,
    asset_ids: IDs,
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> BatchDisassociateProjectAssetsResponse

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

Parameters:

  • project_id (ID) –

    The ID of the project from which to disassociate the assets.

  • asset_ids (IDs) –

    The IDs of the assets to be disassociated from 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.

  • 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_disassociate_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_disassociate_project_assets_response.BatchDisassociateProjectAssetsResponse":
    """<p>Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.</p>

    Args:
        project_id: <p>The ID of the project from which to disassociate the assets.</p>
        asset_ids: <p>The IDs of the assets to be disassociated from 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.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_disassociate_project_assets_request.BatchDisassociateProjectAssetsRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.batch_disassociate_project_assets_response.BatchDisassociateProjectAssetsResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.batch_disassociate_project_assets

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.batch_disassociate_project_assets.batch_disassociate_project_assets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchDisassociateProjectAssets")
    )
    input_: capo_iotsitewise.types.batch_disassociate_project_assets_request.BatchDisassociateProjectAssetsRequest = {
        "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