update_asset ¶

def update_asset(
    self,
    asset_id: "capo_iotsitewise.types.custom_id.CustomID",
    asset_name: "capo_iotsitewise.types.name.Name",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    asset_external_id: Optional[
        "capo_iotsitewise.types.external_id.ExternalId"
    ] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
    asset_description: Optional[
        "capo_iotsitewise.types.description.Description"
    ] = None,
) -> "capo_iotsitewise.types.update_asset_response.UpdateAssetResponse":
    """<p>Updates an asset's name. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html">Updating assets and models</a> in the <i>IoT SiteWise User Guide</i>.</p>

    Args:
        asset_id: <p>The ID of the asset to update. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
        asset_external_id: <p>An external ID to assign to the asset. The asset must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids">Using external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
        asset_name: <p>A friendly name for the asset.</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>
        asset_description: <p>A description for the asset.</p>

    Raises:
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        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_already_exists_exception.ResourceAlreadyExistsException: <p>The resource already exists.</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.update_asset_request.UpdateAssetRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.update_asset_response.UpdateAssetResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.update_asset

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateAsset")
    )
    input_: capo_iotsitewise.types.update_asset_request.UpdateAssetRequest = {
        "asset_id": asset_id,
        "asset_name": asset_name,
    }
    if asset_external_id is not None:
        input_["asset_external_id"] = asset_external_id
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if asset_description is not None:
        input_["asset_description"] = asset_description

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output