Module Awso_opensearch.ValuesSource

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 ]
Sourcemodule LimitValue : sig ... end
Sourcemodule DurationValue : sig ... end

Integer that specifies the value of a maintenance schedule duration.

Sourcemodule TimeUnit : sig ... end
Sourcemodule Boolean : sig ... end
Sourcemodule IntegerClass : sig ... end
Sourcemodule LimitName : sig ... end
Sourcemodule LimitValueList : sig ... end
Sourcemodule SAMLEntityId : sig ... end
Sourcemodule SAMLMetadata : sig ... end
Sourcemodule Duration : sig ... end

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

Sourcemodule StartAt : sig ... end
Sourcemodule String_ : sig ... end
Sourcemodule NodeConfig : sig ... end

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

Sourcemodule NodeOptionsNodeType : sig ... end
Sourcemodule StartTimeHours : sig ... end
Sourcemodule StartTimeMinutes : sig ... end
Sourcemodule Issue : sig ... end
Sourcemodule StorageTypeLimit : sig ... end

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

Sourcemodule IAMFederationRolesKey : sig ... end
Sourcemodule IAMFederationSubjectKey : sig ... end
Sourcemodule JwksUrl : sig ... end
Sourcemodule SAMLIdp : sig ... end

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.

Sourcemodule NodeOption : sig ... end

Configuration settings for defining the node type within a cluster.

Sourcemodule CloudWatchLogsLogGroupArn : sig ... end

ARN of the Cloudwatch log group to publish logs to.

Sourcemodule WindowStartTime : sig ... end

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

Sourcemodule Region : sig ... end

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

Sourcemodule RoleArn : sig ... end
Sourcemodule AMPWorkspaceArn : sig ... end
Sourcemodule TagKey : sig ... end

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.

Sourcemodule TagValue : sig ... end

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.

Sourcemodule Double : sig ... end
Sourcemodule Issues : sig ... end
Sourcemodule UpgradeStatus : sig ... end
Sourcemodule UpgradeStep : sig ... end
Sourcemodule SkipUnavailableStatus : sig ... end
Sourcemodule DomainName : sig ... end

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

Sourcemodule OwnerId : sig ... end
Sourcemodule MaximumInstanceCount : sig ... end

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

Sourcemodule MinimumInstanceCount : sig ... end

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

Sourcemodule StorageSubTypeName : sig ... end

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

Sourcemodule StorageTypeLimitList : sig ... end
Sourcemodule StorageTypeName : sig ... end

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.

Sourcemodule PropertyValueType : sig ... end
Sourcemodule AvailabilityZone : sig ... end
Sourcemodule NumberOfNodes : sig ... end
Sourcemodule NumberOfShards : sig ... end
Sourcemodule ZoneStatus : sig ... end
Sourcemodule AutoTuneDate : sig ... end

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

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

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

Sourcemodule S3VectorsEngine : sig ... end

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

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

Sourcemodule OptionState : sig ... end
Sourcemodule UIntValue : sig ... end
Sourcemodule UpdateTimestamp : sig ... end
Sourcemodule DisableTimestamp : sig ... end

Output parameters showing the current IAM identity federation configuration.

Sourcemodule JWTOptionsOutput : sig ... end

Describes the JWT options configured for the domain.

Sourcemodule SAMLOptionsOutput : sig ... end

Describes the SAML application configured for the domain.

Sourcemodule AutoTuneDesiredState : sig ... end
Sourcemodule RollbackOnDisable : sig ... end
Sourcemodule AutoTuneState : sig ... end
Sourcemodule PauseState : sig ... end
Sourcemodule Timestamp : sig ... end
Sourcemodule ColdStorageOptions : sig ... end

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 NodeOptionsList : sig ... end
Sourcemodule ZoneAwarenessConfig : sig ... end

The zone awareness configuration for an Amazon OpenSearch Service domain.

