AWS opensearch-service documentation change
Summary
Updated service software rollback documentation with new date restriction, clarified conditions, and added detailed API response messages
Security assessment
The changes document feature limitations and API behavior for service software rollbacks, including a new date restriction (April 24, 2026) and clarification that rollback is not available for updates applied during service-initiated maintenance operations. While rollback features can have security implications for vulnerability management, there is no evidence in the diff that these changes address a specific security vulnerability or weakness.
Diff
diff --git a/opensearch-service/latest/developerguide/service-software.md b/opensearch-service/latest/developerguide/service-software.md index c6b8884b8..beb9436da 100644 --- a//opensearch-service/latest/developerguide/service-software.md +++ b//opensearch-service/latest/developerguide/service-software.md @@ -256 +256 @@ Amazon OpenSearch Service supports rolling back service software updates. You ca -Rollback is supported only for service software updates. Engine version upgrades cannot be rolled back. +Rollback is supported only for service software updates applied on or after April 24, 2026\. Engine version upgrades cannot be rolled back. @@ -276 +276,5 @@ Your domain must meet all of the following conditions for a rollback to be avail - * **Software update was not applied with configuration changes in the same blue/green deployment** – If the setting `UseLatestServiceSoftwareForBlueGreen` is enabled, OpenSearch Service applies the latest available software update along with configuration changes submitted during an update domain configuration operation. Software updates that are applied along with configuration changes in the same blue/green deployment cannot be rolled back. You have the option to disable the `UseLatestServiceSoftwareForBlueGreen` setting. + * **Software update was explicitly initiated** – Rollback is only available when the software update was explicitly initiated by you or automatically scheduled by OpenSearch Service as part of a mandatory or optional update. Rollback is not available when: + + * The software update was applied during a blue/green deployment triggered by a configuration change. This includes cases where the `UseLatestServiceSoftwareForBlueGreen` setting is enabled, which bundles the latest software update with configuration changes. You have the option to disable this setting. + + * The update was applied during a service-initiated maintenance operation on your domain, such as infrastructure recovery, automated remediation, or other internal operations performed by OpenSearch Service to maintain the health and availability of your domain. @@ -340 +344,16 @@ Error | Description -#### Example responses +#### Response messages + +The following table describes the possible response messages returned by the `RollbackServiceSoftwareUpdate` API. + +Case | Description +---|--- +Success | Rollback initiated successfully. The domain will be rolled back from `current-version` to `previous-version`. +Feature not enabled | Rollback is not available. Contact [Support](https://console.aws.amazon.com/support/home) for assistance. +Previous software not available | No previous software version available for rollback. Contact [Support](https://console.aws.amazon.com/support/home) for assistance. +Previous software is same as current | Rollback is not available. No previous software version available for rollback. Contact [Support](https://console.aws.amazon.com/support/home) for assistance. +Domain is already rolled back | Domain is already in a rolled-back state. +Cluster is on pinned software version | Software override is currently applied to the domain. +Outside the time window | Rollback is not available. The 15-day rollback window has expired. Contact [Support](https://console.aws.amazon.com/support/home) for assistance. +Mandatory service update auto-applied | Rollback is not available. The current version was applied through a mandatory service update. Contact [Support](https://console.aws.amazon.com/support/home) for assistance. +Engine version upgrade | Rollback is not available. Engine version upgrades are irreversible. Contact [Support](https://console.aws.amazon.com/support/home) for assistance. +Configuration changed after update | Rollback is not available. Cluster configuration has changed since last software update. Contact [Support](https://console.aws.amazon.com/support/home) for assistance. @@ -342 +361 @@ Error | Description -**Rollback initiated successfully:** +**Example response:** @@ -354,47 +373 @@ Error | Description -**Rollback unavailable, outside the time window:** - - - { - "RollbackServiceSoftwareOptions": { - "CurrentVersion": "OpenSearch_2_11_R20240115", - "NewVersion": null, - "RollbackAvailable": false, - "Description": "Rollback is not available. The 15-day rollback window has expired. Please contact AWS Support for assistance." - } - } - -**Rollback unavailable, mandatory update auto-applied by service:** - - - { - "RollbackServiceSoftwareOptions": { - "CurrentVersion": "OpenSearch_2_11_R20240215", - "NewVersion": null, - "RollbackAvailable": false, - "Description": "Rollback is not available. The current version was applied through a mandatory service update. Please contact AWS Support for assistance." - } - } - -**Rollback unavailable, engine version upgrade:** - - - { - "RollbackServiceSoftwareOptions": { - "CurrentVersion": "OpenSearch_2_11_R20240215", - "NewVersion": null, - "RollbackAvailable": false, - "Description": "Rollback is not available. Engine version upgrades are irreversible. Please contact AWS Support for assistance." - } - } - -**Rollback unavailable, domain already in rolled-back state:** - - - { - "RollbackServiceSoftwareOptions": { - "CurrentVersion": "OpenSearch_2_11_R20231023", - "NewVersion": null, - "RollbackAvailable": false, - "Description": "Domain is already in a rolled-back state." - } - } +When rollback is not available, `RollbackAvailable` returns `false` and the `Description` field contains the reason from the table above.