Running commands using a specific document version - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Running commands using a specific document version

You can use the document version parameter to specify which version of an Amazon Systems Manager document to use when the command runs. You can specify one of the following options for this parameter:

  • $DEFAULT

  • $LATEST

  • Version number

Run the following procedure to run a command using the document version parameter.

Linux
To run commands using the Amazon CLI on local Linux machines

  1. Install and configure the Amazon Command Line Interface (Amazon CLI), if you haven't already.

    For information, see Installing or updating the latest version of the Amazon CLI.

  2. List all available documents

    This command lists all of the documents available for your account based on Amazon Identity and Access Management (IAM) permissions.

    aws ssm list-documents

  3. Run the following command to view the different versions of a document. Replace document name with your own information.

    aws ssm list-document-versions \
    --name "document name"

  4. Run the following command to run a command that uses an SSM document version. Replace each example resource placeholder with your own information.

    aws ssm send-command \
    --document-name "AWS-RunShellScript" \
    --parameters commands="echo Hello" \
    --instance-ids instance-ID \
    --document-version '$LATEST'
Windows
To run commands using the Amazon CLI on local Windows machines

  1. Install and configure the Amazon Command Line Interface (Amazon CLI), if you haven't already.

    For information, see Installing or updating the latest version of the Amazon CLI.

  2. List all available documents

    This command lists all of the documents available for your account based on Amazon Identity and Access Management (IAM) permissions.

    aws ssm list-documents

  3. Run the following command to view the different versions of a document. Replace document name with your own information.

    aws ssm list-document-versions ^
    --name "document name"

  4. Run the following command to run a command that uses an SSM document version. Replace each example resource placeholder with your own information.

    aws ssm send-command ^
    --document-name "AWS-RunShellScript" ^
    --parameters commands="echo Hello" ^
    --instance-ids instance-ID ^
    --document-version "$LATEST"
PowerShell
To run commands using the Tools for PowerShell

  1. Install and configure the Amazon Tools for PowerShell (Tools for Windows PowerShell), if you haven't already.

    For information, see Installing the Amazon Tools for PowerShell.

  2. List all available documents

    This command lists all of the documents available for your account based on Amazon Identity and Access Management (IAM) permissions.

    Get-SSMDocumentList

  3. Run the following command to view the different versions of a document. Replace document name with your own information.

    Get-SSMDocumentVersionList `
    -Name "document name"

  4. Run the following command to run a command that uses an SSM document version. Replace each example resource placeholder with your own information.

    Send-SSMCommand `
    -DocumentName "AWS-RunShellScript" `
    -Parameter @{commands = "echo helloWorld"} `
    -InstanceIds "instance-ID" `
    -DocumentVersion $LATEST