Sourcemodule IdentityPoolId : sig ... end
Sourcemodule UserPoolId : sig ... end
Sourcemodule DeploymentStrategy : sig ... end
Sourcemodule ARN : sig ... end

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 DomainNameFqdn : sig ... end
Sourcemodule TLSSecurityPolicy : sig ... end
Sourcemodule VolumeType : sig ... end
Sourcemodule KmsKeyId : sig ... end
Sourcemodule IdentityCenterInstanceARN : sig ... end
Sourcemodule IdentityStoreId : sig ... end
Sourcemodule RolesKeyIdCOption : sig ... end
Sourcemodule SubjectKeyIdCOption : sig ... end
Sourcemodule LogPublishingOption : sig ... end

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.

Sourcemodule LogType : sig ... end
Sourcemodule OffPeakWindow : sig ... end

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.

Sourcemodule StringList : sig ... end
Sourcemodule RegionsList : sig ... end
Sourcemodule ErrorMessage : sig ... end
Sourcemodule ErrorType : sig ... end
Sourcemodule KeyStoreAccessOption : sig ... end

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

Sourcemodule PackageID : sig ... end
Sourcemodule InstanceRole : sig ... end

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

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

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

Sourcemodule Tag : sig ... end

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

Sourcemodule S3GlueDataCatalog : sig ... end

Information about the Amazon S3 Glue Data Catalog.

Sourcemodule UpgradeStepItem : sig ... end

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

Sourcemodule LicenseFilepath : sig ... end
Sourcemodule RequirementLevel : sig ... end
Sourcemodule PluginClassName : sig ... end
Sourcemodule PluginDescription : sig ... end
Sourcemodule PluginName : sig ... end
Sourcemodule PluginVersion : sig ... end
Sourcemodule VersionString : sig ... end
Sourcemodule RecurringCharge : sig ... end

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

Sourcemodule PackageUser : sig ... end

Cross-cluster search specific connection properties.

Sourcemodule Endpoint : sig ... end
Sourcemodule AWSDomainInformation : sig ... end

Information about an Amazon OpenSearch Service domain.

Sourcemodule ConnectionStatusMessage : sig ... end
Sourcemodule NonEmptyString : sig ... end
Sourcemodule AdditionalLimit : sig ... end

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

Sourcemodule InstanceCountLimits : sig ... end

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

Sourcemodule StorageType : sig ... end

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

Sourcemodule ConfigChangeStatus : sig ... end
Sourcemodule GUID : sig ... end
Sourcemodule InitiatedBy : sig ... end
Sourcemodule Message : sig ... end
Sourcemodule ServiceUrl : sig ... end

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.

Sourcemodule ModifyingProperties : sig ... end

Information about the domain properties that are currently being modified.

Sourcemodule DeploymentStatus : sig ... end
Sourcemodule AvailabilityZoneInfo : sig ... end

Information about an Availability Zone on a domain.

Sourcemodule ChangeProgressStageName : sig ... end
Sourcemodule ChangeProgressStageStatus : sig ... end
Sourcemodule Description : sig ... end
Sourcemodule LastUpdated : sig ... end
Sourcemodule ScheduledAutoTuneDetails : sig ... end

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

Sourcemodule Long : sig ... end
Sourcemodule AIMLOptionsOutput : sig ... end

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

Sourcemodule OptionStatus : sig ... end

Provides the current status of an entity.

Sourcemodule PolicyDocument : sig ... end

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.

Sourcemodule AdvancedOptions : sig ... end
Sourcemodule AdvancedSecurityOptions : sig ... end

Container for fine-grained access control settings.

Sourcemodule AutoTuneOptions : sig ... end

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

Sourcemodule AutoTuneStatus : sig ... end

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

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

Sourcemodule ClusterConfig : sig ... end

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

Sourcemodule CognitoOptions : sig ... end

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.

Sourcemodule DeploymentStrategyOptions : sig ... end

Specifies the deployment strategy options for the domain.

Sourcemodule DomainEndpointOptions : sig ... end

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

Sourcemodule EBSOptions : sig ... end

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

Sourcemodule EncryptionAtRestOptions : sig ... end

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.

Sourcemodule IPAddressType : sig ... end
Sourcemodule IdentityCenterOptions : sig ... end

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.

Sourcemodule LogPublishingOptions : sig ... end

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

Sourcemodule OffPeakWindowOptions : sig ... end

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

Sourcemodule SnapshotOptions : sig ... end

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

Sourcemodule SoftwareUpdateOptions : sig ... end

