Migrate REST pipeline and account to HTTP Client

This example outlines how to migrate a REST pipeline to an HTTP Client Snap and the associated REST AWS SigV4 account to an AWS Signature V4 account. In this migration process, we use three pipelines:

  • Source pipeline: The REST pipeline that is to be migrated to the HTTP Client.
  • Account migration pipeline: The pipeline that migrates the REST AWS SigV4 Account to an AWS Signature V4 Account.
  • REST migration pipeline: The pipeline that migrates the source REST pipeline to the HTTP Client.

Understand the migration process

The migration process involves converting existing REST-based Snaps to HTTP Client Snaps using a script. The Source pipeline (REST pipeline) undergoes transformation through two migration pipelines:

  • Account Migration Pipeline: Converts the existing REST AWS SigV4 Account to an AWS Signature V4 Account to ensure compatibility with the HTTP Client.
  • REST Migration Pipeline: Replaces REST Snaps with equivalent HTTP Client methods and updates authentication by migrating the account.

After the migration is complete, the pipeline systematically replaces REST Snaps with HTTP Client Snaps as outlined below:

REST Snaps Migrates to
Create Multipart: REST PostHTTP Client > Request method: POST
Upload Multipart: REST PutHTTP Client > Request method: PUT
Complete Multipart: REST PostHTTP Client > Request method: POST
Read the File: REST GetHTTP Client > Request method: GET
REST AWS SigV4 AccountAWS Signature V4 Account

Source Pipeline

This REST pipeline uses all the REST (GET, PUT, POST, PATCH) Snaps to create a new file in the AWS S3 bucket, initiate the multipart upload, upload the file parts, complete the upload, and finally read the uploaded file.

  1. Copy the REST pipeline and account (to be migrated to HTTP Client) to a specific project folder.

    Source REST pipeline overview

    Download this Pipeline
  2. Open the Account Migration pipeline to begin converting the REST AWS SigV4 Account to an AWS Signature V4 Account.

    Account migration pipeline

  3. Configure the pipeline parameters

    Configure the account migration pipeline parameters as follows:

    Key Value Description
    path /Org/Project/Folder/RESTAccountName The source path where your REST account that is to be migrated is located. Example: /QA/qa_diagnostic_space/Docs-Migrating-REST-pipelines-to-http-client/Docs-REST AWS Sig v4 Account
    destinationFolder /Org/Project/Folder The destination path where you want to create and save the migrated account. Example: /QA/qa_diagnostic_space/Migrated-from-rest-to-http-client
    buildTag 440patches30202 The Snap Pack version.
    action create Creates the AWS Signature V4 Account.
  4. Validate the pipeline

    Validate the pipeline to migrate the REST AWS SigV4 Account to the AWS Signature V4 Account.


    Account migration output

    You can navigate to Manager and view the created account in the destination folder.

  5. Open the REST migration pipeline

    Open the REST migration pipeline that is designed to migrate the REST pipeline to HTTP Client.


    REST migration pipeline

  6. Configure the REST Migration pipeline parameters

    Configure the REST Migration pipeline parameters as follows:

    Key Value Description
    buildTag 440patches30202 The Snap Pack version.
    destinationFolder Org/Project/Folder Provide the destination path where you want to create and save the migrated pipeline. Example: /QA/qa_diagnostic_space/Migrated-from-rest-to-http-client
    action create Creates the HTTP Client pipeline with AWS Signature V4 Account.
    path Org/Project/Folder/RESTPipelineName Provide the path where your REST pipeline that is to be migrated is located. Example: /QA/qa_diagnostic_space/Docs-Migrating-REST-pipelines-to-http-client/REST Pipeline with AWS V4 Sig Account
  7. Validate the pipeline

    Validate the REST migration pipeline. All REST Snaps are migrated to the respective HTTP Client methods.

    Navigate to Manager to view the newly created HTTP Client pipeline migrated from REST.

  1. Confirm that all migrated Snaps in the new pipeline have been converted correctly to HTTP Client methods.
  2. Verify that the migrated AWS Signature V4 Account is linked and functional.