Actions

Actions are effectively “commands” for AME Wizard to execute, and are written in YAML using the camelCase naming convention (ex. appx, scheduledTask).

To get started using actions, follow our Getting Started guide.

Optional Parameters


All actions have the following optional parameters.

Paramater

Description

Type

Default

weight

Specifies how much impact the action will have on the progress bar once completed.

integer

2-5 for most actions

errorAction

Specifies what happens if the action fails.

Enum:
Ignore
(Ignore error)
Log
(Log error) Notify
(Show at end)
Halt
(Halt Playbook)

varies

option

See Features In YAML.

string

None

options

Similar to option, however multiple options can be specified to trigger an action.

string array

None

builds

Specifies which Windows builds the action should apply to.

Builds can be specified using either a basic array of builds (ex. builds: ['22621', '22622']), or more dynamic versions can be specified like in the following example: builds: [ '>=22621' ]

Any of the following conditions can be used:
>= - greater than or equal to
<= - less than or equal to
> - greater than
< - less than

You can also use negative expressions like in the following example: builds: [ '>=22621', '!>22625' ].
You can also specify an update build release number: 22621.1265.

string array

None

cpuArch

Specifies to only run an action if the specified architecture matches the system architecture.

string
Must match a value from here. (Ex. “X64”)

None

onUpgrade

Specifies whether or not to run action during an upgrade. See Upgrades.

bool

false

onUpgradeVersions

Specifies on what previous version(s) onUpgrade should be triggered. See Upgrades

Versions can be specified using either a basic array of versions (ex. onUpgradeVersions: ['1.0', '1.1']), or more dynamic versions can be specified like in the following example: onUpgradeVersions: [ '>=1.0' ]

Any of the following conditions can be used:
>= - greater than or equal to
<= - less than or equal to
> - greater than
< - less than

You can also use negative expressions like in the following example: onUpgradeVersions: [ '>=1.0', '!>1.1' ].

string array

None

previousOption

Specifies what previous option to match during an upgrade. See Upgrades.

string

None

Navigate to an action below for examples and/or parameters.

Actions overview

  • RunAction: runs a specified executable or file.

  • RegistryKey: adds or deletes a specified registry key.

  • RegistryValue: modifies a specified registry value.

  • Appx: removes, or clears the cache of a given APPX component.

  • Service: executes a specified cmd command.

  • ScheduledTask: deletes a task folder, or modifies a specific task.

  • TaskKill: terminates a specified process.

  • SystemPackage: removes a specified Windows component.

  • Cmd: executes a specified cmd command.

  • PowerShell: executes a specified PowerShell command.

  • WriteStatus: writes a status message for AME Wizard.

  • Task: runs a YAML task file.