Options for configuring service software updates for a domain.

Sourcemodule VPCDerivedInfo : sig ... end

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.

Sourcemodule ValidationFailure : sig ... end

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

Sourcemodule RolesKey : sig ... end
Sourcemodule SubjectKey : sig ... end
Sourcemodule Password : sig ... end
Sourcemodule Username : sig ... end
Sourcemodule BackendRole : sig ... end
Sourcemodule AppConfigType : sig ... end
Sourcemodule AppConfigValue : sig ... end
Sourcemodule DataSourceDescription : sig ... end
Sourcemodule DomainArn : sig ... end
Sourcemodule VpcEndpointId : sig ... end
Sourcemodule VpcEndpointStatus : sig ... end
Sourcemodule PrincipalType : sig ... end
Sourcemodule ServiceOptions : sig ... end

Options for the service, such as the supported Regions.

Sourcemodule ActionSeverity : sig ... end
Sourcemodule ActionStatus : sig ... end
Sourcemodule ActionType : sig ... end
Sourcemodule ScheduledBy : sig ... end
Sourcemodule DomainPackageStatus : sig ... end
Sourcemodule ErrorDetails : sig ... end

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

The configuration for associating a package with a domain.

Sourcemodule PackageIDList : sig ... end
Sourcemodule PackageName : sig ... end
Sourcemodule PackageType : sig ... end
Sourcemodule PackageVersion : sig ... end
Sourcemodule ReferencePath : sig ... end
Sourcemodule AvailabilityZoneList : sig ... end
Sourcemodule InstanceRoleList : sig ... end
Sourcemodule InsightPriorityLevel : sig ... end
Sourcemodule InsightStatus : sig ... end
Sourcemodule InsightType : sig ... end
Sourcemodule EngineType : sig ... end
Sourcemodule MaintenanceStatus : sig ... end
Sourcemodule MaintenanceStatusMessage : sig ... end
Sourcemodule MaintenanceType : sig ... end
Sourcemodule NodeId : sig ... end
Sourcemodule RequestId : sig ... end
Sourcemodule DirectQueryDataSourceName : sig ... end
Sourcemodule DirectQueryDataSourceType : sig ... end

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 TagList : sig ... end
Sourcemodule DataSourceName : sig ... end
Sourcemodule DataSourceStatus : sig ... end
Sourcemodule DataSourceType : sig ... end

The type of data source.

Sourcemodule ApplicationName : sig ... end
Sourcemodule ApplicationStatus : sig ... end
Sourcemodule Id : sig ... end
Sourcemodule StartTimestamp : sig ... end
Sourcemodule UpgradeName : sig ... end
Sourcemodule UpgradeStepsList : sig ... end
Sourcemodule CommitMessage : sig ... end
Sourcemodule CreatedAt : sig ... end
Sourcemodule PackageConfiguration : sig ... end

The configuration parameters for a package.

Sourcemodule PluginProperties : sig ... end

Basic information about the plugin.

Sourcemodule VersionList : sig ... end
Sourcemodule CapabilityFailureDetails : sig ... end
Sourcemodule CapabilityFailureReason : sig ... end
Sourcemodule VpcEndpointErrorCode : sig ... end
Sourcemodule AWSAccount : sig ... end
Sourcemodule Integer : sig ... end
Sourcemodule RecurringChargeList : sig ... end
Sourcemodule ReservationToken : sig ... end
Sourcemodule EngineVersion : sig ... end
Sourcemodule PackageDescription : sig ... end
Sourcemodule PackageEncryptionOptions : sig ... end

Encryption options for a package.

Sourcemodule PackageOwner : sig ... end
Sourcemodule PackageStatus : sig ... end
Sourcemodule PackageUserList : sig ... end
Sourcemodule PackageVendingOptions : sig ... end

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

Sourcemodule ConnectionAlias : sig ... end
Sourcemodule ConnectionId : sig ... end
Sourcemodule ConnectionMode : sig ... end
Sourcemodule ConnectionProperties : sig ... end

The connection properties of an outbound connection.

Container for information about an OpenSearch Service domain.

Sourcemodule OutboundConnectionStatus : sig ... end

