Module Awso_opensearch_asyncSource

Sourceval add_tags : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_opensearch.Values.AddTagsRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval delete_direct_query_data_source : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_opensearch.Values.DeleteDirectQueryDataSourceRequest.t -> (unit, unit) Result.t Async.Deferred.t
Sourceval remove_tags : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_opensearch.Values.RemoveTagsRequest.t -> (unit, unit) Result.t Async.Deferred.t
include module type of struct include Awso_opensearch.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Integer that specifies the value of a maintenance schedule duration.

Sourcemodule OpenSearchPartitionInstanceType = Awso_opensearch.Values.OpenSearchPartitionInstanceType

The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

Configuration options for defining the setup of any node type within the cluster.

Limits that are applicable for the given Amazon OpenSearch Service storage type.

Sourcemodule NaturalLanguageQueryGenerationCurrentState = Awso_opensearch.Values.NaturalLanguageQueryGenerationCurrentState
Sourcemodule NaturalLanguageQueryGenerationDesiredState = Awso_opensearch.Values.NaturalLanguageQueryGenerationDesiredState

The SAML identity povider information.

This object is deprecated. Use the domain's off-peak window to schedule Auto-Tune optimizations. For migration instructions, see Migrating from Auto-Tune maintenance windows. The Auto-Tune maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.

Configuration settings for defining the node type within a cluster.

ARN of the Cloudwatch log group to publish logs to.

The desired start time for an off-peak maintenance window.

An Amazon Web Services Region, such as us-east-1.

Sourcemodule DirectQueryDataSourceRoleArn = Awso_opensearch.Values.DirectQueryDataSourceRoleArn

A string between 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the domain to which they're attached.

A string between 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

Maximum number of instances that can be instantiated for a given instance type.

Minimum number of instances that can be instantiated for a given instance type.

Sub-type of the given EBS storage type. List of available sub-storage options. The instance storage type has no storage sub-type. The ebs storage type has the following valid sub-types: standard gp2 gp3 io1

The type of storage that the domain uses. Can be one of the following: instance Built-in storage available for the instance. ebs Elastic Block Storage (EBS) attached to the instance.

The timestamp of the Auto-Tune action scheduled for the domain.

Sourcemodule ScheduledAutoTuneDescription = Awso_opensearch.Values.ScheduledAutoTuneDescription

The description of an Auto-Tune maintenance action that occurs on a domain.

Sourcemodule ScheduledAutoTuneSeverityType = Awso_opensearch.Values.ScheduledAutoTuneSeverityType
Sourcemodule NaturalLanguageQueryGenerationOptionsOutput = Awso_opensearch.Values.NaturalLanguageQueryGenerationOptionsOutput

Container for parameters representing the state of the natural language query generation feature on the specified domain.

Options for enabling S3 vectors engine features on the specified domain.

Sourcemodule ServerlessVectorAcceleration = Awso_opensearch.Values.ServerlessVectorAcceleration

Configuration for serverless vector acceleration, which provides GPU-accelerated vector search capabilities for improved performance on vector workloads.

Output parameters showing the current IAM identity federation configuration.

Describes the JWT options configured for the domain.

Describes the SAML application configured for the domain.

Sourcemodule AutoTuneMaintenanceScheduleList = Awso_opensearch.Values.AutoTuneMaintenanceScheduleList

Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.

Sourcemodule OpenSearchWarmPartitionInstanceType = Awso_opensearch.Values.OpenSearchWarmPartitionInstanceType

The zone awareness configuration for an Amazon OpenSearch Service domain.

The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.

Sourcemodule IdentityCenterApplicationARN = Awso_opensearch.Values.IdentityCenterApplicationARN

Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch. For more information, see Monitoring OpenSearch logs with Amazon CloudWatch Logs. After you enable log publishing, you still have to enable the collection of slow logs using the OpenSearch REST API.

A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain. These actions can include scheduled service software updates and blue/green Auto-Tune enhancements. OpenSearch Service will schedule these actions during the window that you specify. If you don't specify a window start time, it defaults to 10:00 P.M. local time. For more information, see Defining off-peak maintenance windows for Amazon OpenSearch Service.

The configuration parameters to enable access to the key store required by the package.

