Add wait_for_completion to API documentation (#1328)
* updated incorrect links Signed-off-by: ariamarble <armarble@amazon.com> * update with wait for completion Signed-off-by: ariamarble <armarble@amazon.com> * made suggested change Signed-off-by: ariamarble <armarble@amazon.com> * made additional changes Signed-off-by: ariamarble <armarble@amazon.com> Signed-off-by: ariamarble <armarble@amazon.com>
This commit is contained in:
parent
1b69f700f8
commit
9d7592f400
|
@ -77,6 +77,7 @@ terminate_after | Integer | The maximum number of documents OpenSearch should pr
|
|||
timeout | Time | How long the operation should wait from a response from active shards. Default is `1m`.
|
||||
version | Boolean | Whether to include the document version as a match.
|
||||
wait_for_active_shards | String | The number of shards that must be active before OpenSearch executes the operation. Valid values are `all` or any integer up to the total number of shards in the index. Default is 1, which is the primary shard.
|
||||
wait_for_completion | boolean | When set to `false`, the response body includes a task ID and OpenSearch executes the operation asynchronously. The task ID can be used to check the status of the task or to cancel the task. Default is set to `true`.
|
||||
|
||||
## Request body
|
||||
|
||||
|
|
Loading…
Reference in New Issue