The status of an outbound cross-cluster connection.

Sourcemodule ValueStringList : sig ... end
Sourcemodule AdditionalLimitList : sig ... end
Sourcemodule InstanceLimits : sig ... end

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

Sourcemodule StorageTypeList : sig ... end
Sourcemodule InsightFieldType : sig ... end
Sourcemodule InboundConnectionStatus : sig ... end

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

Sourcemodule AutoTuneOptionsOutput : sig ... end

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

Sourcemodule ChangeProgressDetails : sig ... end

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

Sourcemodule DomainId : sig ... end

Unique identifier for an OpenSearch Service domain.

Sourcemodule EndpointsMap : sig ... end
Sourcemodule HostedZoneId : sig ... end
Sourcemodule ModifyingPropertiesList : sig ... end
Sourcemodule ServiceSoftwareOptions : sig ... end

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

Sourcemodule NodeStatus : sig ... end
Sourcemodule NodeType : sig ... end
Sourcemodule VolumeSize : sig ... end
Sourcemodule AvailabilityZoneInfoList : sig ... end
Sourcemodule ChangeProgressStage : sig ... end

Progress details for each stage of a domain update.

Sourcemodule AutoTuneDetails : sig ... end

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

Sourcemodule AutoTuneType : sig ... end
Sourcemodule SlotList : sig ... end
Sourcemodule S3BucketName : sig ... end
Sourcemodule S3Key : sig ... end
Sourcemodule AIMLOptionsStatus : sig ... end

The status of machine learning options on the specified domain.

Sourcemodule AccessPoliciesStatus : sig ... end

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

Sourcemodule AdvancedOptionsStatus : sig ... end

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.

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

Sourcemodule AutoTuneOptionsStatus : sig ... end

The Auto-Tune status for the domain.

The status of automated snapshot pause options for the domain.

Sourcemodule ClusterConfigStatus : sig ... end

The cluster configuration status for a domain.

Sourcemodule CognitoOptionsStatus : sig ... end

The status of the Cognito options for the specified domain.

The status of deployment strategy options for the domain.

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

Sourcemodule EBSOptionsStatus : sig ... end

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

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

Sourcemodule IPAddressTypeStatus : sig ... end

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.

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

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

Sourcemodule SnapshotOptionsStatus : sig ... end

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

The status of the service software options for a domain.

Sourcemodule VPCDerivedInfoStatus : sig ... end

Status of the VPC options for a specified domain.

Sourcemodule VersionStatus : sig ... end

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

Sourcemodule ValidationFailures : sig ... end
Sourcemodule DeploymentType : sig ... end

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

Sourcemodule IAMFederationOptionsInput : sig ... end

Input parameters for configuring IAM identity federation settings.

Sourcemodule JWTOptionsInput : sig ... end

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

Sourcemodule MasterUserOptions : sig ... end

Credentials for the master user for a domain.

Sourcemodule SAMLOptionsInput : sig ... end

The SAML authentication configuration for an Amazon OpenSearch Service domain.

Sourcemodule AppConfig : sig ... end

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

Sourcemodule DataSource : sig ... end

Data sources that are associated with an OpenSearch application.

Sourcemodule AIConfig : sig ... end

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

Sourcemodule VpcEndpointSummary : sig ... end

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

Sourcemodule AuthorizedPrincipal : sig ... end

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.

Sourcemodule ScheduledAction : sig ... end

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.

Sourcemodule DomainPackageDetails : sig ... end

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

Sourcemodule InstanceTypeDetails : sig ... end

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

Sourcemodule Insight : sig ... end

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.

Sourcemodule InsightEntityType : sig ... end
Sourcemodule InsightEntityValue : sig ... end

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

Sourcemodule DomainInfo : sig ... end

Information about an OpenSearch Service domain.

Sourcemodule DomainMaintenanceDetails : sig ... end

Container for the domain maintenance details.

Sourcemodule DirectQueryDataSource : sig ... end

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

Sourcemodule DataSourceDetails : sig ... end

Details about a direct-query data source.

Sourcemodule ApplicationSummary : sig ... end

Basic details of an OpenSearch application.

Sourcemodule UpgradeHistory : sig ... end

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

