Skip to content

TSTool AWS Plugin / Release Notes

Release notes are available for the core TSTool product and plugin. Each component is maintained separately and may be updated at different times. See the TSTool release notes.

Plugin release notes:

Version 1.2.0

Feature release to add the S3 Browser application and significant cleanup of all commands for consistency and to simplify use.

  • change [1.2.0] Update the AwsS3 command with the following general changes:
    • Significant changes to command parameters have been made. Old command files will need to be updated to use the new syntax.
    • In general, use "folder" rather than "directory" in terminology and command parameters. For eample, DownloadDirectories has been replaced with DownloadFolders.
    • Emphasize "files" and "folders" where appropriate rather than using "keys". For example DeleteKey has been replaced with DeleteFiles and DeleteFolders.
    • Where possible, allow multiple files and folders to be processed in one command in order to streamline workflows. Command parameter editors have been improved to provide editing tools for comma-separated lists and dictionary maps.
    • Constraints for folders have been tightened, including requiring / at the end of folder S3 object keys to clearly identify folders compared to files. This allows for more explicit error handling.
    • Treat folder keys that start with / similar to other keys, although S3 bucket objects typically don't use / at the root level.
    • Enhance the documentation to be more detailed.
    • Implement automated tests for all S3 commands to verify functionality and link to the automated tests for examples.
    • More extensive error handling has been added to detect input errors.
    • Add the AppendOutput parameter to Output tab parameters to allow multiple S3 ListBuckets and ListObjects commands to append output in the table and file.
    • Add the CloudFront tab parameters to allow new or changed S3 objects to automatically be invalidated for the CloudFront distribution associated with the S3 bucket. Consequently, a separate AwsCloudFront command can be avoided in many cases.
  • change [1.2.0] Update the AwsS3 CopyObjects command:
    • The command now allows copying multiple objects. The previous CopyObject S3 command has been changed to CopyObjects (plural).
    • The previous CopySourceKey and CopyDestKey parameters are no longer supported.
    • The CopyFiles, CopyBucket (for destination bucket), and CopyObjectsCountProperty parameters have been added.
    • Copying folders is not currently supported but may be added in the future.
  • change [1.2.0] Update the AwsS3 DeleteObjects command:
    • The command has been changed from DeleteObject to DeleteObjects (plural).
    • The command now allows deleting multiple files and folders. Deleting a folder automatically lists the folder contents and then deletes the file objects.
    • The DeleteFiles and DeleteFolders parameters have been added to specify the objects to delete.
    • The DeleteFoldersMinDepth parameter has been added to guard against deleting high-level files and folders.
    • The DeleteFoldersScope parameter has been added to control whether only files in a folder, or the folder and all of its contents are deleted.
  • change [1.2.0] Update the AwsS3 DownloadObjects command:
    • The DownloadDirectories parameter has been changed to DownloadFolders.
    • Added support for * wildcard in local file names when downloading files.
  • change [1.2.0] Update the AwsS3 ListBuckets command:
    • Added the ListBucketsRegEx parameter to filter bucket output.
    • Added the ListBucketsCountProperty parameter to set a processor property to the list size, which is useful for error checks and automated tests.
  • change [1.2.0] Update the AwsS3 ListObjects command:
    • Changed the command from ListBucketObjects to ListObjects consistent with other command names.
    • Add the ListObjectsScope parameter to indicate whether only files in a folder or all files and subfolder contents will be listed.
    • Add the Prefix parameter to filter the object list.
    • Add the Delimiter parameter to allow specifying a folder delimiter other than the default (/).
    • Add the ListObjectsRegEx parameter to filter the object list.
    • Add the ListFiles and ListFolders parameters to filter by object type.
    • Add the ListObjectsCountProperty parameter to set a processor property to the list size, which is useful for error checks and automated tests.
  • change [1.2.0] Update the AwsS3 UploadObjects command:
    • The UploadDirectories parameter has been changed to UploadFolders.
  • change [1.2.0] Update the AwsCloudFront command:
    • Enhance the documentation to be more detailed.
    • Implement automated tests for all CloudFront commands to verify functionality and link to the automated tests for examples.
    • Add the form for editing the invalidation paths.
    • Add the ListDistributionsCountProperty and ListInvalidationsCountProperty parameters to set to the count of the output list.
    • Add the InvalidationStatus parameter when listing invalidations to allow filtering on the status.
    • Enable output to a file.
  • change [1.2.0] Split the previous AwsS3Catalog command to add the new AwsS3LandingPage command to simplify the functionality of each command. Previous command files that used the AwsS3Catalog command need to be updated to use the AwsS3LandingPage command. The AwsS3LandingPage command has been modified from the previoius as follows:
    • The command editor dialog has been updated to provide more information explaining the parameters.
    • The AWS S3 tab has been added to the editor and includes parameters related to the AWS S3 connection.
    • The command now focuses only on creating dataset landing pages and features to create a dataset catalog (list of datasets) have been removed.
    • The StartingPrefix parameter has been renamed to StartingFolder.
    • The ProcessSubdirectories parameter has been renamed to ProcessSubfolders.
    • The UploadDatasetFiles parameter has been renamed to UploadFiles.
    • The HTML Inserts tab has been added to the command editor for HTML-related landing page insert files.
    • The Markdown Inserts tab has been added to the command editor for Markdown-related landing page insert files.
    • The Output tab has been removed from the command editor since these features were used with the catalog landing page.
    • The CloudFront tab has been added to the command editor with parameters similar to the AwsS3 command to automate CloudFront invalidations. The previous DistributionId has been renamed to CloudFrontDistributionId for consistency.
  • new [1.2.0] Add the Browse S3 button to command editors, which starts a separate S3 Browser application to browse S3 objects. This application will be enhanced over time to improve integration of the plugin with S3 and to minimize the need to use the AWS console. For example, use the S3 Browser to determine the keys to use for file and folder objects to use in command parameters.

Version 1.1.1

Maintenance release to add more error handling and improve usability.

  • change [1.1.1] Update the AwsS3 command:
    • Display default values for the profile and region.
    • Add warning messages if the AWS user configuration file does not exist.
    • Better handle default values for profile and region and don't allow a default bucket.
    • Show the correct editor tab based on the S3 command.
  • change [1.1.1] Update the AwsS3Catalog:
    • Display default values for the profile and region.
    • Add warning messages if the AWS user configuration file does not exist.
    • Better handle default values for profile and region.
    • Add support for generating Markdown landing page.
    • Add the ProcessSubdirectories parameter to control whether subdirectories should be processed, which provides flexibility to process main dataset landing page without recursively processing child folders.
  • change [1.1.1] Update the AwsCloudFront command:
    • Display default values for the profile and region.
    • Add warning messages if the AWS user configuration file does not exist.
    • Better handle default values for profile and region.
    • Show the correct editor tab based on the CloudFront command.
  • change [1.1.1] Update the AWS SDK library:
    • The software.amazon.aswssdk libraries for s3, cloudfront, and s3-transfer-manager have been updated from version 2.17.198 to 2.18.19.
    • The software.amazon.aswssdk.crt library for aws-crt has been updated from version 0.16.13 to 0.19.10.

Version 1.1.0

Feature release to add the AwsS3Catalog command.

  • bug [1.1.0] Update the AwsCloudFront command:
    • Fix issue where waiting for invalidation to complete was not occurring.
  • new [1.1.0] Add the AwsS3Catalog command to generate landing pages for S3 datasets.
  • change [1.1.0] Update the AwsS3 command:
    • Allow the file pattern for upload to contain wildcards.

Version 1.0.0

Initial release.