# Amazon OpenSearch Service API

> Amazon OpenSearch Service API on Apizie: 54 endpoints (Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search…, Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value…, Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for…, Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:amazonaws-opensearch`
- Category: Cloud
- Status: byok
- Source: https://github.com/mermade/aws2openapi
- Page: https://zieapi.vercel.app/api/cloud/amazonaws-opensearch
- OpenAPI: https://zieapi.vercel.app/api/cloud/amazonaws-opensearch/openapi.json

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The…

## Endpoints

### Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/accept-inbound-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ConnectionId | string | yes | The ID of the inbound connection to accept. |

### Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/add-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/associate-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | Internal ID of the package to associate with a domain. Use DescribePackages to find this value. |
| DomainName | string | yes | Name of the domain to associate the package with. |

### Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/authorize-vpc-endpoint-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the OpenSearch Service domain to provide access to. |
| body | object | yes | JSON request body |

### Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/cancel-service-software-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/create-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/create-outbound-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/create-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-vpc-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| nextToken | string | no | If your initial ListVpcEndpoints operation returns a nextToken , you can include the returned nextToken in subsequent ListVpcEndpoints… |

### Creates an Amazon OpenSearch Service-managed VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/create-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain that you want information about. |

### Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain you want to permanently delete. |

### Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/delete-inbound-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ConnectionId | string | yes | The ID of the inbound connection to permanently delete. |

### Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/delete-outbound-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ConnectionId | string | yes | The ID of the outbound connection you want to permanently delete. |

### Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/delete-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | The internal ID of the package you want to delete. Use DescribePackages to find this value. |

### Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/delete-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| VpcEndpointId | string | yes | The unique identifier of the endpoint. |

### Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-domain-auto-tunes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | Name of the domain that you want Auto-Tune details about. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-domain-change-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain to get progress information for. |
| changeid | string | no | The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent… |

### Returns the configuration of an Amazon OpenSearch Service domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-domain-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | Name of the OpenSearch Service domain configuration that you want to describe. |

### Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.sl
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/update-domain-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain that you're updating. |
| body | object | yes | JSON request body |

### Returns information about domain and node health, the standby Availability Zone, number of nodes per…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-domain-health` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain. |

### Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes,…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-domain-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain. |

### Returns domain configuration information about the specified Amazon OpenSearch Service domains.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-dry-run-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain. |
| dryRunId | string | no | The unique identifier of the dry run. |
| loadDryRunConfig | boolean | no | Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make… |

### Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-inbound-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-instance-type-limits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| domainName | string | no | The name of the domain. Only specify if you need the limits for an existing domain. |
| InstanceType | string | yes | The OpenSearch Service instance type for which you need limit information. |
| EngineVersion | string | yes | Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. |

### Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-outbound-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-packages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |
| body | object | yes | JSON request body |

### Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-reserved-instance-offerings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| offeringId | string | no | The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified… |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial DescribeReservedInstanceOfferings operation returns a nextToken , you can include the returned nextToken in subsequent… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-reserved-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| reservationId | string | no | The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved… |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial DescribeReservedInstances operation returns a nextToken , you can include the returned nextToken in subsequent… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/describe-vpc-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/dissociate-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value. |
| DomainName | string | yes | Name of the domain to dissociate the package from. |

### Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/get-compatible-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| domainName | string | no | The name of an existing domain. Provide this parameter to limit the results to a single domain. |

### Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/get-package-version-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | The unique identifier of the package. |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial GetPackageVersionHistory operation returns a nextToken , you can include the returned nextToken in subsequent… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/get-upgrade-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of an existing domain. |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial GetUpgradeHistory operation returns a nextToken , you can include the returned nextToken in subsequent GetUpgradeHistory… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/get-upgrade-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The domain of the domain to get upgrade status information for. |

### Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-domain-names` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| engineType | string | no | Filters the output by domain engine type. |

### Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-domains-for-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| PackageID | string | yes | The unique identifier of the package for which to list associated domains. |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial ListDomainsForPackage operation returns a nextToken , you can include the returned nextToken in subsequent… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-instance-type-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| EngineVersion | string | yes | The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch. |
| domainName | string | no | The name of the domain. |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial ListInstanceTypeDetails operation returns a nextToken , you can include the returned nextToken in subsequent… |
| retrieveAZs | boolean | no | An optional parameter that specifies the Availability Zones for the domain. |
| instanceType | string | no | An optional parameter that lists information for a given instance type. |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-packages-for-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain for which you want to list associated packages. |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial ListPackagesForDomain operation returns a nextToken , you can include the returned nextToken in subsequent… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-scheduled-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain. |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial ListScheduledActions operation returns a nextToken , you can include the returned nextToken in subsequent… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| arn | string | yes | Amazon Resource Name (ARN) for the domain to view tags for. |

### Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| maxResults | integer | no | An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. |
| nextToken | string | no | If your initial ListVersions operation returns a nextToken , you can include the returned nextToken in subsequent ListVersions operations,… |
| MaxResults | string | no | Pagination limit |
| NextToken | string | no | Pagination token |

### Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon…
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-vpc-endpoint-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the OpenSearch Service domain to retrieve access information for. |
| nextToken | string | no | If your initial ListVpcEndpointAccess operation returns a nextToken , you can include the returned nextToken in subsequent… |

### Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
`GET https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/list-vpc-endpoints-for-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain to list associated VPC endpoints for. |
| nextToken | string | no | If your initial ListEndpointsForDomain operation returns a nextToken , you can include the returned nextToken in subsequent… |

### Allows you to purchase Amazon OpenSearch Service Reserved Instances.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/purchase-reserved-instance-offering` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/reject-inbound-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| ConnectionId | string | yes | The unique identifier of the inbound connection to reject. |

### Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/remove-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/revoke-vpc-endpoint-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the OpenSearch Service domain. |
| body | object | yes | JSON request body |

### Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/start-service-software-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/update-package` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Reschedules a planned domain configuration change for a later time. This change can be a scheduled service…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/update-scheduled-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| DomainName | string | yes | The name of the domain to reschedule an action for. |
| body | object | yes | JSON request body |

### Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/update-vpc-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

### Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check…
`POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/upgrade-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The AWS region |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/accept-inbound-connection" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Amazon OpenSearch Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:amazonaws-opensearch/accept-inbound-connection with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Amazon OpenSearch Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Amazon OpenSearch Service itself also needs your own key from amazonaws.com.

### Can AI agents use the Amazon OpenSearch Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:amazonaws-opensearch.

### What is the status of the Amazon OpenSearch Service API?
Needs your own provider key (bring your own key)