Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Access
Policies Status The configured access rules for the domain's document and search endpoints, and the current status of those rules.
- Additional
Limit List of limits that are specific to a given InstanceType and for each of it's
InstanceRole
- Advanced
Options Status Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:
- Option to allow references to indices in an HTTP request body. Must be
false
when configuring access to individual sub-resources. By default, the value istrue
. See Configuration Advanced Options for more information. - Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.
For more information, see Configuring Advanced Options.
- Option to allow references to indices in an HTTP request body. Must be
- Advanced
Security Options Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
- Advanced
Security Options Input Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).
- Advanced
Security Options Status Specifies the status of advanced security options for the specified Elasticsearch domain.
- Authorized
Principal Information about an account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- Auto
Tune Specifies Auto-Tune type and Auto-Tune action details.
- Auto
Tune Details Specifies details of the Auto-Tune action. See the Developer Guide for more information.
- Auto
Tune Maintenance Schedule Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.
- Auto
Tune Options Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.
- Auto
Tune Options Input Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
- Auto
Tune Options Output Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
- Auto
Tune Options Status Specifies the status of Auto-Tune options for the specified Elasticsearch domain.
- Auto
Tune Status Provides the current status of the Auto-Tune options.
- Cancelled
Change Property A property change that was cancelled for an Amazon OpenSearch Service domain.
- Change
Progress Details Specifies change details of the domain configuration change.
- Change
Progress Stage A progress stage details of a specific domain configuration change.
- Change
Progress Status Details The progress details of a specific domain configuration change.
- Cognito
Options Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
- Cognito
Options Status Status of the Cognito options for the specified Elasticsearch domain.
- Cold
Storage Options Specifies the configuration for cold storage options such as enabled
- Compatible
Versions Map A map from an
ElasticsearchVersion
ElasticsearchVersion
- Describe
Packages Filter Filter to apply in
DescribePackage
response.- Domain
Endpoint Options Options to configure endpoint for the Elasticsearch domain.
- Domain
Endpoint Options Status The configured endpoint options for the domain and their current status.
- Domain
Info - Domain
Information - Domain
Package Details Information on a package that is associated with a domain.
- DryRun
Results - Duration
Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
- EbsOptions
Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
- EbsOptions
Status Status of the EBS options for the specified Elasticsearch domain.
- Elasticsearch
Cluster Config Specifies the configuration for the domain cluster, such as the type and number of instances.
- Elasticsearch
Cluster Config Status Specifies the configuration status for the specified Elasticsearch domain.
- Elasticsearch
Domain Config The configuration of an Elasticsearch domain.
- Elasticsearch
Domain Status The current status of an Elasticsearch domain.
- Elasticsearch
Version Status Status of the Elasticsearch version options for the specified Elasticsearch domain.
- Encryption
AtRest Options Specifies the Encryption At Rest Options.
- Encryption
AtRest Options Status Status of the Encryption At Rest options for the specified Elasticsearch domain.
- Error
Details - Filter
A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
- Inbound
Cross Cluster Search Connection Specifies details of an inbound connection.
- Inbound
Cross Cluster Search Connection Status Specifies the coonection status of an inbound cross-cluster search connection.
- Instance
Count Limits InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
- Instance
Limits InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
- Limits
Limits for given InstanceType and for each of it's role.
Limits contains followingStorageTypes,
InstanceLimits
AdditionalLimits
- LogPublishing
Option Log Publishing option that is set for given domain.
Attributes and their details:- CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
- Enabled: Whether the log publishing for given log type is enabled or not
- LogPublishing
Options Status The configured log publishing options for the domain and their current status.
- Master
User Options Credentials for the master user: username and password, ARN, or both.
- Modifying
Properties Information about the domain properties that are currently being modified.
- Node
ToNode Encryption Options Specifies the node-to-node encryption options.
- Node
ToNode Encryption Options Status Status of the node-to-node encryption options for the specified Elasticsearch domain.
- Option
Status Provides the current status of the entity.
- Outbound
Cross Cluster Search Connection Specifies details of an outbound connection.
- Outbound
Cross Cluster Search Connection Status Specifies the connection status of an outbound cross-cluster search connection.
- Package
Details Basic information about a package.
- Package
Source The S3 location for importing the package specified as
S3BucketName
andS3Key
- Package
Version History Details of a package version.
- Recurring
Charge Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
- Reserved
Elasticsearch Instance Details of a reserved Elasticsearch instance.
- Reserved
Elasticsearch Instance Offering Details of a reserved Elasticsearch instance offering.
- SamlIdp
Specifies the SAML Identity Provider's information.
- Saml
Options Input Specifies the SAML application configuration for the domain.
- Saml
Options Output Describes the SAML application configured for the domain.
- Scheduled
Auto Tune Details Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.
- Service
Software Options The current options of an Elasticsearch domain service software options.
- Snapshot
Options Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is
0
hours.- Snapshot
Options Status Status of a daily automated snapshot.
- Storage
Type StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.
- Storage
Type Limit Limits that are applicable for given storage type.
- Tag
Specifies a key value pair for a resource tag.
- Upgrade
History History of the last 10 Upgrades and Upgrade Eligibility Checks.
- Upgrade
Step Item Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.
- VpcDerived
Info Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
- VpcDerived
Info Status Status of the VPC options for the specified Elasticsearch domain.
- VpcEndpoint
The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
- VpcEndpoint
Error Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
- VpcEndpoint
Summary Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
- VpcOptions
Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
- Zone
Awareness Config Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.
Enums§
- Auto
Tune Desired State - When writing a match expression against
AutoTuneDesiredState
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Auto
Tune State - When writing a match expression against
AutoTuneState
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Auto
Tune Type - When writing a match expression against
AutoTuneType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Config
Change Status - When writing a match expression against
ConfigChangeStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Deployment
Status - When writing a match expression against
DeploymentStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Describe
Packages Filter Name - When writing a match expression against
DescribePackagesFilterName
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Domain
Package Status - When writing a match expression against
DomainPackageStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Domain
Processing Status Type - When writing a match expression against
DomainProcessingStatusType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Engine
Type - When writing a match expression against
EngineType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - EsPartition
Instance Type - When writing a match expression against
EsPartitionInstanceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - EsWarm
Partition Instance Type - When writing a match expression against
EsWarmPartitionInstanceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Inbound
Cross Cluster Search Connection Status Code - When writing a match expression against
InboundCrossClusterSearchConnectionStatusCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Initiated
By - When writing a match expression against
InitiatedBy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - LogType
- When writing a match expression against
LogType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Option
State - When writing a match expression against
OptionState
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Outbound
Cross Cluster Search Connection Status Code - When writing a match expression against
OutboundCrossClusterSearchConnectionStatusCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Overall
Change Status - When writing a match expression against
OverallChangeStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Status - When writing a match expression against
PackageStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Type - When writing a match expression against
PackageType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Principal
Type - When writing a match expression against
PrincipalType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Property
Value Type - When writing a match expression against
PropertyValueType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Reserved
Elasticsearch Instance Payment Option - When writing a match expression against
ReservedElasticsearchInstancePaymentOption
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Rollback
OnDisable - When writing a match expression against
RollbackOnDisable
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Scheduled
Auto Tune Action Type - When writing a match expression against
ScheduledAutoTuneActionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Scheduled
Auto Tune Severity Type - When writing a match expression against
ScheduledAutoTuneSeverityType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Time
Unit - When writing a match expression against
TimeUnit
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - TlsSecurity
Policy - When writing a match expression against
TlsSecurityPolicy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Upgrade
Status - When writing a match expression against
UpgradeStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Upgrade
Step - When writing a match expression against
UpgradeStep
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Volume
Type - When writing a match expression against
VolumeType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - VpcEndpoint
Error Code - When writing a match expression against
VpcEndpointErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - VpcEndpoint
Status - When writing a match expression against
VpcEndpointStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.