Skip to main content

Set-IMMemory

SYNOPSIS​

Updates an existing Immich memory configuration.

SYNTAX​

Set-IMMemory [[-Session] <ImmichSession>] [-Id] <String[]> [[-IsSaved] <Boolean>] [[-MemoryAt] <DateTime>]
 [[-SeenAt] <DateTime>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

The Set-IMMemory function modifies the properties of an existing memory in Immich. You can update the memory's anchor date, tracking information, and saved status. This function supports pipeline input for batch operations and includes confirmation prompts for safety when making changes to memory configurations.

Memories are curated collections that help users rediscover their photos, and updating their properties can improve the user experience and memory organization.

EXAMPLES​

EXAMPLE 1​

Set-IMMemory -Id 'bf973405-3f2a-48d2-a687-2ed4167164be' -IsSaved $true

Marks the specified memory as saved for future reference.

EXAMPLE 2​

Set-IMMemory -Id 'bf973405-3f2a-48d2-a687-2ed4167164be' -MemoryAt "2024-07-04 12:00:00"

Updates the memory's anchor date to July 4th, 2024 at noon.

EXAMPLE 3​

Get-IMMemory | Where-Object IsSaved -eq $false | Set-IMMemory -IsSaved $true

Marks all unsaved memories as saved using pipeline processing.

EXAMPLE 4​

Set-IMMemory -Id 'bf973405-3f2a-48d2-a687-2ed4167164be' -SeenAt (Get-Date)

Updates the memory's last seen timestamp to the current date and time.

PARAMETERS​

-Session​

Optionally define a immich session object to use. This is useful when you are connected to more than one immich instance.

-Session $Session

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id​

Specifies the unique identifier of the memory to update. Must be a valid GUID format. Accepts pipeline input by value and by property name for batch update operations.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-IsSaved​

Controls whether the memory is marked as saved by the user. Set to $true to save the memory for future reference, or $false to unsave it. Saved memories may receive different treatment in the user interface.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-MemoryAt​

Updates the date and time when the memory is anchored. This represents the focal point of the memory and affects how it's organized and presented to users. Must be provided in a valid DateTime format.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SeenAt​

Updates the timestamp indicating when the memory was last viewed or acknowledged by the user. This helps track engagement and can influence memory presentation logic.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm​

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

This function supports ShouldProcess for confirmation prompts when making changes. Use -WhatIf to preview changes before applying them to memory configurations.

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github