Sourcemodule CloudWatchDirectQueryDataSource = Awso_opensearch.Values.CloudWatchDirectQueryDataSource

Configuration details for a CloudWatch Logs data source that can be used for direct queries.

Sourcemodule PrometheusDirectQueryDataSource = Awso_opensearch.Values.PrometheusDirectQueryDataSource

Configuration details for a Prometheus data source that can be used for direct queries.

Sourcemodule SecurityLakeDirectQueryDataSource = Awso_opensearch.Values.SecurityLakeDirectQueryDataSource

Configuration details for a Security Lake data source that can be used for direct queries.

A tag (key-value pair) for an Amazon OpenSearch Service resource.

Information about the Amazon S3 Glue Data Catalog.

Represents a single step of an upgrade or upgrade eligibility check workflow.

Sourcemodule UncompressedPluginSizeInBytes = Awso_opensearch.Values.UncompressedPluginSizeInBytes

Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.

Sourcemodule CrossClusterSearchConnectionProperties = Awso_opensearch.Values.CrossClusterSearchConnectionProperties

Cross-cluster search specific connection properties.

Information about an Amazon OpenSearch Service domain.

Sourcemodule OutboundConnectionStatusCode = Awso_opensearch.Values.OutboundConnectionStatusCode

List of limits that are specific to a given instance type.

Limits on the number of instances that can be created in OpenSearch Service for a given instance type.

A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.

The domain endpoint to which index and search requests are submitted. For example, search-imdb-movies-oopcnjfn6ugo.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6u.eu-west-1.es.amazonaws.com.

Information about the domain properties that are currently being modified.

Sourcemodule DeploymentCloseDateTimeStamp = Awso_opensearch.Values.DeploymentCloseDateTimeStamp

Information about an Availability Zone on a domain.

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

Container for parameters representing the state of machine learning features on the specified domain.

Provides the current status of an entity.

Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB.

Container for fine-grained access control settings.

Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

The current status of Auto-Tune for the domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

Sourcemodule AutomatedSnapshotPauseOptions = Awso_opensearch.Values.AutomatedSnapshotPauseOptions

Specifies the automated snapshot pause options for the domain. These options allow you to temporarily pause automated snapshots for a specified time period.

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

Specifies the deployment strategy options for the domain.

Options to configure a custom endpoint for an OpenSearch Service domain.

Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use. Can only be used when creating a new domain or enabling encryption at rest for the first time on an existing domain. You can't modify this parameter after it's already been specified.

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.

Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

Options for configuring service software updates for a domain.

Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC). For more information, see Launching your Amazon OpenSearch Service domains using a VPC. This information only exists if the domain was created with VPCOptions.

A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.

Options for the service, such as the supported Regions.

Additional information if the package is in an error state. Null otherwise.

Sourcemodule PackageAssociationConfiguration = Awso_opensearch.Values.PackageAssociationConfiguration

The configuration for associating a package with a domain.

Sourcemodule DirectQueryDataSourceDescription = Awso_opensearch.Values.DirectQueryDataSourceDescription

The type of data source that is used for direct queries. This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake.

Sourcemodule DirectQueryOpenSearchARNList = Awso_opensearch.Values.DirectQueryOpenSearchARNList

The type of data source.

The configuration parameters for a package.

Basic information about the plugin.

Sourcemodule ReservedInstancePaymentOption = Awso_opensearch.Values.ReservedInstancePaymentOption

Encryption options for a package.

Configuration options for determining whether a package can be made available for use by other users.

Sourcemodule DescribePackagesFilterValues = Awso_opensearch.Values.DescribePackagesFilterValues

The connection properties of an outbound connection.

Container for information about an OpenSearch Service domain.

The status of an outbound cross-cluster connection.

Instance-related attributes that are available for a given instance type.

The status of an inbound cross-cluster connection for OpenSearch Service.

The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.

Container for information about a configuration change happening on a domain.

Unique identifier for an OpenSearch Service domain.

The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Progress details for each stage of a domain update.

Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

The status of machine learning options on the specified domain.

The configured access rules for the domain's search endpoint, and the current status of those rules.

Status of the advanced options for the specified domain. The following options are available: "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error. "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain. For more information, see Advanced cluster parameters.

