Package-level declarations
Types
Container for the parameters to the AcceptInboundConnection operation.
Contains details about the accepted inbound connection.
An error occurred because you don't have permissions to access the resource.
The configured access rules for the domain's search endpoint, and the current status of those rules.
Container for the parameters to the AddDataSource operation.
The result of an AddDataSource operation.
List of limits that are specific to a given instance type.
Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain, data source, or application.
Status of the advanced options for the specified domain. The following options are available:
Container for fine-grained access control settings.
Options for enabling and configuring fine-grained access control. For more information, see Fine-grained access control in Amazon OpenSearch Service.
The status of fine-grained access control settings for a domain.
Container for parameters required to enable all machine learning features.
Container for parameters representing the state of machine learning features on the specified domain.
The status of machine learning options on the specified domain.
Configuration settings for an OpenSearch application. For more information, see see Using the OpenSearch user interface in Amazon OpenSearch Service.
Basic details of an OpenSearch application.
Container for the request parameters to the AssociatePackage operation.
Container for the response returned by the AssociatePackage operation.
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 an Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
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.
Auto-Tune settings when updating a domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
Options for configuring Auto-Tune. For more information, see Auto-Tune for Amazon OpenSearch Service
The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.
The Auto-Tune status for the domain.
The Auto-Tune state for the domain. For valid states 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.
Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
Information about an Availability Zone on a domain.
Information about an Amazon OpenSearch Service domain.
An error occurred while processing the request.
A property change that was cancelled for an Amazon OpenSearch Service domain.
Container for the request parameters to cancel a service software update.
Container for the response to a CancelServiceSoftwareUpdate operation. Contains the status of the update.
Container for information about a configuration change happening on a domain.
Progress details for each stage of a domain update.
The progress details of a specific domain configuration change.
Configuration details for a CloudWatch Logs data source that can be used for direct queries.
Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
The cluster configuration status for a domain.
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.
The status of the Cognito options for the specified domain.
Container for the parameters required to enable cold storage for an OpenSearch Service domain. For more information, see Cold storage for Amazon OpenSearch Service.
A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
An error occurred because the client attempts to remove a resource that is currently in use.
The connection mode for the cross-cluster connection.
The connection properties of an outbound connection.
The result of a CreateDomain operation. Contains the status of the newly created domain.
Container for the parameters to the CreateOutboundConnection operation.
The result of a CreateOutboundConnection request. Contains details about the newly created cross-cluster connection.
Container for request parameters to the CreatePackage operation.
Container for the response returned by the CreatePackage operation.
Cross-cluster search specific connection properties.
Data sources that are associated with an OpenSearch application.
Details about a direct-query data source.
The type of data source.
Container for the parameters to the DeleteDataSource operation.
The result of a GetDataSource operation.
Container for the parameters to the DeleteDomain 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 DeleteInboundConnection operation.
The results of a DeleteInboundConnection operation. Contains details about the deleted inbound connection.
Container for the parameters to the DeleteOutboundConnection operation.
Details about the deleted outbound connection.
Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.
Container for the response parameters to the DeletePackage operation.
An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
Container for the parameters to the DescribeDomainAutoTunes operation.
The result of a DescribeDomainAutoTunes request.
Container for the parameters to the DescribeDomainChangeProgress operation.
The result of a DescribeDomainChangeProgress request. Contains progress information for the requested domain change.
Container for the parameters to the DescribeDomainConfig operation.
Contains the configuration information of the requested domain.
Container for the parameters to the DescribeDomainHealth operation.
The result of a DescribeDomainHealth request. Contains health information for the requested domain.
Container for the parameters to the DescribeDomainNodes operation.
The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.
Container for the parameters to the DescribeDomain operation.
Contains the status of the domain specified in the request.
Container for the parameters to the DescribeDomains operation.
Contains the status of the specified domains or all domains owned by the account.
Container for the parameters to the DescribeInboundConnections operation.
Contains a list of connections matching the filter criteria.
Container for the parameters to the DescribeInstanceTypeLimits operation.
Container for the parameters received from the DescribeInstanceTypeLimits operation.
Container for the parameters to the DescribeOutboundConnections operation.
Contains a list of connections matching the filter criteria.
A filter to apply to the DescribePackage response.
Container for the request parameters to the DescribePackage operation.
Container for the response returned by the DescribePackages operation.
Container for the request parameters to a DescribeReservedInstanceOfferings operation.
Container for results of a DescribeReservedInstanceOfferings request.
Container for the request parameters to the DescribeReservedInstances operation.
Container for results from DescribeReservedInstances
The configuration details for a data source that can be directly queried.
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.
An error occured because the client wanted to access an unsupported operation.
Container for the request parameters to the DissociatePackage operation.
Container for the response returned by an DissociatePackage operation.
Container for the configuration of an OpenSearch Service domain.
Options to configure a custom endpoint for an OpenSearch Service domain.
The configured endpoint options for a domain and their current status.
Information about an OpenSearch Service domain.
Container for information about an OpenSearch Service domain.
Container for the domain maintenance details.
Container for information about nodes on the domain.
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.
The current status 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.
The duration of a maintenance schedule. For more information, see Auto-Tune for Amazon OpenSearch Service.
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
The status of the EBS options for the specified 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.
Status of the encryption at rest options for the specified OpenSearch Service domain.
Information about the active domain environment.
Additional information if the package is in an error state. Null otherwise.
Container for the request parameters to GetCompatibleVersions operation.
Container for the response returned by the GetCompatibleVersions operation.
Container for the parameters to the GetDataSource operation.
The result of a GetDataSource operation.
Container for the parameters to the GetDomainMaintenanceStatus operation.
The result of a GetDomainMaintenanceStatus request that information about the requested action.
Container for the request parameters to the GetPackageVersionHistory operation.
Container for response returned by GetPackageVersionHistory operation.
Container for the request parameters to the GetUpgradeHistory operation.
Container for the response returned by the GetUpgradeHistory operation.
Container for the request parameters to the GetUpgradeStatus operation.
Container for the response returned by the GetUpgradeStatus operation.
Configuration settings for IAM Identity Center in an OpenSearch application.
Configuration settings for enabling and managing IAM Identity Center.
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.
Configuration settings for enabling and managing IAM Identity Center.
The status of IAM Identity Center configuration settings for a domain.
Describes an inbound cross-cluster connection for Amazon OpenSearch Service. For more information, see Cross-cluster search for Amazon OpenSearch Service.
The status of an inbound cross-cluster connection for OpenSearch Service.
Limits on the number of instances that can be created in OpenSearch Service for a given instance type.
Instance-related attributes that are available for a given instance type.
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
Request processing failed because of an unknown error, exception, or internal failure.
Request processing failed because you provided an invalid pagination token.
An exception for trying to create or access a sub-resource that's either invalid or not supported.
The IP address type status for the domain.
The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.
Describes the JWT options configured for the domain.
The configuration parameters to enable access to the key store required by the package.
An exception for trying to create more than the allowed number of resources or sub-resources.
Container for the parameters to the ListDataSources operation.
The result of a ListDataSources operation.
Container for the parameters to the ListDomainMaintenances operation.
The result of a ListDomainMaintenances request that contains information about the requested actions.
Container for the parameters to the ListDomainNames 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 request parameters to the ListDomainsForPackage operation.
Container for the response parameters to the ListDomainsForPackage operation.
Container for the request parameters to the ListPackagesForDomain operation.
Container for the response parameters to the ListPackagesForDomain operation.
Container for the parameters to the ListTags operation.
The results of a ListTags operation.
Container for the request parameters to the ListVersions operation.
Container for the parameters for response received from the ListVersions operation.
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.
The configured log publishing options for the domain and their current status.
Credentials for the master user for a domain.
Information about the domain properties that are currently being modified.
Container for parameters required to enable the natural language query generation feature.
Container for parameters representing the state of the natural language query generation feature on the specified domain.
Configuration options for defining the setup of any node type within the cluster.
Configuration settings for defining the node type within a cluster.
Enables or disables node-to-node encryption. For more information, see Node-to-node encryption for Amazon OpenSearch Service.
Status of the node-to-node encryption options for the specified domain.
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.
Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
The status of off-peak window options for a domain.
Base class for all service related exceptions thrown by the OpenSearch client
The state of a requested domain configuration change. Can be one of the following:
Provides the current status of an entity.
Specifies details about an outbound cross-cluster connection.
The status of an outbound cross-cluster connection.
The overall status value of the domain configuration change.
The configuration for associating a package with a domain.
The configuration parameters for a package.
Basic information about a package.
Details of a package that is associated with a domain.
Encryption options for a package.
The Amazon S3 location to import the package from.
Configuration options for determining whether a package can be made available for use by other users.
Details about a package version.
Basic information about the plugin.
Container for request parameters to the PurchaseReservedInstanceOffering operation.
Represents the output of a PurchaseReservedInstanceOffering operation.
Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.
Container for the request parameters to the RejectInboundConnection operation.
Represents the output of a RejectInboundConnection operation.
Container for the request parameters to the RemoveTags operation.
Details of an OpenSearch Reserved Instance.
Details of an OpenSearch Reserved Instance offering.
An exception for creating a resource that already exists.
An exception for accessing or deleting a resource that doesn't exist.
The rollback state while disabling Auto-Tune for the domain.
Information about the Amazon S3 Glue Data Catalog.
Options for enabling S3 vectors engine features on the specified domain.
The SAML authentication configuration for an Amazon OpenSearch Service domain.
Describes the SAML application configured for the domain.
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.
The Auto-Tune action type.
Specifies details about a scheduled Auto-Tune action. For more information, see Auto-Tune for Amazon OpenSearch Service.
The Auto-Tune action severity.
Configuration details for a Security Lake data source that can be used for direct queries.
The current status of the service software for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
The status of SkipUnavailable setting for the outbound connection.
An exception for attempting to schedule a domain action during an unavailable time slot.
The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.
Container for information about a daily automated snapshot for an OpenSearch Service domain.
Options for configuring service software updates for a domain.
The status of the service software options for a domain.
Container for the parameters to the StartDomainMaintenance operation.
The result of a StartDomainMaintenance request that information about the requested action.
Container for the request parameters to the StartServiceSoftwareUpdate operation.
Represents the output of a StartServiceSoftwareUpdate operation. Contains the status of the update.
A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.
Limits that are applicable for the given Amazon OpenSearch Service storage type.
Container for the parameters to the UpdateDataSource operation.
The result of an UpdateDataSource operation.
Container for the request parameters to the UpdateDomain operation.
The results of an UpdateDomain request. Contains the status of the domain being updated.
Container for request parameters to the UpdatePackage operation.
Container for the response returned by the UpdatePackage operation.
Container for the request parameters to the UpgradeDomain operation.
Container for the response returned by UpgradeDomain operation.
History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.
Represents a single step of an upgrade or upgrade eligibility check workflow.
An exception for accessing or deleting a resource that doesn't exist.
A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.
The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.
The type of EBS volume that a domain uses. For more information, see Configuring EBS-based storage.
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.
Status of the VPC options for a specified domain.
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
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.
The desired start time for an off-peak maintenance window.
The zone awareness configuration for an Amazon OpenSearch Service domain.