This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

ISM error prevention

Error prevention validates Index State Management (ISM) actions before they are performed in order to prevent actions from failing. It also outputs additional information from the action validation results in the response of the Index Explain API. Validation rules and troubleshooting of each action are listed in the following sections.

---

Table of contents

1. rollover
2. delete
3. force_merge
4. replica_count
5. open
6. read_only
7. read_write
8. close
9. index_priority
10. snapshot
11. transition

---

rollover

ISM does not perform a rollover action for an index under any of these conditions:

• The index is not the write index.
• The index does not have an alias.
• The rollover policy does not contain a rollover_alias index setting.
• Skipping of a rollover action has occured.
• The index has already been rolled over using the alias successfully.

delete

ISM does not perform a delete action for an index under any of these conditions:

• The index does not exist.
• The index name is invalid.
• The index is the write index for a data stream.

force_merge

ISM does not perform a force_merge action for an index if its dataset is too large and exceeds the threshold.

replica_count

ISM does not perform a replica_count action for an index under any of these conditions:

• The amount of data exceeds the threshold.
• The number of shards exceeds the maximum.

open

ISM does not perform an open action for an index under any of these conditions:

• The index is blocked.
• The number of shards exceeds the maximum.

read_only

ISM does not perform a read_only action for an index under any of these conditions:

• The index is blocked.
• The amount of data exceeds the threshold.

read_write

ISM does not perform a read_write action for an index if the index is blocked.

close

ISM does not perform a close action for an index under any of these conditions:

• The index does not exist.
• The index name is invalid.

index_priority

ISM does not perform an index_priority action for an index that does not have read-only-allow-delete permission.

snapshot

ISM does not perform a snapshot action for an index under any of these conditions:

• The index does not exist.
• The index name is invalid.

transition

ISM does not perform a transition action for an index under any of these conditions:

• The index does not exist.
• The index name is invalid.