Sourcemodule AdvancedSecurityOptionsStatus = Awso_opensearch.Values.AdvancedSecurityOptionsStatus

The status of fine-grained access control settings for a domain.

The Auto-Tune status for the domain.

Sourcemodule AutomatedSnapshotPauseOptionsStatus = Awso_opensearch.Values.AutomatedSnapshotPauseOptionsStatus

The status of automated snapshot pause options for the domain.

The cluster configuration status for a domain.

The status of the Cognito options for the specified domain.

Sourcemodule DeploymentStrategyOptionsStatus = Awso_opensearch.Values.DeploymentStrategyOptionsStatus

The status of deployment strategy options for the domain.

The configured endpoint options for a domain and their current status.

The status of the EBS options for the specified OpenSearch Service domain.

Sourcemodule EncryptionAtRestOptionsStatus = Awso_opensearch.Values.EncryptionAtRestOptionsStatus

Status of the encryption at rest options for the specified OpenSearch Service domain.

The IP address type status for the domain.

The status of IAM Identity Center configuration settings for a domain.

The configured log publishing options for the domain and their current status.

Sourcemodule NodeToNodeEncryptionOptionsStatus = Awso_opensearch.Values.NodeToNodeEncryptionOptionsStatus

Status of the node-to-node encryption options for the specified domain.

The status of off-peak window options for a domain.

Container for information about a daily automated snapshot for an OpenSearch Service domain.

The status of the service software options for a domain.

Status of the VPC options for a specified domain.

The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.

Sourcemodule NaturalLanguageQueryGenerationOptionsInput = Awso_opensearch.Values.NaturalLanguageQueryGenerationOptionsInput

Container for parameters required to enable the natural language query generation feature.

Input parameters for configuring IAM identity federation settings.

The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.

Credentials for the master user for a domain.

The SAML authentication configuration for an Amazon OpenSearch Service domain.

Configuration settings for an OpenSearch application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

Data sources that are associated with an OpenSearch application.

Configuration settings for AI-powered capabilities of an OpenSearch UI application.

Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

Information about an Amazon Web Services account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

Represents an insight returned by the ListInsights operation. An insight is a notification about a domain event or recommendation that helps you optimize your Amazon OpenSearch Service domain.

The value of the entity, such as a domain name or Amazon Web Services account ID.

Information about an OpenSearch Service domain.

Container for the domain maintenance details.

The configuration details for a data source that can be directly queried.

Details about a direct-query data source.

Basic details of an OpenSearch application.

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

Details about a package version.

A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

Information about a capability failure.

Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

Details of an OpenSearch Reserved Instance.

Details of an OpenSearch Reserved Instance offering.

Basic information about a package.

A filter to apply to the DescribePackage response.

Specifies details about an outbound cross-cluster connection.

A filter used to limit results when describing inbound or outbound cross-cluster connections. You can specify multiple values per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

Limits for a given instance type and for each of its roles.

Represents a field in the detailed view of an insight, returned by the DescribeInsightDetails operation.

Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.

The current status of an OpenSearch Service domain.

Container for information about nodes on the domain.

Information about the active domain environment.

Information about an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.

A property change that was cancelled for an Amazon OpenSearch Service domain.

Sourcemodule PackageDetailsForAssociation = Awso_opensearch.Values.PackageDetailsForAssociation

Details of a package that is associated with a domain.

An error occurred while processing the request.

An error occured because the client wanted to access an unsupported operation.

Request processing failed because of an unknown error, exception, or internal failure.

Sourcemodule ResourceAlreadyExistsException = Awso_opensearch.Values.ResourceAlreadyExistsException

An exception for creating a resource that already exists.

An exception for accessing or deleting a resource that doesn't exist.

An exception for accessing or deleting a resource that doesn't exist.

An error occurred because the client attempts to remove a resource that is currently in use.

Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

An exception for trying to create more than the allowed number of resources or sub-resources.

An exception for attempting to schedule a domain action during an unavailable time slot.

An error occurred because you don't have permissions to access the resource.

The Amazon S3 location to import the package from.

An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.

The request was denied due to request throttling. Reduce the frequency of your requests and try again.