Sourcemodule PackageVersionHistory : sig ... end

Details about a package version.

Sourcemodule CompatibleVersionsMap : sig ... end

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

Sourcemodule CapabilityFailure : sig ... end

Information about a capability failure.

Sourcemodule VpcEndpointError : sig ... end

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

Sourcemodule VpcEndpoint : sig ... end

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

Sourcemodule ReservedInstance : sig ... end

Details of an OpenSearch Reserved Instance.

Sourcemodule ReservedInstanceOffering : sig ... end

Details of an OpenSearch Reserved Instance offering.

Sourcemodule PackageDetails : sig ... end

Basic information about a package.

Sourcemodule DescribePackagesFilter : sig ... end

A filter to apply to the DescribePackage response.

Sourcemodule OutboundConnection : sig ... end

Specifies details about an outbound cross-cluster connection.

Sourcemodule Filter : sig ... end

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.

Sourcemodule Limits : sig ... end

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

Sourcemodule InsightField : sig ... end

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

Sourcemodule InboundConnection : sig ... end

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

Sourcemodule DomainStatus : sig ... end

The current status of an OpenSearch Service domain.

Sourcemodule DomainNodesStatus : sig ... end

Container for information about nodes on the domain.

Sourcemodule EnvironmentInfo : sig ... end

Information about the active domain environment.

Sourcemodule ChangeProgressStageList : sig ... end
Sourcemodule OverallChangeStatus : sig ... end
Sourcemodule TotalNumberOfStages : sig ... end
Sourcemodule AutoTune : sig ... end

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

Sourcemodule CancelledChangeProperty : sig ... end

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

Details of a package that is associated with a domain.

Sourcemodule BaseException : sig ... end

An error occurred while processing the request.

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

Sourcemodule InternalException : sig ... end

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

An exception for creating a resource that already exists.

Sourcemodule ResourceNotFoundException : sig ... end

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

Sourcemodule ValidationException : sig ... end

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

Sourcemodule ConflictException : sig ... end

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

Sourcemodule VPCOptions : sig ... end

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.

Sourcemodule LimitExceededException : sig ... end

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

Sourcemodule SlotNotAvailableException : sig ... end

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

Sourcemodule ScheduleAt : sig ... end
Sourcemodule PackageScopeOperationEnum : sig ... end
Sourcemodule AccessDeniedException : sig ... end

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

Sourcemodule PackageSource : sig ... end

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.

Sourcemodule IndexStatus : sig ... end
Sourcemodule ThrottlingException : sig ... end

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

Sourcemodule IndexName : sig ... end

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

Sourcemodule IndexSchema : sig ... end
Sourcemodule DomainConfig : sig ... end

Container for the configuration of an OpenSearch Service domain.

Sourcemodule DryRunProgressStatus : sig ... end

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

Sourcemodule DryRunResults : sig ... end

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

Sourcemodule InvalidTypeException : sig ... end

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

Sourcemodule AIMLOptionsInput : sig ... end

Container for parameters required to enable all machine learning features.

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

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.

Sourcemodule DryRun : sig ... end
Sourcemodule DryRunMode : sig ... end

Configuration settings for enabling and managing IAM Identity Center.

Sourcemodule AppConfigs : sig ... end
Sourcemodule DataSources : sig ... end
Sourcemodule IamIdentityCenterOptions : sig ... end

Configuration settings for IAM Identity Center in an OpenSearch application.

Details about the rollback options for a service software update.

Sourcemodule AWSServicePrincipal : sig ... end
Sourcemodule ApplicationId : sig ... end

The base configuration returned for a registered capability.

Sourcemodule CapabilityName : sig ... end

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

Sourcemodule CapabilityStatus : sig ... end

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.

Sourcemodule InstanceCount : sig ... end

Number of instances in an OpenSearch Service cluster.

Sourcemodule NextToken : sig ... end

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.

Sourcemodule VpcEndpointSummaryList : sig ... end
Sourcemodule AuthorizedPrincipalList : sig ... end
Sourcemodule MaxResults : sig ... end

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

Request processing failed because you provided an invalid pagination token.

