Skip to main content
AWS SigV4 is the only accepted auth mode for AWS OpenSearch Serverless collections (service aoss) and for AWS OpenSearch Service domains whose access policy references IAM principals. Every request is signed with the caller’s AWS credentials and region — the SigV4 service value differs between the two products, so pick the right one below.

Identify your AWS OpenSearch endpoint and product

There are two AWS-managed products with different endpoint URL shapes, IAM permissions, and SigV4 service values.

1

Copy the endpoint from the AWS console

Check the endpoint hostname:

  • AWS OpenSearch Service (Managed domain) — host ends in .es.amazonaws.com, e.g. search-mydomain-abc123.us-east-1.es.amazonaws.com. Signing service: es.
  • AWS OpenSearch Serverless (Collection) — host ends in .aoss.amazonaws.com, e.g. abcd1234.us-east-1.aoss.amazonaws.com. Signing service: aoss.
  • Reference: Making and signing OpenSearch Service requests.

Create an IAM user for the integration

SigV4 signing requires a long-term IAM user (or STS-issued temporary credentials via role assumption). Create a dedicated IAM user rather than reusing an admin’s keys.

1

Create the IAM user in the AWS Console

Sign in to the AWS IAM Console as an administrator, then:

  • Go to Users > Create user.
  • Enter a User name (e.g. stackone-opensearch) and click Next.
  • On Set permissions, attach the policy that matches your product (next step below), then click Next, review, and click Create user.
  • Reference: Create an IAM user in your AWS account.
2

Grant the access policy for your product

Which IAM policy the user needs depends on whether you’re connecting to a Managed domain or a Serverless collection.

  • OpenSearch Service (Managed) — attach AmazonOpenSearchServiceFullAccess (broad) or a scoped policy allowing es:ESHttp* on your domain ARN. Also ensure the domain access policy references the IAM user’s ARN — under Amazon OpenSearch Service > select domain > Actions > Edit security configuration, edit the resource-based access policy to allow the principal. Reference: Fine-grained access control.
  • OpenSearch Serverless — the user needs BOTH IAM permissions (aoss:APIAccessAll and aoss:DashboardsAccessAll on the collection ARN) AND a data-access policy granting collection/index permissions. Without both, requests return 403. Reference: Data access control for Amazon OpenSearch Serverless.
3

Add the user to a Serverless data-access policy

Data access policies are separate from IAM permissions and required for every Serverless collection.

  • Open the Amazon OpenSearch Service console. In the left nav pane, expand Serverless and under Security choose Data access policies.
  • Choose Create access policy. Provide a name and description, then a rule name (e.g. stackone-integration).
  • Choose Add principals and select the IAM user’s ARN.
  • Choose Grant and select the collection and index permissions the connector needs (for read-only datasync: aoss:DescribeCollectionItems, aoss:ReadDocument, aoss:DescribeIndex).
  • Choose Create. Enforcement may lag up to a minute.

Generate an access key pair

SigV4 signing needs an Access Key ID + Secret Access Key. Generate the pair from the user’s Security credentials tab.

1

Create the access key

In the IAM Console:

  • Open the user you just created, go to the Security credentials tab, and in the Access keys panel choose Create access key.
  • On the Access key best practices & alternatives screen, pick a use-case (Third-party service is appropriate for StackOne), acknowledge the recommendation checkbox, and click Next.
  • Add an optional description tag (e.g. stackone-integration) and click Create access key.
  • Copy the Access key (Access Key ID, format AKIAIOSFODNN7EXAMPLE) and the Secret access key (format wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY) immediately — the secret can only be retrieved at creation time. If you lose it, delete the key and create a new one.
  • Reference: Manage access keys for IAM users.
2

Configure temporary STS credentials as an alternative

For higher-security setups, use short-lived STS credentials from an assume-role or federated session.

  • Call sts:AssumeRole (or your identity federation flow) to obtain a temporary access key pair plus a Session Token.
  • Paste all three values into the corresponding StackOne fields (Access Key ID, Secret Access Key, AWS Session Token) — StackOne signs each request with all three.
  • Refresh the credentials before the STS expiry and update the connection — StackOne does not renew STS credentials automatically.

Test the credentials

A signed test call catches missing permissions or wrong signing service before configuring the connector.

1

Verify with a signed manual health check

Two convenient options:

  • curl (7.75+): curl --aws-sigv4 'aws:amz:{region}:{service}' -u '{accessKeyId}:{secretAccessKey}' https://{coreBaseUrl}/_cluster/health — set {service} to es or aoss to match your product.
  • awscurl: awscurl --service {service} --region {region} https://{coreBaseUrl}/_cluster/health.
  • 403 Forbidden on Serverless — you likely have IAM permissions but not a matching data-access policy. Re-check the data-access policy principals.
  • 403 Forbidden on Managed — the domain access policy does not reference this IAM principal. Edit the domain’s access policy to grant es:ESHttp* for this user.
  • Signature does not match — usually a wrong region or awsService value in the connection fields.

Enter credentials in StackOne Hub

Paste the values below into StackOne Hub to connect the account.

1

Fill in the connection fields

Copy each value from the IAM Console and the AWS OpenSearch console.

  • OpenSearch Endpoint URL — the HTTPS endpoint from step 1.
  • AWS Access Key ID — the Access Key ID from step 3.
  • AWS Secret Access Key — the Secret Access Key from step 3.
  • AWS Session Token — only for temporary STS credentials; leave blank for long-term IAM user access keys.
  • AWS Region — the region hosting the endpoint (e.g. us-east-1, eu-west-2).
  • AWS Servicees for AWS OpenSearch Service (Managed domain), aoss for AWS OpenSearch Serverless. This value is used as the SigV4 signing service and must match your endpoint host suffix.
  • OpenSearch Dashboards URL — optional. For Managed domains, the Dashboards URL is {coreBaseUrl}/_dashboards. For Serverless, the Dashboards URL is https://dashboards.{region}.aoss.amazonaws.com/_login/?collectionId={collection-id} (found on the collection’s detail page). Required only for dashboards_* actions.

Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • OpenSearch Endpoint URL
  • AWS Access Key ID
  • AWS Secret Access Key
  • AWS Session Token (Optional)
  • AWS Region
  • AWS Service
  • OpenSearch Dashboards URL (Optional)
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.