Name of OpenSearch index to be created/updated/retrieved/deleted for customer's domain

Container for the configuration of an OpenSearch Service domain.

Information about the progress of a pre-upgrade dry run analysis.

Results of a dry run performed in an update domain request.

An exception for trying to create or access a sub-resource that's either invalid or not supported.

Container for parameters required to enable all machine learning features.

Sourcemodule AdvancedSecurityOptionsInput = Awso_opensearch.Values.AdvancedSecurityOptionsInput

Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.

Sourcemodule AutomatedSnapshotPauseRequestOptions = Awso_opensearch.Values.AutomatedSnapshotPauseRequestOptions

Specifies the automated snapshot pause request options for the domain. Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows. Maximum suspension duration: 3 days.

Configuration settings for enabling and managing IAM Identity Center.

Configuration settings for IAM Identity Center in an OpenSearch application.

Sourcemodule RollbackServiceSoftwareOptions = Awso_opensearch.Values.RollbackServiceSoftwareOptions

Details about the rollback options for a service software update.

Sourcemodule CapabilityBaseResponseConfig = Awso_opensearch.Values.CapabilityBaseResponseConfig

The base configuration returned for a registered capability.

The name of a capability. Must be between 3 and 30 characters and contain only alphanumeric characters and hyphens.

Sourcemodule ServiceQuotaExceededException = Awso_opensearch.Values.ServiceQuotaExceededException

An exception for when a request would cause a service quota to be exceeded.

The base configuration for registering a capability. Contains capability-specific configuration such as AI settings.

Number of instances in an OpenSearch Service cluster.

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

An optional parameter that specifies the maximum number of results to return for a given request.

Sourcemodule InvalidPaginationTokenException = Awso_opensearch.Values.InvalidPaginationTokenException

Request processing failed because you provided an invalid pagination token.

Specifies the entity for which to retrieve insights. An entity can be an Amazon OpenSearch Service domain or an Amazon Web Services account.

The maximum number of insights to return per page. Valid values are 1 to 500.

Specifies the time range for filtering insights.

Sourcemodule CapabilityExtendedResponseConfig = Awso_opensearch.Values.CapabilityExtendedResponseConfig

The extended configuration returned for a registered capability, including additional details beyond the base configuration.

Sourcemodule ReservedInstanceOfferingList = Awso_opensearch.Values.ReservedInstanceOfferingList

The progress details of a specific domain configuration change.

Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service

Sourcemodule IamIdentityCenterOptionsInput = Awso_opensearch.Values.IamIdentityCenterOptionsInput

Configuration settings for enabling and managing IAM Identity Center.

Sourcemodule PackageDetailsForAssociationList = Awso_opensearch.Values.PackageDetailsForAssociationList

Container for the response returned by UpgradeDomain operation.

Container for the request parameters to the UpgradeDomain operation.

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Sourcemodule UpdateScheduledActionResponse = Awso_opensearch.Values.UpdateScheduledActionResponse

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

Sourcemodule UpdateScheduledActionRequest = Awso_opensearch.Values.UpdateScheduledActionRequest

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

Container for the response returned by the UpdatePackage operation.

Container for request parameters to the UpdatePackage operation.

Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.

Updates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search settings for text fields. Changes to semantic enrichment configuration will apply to newly ingested documents.

The results of an UpdateDomain request. Contains the status of the domain being updated.

Container for the request parameters to the UpdateDomain operation.

Sourcemodule UpdateDirectQueryDataSourceResponse = Awso_opensearch.Values.UpdateDirectQueryDataSourceResponse

Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.

Sourcemodule UpdateDirectQueryDataSourceRequest = Awso_opensearch.Values.UpdateDirectQueryDataSourceRequest

Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.

The result of an UpdateDataSource operation.

Container for the parameters to the UpdateDataSource operation.

Updates the configuration and settings of an existing OpenSearch application.

Updates the configuration and settings of an existing OpenSearch application.

Sourcemodule StartServiceSoftwareUpdateResponse = Awso_opensearch.Values.StartServiceSoftwareUpdateResponse

Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.

Sourcemodule StartServiceSoftwareUpdateRequest = Awso_opensearch.Values.StartServiceSoftwareUpdateRequest