Sourcemodule ScheduledActionsList : sig ... end
Sourcemodule DomainPackageDetailsList : sig ... end
Sourcemodule InstanceTypeDetailsList : sig ... end
Sourcemodule InstanceTypeString : sig ... end
Sourcemodule InsightList : sig ... end
Sourcemodule InsightEntity : sig ... end

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

Sourcemodule InsightPageSize : sig ... end

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

Sourcemodule InsightSortOrder : sig ... end
Sourcemodule InsightTimeRange : sig ... end

Specifies the time range for filtering insights.

Sourcemodule DomainInfoList : sig ... end
Sourcemodule DomainMaintenanceList : sig ... end
Sourcemodule DirectQueryDataSourceList : sig ... end
Sourcemodule DataSourceList : sig ... end
Sourcemodule ApplicationSummaries : sig ... end
Sourcemodule ApplicationStatuses : sig ... end
Sourcemodule UpgradeHistoryList : sig ... end
Sourcemodule PackageVersionHistoryList : sig ... end
Sourcemodule CompatibleVersionsList : sig ... end

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

Sourcemodule CapabilityFailures : sig ... end
Sourcemodule KmsKeyArn : sig ... end
Sourcemodule VpcEndpointErrorList : sig ... end
Sourcemodule VpcEndpoints : sig ... end
Sourcemodule VpcEndpointIdList : sig ... end
Sourcemodule ReservedInstanceList : sig ... end
Sourcemodule PackageDetailsList : sig ... end
Sourcemodule OutboundConnections : sig ... end
Sourcemodule FilterList : sig ... end
Sourcemodule LimitsByRole : sig ... end
Sourcemodule InsightFieldList : sig ... end
Sourcemodule InboundConnections : sig ... end
Sourcemodule DomainStatusList : sig ... end
Sourcemodule DomainNameList : sig ... end
Sourcemodule DomainNodesStatusList : sig ... end
Sourcemodule DomainHealth : sig ... end
Sourcemodule DomainState : sig ... end
Sourcemodule EnvironmentInfoList : sig ... end
Sourcemodule MasterNodeStatus : sig ... end
Sourcemodule NumberOfAZs : sig ... end

The progress details of a specific domain configuration change.

Sourcemodule AutoTuneList : sig ... end
Sourcemodule ClientToken : sig ... end
Sourcemodule AutoTuneOptionsInput : sig ... end

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

Configuration settings for enabling and managing IAM Identity Center.

Sourcemodule GUIDList : sig ... end
Sourcemodule UpgradeDomainResponse : sig ... end

Container for the response returned by UpgradeDomain operation.

Sourcemodule UpgradeDomainRequest : sig ... end

Container for the request parameters to the UpgradeDomain operation.

Sourcemodule UpdateVpcEndpointResponse : sig ... end

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Sourcemodule UpdateVpcEndpointRequest : sig ... end

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

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.

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.

Sourcemodule UpdatePackageScopeRequest : sig ... end

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

Sourcemodule UpdatePackageResponse : sig ... end

Container for the response returned by the UpdatePackage operation.

Sourcemodule UpdatePackageRequest : sig ... end

Container for request parameters to the UpdatePackage operation.

Sourcemodule UpdateIndexResponse : sig ... end

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.

Sourcemodule UpdateIndexRequest : sig ... end

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.

Sourcemodule UpdateDomainConfigRequest : sig ... end

Container for the request parameters to the UpdateDomain operation.

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

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

Sourcemodule UpdateDataSourceResponse : sig ... end

The result of an UpdateDataSource operation.

Sourcemodule UpdateDataSourceRequest : sig ... end

Container for the parameters to the UpdateDataSource operation.

Sourcemodule UpdateApplicationResponse : sig ... end

Updates the configuration and settings of an existing OpenSearch application.

Sourcemodule UpdateApplicationRequest : sig ... end

Updates the configuration and settings of an existing OpenSearch application.

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

Container for the request parameters to the StartServiceSoftwareUpdate operation.

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

Container for the parameters to the StartDomainMaintenance operation.

Contains details about the rolled-back service software update.

Container for the request parameters to the RollbackServiceSoftwareUpdate operation.

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

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

Sourcemodule RemoveTagsRequest : sig ... end

