AWS opensearch-service documentation change
Summary
Restructured documentation for clarity, updated terminology from 'indices' to 'indexes', added console-based procedures for snapshot management, and revised example values in CLI commands/IAM policies to use generic placeholders.
Security assessment
The changes focus on improving documentation structure, terminology consistency, and example standardization. While IAM policy examples were updated, there is no evidence of addressing a specific security vulnerability or weakness. The modifications to snapshot restoration warnings (e.g., UUID changes, restore limitations) are existing security considerations being clarified rather than new security content.
Diff
diff --git a/opensearch-service/latest/developerguide/serverless-snapshots.md b/opensearch-service/latest/developerguide/serverless-snapshots.md index 04cb9e6e4..09ebd28f0 100644 --- a//opensearch-service/latest/developerguide/serverless-snapshots.md +++ b//opensearch-service/latest/developerguide/serverless-snapshots.md @@ -9,42 +9 @@ Required permissionsWorking with snapshotsRestoring from a snapshot -Snapshots are point-in-time backups of your Amazon OpenSearch Serverless collections that provide disaster recovery capabilities. OpenSearch Serverless automatically creates and manages snapshots of your collections, ensuring business continuity and data protection. Each snapshot contains: - - * Index metadata: Settings and mappings for your indices - - * Cluster metadata: Index templates and aliases - - * Index data: All documents and data stored in your indices - - - - -**Key benefits** - - * Automatic hourly backups with no manual configuration required - - * Zero maintenance overhead - - * No additional storage costs - - * Quick recovery from accidental data loss - - * Ability to restore specific indices from a snapshot - - - - -**Important considerations** - - * Creating a snapshot isn't instantaneous and requires time to complete. - - * New documents or updates during snapshot creation might not be included in the snapshot. - - * You can restore snapshots only to their original collection and not to a new one. - - * When restored, indices receive new UUIDs that differ from their original versions. - - * You can run only one restore operation at a time. - - * You can't start multiple restore operations on the same collection at the same time. Attempting to restore indices during an active restore operation causes the operation to fail. - - * During a restore operation, your requests to the indices fail. - +Snapshots are point-in-time backups of your Amazon OpenSearch Serverless collections that provide disaster recovery capabilities. OpenSearch Serverless automatically creates and manages snapshots of your collections, ensuring business continuity and data protection. Each snapshot contains index metadata (settings and mappings for your indexes), cluster metadata (index templates and aliases), and index data (all documents and data stored in your indexes). @@ -51,0 +11 @@ Snapshots are point-in-time backups of your Amazon OpenSearch Serverless collect +OpenSearch Serverless provides automatic hourly backups with no manual configuration, zero maintenance overhead, no additional storage costs, quick recovery from accidental data loss, and the ability to restore specific indexes from a snapshot. @@ -52,0 +13 @@ Snapshots are point-in-time backups of your Amazon OpenSearch Serverless collect +Before working with snapshots, understand these important considerations. Creating a snapshot takes time to complete and isn't instantaneous. New documents or updates during snapshot creation will not be included in the snapshot. You can restore snapshots only to their original collection and not to a new one. When restored, indexes receive new UUIDs that differ from their original versions. You can run only one restore operation at a time, and you can't start multiple restore operations on the same collection simultaneously. Attempting to restore indexes during an active restore operation causes the operation to fail. During a restore operation, your requests to the indexes fail. @@ -60,2 +21,2 @@ Data Access Policy | APIs -aoss:DescribeSnapshot | GET /_cat/snapshotsGET /_cat/snapshots/aoss-automated/GET _snapshot/aoss-automated/`snapshot`/ -aoss:RestoreSnapshot | POST /_snapshot/aoss-automated/`snapshot`/_restore +aoss:DescribeSnapshot | GET /_cat/snapshots/aoss-automatedGET _snapshot/aoss-automated/snapshot/ +aoss:RestoreSnapshot | POST /_snapshot/aoss-automated/snapshot/_restore @@ -77 +38 @@ You can configure policies using the following AWS CLI commands: -Here is a sample CLI command for creating an access policy: +Here is a sample CLI command for creating an access policy. In the command, replace the `example` content with your specific information. @@ -82,2 +43,2 @@ Here is a sample CLI command for creating an access policy: - --name AWSExample-data-access-policy \ - --region us-west-2 \ + --name Example-data-access-policy \ + --region aws-region \ @@ -89 +50 @@ Here is a sample CLI command for creating an access policy: - "collection/AWSExample-collection" + "collection/Example-collection" @@ -100 +61 @@ Here is a sample CLI command for creating an access policy: - "arn:aws:iam::AWSExample-account-ID:user/AWSExample-user" + "arn:aws:iam::111122223333:user/UserName" @@ -108 +69,25 @@ Here is a sample CLI command for creating an access policy: -By default, when you create a new collection, OpenSearch Serverless automatically creates snapshots every hour. No action is required on your part. Each snapshot includes all indices in the collection. After OpenSearch Serverless creates snapshots, you can list them and view the details of the snapshot using the following commands. +By default, when you create a new collection, OpenSearch Serverless automatically creates snapshots every hour. You don't need to take any action. Each snapshot includes all indexes in the collection. After OpenSearch Serverless creates snapshots, you can list them and review the details of the snapshot using the following procedures. + +### List snapshots + +Use the following procedures to list all snapshots in a collection and review their details. + +Console + + + 1. Open the Amazon OpenSearch Service console at [https://console.aws.amazon.com/aos/](https://console.aws.amazon.com/aos/). + + 2. In the left navigation pane, choose **Serverless** , then choose **Collections**. + + 3. Choose the name of your collection to open its details page. + + 4. Choose the **Snapshots** tab to display all generated snapshots. + + 5. Review the snapshot information including: + + * **Snapshot ID** \- Unique identifier for the snapshot + + * **Status** \- Current state (Available, In Progress) + + * **Created time** \- When the snapshot was taken + @@ -110 +94,0 @@ By default, when you create a new collection, OpenSearch Serverless automaticall -**Listing snapshots** @@ -112 +95,0 @@ By default, when you create a new collection, OpenSearch Serverless automaticall -Use the following command to list all snapshots in a collection: @@ -113,0 +97 @@ Use the following command to list all snapshots in a collection: +AWS CLI @@ -115 +99,4 @@ Use the following command to list all snapshots in a collection: - GET /_cat/snapshots/aoss-automated/ + + * Use the following command to list all snapshots in a collection: + + GET /_cat/snapshots/aoss-automated @@ -118,0 +106,5 @@ OpenSearch Serverless returns a response like the following: + id status start_epoch start_time end_epoch end_time duration indexes successful_shards failed_shards total_shards + snapshot-ExampleSnapshotID1 SUCCESS 1737964331 07:52:11 1737964382 07:53:02 50.4s 1 + snapshot-ExampleSnapshotID2 SUCCESS 1737967931 08:52:11 1737967979 08:52:59 47.7s 2 + snapshot-ExampleSnapshotID3 SUCCESS 1737971531 09:52:11 1737971581 09:53:01 49.1s 3 + snapshot-ExampleSnapshotID4 IN_PROGRESS 1737975131 10:52:11 - - 4.8d 3 @@ -120,5 +111,0 @@ OpenSearch Serverless returns a response like the following: - id status start_epoch start_time end_epoch end_time duration indices successful_shards failed_shards total_shards - snapshot-AWSExampleSnapshotID1 SUCCESS 1737964331 07:52:11 1737964382 07:53:02 50.4s 1 - snapshot-AWSExampleSnapshotID2 SUCCESS 1737967931 08:52:11 1737967979 08:52:59 47.7s 2 - snapshot-AWSExampleSnapshotID3 SUCCESS 1737971531 09:52:11 1737971581 09:53:01 49.1s 3 - snapshot-AWSExampleSnapshotID4 IN_PROGRESS 1737975131 10:52:11 - - 4.8d 3 @@ -126 +112,0 @@ OpenSearch Serverless returns a response like the following: -**Get snapshots** @@ -128 +113,0 @@ OpenSearch Serverless returns a response like the following: -Retrieves information about a snapshot. @@ -129,0 +115 @@ Retrieves information about a snapshot. +### Get snapshot details @@ -131 +117,14 @@ Retrieves information about a snapshot. - GET _snapshot/aoss-automated/snapshot/ +Use the following procedures to retrieve detailed information about a specific snapshot. + +Console + + + 1. Open the Amazon OpenSearch Service console at [https://console.aws.amazon.com/aos/](https://console.aws.amazon.com/aos/). + + 2. In the left navigation pane, choose **Serverless** , then choose **Collections**. + + 3. Choose the name of your collection to open its details page. + + 4. Choose the **Snapshots** tab. + + 5. Choose the snapshot job ID to display detailed information about the snapshot, including metadata, indexes included, and timing information. @@ -133 +131,0 @@ Retrieves information about a snapshot. -Example Request @@ -136 +133,0 @@ Example Request - GET _snapshot/aoss-automated/snapshot-AWSExampleSnapshotID1/ @@ -138 +135 @@ Example Request -Example Response +AWS CLI @@ -140,0 +138,10 @@ Example Response + * Use the following command to retrieve information about a snapshot. In the command, replace the `example` content with your specific information. + + GET _snapshot/aoss-automated/snapshot/ + +Example Request: + + GET _snapshot/aoss-automated/snapshot-ExampleSnapshotID1/ + +Example Response: + @@ -144,2 +151,2 @@ Example Response - "snapshot": "snapshot-AWSExampleSnapshotID1-5e01-4423-9833Example", - "uuid": "AWSExample-5e01-4423-9833-9e9eb757Example", + "snapshot": "snapshot-ExampleSnapshotID1-5e01-4423-9833Example", + "uuid": "Example-5e01-4423-9833-9e9eb757Example", @@ -149,2 +156,2 @@ Example Response - "indices": [ - "AWSExample-index-0117" + "indexes": [ + "Example-index-0117" @@ -171 +177,0 @@ Example Response -**Understanding snapshot response fields** @@ -173 +178,0 @@ Example Response -**id** @@ -176 +181,3 @@ Example Response -A unique identifier for the snapshot operation. +The snapshot response includes several key fields: `id` provides a unique identifier for the snapshot operation, `status` returns the current state `SUCCESS` or `IN_PROGRESS`, `duration` indicates the time taken to complete the snapshot operation, and `indexes` returns the number of indexes included in the snapshot. + +## Restoring from a snapshot @@ -178 +185 @@ A unique identifier for the snapshot operation. -**status** +Restoring from a snapshot recovers data from a previously taken backup. This process is crucial for disaster recovery and data management in OpenSearch Serverless. Before restoring, understand that restored indexes will have different UUIDs than their original versions, snapshots can only be restored to their original collection (cross-collection restoration is not supported), and restore operations will impact cluster performance so plan accordingly. @@ -179,0 +187 @@ A unique identifier for the snapshot operation. +Use the following procedures to restore backed up indexes from a snapshot. @@ -181 +189 @@ A unique identifier for the snapshot operation. -The current state of the snapshot operation. Possible values include: +Console @@ -183 +190,0 @@ The current state of the snapshot operation. Possible values include: - * `SUCCESS` @@ -185 +192 @@ The current state of the snapshot operation. Possible values include: - * `IN_PROGRESS` + 1. Open the Amazon OpenSearch Service console at [https://console.aws.amazon.com/aos/](https://console.aws.amazon.com/aos/). @@ -186,0 +194 @@ The current state of the snapshot operation. Possible values include: + 2. In the left navigation pane, choose **Serverless** , then choose **Collections**. @@ -187,0 +196 @@ The current state of the snapshot operation. Possible values include: + 3. Choose the name of your collection to open its details page. @@ -188,0 +198 @@ The current state of the snapshot operation. Possible values include: + 4. Choose the **Snapshots** tab to display available snapshots.