Container for the request parameters to the StartServiceSoftwareUpdate operation.

Sourcemodule StartDomainMaintenanceResponse = Awso_opensearch.Values.StartDomainMaintenanceResponse

The result of a StartDomainMaintenance request that information about the requested action.

Sourcemodule StartDomainMaintenanceRequest = Awso_opensearch.Values.StartDomainMaintenanceRequest

Container for the parameters to the StartDomainMaintenance operation.

Sourcemodule RollbackServiceSoftwareUpdateResponse = Awso_opensearch.Values.RollbackServiceSoftwareUpdateResponse

Contains details about the rolled-back service software update.

Sourcemodule RollbackServiceSoftwareUpdateRequest = Awso_opensearch.Values.RollbackServiceSoftwareUpdateRequest

Container for the request parameters to the RollbackServiceSoftwareUpdate operation.

Sourcemodule RevokeVpcEndpointAccessResponse = Awso_opensearch.Values.RevokeVpcEndpointAccessResponse

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Sourcemodule RevokeVpcEndpointAccessRequest = Awso_opensearch.Values.RevokeVpcEndpointAccessRequest

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Container for the request parameters to the RemoveTags operation.

Sourcemodule RejectInboundConnectionResponse = Awso_opensearch.Values.RejectInboundConnectionResponse

Represents the output of a RejectInboundConnection operation.

Sourcemodule RejectInboundConnectionRequest = Awso_opensearch.Values.RejectInboundConnectionRequest

Container for the request parameters to the RejectInboundConnection operation.

The result of a RegisterCapability request. Contains details about the registered capability.

Container for the parameters to the RegisterCapability operation.

Sourcemodule PutDefaultApplicationSettingResponse = Awso_opensearch.Values.PutDefaultApplicationSettingResponse

Sets the default application to the application with the specified ARN. To remove the default application, use the GetDefaultApplicationSetting operation to get the current default and then call the PutDefaultApplicationSetting with the current applications ARN and the setAsDefault parameter set to false.

Sourcemodule PutDefaultApplicationSettingRequest = Awso_opensearch.Values.PutDefaultApplicationSettingRequest

Sets the default application to the application with the specified ARN. To remove the default application, use the GetDefaultApplicationSetting operation to get the current default and then call the PutDefaultApplicationSetting with the current applications ARN and the setAsDefault parameter set to false.

Sourcemodule PurchaseReservedInstanceOfferingResponse = Awso_opensearch.Values.PurchaseReservedInstanceOfferingResponse

Represents the output of a PurchaseReservedInstanceOffering operation.

Sourcemodule PurchaseReservedInstanceOfferingRequest = Awso_opensearch.Values.PurchaseReservedInstanceOfferingRequest

Container for request parameters to the PurchaseReservedInstanceOffering operation.

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

Sourcemodule ListVpcEndpointsForDomainResponse = Awso_opensearch.Values.ListVpcEndpointsForDomainResponse

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Sourcemodule ListVpcEndpointsForDomainRequest = Awso_opensearch.Values.ListVpcEndpointsForDomainRequest

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Sourcemodule ListVpcEndpointAccessResponse = Awso_opensearch.Values.ListVpcEndpointAccessResponse

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Sourcemodule ListVpcEndpointAccessRequest = Awso_opensearch.Values.ListVpcEndpointAccessRequest

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Container for the parameters for response received from the ListVersions operation.

Container for the request parameters to the ListVersions operation.

The results of a ListTags operation.

Container for the parameters to the ListTags operation.

Sourcemodule ListScheduledActionsResponse = Awso_opensearch.Values.ListScheduledActionsResponse

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

Sourcemodule ListPackagesForDomainResponse = Awso_opensearch.Values.ListPackagesForDomainResponse

Container for the response parameters to the ListPackagesForDomain operation.

Sourcemodule ListPackagesForDomainRequest = Awso_opensearch.Values.ListPackagesForDomainRequest

Container for the request parameters to the ListPackagesForDomain operation.

Sourcemodule ListInstanceTypeDetailsResponse = Awso_opensearch.Values.ListInstanceTypeDetailsResponse

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

