AWS opensearch-service documentation change
Summary
Editorial updates including grammar corrections, terminology fixes (e.g., 'connection' to 'collection'), and instructional phrasing changes from first-person to second-person perspective.
Security assessment
The changes are purely editorial and grammatical (typo fixes, wording improvements). No security vulnerabilities, weaknesses, or incident responses are addressed. The existing security guidance (encryption policies, least privilege) remains unchanged.
Diff
diff --git a/opensearch-service/latest/developerguide/gsg-serverless-cli.md b/opensearch-service/latest/developerguide/gsg-serverless-cli.md index 59a5eec0e..afc99c650 100644 --- a//opensearch-service/latest/developerguide/gsg-serverless-cli.md +++ b//opensearch-service/latest/developerguide/gsg-serverless-cli.md @@ -9 +9 @@ -This tutorial walks you through the steps described in the [console getting started tutorial](./gsg-serverless.html) for security, but uses the AWS CLI rather than the OpenSearch Service console. +This tutorial covers the steps described in the [console getting started tutorial](./gsg-serverless.html) for security, but uses the AWS CLI rather than the OpenSearch Service console. @@ -11 +11 @@ This tutorial walks you through the steps described in the [console getting star -You'll complete the following steps in this tutorial: +You complete the following steps in this tutorial: @@ -15 +15 @@ You'll complete the following steps in this tutorial: - 2. Attatch the IAM policy to an IAM role + 2. Attach the IAM policy to an IAM role @@ -27 +27 @@ You'll complete the following steps in this tutorial: - 8. Upload data to your connection + 8. Upload data to your collection @@ -34 +34 @@ You'll complete the following steps in this tutorial: -The goal of this tutorial is to set up a single OpenSearch Serverless collection with fairly simple encryption, network, and data access settings. For example, we'll configure public network access, an AWS managed key for encryption, and a simplified data access policy that grants minimal permissions to a single user. +The goal of this tutorial is to set up a single OpenSearch Serverless collection with fairly simple encryption, network, and data access settings. For example, you configure public network access, an AWS managed key for encryption, and a simplified data access policy that grants minimal permissions to a single user. @@ -42 +42 @@ In a production scenario, consider implementing a more robust configuration, inc -You can skip this step if you're already using a more broad identity-based policy, such as `Action":"aoss:*"` or `Action":"*"`. In production environments, however, we recommend that you follow the principal of least privilege and only assign the minimum permissions necessary to complete a task. +You can skip this step if you're already using a more broad identity-based policy, such as `Action":"aoss:*"` or `Action":"*"`. In production environments, however, follow the principle of least privilege and only assign the minimum permissions necessary to complete a task. @@ -44 +44 @@ You can skip this step if you're already using a more broad identity-based polic -To start, create an AWS Identity and Access Management policy with the minimum required permissions to perform the steps in this tutorial. We'll name the policy `TutorialPolicy`: +To start, create an AWS Identity and Access Management policy with the minimum required permissions to perform the steps in this tutorial. Name the policy `TutorialPolicy`: @@ -67 +67 @@ To start, create an AWS Identity and Access Management policy with the minimum r - 2. Attach `TutorialPolicy` to the IAM role who will index and search data in the collection. We'll name the user `TutorialRole`: + 2. Attach `TutorialPolicy` to the IAM role who will index and search data in the collection. In this example, the role is named `TutorialRole`: @@ -73 +73 @@ To start, create an AWS Identity and Access Management policy with the minimum r - 3. Before you create a collection, you need to create an [encryption policy](./serverless-encryption.html) that assigns an AWS owned key to the _books_ collection that you'll create in a later step. + 3. Before you create a collection, you need to create an [encryption policy](./serverless-encryption.html) that assigns an AWS owned key to the _books_ collection that you create in a later step. @@ -229 +229 @@ Send the following request to create an encryption policy for the _books_ collec -You won't be able to see the collection endpoint until the collection status changes to `ACTIVE`. You might have to make multiple calls to check the status until the collection is successfully created. +The collection endpoint isn't available until the collection status changes to `ACTIVE`. You might need to make multiple calls to check the status until the collection is successfully created. @@ -231 +231 @@ You won't be able to see the collection endpoint until the collection status cha - 8. Use an HTTP tool such as [Postman](https://www.getpostman.com/) or curl to index data into the _books_ collection. We'll create an index called _books-index_ and add a single document. + 8. Use an HTTP tool such as [Postman](https://www.getpostman.com/) or curl to index data into the _books_ collection. The following example creates an index called _books-index_ and adds a single document.