AWS Systems Manager
User Guide

Add a Package Version to Distributor

To add a package version, create a package and manifest, upload it to Amazon S3, and then use Distributor to add a package version by adding an entry to the document that already exists for older versions. To save time, update the manifest for an older version of the package, change the value of the version entry in the manifest (for example, from Test_1.0 to Test_2.0) and save it as the manifest for the new version.

A new package version can:

  • Replace at least one of the ZIP files attached to the current version.

  • Add new ZIP files to support additional platforms.

  • Delete files to discontinue support for specific platforms.

A newer version can use the same S3 bucket, but must have a URL with a different file name shown at the end. You can use the AWS Systems Manager console or the AWS CLI to add the new version.

Add a Package Version (Console)

Before you perform these steps, follow the instructions in Create a Package to create a new package for the version. Then, use the AWS Systems Manager console to add a new package version to Distributor.

  1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems-manager/.

  2. In the navigation pane, choose Distributor.

  3. On the Distributor home page, choose the package to which you want to add another version.

  4. On the Add package version page, enter a description for the new package version. Descriptions can be a maximum of 512 characters.

  5. (Optional) If you did not upload your JSON manifest to the S3 bucket where you stored your ZIP files, you can author or paste the entire JSON manifest in the JSON manifest field. For more information about how to create the JSON manifest, see Step 2: Create the JSON Package Manifest.

  6. In Version name, enter the exact value that is in the version entry of your manifest file.

  7. In Package location, paste the URL that you copied when you uploaded your package to S3, and then choose Add package version.

  8. On the package's Details page, on the Versions tab, view the new version in the list of available package versions. Set a default version of the package by choosing a version, and then choosing Set default version.

    If you do not set a default version, the newest package version is the default version.

Add a Package Version (CLI)

You can use the AWS CLI to add a new package version to Distributor. Before you run these commands, you must create a new package version and upload it to S3, as described at the start of this topic.

  1. Run the following command to edit the AWS Systems Manager document with an entry for a new package version. Replace document_name with the name of your document. Replace S3_bucket_URL_to_manifest_file with the URL of the JSON manifest that you copied in Step 3: Upload the Package and Manifest to an Amazon S3 Bucket. S3_bucket_URL_of_package is the URL of the S3 bucket where the entire package is stored. Replace version_name_from_updated_manifest with the value of version in the manifest. Set the --document-version parameter to $LATEST to make the document associated with this package version the latest version of the document.

    aws ssm update-document --name "document_name" --content "S3_bucket_URL_to_manifest_file" --attachments Key="SourceUrl",Values="S3_bucket_URL_of_package" --version-name version_name_from_updated_manifest --document-version $LATEST

    The following is an example.

    aws ssm update-document --name ExamplePackage --content "https://s3.amazonaws.com/mybucket/ExamplePackage/manifest.json" --attachments Key="SourceUrl",Values="https://s3.amazonaws.com/mybucket/ExamplePackage" --version-name 1.1.1 --document-version $LATEST
  2. Run the following command to verify that your package was updated and show the package manifest. Replace package_name with the name of your package, and optionally, document_version with the version number of the document (not the same as the package version) that you updated. If this package version is associated with the latest version of the document, you can specify $LATEST for the value of the optional --document-version parameter.

    aws ssm get-document --name "package_name" --document-version "document_version"

For information about other options you can use with the update-document command, see update-document in the AWS Systems Manager section of the AWS CLI Command Reference.