Sourcemodule ListInstanceTypeDetailsRequest = Awso_opensearch.Values.ListInstanceTypeDetailsRequest

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

The result of a ListInsights request. Contains the list of insights and a pagination token for retrieving the next page of results.

Container for the parameters to the ListInsights operation.

Sourcemodule ListDomainsForPackageResponse = Awso_opensearch.Values.ListDomainsForPackageResponse

Container for the response parameters to the ListDomainsForPackage operation.

Sourcemodule ListDomainsForPackageRequest = Awso_opensearch.Values.ListDomainsForPackageRequest

Container for the request parameters to the ListDomainsForPackage operation.

The results of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

Container for the parameters to the ListDomainNames operation.

Sourcemodule ListDomainMaintenancesResponse = Awso_opensearch.Values.ListDomainMaintenancesResponse

The result of a ListDomainMaintenances request that contains information about the requested actions.

Sourcemodule ListDomainMaintenancesRequest = Awso_opensearch.Values.ListDomainMaintenancesRequest

Container for the parameters to the ListDomainMaintenances operation.

Sourcemodule ListDirectQueryDataSourcesResponse = Awso_opensearch.Values.ListDirectQueryDataSourcesResponse

Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.

Sourcemodule ListDirectQueryDataSourcesRequest = Awso_opensearch.Values.ListDirectQueryDataSourcesRequest

Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.

The result of a ListDataSources operation.

Container for the parameters to the ListDataSources operation.

Lists all OpenSearch applications under your account.

Lists all OpenSearch applications under your account.

Container for the response returned by the GetUpgradeStatus operation.

Container for the request parameters to the GetUpgradeStatus operation.

Container for the response returned by the GetUpgradeHistory operation.

Container for the request parameters to the GetUpgradeHistory operation.

Sourcemodule GetPackageVersionHistoryResponse = Awso_opensearch.Values.GetPackageVersionHistoryResponse

Container for response returned by GetPackageVersionHistory operation.

Sourcemodule GetPackageVersionHistoryRequest = Awso_opensearch.Values.GetPackageVersionHistoryRequest

Container for the request parameters to the GetPackageVersionHistory operation.

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index structure and semantic search settings.

Sourcemodule GetDomainMaintenanceStatusResponse = Awso_opensearch.Values.GetDomainMaintenanceStatusResponse

The result of a GetDomainMaintenanceStatus request that information about the requested action.

Sourcemodule GetDomainMaintenanceStatusRequest = Awso_opensearch.Values.GetDomainMaintenanceStatusRequest

Container for the parameters to the GetDomainMaintenanceStatus operation.

Sourcemodule GetDirectQueryDataSourceResponse = Awso_opensearch.Values.GetDirectQueryDataSourceResponse

Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.

Sourcemodule GetDirectQueryDataSourceRequest = Awso_opensearch.Values.GetDirectQueryDataSourceRequest

Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.

Sourcemodule GetDefaultApplicationSettingResponse = Awso_opensearch.Values.GetDefaultApplicationSettingResponse

Gets the ARN of the current default application. If the default application isn't set, the operation returns a resource not found error.

Sourcemodule GetDefaultApplicationSettingRequest = Awso_opensearch.Values.GetDefaultApplicationSettingRequest

Gets the ARN of the current default application. If the default application isn't set, the operation returns a resource not found error.

The result of a GetDataSource operation.

Container for the parameters to the GetDataSource operation.

Sourcemodule GetCompatibleVersionsResponse = Awso_opensearch.Values.GetCompatibleVersionsResponse

Container for the response returned by the GetCompatibleVersions operation.

Sourcemodule GetCompatibleVersionsRequest = Awso_opensearch.Values.GetCompatibleVersionsRequest

Container for the request parameters to GetCompatibleVersions operation.

The result of a GetCapability request. Contains details about the capability.

Container for the parameters to the GetCapability operation.

Retrieves the configuration and status of an existing OpenSearch application.

Retrieves the configuration and status of an existing OpenSearch application.

Dissociates multiple packages from a domain simultaneously.

Dissociates multiple packages from a domain simultaneously.

Container for the response returned by an DissociatePackage operation.

Container for the request parameters to the DissociatePackage operation.

