AWS braket documentation change
Summary
Restructured documentation headings and content flow, removed detailed permissions verification section with screenshots, updated terminology from 'Saving' to 'Save', and added new API/local mode references
Security assessment
The changes primarily involve documentation restructuring and wording improvements rather than security-specific content. The removed permissions section was about general IAM role setup rather than addressing a specific vulnerability. No security vulnerabilities or exploits are mentioned in the diff.
Diff
diff --git a/braket/latest/developerguide/braket-jobs-first.md b/braket/latest/developerguide/braket-jobs-first.md index f3f407223..2f0c1426d 100644 --- a//braket/latest/developerguide/braket-jobs-first.md +++ b//braket/latest/developerguide/braket-jobs-first.md @@ -5 +5 @@ -Set permissionsCreate and runMonitor resultsSaving your job resultsSaving and restarting hybrid jobs using checkpoints +Create and runMonitor your resultsSave your resultsUsing checkpoints @@ -7 +7 @@ Set permissionsCreate and runMonitor resultsSaving your job resultsSaving and re -# Create your first Hybrid Job +# Create a Hybrid Job @@ -9 +9 @@ Set permissionsCreate and runMonitor resultsSaving your job resultsSaving and re -This section shows you how to create a Hybrid Job using a Python script. Alternatively, to create a hybrid job from local Python code, such as your preferred integrated development environment (IDE) or a Braket notebook, see [Running your local code as a hybrid job](./braket-hybrid-job-decorator.html). +This section shows you how to create a Hybrid Job using a Python script. Alternatively, to create a hybrid job from local Python code, such as your preferred integrated development environment (IDE) or a Braket notebook, see [Run your local code as a hybrid job](./braket-hybrid-job-decorator.html). @@ -13,2 +12,0 @@ This section shows you how to create a Hybrid Job using a Python script. Alterna - * Set permissions - @@ -17,14 +15 @@ This section shows you how to create a Hybrid Job using a Python script. Alterna - * Monitor results - - * Saving your job results - - * Saving and restarting hybrid jobs using checkpoints - - - - -## Set permissions - -Before you run your first hybrid job, you must ensure that you have sufficient permissions to proceed with this task. To determine that you have the correct permissions, select **Permissions** from the menu on left side of the Braket Console. The **Permissions management for Amazon Braket** page helps you verify whether one of your existing roles has permissions that are sufficient to run your hybrid job or guides you through the creation of a default role that can be used to run your hybrid job if you do not already have such a role. - - + * Monitor your results @@ -32 +17 @@ Before you run your first hybrid job, you must ensure that you have sufficient p -To verify that you have roles with sufficient permissions to run a hybrid job, select the **Verify existing role** button. If you do, you get a message that the roles were found. To see the names of the roles and their role ARNs, select the **Show roles** button. + * Save your results @@ -34 +19 @@ To verify that you have roles with sufficient permissions to run a hybrid job, s - + * Using checkpoints @@ -36 +21 @@ To verify that you have roles with sufficient permissions to run a hybrid job, s -If you do not have a role with sufficient permissions to run a hybrid job, you get a message that no such role was found. Select the **Create default role** button to obtain a role with sufficient permissions. + * [Run your local code as a hybrid job](./braket-hybrid-job-decorator.html) @@ -38 +23 @@ If you do not have a role with sufficient permissions to run a hybrid job, you g - + * [Using the API with Hybrid Jobs](./braket-jobs-api.html) @@ -40 +25 @@ If you do not have a role with sufficient permissions to run a hybrid job, you g -If the role was created successfully, you get a message confirming this. + * [Create and debug a hybrid job with local mode](./braket-jobs-local-mode.html) @@ -42 +26,0 @@ If the role was created successfully, you get a message confirming this. - @@ -44 +27,0 @@ If the role was created successfully, you get a message confirming this. -If you do not have permissions to make this inquiry, you will be denied access. In this case, contact your internal AWS administrator. @@ -46 +28,0 @@ If you do not have permissions to make this inquiry, you will be denied access. - @@ -133 +115 @@ You can also use your custom-made module with the [AwsQuantumJob.create](https:/ -## Monitor results +## Monitor your results @@ -151 +133 @@ The `jobs/<jobname>/<timestamp>` directory contains a subfolder with the output -## Saving your job results +## Save your results @@ -226 +208 @@ In this example, we have removed `wait_until_complete=True` to suppress verbose -## Saving and restarting hybrid jobs using checkpoints +## Using checkpoints @@ -290 +272 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Running a hybrid job with Amazon Braket Hybrid Jobs +Prerequisites @@ -292 +274 @@ Running a hybrid job with Amazon Braket Hybrid Jobs -Building and debugging a hybrid job with local mode +Run your local code as a hybrid job