update_entity ¶

def update_entity(
    self,
    workspace_id: "capo_iottwinmaker.types.id.Id",
    entity_id: "capo_iottwinmaker.types.entity_id.EntityId",
    *,
    config_overrides: Optional[IoTTwinMakerClientConfig] = None,
    entity_name: Optional["capo_iottwinmaker.types.entity_name.EntityName"] = None,
    description: Optional["capo_iottwinmaker.types.description.Description"] = None,
    component_updates: Optional[
        "capo_iottwinmaker.types.component_updates_map_request.ComponentUpdatesMapRequest"
    ] = None,
    composite_component_updates: Optional[
        "capo_iottwinmaker.types.composite_component_updates_map_request.CompositeComponentUpdatesMapRequest"
    ] = None,
    parent_entity_update: Optional[
        "capo_iottwinmaker.types.parent_entity_update_request.ParentEntityUpdateRequest"
    ] = None,
) -> "capo_iottwinmaker.types.update_entity_response.UpdateEntityResponse":
    """<p>Updates an entity.</p>

    Args:
        workspace_id: <p>The ID of the workspace that contains the entity.</p>
        entity_id: <p>The ID of the entity.</p>
        entity_name: <p>The name of the entity.</p>
        description: <p>The description of the entity.</p>
        component_updates: <p>An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.</p>
        composite_component_updates: <p>This is an object that maps strings to <code>compositeComponent</code> updates in the request. Each key of the map represents the <code>componentPath</code> of the <code>compositeComponent</code>.</p>
        parent_entity_update: <p>An object that describes the update request for a parent entity.</p>

    Raises:
        capo_iottwinmaker.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iottwinmaker.errors.conflict_exception.ConflictException: <p>A conflict occurred.</p>
        capo_iottwinmaker.errors.internal_server_exception.InternalServerException: <p>An unexpected error has occurred.</p>
        capo_iottwinmaker.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource wasn't found.</p>
        capo_iottwinmaker.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota was exceeded.</p>
        capo_iottwinmaker.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iottwinmaker.errors.validation_exception.ValidationException: <p>Failed</p>
        capo_iottwinmaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iottwinmaker.types.update_entity_request.UpdateEntityRequest]",
    ) -> OperationResponse[
        "capo_iottwinmaker.types.update_entity_response.UpdateEntityResponse"
    ]:
        import capo_iottwinmaker._operations.aws_io_t_twin_maker.update_entity

        output, http_response = (
            capo_iottwinmaker._operations.aws_io_t_twin_maker.update_entity.update_entity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateEntity")
    )
    input_: capo_iottwinmaker.types.update_entity_request.UpdateEntityRequest = {
        "workspace_id": workspace_id,
        "entity_id": entity_id,
    }
    if entity_name is not None:
        input_["entity_name"] = entity_name
    if description is not None:
        input_["description"] = description
    if component_updates is not None:
        input_["component_updates"] = component_updates
    if composite_component_updates is not None:
        input_["composite_component_updates"] = composite_component_updates
    if parent_entity_update is not None:
        input_["parent_entity_update"] = parent_entity_update

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