AWS amazonq documentation change
Summary
Updated documentation for Amazon Q CLI transformations, including reordering steps, adding authentication method details, updating version numbers, and expanding configuration instructions
Security assessment
The changes add detailed documentation about authentication methods (IAM and IAM Identity Center) and permissions management, which are security-related features. However, there is no evidence this addresses a specific security vulnerability or incident.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/run-CLI-transformations.md index 8fa29d9c1..fc6750e5d 100644 --- a/amazonq/latest/qdeveloper-ug/run-CLI-transformations.md +++ b/amazonq/latest/qdeveloper-ug/run-CLI-transformations.md @@ -5 +5 @@ -PrerequisitesStep 1: Install the toolStep 2: Configure and authenticateStep 3: Run a transformation +PrerequisitesStep 1: Choose authentication method and add permissionsStep 2: Install the toolStep 3: Configure and authenticateStep 4: Run a transformation @@ -8,0 +9,3 @@ PrerequisitesStep 1: Install the toolStep 2: Configure and authenticateStep 3: R +Transforming code with Amazon Q on the command line is in preview, and is subject to change. +--- + @@ -19,2 +21,0 @@ Before you begin a transformation on the command line, the following prerequisit - * You are [subscribed to Amazon Q Developer Pro](./q-pro-tier.html) and have a Start URL to access your subscription. You or your administrator can find the Start URL in the Amazon Q Developer console. For more information see, [Managing account details in Amazon Q Developer](./manage-account-details.html). - @@ -32 +33,27 @@ Before you begin a transformation on the command line, the following prerequisit -## Step 1: Install the tool +## Step 1: Choose authentication method and add permissions + +You can authenticate with AWS Identity and Access Management (IAM) or IAM Identity Center to run transformations on the command line. Regardless of the authentication method you use, ensure you have the proper permissions. + +###### Note + +Customer managed keys aren't supported for transformations performed on the command line. + +### Add permissions + +The IAM identity associated with either the AWS CLI profile or the Amazon Q Developer subscription you are using to authenticate must have permissions to perform transformations on the command line. Before you proceed, ensure your IAM identity has the permissions defined in [Allow users to run transformations on the command line](./id-based-policy-examples-users.html#id-based-policy-examples-allow-cli-transformations). + +### Authenticate with IAM + +###### Note + +You can't use IAM to authenticate with a Amazon Q Developer subscription. + +To authenticate with IAM, you must: + + * Install the AWS Command Line Interface (AWS CLI). For more information, see [Getting started with the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html). + + * Configure an AWS CLI profile with a `credentials` file where your IAM credentials are stored. + +For more information on adding your IAM credentials to your AWS CLI profile, see [Configuration and credential file settings in the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html). + + * When you configure your profile, you must set the `Default region name` field to `us-east-1`. Transformations on the CLI are only available in US East (N. Virginia). @@ -34 +61,20 @@ Before you begin a transformation on the command line, the following prerequisit - 1. [Download the Amazon Q command line tool for transformations](https://desktop-release.codewhisperer.us-east-1.amazonaws.com/amzn_qct_cli/amzn_qct_cli-0.4.1.zip). + * Add the required permissions to your IAM identity. For more information, see Add permissions + + + + +You can specify this configuration on your command line by running `aws configure` after installing the AWS CLI. + +You provide the AWS CLI profile you configured in Step 3: Configure and authenticate. + +### Authenticate with IAM Identity Center through a Amazon Q Developer subscription + +To authenticate with IAM Identity Center, you must be [subscribed to Amazon Q Developer Pro](./q-pro-tier.html) and provide the Start URL to authenticate through your subscription. You or your administrator can find the Start URL in the Amazon Q Developer console. For more information see, [Managing account details in Amazon Q Developer](./manage-account-details.html). + +To add required permissions, see Add permissions. + +You provide the Start URL in Step 3: Configure and authenticate. + +## Step 2: Install the tool + + 1. [Download the Amazon Q command line tool for transformations](https://desktop-release.codewhisperer.us-east-1.amazonaws.com/amzn_qct_cli/amzn_qct_cli-0.5.0.zip). @@ -48 +94 @@ To download a previous version of the command line tool, see [Version history](. - pip install amzn_qct_cli-0.4.1-py3-none-any.whl + pip install amzn_qct_cli-0.5.0-py3-none-any.whl @@ -52 +98 @@ To download a previous version of the command line tool, see [Version history](. -If you are using an older version of the command line tool for transformations, replace `0.4.1` with the [version](./transform-CLI-versions.html) you downloaded. +If you are using an older version of the command line tool for transformations, replace `0.5.0` with the [version](./transform-CLI-versions.html) you downloaded. @@ -61 +107,3 @@ If you are using an older version of the command line tool for transformations, -## Step 2: Configure and authenticate +## Step 3: Configure and authenticate + +Before you can begin a transformation, you must authenticate to the AWS CLI and provide configuration details for your transformation. @@ -63 +111 @@ If you are using an older version of the command line tool for transformations, -Before you can begin a transformation, you must provide configuration details and authenticate to your Amazon Q Developer Pro subscription with IAM Identity Center. + 1. If you're authenticating with IAM and you haven't already configured the AWS CLI, run the following command to provide authentication details. For requirements to authenticate with IAM on the AWS CLI, see Authenticate with IAM. @@ -65 +113,3 @@ Before you can begin a transformation, you must provide configuration details an - 1. To start the configuration process, run the following command: + aws configure + + 2. To start the transformation configuration process, run the following command: @@ -69 +119 @@ Before you can begin a transformation, you must provide configuration details an - 2. First, your Maven version is verified. If you have at least the minimum supported version, you will see the following output: + 3. First, your Maven version is verified. If you have at least the minimum supported version, you will see the following output: @@ -76 +126,7 @@ If you don’t have a supported version of Maven, you must update it to continue - 3. You are then be prompted to enter a JDK path for each supported Java version. You only need to specify the path to the JDK of the Java version you are upgrading. + 4. You are then prompted to enter a JDK path for each supported Java version. You only need to specify the path to the JDK of the Java version you are upgrading. + + 5. Next, you are prompted to choose your authentication method. + + 1. To authenticate with IAM credentials stored in your AWS CLI profile, enter `1`. You can specify a specific profile name or press enter to use the default profile. + +If you'd like to add tags to your transformation, you can supply a CSV file where your tags are stored. The CSV must have two columns, with headers titled _key_ and _value_ , where tag key-value pairs are listed. To add these tags to your transformation, enter the path to the CSV file where tags are stored. @@ -78 +134 @@ If you don’t have a supported version of Maven, you must update it to continue - 4. Next, you are prompted to provide the Start URL to authenticate to Amazon Q Developer Pro through OpenID Connect identity provider. For more information, see the Prerequisites. + 2. To authenticate with IAM Identity Center through your Amazon Q Developer subscription, enter `2`, and then enter the start URL for your subscription profile. @@ -80 +136 @@ If you don’t have a supported version of Maven, you must update it to continue - 5. Enter the AWS Region where your Amazon Q Developer subscription profile is configured, in the following format: `us-east-1`. For a list of supported Regions, see [Supported Regions](./regions.html). For a list of Region codes, see [Regional endpoints ](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) in the _AWS General Reference guide_. +Next, enter the AWS Region where you were subscribed in the following format: `us-east-1`. For a list of supported Regions, see [Supported Regions](./regions.html). For a list of Region codes, see [Regional endpoints ](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) in the _AWS General Reference guide_. @@ -91 +147 @@ For more information on how Amazon Q splits up the code changes, see [Reviewing -## Step 3: Run a transformation +## Step 4: Run a transformation