Container for the request parameters to the RemoveTags operation.

Represents the output of a RejectInboundConnection operation.

Container for the request parameters to the RejectInboundConnection operation.

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

Sourcemodule RegisterCapabilityRequest : sig ... end

Container for the parameters to the RegisterCapability operation.

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.

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.

Represents the output of a PurchaseReservedInstanceOffering operation.

Container for request parameters to the PurchaseReservedInstanceOffering operation.

Sourcemodule ListVpcEndpointsResponse : sig ... end

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

Sourcemodule ListVpcEndpointsRequest : sig ... end

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 associated with a particular domain.

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

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.

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 ListVersionsResponse : sig ... end

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

Sourcemodule ListVersionsRequest : sig ... end

Container for the request parameters to the ListVersions operation.

Sourcemodule ListTagsResponse : sig ... end

The results of a ListTags operation.

Sourcemodule ListTagsRequest : sig ... end

Container for the parameters to the ListTags operation.

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.

Container for the response parameters to the ListPackagesForDomain operation.

Container for the request parameters to the ListPackagesForDomain operation.

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

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

Sourcemodule ListInsightsResponse : sig ... end

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

Sourcemodule ListInsightsRequest : sig ... end

Container for the parameters to the ListInsights operation.

Container for the response parameters to the ListDomainsForPackage operation.

Container for the request parameters to the ListDomainsForPackage operation.

Sourcemodule ListDomainNamesResponse : sig ... end

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

Sourcemodule ListDomainNamesRequest : sig ... end

Container for the parameters to the ListDomainNames operation.

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

Container for the parameters to the ListDomainMaintenances operation.

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

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

Sourcemodule ListDataSourcesResponse : sig ... end

The result of a ListDataSources operation.

Sourcemodule ListDataSourcesRequest : sig ... end

Container for the parameters to the ListDataSources operation.

Sourcemodule ListApplicationsResponse : sig ... end

Lists all OpenSearch applications under your account.

Sourcemodule ListApplicationsRequest : sig ... end

Lists all OpenSearch applications under your account.

Sourcemodule GetUpgradeStatusResponse : sig ... end

Container for the response returned by the GetUpgradeStatus operation.

Sourcemodule GetUpgradeStatusRequest : sig ... end

Container for the request parameters to the GetUpgradeStatus operation.

Sourcemodule GetUpgradeHistoryResponse : sig ... end

Container for the response returned by the GetUpgradeHistory operation.

Sourcemodule GetUpgradeHistoryRequest : sig ... end

Container for the request parameters to the GetUpgradeHistory operation.

Container for response returned by GetPackageVersionHistory operation.

Container for the request parameters to the GetPackageVersionHistory operation.

Sourcemodule GetIndexResponse : sig ... end

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 GetIndexRequest : sig ... end

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.

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

Container for the parameters to the GetDomainMaintenanceStatus operation.

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

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

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

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

Sourcemodule GetDataSourceResponse : sig ... end

The result of a GetDataSource operation.

Sourcemodule GetDataSourceRequest : sig ... end

Container for the parameters to the GetDataSource operation.

Container for the response returned by the GetCompatibleVersions operation.

Container for the request parameters to GetCompatibleVersions operation.

Sourcemodule GetCapabilityResponse : sig ... end

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

Sourcemodule GetCapabilityRequest : sig ... end

Container for the parameters to the GetCapability operation.

Sourcemodule GetApplicationResponse : sig ... end

Retrieves the configuration and status of an existing OpenSearch application.

Sourcemodule GetApplicationRequest : sig ... end

Retrieves the configuration and status of an existing OpenSearch application.

Dissociates multiple packages from a domain simultaneously.

Sourcemodule DissociatePackagesRequest : sig ... end

Dissociates multiple packages from a domain simultaneously.

Sourcemodule DissociatePackageResponse : sig ... end

Container for the response returned by an DissociatePackage operation.

Sourcemodule DissociatePackageRequest : sig ... end

Container for the request parameters to the DissociatePackage operation.

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

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

Container for results from DescribeReservedInstances

Container for the request parameters to the DescribeReservedInstances operation.

Container for results of a DescribeReservedInstanceOfferings request.

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

