Configure Workflows on Amazon OpenSearch Serverless - Amazon OpenSearch Service

Configure Workflows on Amazon OpenSearch Serverless

Workflows

Workflows support builders in innovating AI applications on OpenSearch. The current process of using machine learning (ML) offerings in OpenSearch, such as Semantic Search, requires complex setup and pre-processing tasks, along with verbose user queries, both of which can be time-consuming and error-prone. Workflows are a simplification framework to chain multiple API calls for OpenSearch.

For setup and usage, see Automating configurations on the OpenSearch website. When you use Workflows in OpenSearch Serverless, consider these important differences:

  • OpenSearch Serverless uses only remote models in workflow steps. You don't need to deploy these models.

  • OpenSearch Serverless doesn't support the Re-index Workflow step.

  • When you search Workflows and Workflow states after other API calls, expect up to 15 seconds of latency for updates to appear.

OpenSearch Serverless Collections support Workflows when it's used as a data source in your OpenSearch UI application. For more information, see Managing data source associations.

Configure permissions

Before you create and provision a template, verify that you have the required permissions. If you need assistance, contact your account administrator. OpenSearch Serverless Workflows require the following permissions. You can scope permissions to a specific collection by defining the collection resource ARN in your IAM policy.

Example : Workflows policy
JSON
{ "Version": "2012-10-17", "Statement": [ { "Sid": "VisualEditor0", "Effect": "Allow", "Action": [ "aoss:CreateIndex", "aoss:CreateCollectionItems", "aoss:CreateMLResource", "aoss:DescribeCollectionItems", "aoss:UpdateCollectionItems", "aoss:DeleteIndex", "aoss:DeleteCollectionItems", "aoss:DeleteMLResource", "aoss:APIAccessAll", ], "Resource": "*" } ] }
  • aoss:*CollectionItems – Grants permission to create and manage templates, and provision search and ingest pipelines.

  • aoss:*Index – Grants permission to create and delete indices using OpenSearch API operations.

  • aoss:*MLResource – Grants permission to provision workflow steps that use the Configure Machine Learning.