Sourcemodule DescribeVpcEndpointsResponse = Awso_opensearch.Values.DescribeVpcEndpointsResponse

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Sourcemodule DescribeReservedInstancesResponse = Awso_opensearch.Values.DescribeReservedInstancesResponse

Container for results from DescribeReservedInstances

Sourcemodule DescribeReservedInstancesRequest = Awso_opensearch.Values.DescribeReservedInstancesRequest

Container for the request parameters to the DescribeReservedInstances operation.

Sourcemodule DescribeReservedInstanceOfferingsResponse = Awso_opensearch.Values.DescribeReservedInstanceOfferingsResponse

Container for results of a DescribeReservedInstanceOfferings request.

Sourcemodule DescribeReservedInstanceOfferingsRequest = Awso_opensearch.Values.DescribeReservedInstanceOfferingsRequest

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

Container for the response returned by the DescribePackages operation.

Container for the request parameters to the DescribePackage operation.

Sourcemodule DescribeOutboundConnectionsResponse = Awso_opensearch.Values.DescribeOutboundConnectionsResponse

Contains a list of connections matching the filter criteria.

Sourcemodule DescribeOutboundConnectionsRequest = Awso_opensearch.Values.DescribeOutboundConnectionsRequest

Container for the parameters to the DescribeOutboundConnections operation.

Sourcemodule DescribeInstanceTypeLimitsResponse = Awso_opensearch.Values.DescribeInstanceTypeLimitsResponse

Container for the parameters received from the DescribeInstanceTypeLimits operation.

Sourcemodule DescribeInstanceTypeLimitsRequest = Awso_opensearch.Values.DescribeInstanceTypeLimitsRequest

Container for the parameters to the DescribeInstanceTypeLimits operation.

Sourcemodule DescribeInsightDetailsResponse = Awso_opensearch.Values.DescribeInsightDetailsResponse

The result of a DescribeInsightDetails request. Contains the detailed fields associated with the specified insight.

Sourcemodule DescribeInsightDetailsRequest = Awso_opensearch.Values.DescribeInsightDetailsRequest

Container for the parameters to the DescribeInsightDetails operation.

Sourcemodule DescribeInboundConnectionsResponse = Awso_opensearch.Values.DescribeInboundConnectionsResponse

Contains a list of connections matching the filter criteria.

Sourcemodule DescribeInboundConnectionsRequest = Awso_opensearch.Values.DescribeInboundConnectionsRequest

Container for the parameters to the DescribeInboundConnections operation.

Sourcemodule DescribeDryRunProgressResponse = Awso_opensearch.Values.DescribeDryRunProgressResponse

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

Sourcemodule DescribeDryRunProgressRequest = Awso_opensearch.Values.DescribeDryRunProgressRequest

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

Contains the status of the specified domains or all domains owned by the account.

Container for the parameters to the DescribeDomains operation.

Contains the status of the domain specified in the request.

Container for the parameters to the DescribeDomain operation.

The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.

Container for the parameters to the DescribeDomainNodes operation.

Sourcemodule DescribeDomainHealthResponse = Awso_opensearch.Values.DescribeDomainHealthResponse

The result of a DescribeDomainHealth request. Contains health information for the requested domain.

Container for the parameters to the DescribeDomainHealth operation.

Sourcemodule DescribeDomainConfigResponse = Awso_opensearch.Values.DescribeDomainConfigResponse

Contains the configuration information of the requested domain.

Container for the parameters to the DescribeDomainConfig operation.

Sourcemodule DescribeDomainChangeProgressResponse = Awso_opensearch.Values.DescribeDomainChangeProgressResponse

The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.

Sourcemodule DescribeDomainChangeProgressRequest = Awso_opensearch.Values.DescribeDomainChangeProgressRequest

Container for the parameters to the DescribeDomainChangeProgress operation.

Sourcemodule DescribeDomainAutoTunesResponse = Awso_opensearch.Values.DescribeDomainAutoTunesResponse

The result of a DescribeDomainAutoTunes request.

Sourcemodule DescribeDomainAutoTunesRequest = Awso_opensearch.Values.DescribeDomainAutoTunesRequest

Container for the parameters to the DescribeDomainAutoTunes operation.