Sourcemodule DescribePackagesResponse : sig ... end

Container for the response returned by the DescribePackages operation.

Sourcemodule DescribePackagesRequest : sig ... end

Container for the request parameters to the DescribePackage operation.

Contains a list of connections matching the filter criteria.

Container for the parameters to the DescribeOutboundConnections operation.

Container for the parameters received from the DescribeInstanceTypeLimits operation.

Container for the parameters to the DescribeInstanceTypeLimits operation.

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

Container for the parameters to the DescribeInsightDetails operation.

Contains a list of connections matching the filter criteria.

Container for the parameters to the DescribeInboundConnections operation.

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.

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 DescribeDomainsResponse : sig ... end

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

Sourcemodule DescribeDomainsRequest : sig ... end

Container for the parameters to the DescribeDomains operation.

Sourcemodule DescribeDomainResponse : sig ... end

Contains the status of the domain specified in the request.

Sourcemodule DescribeDomainRequest : sig ... end

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.

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

Container for the parameters to the DescribeDomainHealth operation.

Contains the configuration information of the requested domain.

Container for the parameters to the DescribeDomainConfig operation.

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

Container for the parameters to the DescribeDomainChangeProgress operation.

The result of a DescribeDomainAutoTunes request.

Container for the parameters to the DescribeDomainAutoTunes operation.

The result of a DeregisterCapability request.

Container for the parameters to the DeregisterCapability operation.

Sourcemodule DeleteVpcEndpointResponse : sig ... end

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Sourcemodule DeleteVpcEndpointRequest : sig ... end

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Sourcemodule DeletePackageResponse : sig ... end

Container for the response parameters to the DeletePackage operation.

Sourcemodule DeletePackageRequest : sig ... end

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

Details about the deleted outbound connection.

Container for the parameters to the DeleteOutboundConnection operation.

Sourcemodule DeleteIndexResponse : sig ... end

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

Sourcemodule DeleteIndexRequest : sig ... end

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

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

Container for the parameters to the DeleteInboundConnection operation.

Sourcemodule DeleteDomainResponse : sig ... end

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.

Sourcemodule DeleteDomainRequest : sig ... end

Container for the parameters to the DeleteDomain operation.

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

Sourcemodule DeleteDataSourceResponse : sig ... end

The result of a GetDataSource operation.

Sourcemodule DeleteDataSourceRequest : sig ... end

Container for the parameters to the DeleteDataSource operation.

Sourcemodule DeleteApplicationResponse : sig ... end

Deletes a specified OpenSearch application.

Sourcemodule DeleteApplicationRequest : sig ... end

Deletes a specified OpenSearch application.

Sourcemodule CreateVpcEndpointResponse : sig ... end

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Sourcemodule CreateVpcEndpointRequest : sig ... end

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Sourcemodule CreatePackageResponse : sig ... end

Container for the response returned by the CreatePackage operation.

Sourcemodule CreatePackageRequest : sig ... end

Container for request parameters to the CreatePackage operation.

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

Container for the parameters to the CreateOutboundConnection operation.

Sourcemodule CreateIndexResponse : sig ... end

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.

Sourcemodule CreateIndexRequest : sig ... end

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.

Sourcemodule CreateDomainResponse : sig ... end

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

Sourcemodule CreateDomainRequest : sig ... end

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

Sourcemodule CreateApplicationResponse : sig ... end

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

Sourcemodule CreateApplicationRequest : sig ... end

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

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

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

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

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

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

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

Sourcemodule AssociatePackagesResponse : sig ... end

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

Sourcemodule AssociatePackagesRequest : sig ... end

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

Sourcemodule AssociatePackageResponse : sig ... end

Container for the response returned by the AssociatePackage operation.

Sourcemodule AssociatePackageRequest : sig ... end

Container for the request parameters to the AssociatePackage operation.

Sourcemodule AddTagsRequest : sig ... end

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

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

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

Sourcemodule AddDataSourceResponse : sig ... end

The result of an AddDataSource operation.

Sourcemodule AddDataSourceRequest : sig ... end

Container for the parameters to the AddDataSource operation.

Contains details about the accepted inbound connection.

Container for the parameters to the AcceptInboundConnection operation.