Sourcemodule DeregisterCapabilityResponse = Awso_opensearch.Values.DeregisterCapabilityResponse

The result of a DeregisterCapability request.

Container for the parameters to the DeregisterCapability operation.

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Container for the response parameters to the DeletePackage operation.

Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.

Sourcemodule DeleteOutboundConnectionResponse = Awso_opensearch.Values.DeleteOutboundConnectionResponse

Details about the deleted outbound connection.

Sourcemodule DeleteOutboundConnectionRequest = Awso_opensearch.Values.DeleteOutboundConnectionRequest

Container for the parameters to the DeleteOutboundConnection operation.

Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone.

Deletes an OpenSearch index. This operation permanently removes the index and cannot be undone.

Sourcemodule DeleteInboundConnectionResponse = Awso_opensearch.Values.DeleteInboundConnectionResponse

The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.

Sourcemodule DeleteInboundConnectionRequest = Awso_opensearch.Values.DeleteInboundConnectionRequest

Container for the parameters to the DeleteInboundConnection operation.

The results of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

Container for the parameters to the DeleteDomain operation.

Sourcemodule DeleteDirectQueryDataSourceRequest = Awso_opensearch.Values.DeleteDirectQueryDataSourceRequest

Deletes a previously configured direct query data source from Amazon OpenSearch Service.

The result of a GetDataSource operation.

Container for the parameters to the DeleteDataSource operation.

Deletes a specified OpenSearch application.

Deletes a specified OpenSearch application.

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Container for the response returned by the CreatePackage operation.

Container for request parameters to the CreatePackage operation.

Sourcemodule CreateOutboundConnectionResponse = Awso_opensearch.Values.CreateOutboundConnectionResponse

The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.

Sourcemodule CreateOutboundConnectionRequest = Awso_opensearch.Values.CreateOutboundConnectionRequest

Container for the parameters to the CreateOutboundConnection operation.

Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual meaning beyond keyword matching. The semantic enrichment process has zero impact on search latency as sparse encodings are stored directly within the index during indexing. For more information, see Automatic semantic enrichment.

Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search capabilities without requiring machine learning expertise, improving search relevance by up to 20% by understanding search intent and contextual meaning beyond keyword matching. The semantic enrichment process has zero impact on search latency as sparse encodings are stored directly within the index during indexing. For more information, see Automatic semantic enrichment.

The result of a CreateDomain operation. Contains the status of the newly created domain.

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

Sourcemodule CancelServiceSoftwareUpdateResponse = Awso_opensearch.Values.CancelServiceSoftwareUpdateResponse

Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.

Sourcemodule CancelServiceSoftwareUpdateRequest = Awso_opensearch.Values.CancelServiceSoftwareUpdateRequest

Container for the request parameters to cancel a service software update.

Sourcemodule CancelDomainConfigChangeResponse = Awso_opensearch.Values.CancelDomainConfigChangeResponse

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Sourcemodule CancelDomainConfigChangeRequest = Awso_opensearch.Values.CancelDomainConfigChangeRequest

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Sourcemodule AuthorizeVpcEndpointAccessResponse = Awso_opensearch.Values.AuthorizeVpcEndpointAccessResponse

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Sourcemodule AuthorizeVpcEndpointAccessRequest = Awso_opensearch.Values.AuthorizeVpcEndpointAccessRequest

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

Container for the response returned by the AssociatePackage operation.

Container for the request parameters to the AssociatePackage operation.

Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain, data source, or application.

Sourcemodule AddDirectQueryDataSourceResponse = Awso_opensearch.Values.AddDirectQueryDataSourceResponse

Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.

Sourcemodule AddDirectQueryDataSourceRequest = Awso_opensearch.Values.AddDirectQueryDataSourceRequest

Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.

The result of an AddDataSource operation.

Container for the parameters to the AddDataSource operation.

Sourcemodule AcceptInboundConnectionResponse = Awso_opensearch.Values.AcceptInboundConnectionResponse

Contains details about the accepted inbound connection.

Sourcemodule AcceptInboundConnectionRequest = Awso_opensearch.Values.AcceptInboundConnectionRequest

Container for the parameters to the AcceptInboundConnection operation.

Sourcemodule Cli : sig ... end