# frozen_string_literal: true

# WARNING ABOUT GENERATED CODE
#
# This file is generated. See the contributing guide for more information:
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
#
# WARNING ABOUT GENERATED CODE

module Aws::OpenSearchService
  module Types

    # Information about an Amazon OpenSearch Service domain.
    #
    # @!attribute [rw] owner_id
    #   The Amazon Web Services account ID of the domain owner.
    #   @return [String]
    #
    # @!attribute [rw] domain_name
    #   Name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] region
    #   The Amazon Web Services Region in which the domain is located.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AWSDomainInformation AWS API Documentation
    #
    class AWSDomainInformation < Struct.new(
      :owner_id,
      :domain_name,
      :region)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `AcceptInboundConnection`
    # operation.
    #
    # @!attribute [rw] connection_id
    #   The ID of the inbound connection to accept.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnectionRequest AWS API Documentation
    #
    class AcceptInboundConnectionRequest < Struct.new(
      :connection_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Contains details about the accepted inbound connection.
    #
    # @!attribute [rw] connection
    #   Information about the accepted inbound connection.
    #   @return [Types::InboundConnection]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AcceptInboundConnectionResponse AWS API Documentation
    #
    class AcceptInboundConnectionResponse < Struct.new(
      :connection)
      SENSITIVE = []
      include Aws::Structure
    end

    # An error occurred because you don't have permissions to access the
    # resource.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AccessDeniedException AWS API Documentation
    #
    class AccessDeniedException < Aws::EmptyStructure; end

    # The configured access rules for the domain's search endpoint, and the
    # current status of those rules.
    #
    # @!attribute [rw] options
    #   The access policy configured for the domain. Access policies can be
    #   resource-based, IP-based, or IAM-based. For more information, see
    #   [Configuring access policies][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-access-policies
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The status of the access policy for the domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AccessPoliciesStatus AWS API Documentation
    #
    class AccessPoliciesStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `AddDataSource` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain to add the data source to.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   A name for the data source.
    #   @return [String]
    #
    # @!attribute [rw] data_source_type
    #   The type of data source.
    #   @return [Types::DataSourceType]
    #
    # @!attribute [rw] description
    #   A description of the data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDataSourceRequest AWS API Documentation
    #
    class AddDataSourceRequest < Struct.new(
      :domain_name,
      :name,
      :data_source_type,
      :description)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of an `AddDataSource` operation.
    #
    # @!attribute [rw] message
    #   A message associated with creation of the data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddDataSourceResponse AWS API Documentation
    #
    class AddDataSourceResponse < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `AddTags` operation. Specifies the
    # tags to attach to the domain.
    #
    # @!attribute [rw] arn
    #   Amazon Resource Name (ARN) for the OpenSearch Service domain to
    #   which you want to attach resource tags.
    #   @return [String]
    #
    # @!attribute [rw] tag_list
    #   List of resource tags.
    #   @return [Array<Types::Tag>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AddTagsRequest AWS API Documentation
    #
    class AddTagsRequest < Struct.new(
      :arn,
      :tag_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # List of limits that are specific to a given instance type.
    #
    # @!attribute [rw] limit_name
    #   * `MaximumNumberOfDataNodesSupported` - This attribute only applies
    #     to master nodes and specifies the maximum number of data nodes of
    #     a given instance type a master node can support.
    #
    #   * `MaximumNumberOfDataNodesWithoutMasterNode` - This attribute only
    #     applies to data nodes and specifies the maximum number of data
    #     nodes of a given instance type can exist without a master node
    #     governing them.
    #   @return [String]
    #
    # @!attribute [rw] limit_values
    #   The values of the additional instance type limits.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AdditionalLimit AWS API Documentation
    #
    class AdditionalLimit < Struct.new(
      :limit_name,
      :limit_values)
      SENSITIVE = []
      include Aws::Structure
    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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
    #
    # @!attribute [rw] options
    #   The status of advanced options for the specified domain.
    #   @return [Hash<String,String>]
    #
    # @!attribute [rw] status
    #   The status of advanced options for the specified domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AdvancedOptionsStatus AWS API Documentation
    #
    class AdvancedOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for fine-grained access control settings.
    #
    # @!attribute [rw] enabled
    #   True if fine-grained access control is enabled.
    #   @return [Boolean]
    #
    # @!attribute [rw] internal_user_database_enabled
    #   True if the internal user database is enabled.
    #   @return [Boolean]
    #
    # @!attribute [rw] saml_options
    #   Container for information about the SAML configuration for
    #   OpenSearch Dashboards.
    #   @return [Types::SAMLOptionsOutput]
    #
    # @!attribute [rw] anonymous_auth_disable_date
    #   Date and time when the migration period will be disabled. Only
    #   necessary when [enabling fine-grained access control on an existing
    #   domain][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing
    #   @return [Time]
    #
    # @!attribute [rw] anonymous_auth_enabled
    #   True if a 30-day migration period is enabled, during which
    #   administrators can create role mappings. Only necessary when
    #   [enabling fine-grained access control on an existing domain][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AdvancedSecurityOptions AWS API Documentation
    #
    class AdvancedSecurityOptions < Struct.new(
      :enabled,
      :internal_user_database_enabled,
      :saml_options,
      :anonymous_auth_disable_date,
      :anonymous_auth_enabled)
      SENSITIVE = []
      include Aws::Structure
    end

    # Options for enabling and configuring fine-grained access control. For
    # more information, see [Fine-grained access control in Amazon
    # OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html
    #
    # @!attribute [rw] enabled
    #   True to enable fine-grained access control.
    #   @return [Boolean]
    #
    # @!attribute [rw] internal_user_database_enabled
    #   True to enable the internal user database.
    #   @return [Boolean]
    #
    # @!attribute [rw] master_user_options
    #   Container for information about the master user.
    #   @return [Types::MasterUserOptions]
    #
    # @!attribute [rw] saml_options
    #   Container for information about the SAML configuration for
    #   OpenSearch Dashboards.
    #   @return [Types::SAMLOptionsInput]
    #
    # @!attribute [rw] anonymous_auth_enabled
    #   True to enable a 30-day migration period during which administrators
    #   can create role mappings. Only necessary when [enabling fine-grained
    #   access control on an existing domain][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AdvancedSecurityOptionsInput AWS API Documentation
    #
    class AdvancedSecurityOptionsInput < Struct.new(
      :enabled,
      :internal_user_database_enabled,
      :master_user_options,
      :saml_options,
      :anonymous_auth_enabled)
      SENSITIVE = []
      include Aws::Structure
    end

    # The status of fine-grained access control settings for a domain.
    #
    # @!attribute [rw] options
    #   Container for fine-grained access control settings.
    #   @return [Types::AdvancedSecurityOptions]
    #
    # @!attribute [rw] status
    #   Status of the fine-grained access control settings for a domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AdvancedSecurityOptionsStatus AWS API Documentation
    #
    class AdvancedSecurityOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `AssociatePackage`
    # operation.
    #
    # @!attribute [rw] package_id
    #   Internal ID of the package to associate with a domain. Use
    #   `DescribePackages` to find this value.
    #   @return [String]
    #
    # @!attribute [rw] domain_name
    #   Name of the domain to associate the package with.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackageRequest AWS API Documentation
    #
    class AssociatePackageRequest < Struct.new(
      :package_id,
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by the `AssociatePackage`
    # operation.
    #
    # @!attribute [rw] domain_package_details
    #   Information about a package that is associated with a domain.
    #   @return [Types::DomainPackageDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AssociatePackageResponse AWS API Documentation
    #
    class AssociatePackageResponse < Struct.new(
      :domain_package_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_name
    #   The name of the OpenSearch Service domain to provide access to.
    #   @return [String]
    #
    # @!attribute [rw] account
    #   The Amazon Web Services account ID to grant access to.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccessRequest AWS API Documentation
    #
    class AuthorizeVpcEndpointAccessRequest < Struct.new(
      :domain_name,
      :account)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] authorized_principal
    #   Information about the Amazon Web Services account or service that
    #   was provided access to the domain.
    #   @return [Types::AuthorizedPrincipal]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizeVpcEndpointAccessResponse AWS API Documentation
    #
    class AuthorizeVpcEndpointAccessResponse < Struct.new(
      :authorized_principal)
      SENSITIVE = []
      include Aws::Structure
    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.
    #
    # @!attribute [rw] principal_type
    #   The type of principal.
    #   @return [String]
    #
    # @!attribute [rw] principal
    #   The [IAM principal][1] that is allowed access to the domain.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AuthorizedPrincipal AWS API Documentation
    #
    class AuthorizedPrincipal < Struct.new(
      :principal_type,
      :principal)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about an Auto-Tune action. For more information, see
    # [Auto-Tune for Amazon OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
    #
    # @!attribute [rw] auto_tune_type
    #   The type of Auto-Tune action.
    #   @return [String]
    #
    # @!attribute [rw] auto_tune_details
    #   Details about an Auto-Tune action.
    #   @return [Types::AutoTuneDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTune AWS API Documentation
    #
    class AutoTune < Struct.new(
      :auto_tune_type,
      :auto_tune_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # Specifies details about a scheduled Auto-Tune action. For more
    # information, see [Auto-Tune for Amazon OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
    #
    # @!attribute [rw] scheduled_auto_tune_details
    #   Container for details about a scheduled Auto-Tune action.
    #   @return [Types::ScheduledAutoTuneDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneDetails AWS API Documentation
    #
    class AutoTuneDetails < Struct.new(
      :scheduled_auto_tune_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # <note markdown="1"> This object is deprecated. Use the domain's [off-peak window][1] to
    # schedule Auto-Tune optimizations. For migration instructions, see
    # [Migrating from Auto-Tune maintenance windows][2].
    #
    #  </note>
    #
    # The Auto-Tune maintenance schedule. For more information, see
    # [Auto-Tune for Amazon OpenSearch Service][3].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
    # [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html#off-peak-migrate
    # [3]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
    #
    # @!attribute [rw] start_at
    #   The Epoch timestamp at which the Auto-Tune maintenance schedule
    #   starts.
    #   @return [Time]
    #
    # @!attribute [rw] duration
    #   The duration of the maintenance schedule. For example, `"Duration":
    #   \{"Value": 2, "Unit": "HOURS"\}`.
    #   @return [Types::Duration]
    #
    # @!attribute [rw] cron_expression_for_recurrence
    #   A cron expression for a recurring maintenance schedule during which
    #   Auto-Tune can deploy changes.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneMaintenanceSchedule AWS API Documentation
    #
    class AutoTuneMaintenanceSchedule < Struct.new(
      :start_at,
      :duration,
      :cron_expression_for_recurrence)
      SENSITIVE = []
      include Aws::Structure
    end

    # Auto-Tune settings when updating a domain. For more information, see
    # [Auto-Tune for Amazon OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
    #
    # @!attribute [rw] desired_state
    #   Whether Auto-Tune is enabled or disabled.
    #   @return [String]
    #
    # @!attribute [rw] rollback_on_disable
    #   When disabling Auto-Tune, specify `NO_ROLLBACK` to retain all prior
    #   Auto-Tune settings or `DEFAULT_ROLLBACK` to revert to the OpenSearch
    #   Service defaults. If you specify `DEFAULT_ROLLBACK`, you must
    #   include a `MaintenanceSchedule` in the request. Otherwise,
    #   OpenSearch Service is unable to perform the rollback.
    #   @return [String]
    #
    # @!attribute [rw] maintenance_schedules
    #   DEPRECATED. Use [off-peak window][1] instead.
    #
    #   A list of maintenance schedules during which Auto-Tune can deploy
    #   changes.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
    #   @return [Array<Types::AutoTuneMaintenanceSchedule>]
    #
    # @!attribute [rw] use_off_peak_window
    #   Whether to use the domain's [off-peak window][1] to deploy
    #   configuration changes on the domain rather than a maintenance
    #   schedule.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptions AWS API Documentation
    #
    class AutoTuneOptions < Struct.new(
      :desired_state,
      :rollback_on_disable,
      :maintenance_schedules,
      :use_off_peak_window)
      SENSITIVE = []
      include Aws::Structure
    end

    # Options for configuring Auto-Tune. For more information, see
    # [Auto-Tune for Amazon OpenSearch Service][1]
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
    #
    # @!attribute [rw] desired_state
    #   Whether Auto-Tune is enabled or disabled.
    #   @return [String]
    #
    # @!attribute [rw] maintenance_schedules
    #   A list of maintenance schedules during which Auto-Tune can deploy
    #   changes. Maintenance windows are deprecated and have been replaced
    #   with [off-peak windows][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
    #   @return [Array<Types::AutoTuneMaintenanceSchedule>]
    #
    # @!attribute [rw] use_off_peak_window
    #   Whether to schedule Auto-Tune optimizations that require blue/green
    #   deployments during the domain's configured daily off-peak window.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptionsInput AWS API Documentation
    #
    class AutoTuneOptionsInput < Struct.new(
      :desired_state,
      :maintenance_schedules,
      :use_off_peak_window)
      SENSITIVE = []
      include Aws::Structure
    end

    # The Auto-Tune settings for a domain, displayed when enabling or
    # disabling Auto-Tune.
    #
    # @!attribute [rw] state
    #   The current state of Auto-Tune on the domain.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   Any errors that occurred while enabling or disabling Auto-Tune.
    #   @return [String]
    #
    # @!attribute [rw] use_off_peak_window
    #   Whether the domain's off-peak window will be used to deploy
    #   Auto-Tune changes rather than a maintenance schedule.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptionsOutput AWS API Documentation
    #
    class AutoTuneOptionsOutput < Struct.new(
      :state,
      :error_message,
      :use_off_peak_window)
      SENSITIVE = []
      include Aws::Structure
    end

    # The Auto-Tune status for the domain.
    #
    # @!attribute [rw] options
    #   Auto-Tune settings for updating a domain.
    #   @return [Types::AutoTuneOptions]
    #
    # @!attribute [rw] status
    #   The current status of Auto-Tune for a domain.
    #   @return [Types::AutoTuneStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneOptionsStatus AWS API Documentation
    #
    class AutoTuneOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # The current status of Auto-Tune for the domain. For more information,
    # see [Auto-Tune for Amazon OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
    #
    # @!attribute [rw] creation_date
    #   Date and time when Auto-Tune was enabled for the domain.
    #   @return [Time]
    #
    # @!attribute [rw] update_date
    #   Date and time when the Auto-Tune options were last updated for the
    #   domain.
    #   @return [Time]
    #
    # @!attribute [rw] update_version
    #   The latest version of the Auto-Tune options.
    #   @return [Integer]
    #
    # @!attribute [rw] state
    #   The current state of Auto-Tune on the domain.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   Any errors that occurred while enabling or disabling Auto-Tune.
    #   @return [String]
    #
    # @!attribute [rw] pending_deletion
    #   Indicates whether the domain is being deleted.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AutoTuneStatus AWS API Documentation
    #
    class AutoTuneStatus < Struct.new(
      :creation_date,
      :update_date,
      :update_version,
      :state,
      :error_message,
      :pending_deletion)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about an Availability Zone on a domain.
    #
    # @!attribute [rw] availability_zone_name
    #   The name of the Availability Zone.
    #   @return [String]
    #
    # @!attribute [rw] zone_status
    #   The current state of the Availability Zone. Current options are
    #   `Active` and `StandBy`.
    #
    #   * `Active` - Data nodes in the Availability Zone are in use.
    #
    #   * `StandBy` - Data nodes in the Availability Zone are in a standby
    #     state.
    #
    #   * `NotAvailable` - Unable to retrieve information.
    #   @return [String]
    #
    # @!attribute [rw] configured_data_node_count
    #   The total number of data nodes configured in the Availability Zone.
    #   @return [String]
    #
    # @!attribute [rw] available_data_node_count
    #   The number of data nodes active in the Availability Zone.
    #   @return [String]
    #
    # @!attribute [rw] total_shards
    #   The total number of primary and replica shards in the Availability
    #   Zone.
    #   @return [String]
    #
    # @!attribute [rw] total_un_assigned_shards
    #   The total number of primary and replica shards that aren't
    #   allocated to any of the nodes in the Availability Zone.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/AvailabilityZoneInfo AWS API Documentation
    #
    class AvailabilityZoneInfo < Struct.new(
      :availability_zone_name,
      :zone_status,
      :configured_data_node_count,
      :available_data_node_count,
      :total_shards,
      :total_un_assigned_shards)
      SENSITIVE = []
      include Aws::Structure
    end

    # An error occurred while processing the request.
    #
    # @!attribute [rw] message
    #   A description of the error.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/BaseException AWS API Documentation
    #
    class BaseException < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_name
    #   The name of an OpenSearch Service domain. Domain names are unique
    #   across the domains owned by an account within an Amazon Web Services
    #   Region.
    #   @return [String]
    #
    # @!attribute [rw] dry_run
    #   When set to `True`, returns the list of change IDs and properties
    #   that will be cancelled without actually cancelling the change.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelDomainConfigChangeRequest AWS API Documentation
    #
    class CancelDomainConfigChangeRequest < Struct.new(
      :domain_name,
      :dry_run)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] cancelled_change_ids
    #   The unique identifiers of the changes that were cancelled.
    #   @return [Array<String>]
    #
    # @!attribute [rw] cancelled_change_properties
    #   The domain change properties that were cancelled.
    #   @return [Array<Types::CancelledChangeProperty>]
    #
    # @!attribute [rw] dry_run
    #   Whether or not the request was a dry run. If `True`, the changes
    #   were not actually cancelled.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelDomainConfigChangeResponse AWS API Documentation
    #
    class CancelDomainConfigChangeResponse < Struct.new(
      :cancelled_change_ids,
      :cancelled_change_properties,
      :dry_run)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to cancel a service software
    # update.
    #
    # @!attribute [rw] domain_name
    #   Name of the OpenSearch Service domain that you want to cancel the
    #   service software update on.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdateRequest AWS API Documentation
    #
    class CancelServiceSoftwareUpdateRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response to a `CancelServiceSoftwareUpdate`
    # operation. Contains the status of the update.
    #
    # @!attribute [rw] service_software_options
    #   Container for the state of your domain relative to the latest
    #   service software.
    #   @return [Types::ServiceSoftwareOptions]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelServiceSoftwareUpdateResponse AWS API Documentation
    #
    class CancelServiceSoftwareUpdateResponse < Struct.new(
      :service_software_options)
      SENSITIVE = []
      include Aws::Structure
    end

    # A property change that was cancelled for an Amazon OpenSearch Service
    # domain.
    #
    # @!attribute [rw] property_name
    #   The name of the property whose change was cancelled.
    #   @return [String]
    #
    # @!attribute [rw] cancelled_value
    #   The pending value of the property that was cancelled. This would
    #   have been the eventual value of the property if the chance had not
    #   been cancelled.
    #   @return [String]
    #
    # @!attribute [rw] active_value
    #   The current value of the property, after the change was cancelled.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CancelledChangeProperty AWS API Documentation
    #
    class CancelledChangeProperty < Struct.new(
      :property_name,
      :cancelled_value,
      :active_value)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for information about a configuration change happening on a
    # domain.
    #
    # @!attribute [rw] change_id
    #   The ID of the configuration change.
    #   @return [String]
    #
    # @!attribute [rw] message
    #   A message corresponding to the status of the configuration change.
    #   @return [String]
    #
    # @!attribute [rw] config_change_status
    #   The current status of the configuration change.
    #   @return [String]
    #
    # @!attribute [rw] initiated_by
    #   The IAM principal who initiated the configuration change.
    #   @return [String]
    #
    # @!attribute [rw] start_time
    #   The time that the configuration change was initiated, in Universal
    #   Coordinated Time (UTC).
    #   @return [Time]
    #
    # @!attribute [rw] last_updated_time
    #   The last time that the configuration change was updated.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ChangeProgressDetails AWS API Documentation
    #
    class ChangeProgressDetails < Struct.new(
      :change_id,
      :message,
      :config_change_status,
      :initiated_by,
      :start_time,
      :last_updated_time)
      SENSITIVE = []
      include Aws::Structure
    end

    # Progress details for each stage of a domain update.
    #
    # @!attribute [rw] name
    #   The name of the stage.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The status of the stage.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The description of the stage.
    #   @return [String]
    #
    # @!attribute [rw] last_updated
    #   The most recent updated timestamp of the stage.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ChangeProgressStage AWS API Documentation
    #
    class ChangeProgressStage < Struct.new(
      :name,
      :status,
      :description,
      :last_updated)
      SENSITIVE = []
      include Aws::Structure
    end

    # The progress details of a specific domain configuration change.
    #
    # @!attribute [rw] change_id
    #   The unique change identifier associated with a specific domain
    #   configuration change.
    #   @return [String]
    #
    # @!attribute [rw] start_time
    #   The time at which the configuration change is made on the domain.
    #   @return [Time]
    #
    # @!attribute [rw] status
    #   The overall status of the domain configuration change.
    #   @return [String]
    #
    # @!attribute [rw] pending_properties
    #   The list of properties in the domain configuration change that are
    #   still pending.
    #   @return [Array<String>]
    #
    # @!attribute [rw] completed_properties
    #   The list of properties in the domain configuration change that have
    #   completed.
    #   @return [Array<String>]
    #
    # @!attribute [rw] total_number_of_stages
    #   The total number of stages required for the configuration change.
    #   @return [Integer]
    #
    # @!attribute [rw] change_progress_stages
    #   The specific stages that the domain is going through to perform the
    #   configuration change.
    #   @return [Array<Types::ChangeProgressStage>]
    #
    # @!attribute [rw] last_updated_time
    #   The last time that the status of the configuration change was
    #   updated.
    #   @return [Time]
    #
    # @!attribute [rw] config_change_status
    #   The current status of the configuration change.
    #   @return [String]
    #
    # @!attribute [rw] initiated_by
    #   The IAM principal who initiated the configuration change.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ChangeProgressStatusDetails AWS API Documentation
    #
    class ChangeProgressStatusDetails < Struct.new(
      :change_id,
      :start_time,
      :status,
      :pending_properties,
      :completed_properties,
      :total_number_of_stages,
      :change_progress_stages,
      :last_updated_time,
      :config_change_status,
      :initiated_by)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the cluster configuration of an OpenSearch Service
    # domain. For more information, see [Creating and managing Amazon
    # OpenSearch Service domains][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html
    #
    # @!attribute [rw] instance_type
    #   Instance type of data nodes in the cluster.
    #   @return [String]
    #
    # @!attribute [rw] instance_count
    #   Number of data nodes in the cluster. This number must be greater
    #   than 1, otherwise you receive a validation exception.
    #   @return [Integer]
    #
    # @!attribute [rw] dedicated_master_enabled
    #   Indicates whether dedicated master nodes are enabled for the
    #   cluster.`True` if the cluster will use a dedicated master
    #   node.`False` if the cluster will not.
    #   @return [Boolean]
    #
    # @!attribute [rw] zone_awareness_enabled
    #   Indicates whether multiple Availability Zones are enabled. For more
    #   information, see [Configuring a multi-AZ domain in Amazon OpenSearch
    #   Service][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html
    #   @return [Boolean]
    #
    # @!attribute [rw] zone_awareness_config
    #   Container for zone awareness configuration options. Only required if
    #   `ZoneAwarenessEnabled` is `true`.
    #   @return [Types::ZoneAwarenessConfig]
    #
    # @!attribute [rw] dedicated_master_type
    #   OpenSearch Service instance type of the dedicated master nodes in
    #   the cluster.
    #   @return [String]
    #
    # @!attribute [rw] dedicated_master_count
    #   Number of dedicated master nodes in the cluster. This number must be
    #   greater than 2 and not 4, otherwise you receive a validation
    #   exception.
    #   @return [Integer]
    #
    # @!attribute [rw] warm_enabled
    #   Whether to enable warm storage for the cluster.
    #   @return [Boolean]
    #
    # @!attribute [rw] warm_type
    #   The instance type for the cluster's warm nodes.
    #   @return [String]
    #
    # @!attribute [rw] warm_count
    #   The number of warm nodes in the cluster.
    #   @return [Integer]
    #
    # @!attribute [rw] cold_storage_options
    #   Container for cold storage configuration options.
    #   @return [Types::ColdStorageOptions]
    #
    # @!attribute [rw] multi_az_with_standby_enabled
    #   A boolean that indicates whether a multi-AZ domain is turned on with
    #   a standby AZ. For more information, see [Configuring a multi-AZ
    #   domain in Amazon OpenSearch Service][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ClusterConfig AWS API Documentation
    #
    class ClusterConfig < Struct.new(
      :instance_type,
      :instance_count,
      :dedicated_master_enabled,
      :zone_awareness_enabled,
      :zone_awareness_config,
      :dedicated_master_type,
      :dedicated_master_count,
      :warm_enabled,
      :warm_type,
      :warm_count,
      :cold_storage_options,
      :multi_az_with_standby_enabled)
      SENSITIVE = []
      include Aws::Structure
    end

    # The cluster configuration status for a domain.
    #
    # @!attribute [rw] options
    #   Cluster configuration options for the specified domain.
    #   @return [Types::ClusterConfig]
    #
    # @!attribute [rw] status
    #   The status of cluster configuration options for the specified
    #   domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ClusterConfigStatus AWS API Documentation
    #
    class ClusterConfigStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
    #
    # @!attribute [rw] enabled
    #   Whether to enable or disable Amazon Cognito authentication for
    #   OpenSearch Dashboards.
    #   @return [Boolean]
    #
    # @!attribute [rw] user_pool_id
    #   The Amazon Cognito user pool ID that you want OpenSearch Service to
    #   use for OpenSearch Dashboards authentication.
    #   @return [String]
    #
    # @!attribute [rw] identity_pool_id
    #   The Amazon Cognito identity pool ID that you want OpenSearch Service
    #   to use for OpenSearch Dashboards authentication.
    #   @return [String]
    #
    # @!attribute [rw] role_arn
    #   The `AmazonOpenSearchServiceCognitoAccess` role that allows
    #   OpenSearch Service to configure your user pool and identity pool.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CognitoOptions AWS API Documentation
    #
    class CognitoOptions < Struct.new(
      :enabled,
      :user_pool_id,
      :identity_pool_id,
      :role_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # The status of the Cognito options for the specified domain.
    #
    # @!attribute [rw] options
    #   Cognito options for the specified domain.
    #   @return [Types::CognitoOptions]
    #
    # @!attribute [rw] status
    #   The status of the Cognito options for the specified domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CognitoOptionsStatus AWS API Documentation
    #
    class CognitoOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cold-storage.html
    #
    # @!attribute [rw] enabled
    #   Whether to enable or disable cold storage on the domain.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ColdStorageOptions AWS API Documentation
    #
    class ColdStorageOptions < Struct.new(
      :enabled)
      SENSITIVE = []
      include Aws::Structure
    end

    # A map of OpenSearch or Elasticsearch versions and the versions you can
    # upgrade them to.
    #
    # @!attribute [rw] source_version
    #   The current version that the OpenSearch Service domain is running.
    #   @return [String]
    #
    # @!attribute [rw] target_versions
    #   The possible versions that you can upgrade the domain to.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CompatibleVersionsMap AWS API Documentation
    #
    class CompatibleVersionsMap < Struct.new(
      :source_version,
      :target_versions)
      SENSITIVE = []
      include Aws::Structure
    end

    # An error occurred because the client attempts to remove a resource
    # that is currently in use.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ConflictException AWS API Documentation
    #
    class ConflictException < Aws::EmptyStructure; end

    # The connection properties of an outbound connection.
    #
    # @!attribute [rw] endpoint
    #   The Endpoint attribute cannot be modified.
    #
    #   The endpoint of the remote domain. Applicable for VPC\_ENDPOINT
    #   connection mode.
    #   @return [String]
    #
    # @!attribute [rw] cross_cluster_search
    #   The connection properties for cross cluster search.
    #   @return [Types::CrossClusterSearchConnectionProperties]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ConnectionProperties AWS API Documentation
    #
    class ConnectionProperties < Struct.new(
      :endpoint,
      :cross_cluster_search)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_name
    #   Name of the OpenSearch Service domain to create. Domain names are
    #   unique across the domains owned by an account within an Amazon Web
    #   Services Region.
    #   @return [String]
    #
    # @!attribute [rw] engine_version
    #   String of format Elasticsearch\_X.Y or OpenSearch\_X.Y to specify
    #   the engine version for the OpenSearch Service domain. For example,
    #   `OpenSearch_1.0` or `Elasticsearch_7.9`. For more information, see
    #   [Creating and managing Amazon OpenSearch Service domains][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains
    #   @return [String]
    #
    # @!attribute [rw] cluster_config
    #   Container for the cluster configuration of a domain.
    #   @return [Types::ClusterConfig]
    #
    # @!attribute [rw] ebs_options
    #   Container for the parameters required to enable EBS-based storage
    #   for an OpenSearch Service domain.
    #   @return [Types::EBSOptions]
    #
    # @!attribute [rw] access_policies
    #   Identity and Access Management (IAM) policy document specifying the
    #   access policies for the new domain.
    #   @return [String]
    #
    # @!attribute [rw] ip_address_type
    #   Specify either dual stack or IPv4 as your IP address type. Dual
    #   stack allows you to share domain resources across IPv4 and IPv6
    #   address types, and is the recommended option. If you set your IP
    #   address type to dual stack, you can't change your address type
    #   later.
    #   @return [String]
    #
    # @!attribute [rw] snapshot_options
    #   DEPRECATED. Container for the parameters required to configure
    #   automated snapshots of domain indexes.
    #   @return [Types::SnapshotOptions]
    #
    # @!attribute [rw] vpc_options
    #   Container for the values required to configure VPC access domains.
    #   If you don't specify these values, OpenSearch Service creates the
    #   domain with a public endpoint. For more information, see [Launching
    #   your Amazon OpenSearch Service domains using a VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
    #   @return [Types::VPCOptions]
    #
    # @!attribute [rw] cognito_options
    #   Key-value pairs to configure Amazon Cognito authentication. For more
    #   information, see [Configuring Amazon Cognito authentication for
    #   OpenSearch Dashboards][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html
    #   @return [Types::CognitoOptions]
    #
    # @!attribute [rw] encryption_at_rest_options
    #   Key-value pairs to enable encryption at rest.
    #   @return [Types::EncryptionAtRestOptions]
    #
    # @!attribute [rw] node_to_node_encryption_options
    #   Enables node-to-node encryption.
    #   @return [Types::NodeToNodeEncryptionOptions]
    #
    # @!attribute [rw] advanced_options
    #   Key-value pairs to specify advanced configuration options. The
    #   following key-value pairs are supported:
    #
    #   * `"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][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
    #   @return [Hash<String,String>]
    #
    # @!attribute [rw] log_publishing_options
    #   Key-value pairs to configure log publishing.
    #   @return [Hash<String,Types::LogPublishingOption>]
    #
    # @!attribute [rw] domain_endpoint_options
    #   Additional options for the domain endpoint, such as whether to
    #   require HTTPS for all traffic.
    #   @return [Types::DomainEndpointOptions]
    #
    # @!attribute [rw] advanced_security_options
    #   Options for fine-grained access control.
    #   @return [Types::AdvancedSecurityOptionsInput]
    #
    # @!attribute [rw] tag_list
    #   List of tags to add to the domain upon creation.
    #   @return [Array<Types::Tag>]
    #
    # @!attribute [rw] auto_tune_options
    #   Options for Auto-Tune.
    #   @return [Types::AutoTuneOptionsInput]
    #
    # @!attribute [rw] off_peak_window_options
    #   Specifies a daily 10-hour time block during which OpenSearch Service
    #   can perform configuration changes on the domain, including service
    #   software updates and Auto-Tune enhancements that require a
    #   blue/green deployment. If no options are specified, the default
    #   start time of 10:00 P.M. local time (for the Region that the domain
    #   is created in) is used.
    #   @return [Types::OffPeakWindowOptions]
    #
    # @!attribute [rw] software_update_options
    #   Software update options for the domain.
    #   @return [Types::SoftwareUpdateOptions]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomainRequest AWS API Documentation
    #
    class CreateDomainRequest < Struct.new(
      :domain_name,
      :engine_version,
      :cluster_config,
      :ebs_options,
      :access_policies,
      :ip_address_type,
      :snapshot_options,
      :vpc_options,
      :cognito_options,
      :encryption_at_rest_options,
      :node_to_node_encryption_options,
      :advanced_options,
      :log_publishing_options,
      :domain_endpoint_options,
      :advanced_security_options,
      :tag_list,
      :auto_tune_options,
      :off_peak_window_options,
      :software_update_options)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `CreateDomain` operation. Contains the status of the
    # newly created domain.
    #
    # @!attribute [rw] domain_status
    #   The status of the newly created domain.
    #   @return [Types::DomainStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateDomainResponse AWS API Documentation
    #
    class CreateDomainResponse < Struct.new(
      :domain_status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `CreateOutboundConnection`
    # operation.
    #
    # @!attribute [rw] local_domain_info
    #   Name and Region of the source (local) domain.
    #   @return [Types::DomainInformationContainer]
    #
    # @!attribute [rw] remote_domain_info
    #   Name and Region of the destination (remote) domain.
    #   @return [Types::DomainInformationContainer]
    #
    # @!attribute [rw] connection_alias
    #   Name of the connection.
    #   @return [String]
    #
    # @!attribute [rw] connection_mode
    #   The connection mode.
    #   @return [String]
    #
    # @!attribute [rw] connection_properties
    #   The `ConnectionProperties` for the outbound connection.
    #   @return [Types::ConnectionProperties]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnectionRequest AWS API Documentation
    #
    class CreateOutboundConnectionRequest < Struct.new(
      :local_domain_info,
      :remote_domain_info,
      :connection_alias,
      :connection_mode,
      :connection_properties)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `CreateOutboundConnection` request. Contains details
    # about the newly created cross-cluster connection.
    #
    # @!attribute [rw] local_domain_info
    #   Information about the source (local) domain.
    #   @return [Types::DomainInformationContainer]
    #
    # @!attribute [rw] remote_domain_info
    #   Information about the destination (remote) domain.
    #   @return [Types::DomainInformationContainer]
    #
    # @!attribute [rw] connection_alias
    #   Name of the connection.
    #   @return [String]
    #
    # @!attribute [rw] connection_status
    #   The status of the connection.
    #   @return [Types::OutboundConnectionStatus]
    #
    # @!attribute [rw] connection_id
    #   The unique identifier for the created outbound connection, which is
    #   used for subsequent operations on the connection.
    #   @return [String]
    #
    # @!attribute [rw] connection_mode
    #   The connection mode.
    #   @return [String]
    #
    # @!attribute [rw] connection_properties
    #   The `ConnectionProperties` for the newly created connection.
    #   @return [Types::ConnectionProperties]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateOutboundConnectionResponse AWS API Documentation
    #
    class CreateOutboundConnectionResponse < Struct.new(
      :local_domain_info,
      :remote_domain_info,
      :connection_alias,
      :connection_status,
      :connection_id,
      :connection_mode,
      :connection_properties)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for request parameters to the `CreatePackage` operation.
    #
    # @!attribute [rw] package_name
    #   Unique name for the package.
    #   @return [String]
    #
    # @!attribute [rw] package_type
    #   The type of package.
    #   @return [String]
    #
    # @!attribute [rw] package_description
    #   Description of the package.
    #   @return [String]
    #
    # @!attribute [rw] package_source
    #   The Amazon S3 location from which to import the package.
    #   @return [Types::PackageSource]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackageRequest AWS API Documentation
    #
    class CreatePackageRequest < Struct.new(
      :package_name,
      :package_type,
      :package_description,
      :package_source)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by the `CreatePackage` operation.
    #
    # @!attribute [rw] package_details
    #   Basic information about an OpenSearch Service package.
    #   @return [Types::PackageDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreatePackageResponse AWS API Documentation
    #
    class CreatePackageResponse < Struct.new(
      :package_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_arn
    #   The Amazon Resource Name (ARN) of the domain to create the endpoint
    #   for.
    #   @return [String]
    #
    # @!attribute [rw] vpc_options
    #   Options to specify the subnets and security groups for the endpoint.
    #   @return [Types::VPCOptions]
    #
    # @!attribute [rw] client_token
    #   Unique, case-sensitive identifier to ensure idempotency of the
    #   request.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateVpcEndpointRequest AWS API Documentation
    #
    class CreateVpcEndpointRequest < Struct.new(
      :domain_arn,
      :vpc_options,
      :client_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoint
    #   Information about the newly created VPC endpoint.
    #   @return [Types::VpcEndpoint]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CreateVpcEndpointResponse AWS API Documentation
    #
    class CreateVpcEndpointResponse < Struct.new(
      :vpc_endpoint)
      SENSITIVE = []
      include Aws::Structure
    end

    # Cross-cluster search specific connection properties.
    #
    # @!attribute [rw] skip_unavailable
    #   The status of the `SkipUnavailable` setting for the outbound
    #   connection. This feature allows you to specify some clusters as
    #   optional and ensure that your cross-cluster queries return partial
    #   results despite failures on one or more remote clusters.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/CrossClusterSearchConnectionProperties AWS API Documentation
    #
    class CrossClusterSearchConnectionProperties < Struct.new(
      :skip_unavailable)
      SENSITIVE = []
      include Aws::Structure
    end

    # Details about a direct-query data source.
    #
    # @!attribute [rw] data_source_type
    #   The type of data source.
    #   @return [Types::DataSourceType]
    #
    # @!attribute [rw] name
    #   The name of the data source.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A description of the data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DataSourceDetails AWS API Documentation
    #
    class DataSourceDetails < Struct.new(
      :data_source_type,
      :name,
      :description)
      SENSITIVE = []
      include Aws::Structure
    end

    # The type of data source.
    #
    # @note DataSourceType is a union - when making an API calls you must set exactly one of the members.
    #
    # @note DataSourceType is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DataSourceType corresponding to the set member.
    #
    # @!attribute [rw] s3_glue_data_catalog
    #   An Amazon S3 data source.
    #   @return [Types::S3GlueDataCatalog]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DataSourceType AWS API Documentation
    #
    class DataSourceType < Struct.new(
      :s3_glue_data_catalog,
      :unknown)
      SENSITIVE = []
      include Aws::Structure
      include Aws::Structure::Union

      class S3GlueDataCatalog < DataSourceType; end
      class Unknown < DataSourceType; end
    end

    # Container for the parameters to the `DeleteDataSource` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name of the data source to delete.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDataSourceRequest AWS API Documentation
    #
    class DeleteDataSourceRequest < Struct.new(
      :domain_name,
      :name)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `GetDataSource` operation.
    #
    # @!attribute [rw] message
    #   A message associated with deletion of the data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDataSourceResponse AWS API Documentation
    #
    class DeleteDataSourceResponse < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DeleteDomain` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain you want to permanently delete.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomainRequest AWS API Documentation
    #
    class DeleteDomainRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    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.
    #
    # @!attribute [rw] domain_status
    #   The status of the domain being deleted.
    #   @return [Types::DomainStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteDomainResponse AWS API Documentation
    #
    class DeleteDomainResponse < Struct.new(
      :domain_status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DeleteInboundConnection`
    # operation.
    #
    # @!attribute [rw] connection_id
    #   The ID of the inbound connection to permanently delete.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteInboundConnectionRequest AWS API Documentation
    #
    class DeleteInboundConnectionRequest < Struct.new(
      :connection_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # The results of a `DeleteInboundConnection` operation. Contains details
    # about the deleted inbound connection.
    #
    # @!attribute [rw] connection
    #   The deleted inbound connection.
    #   @return [Types::InboundConnection]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteInboundConnectionResponse AWS API Documentation
    #
    class DeleteInboundConnectionResponse < Struct.new(
      :connection)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DeleteOutboundConnection`
    # operation.
    #
    # @!attribute [rw] connection_id
    #   The ID of the outbound connection you want to permanently delete.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteOutboundConnectionRequest AWS API Documentation
    #
    class DeleteOutboundConnectionRequest < Struct.new(
      :connection_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Details about the deleted outbound connection.
    #
    # @!attribute [rw] connection
    #   The deleted inbound connection.
    #   @return [Types::OutboundConnection]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteOutboundConnectionResponse AWS API Documentation
    #
    class DeleteOutboundConnectionResponse < Struct.new(
      :connection)
      SENSITIVE = []
      include Aws::Structure
    end

    # Deletes a package from OpenSearch Service. The package can't be
    # associated with any OpenSearch Service domain.
    #
    # @!attribute [rw] package_id
    #   The internal ID of the package you want to delete. Use
    #   `DescribePackages` to find this value.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeletePackageRequest AWS API Documentation
    #
    class DeletePackageRequest < Struct.new(
      :package_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response parameters to the `DeletePackage`
    # operation.
    #
    # @!attribute [rw] package_details
    #   Information about the deleted package.
    #   @return [Types::PackageDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeletePackageResponse AWS API Documentation
    #
    class DeletePackageResponse < Struct.new(
      :package_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoint_id
    #   The unique identifier of the endpoint.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteVpcEndpointRequest AWS API Documentation
    #
    class DeleteVpcEndpointRequest < Struct.new(
      :vpc_endpoint_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoint_summary
    #   Information about the deleted endpoint, including its current status
    #   (`DELETING` or `DELETE_FAILED`).
    #   @return [Types::VpcEndpointSummary]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DeleteVpcEndpointResponse AWS API Documentation
    #
    class DeleteVpcEndpointResponse < Struct.new(
      :vpc_endpoint_summary)
      SENSITIVE = []
      include Aws::Structure
    end

    # An exception for when a failure in one of the dependencies results in
    # the service being unable to fetch details about the resource.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DependencyFailureException AWS API Documentation
    #
    class DependencyFailureException < Aws::EmptyStructure; end

    # Container for the parameters to the `DescribeDomainAutoTunes`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   Name of the domain that you want Auto-Tune details about.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `DescribeDomainAutoTunes` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `DescribeDomainAutoTunes` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainAutoTunesRequest AWS API Documentation
    #
    class DescribeDomainAutoTunesRequest < Struct.new(
      :domain_name,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `DescribeDomainAutoTunes` request.
    #
    # @!attribute [rw] auto_tunes
    #   The list of setting adjustments that Auto-Tune has made to the
    #   domain.
    #   @return [Array<Types::AutoTune>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainAutoTunesResponse AWS API Documentation
    #
    class DescribeDomainAutoTunesResponse < Struct.new(
      :auto_tunes,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeDomainChangeProgress`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain to get progress information for.
    #   @return [String]
    #
    # @!attribute [rw] change_id
    #   The specific change ID for which you want to get progress
    #   information. If omitted, the request returns information about the
    #   most recent configuration change.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainChangeProgressRequest AWS API Documentation
    #
    class DescribeDomainChangeProgressRequest < Struct.new(
      :domain_name,
      :change_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `DescribeDomainChangeProgress` request. Contains
    # progress information for the requested domain change.
    #
    # @!attribute [rw] change_progress_status
    #   Container for information about the stages of a configuration change
    #   happening on a domain.
    #   @return [Types::ChangeProgressStatusDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainChangeProgressResponse AWS API Documentation
    #
    class DescribeDomainChangeProgressResponse < Struct.new(
      :change_progress_status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeDomainConfig` operation.
    #
    # @!attribute [rw] domain_name
    #   Name of the OpenSearch Service domain configuration that you want to
    #   describe.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfigRequest AWS API Documentation
    #
    class DescribeDomainConfigRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Contains the configuration information of the requested domain.
    #
    # @!attribute [rw] domain_config
    #   Container for the configuration of the OpenSearch Service domain.
    #   @return [Types::DomainConfig]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainConfigResponse AWS API Documentation
    #
    class DescribeDomainConfigResponse < Struct.new(
      :domain_config)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeDomainHealth` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainHealthRequest AWS API Documentation
    #
    class DescribeDomainHealthRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `DescribeDomainHealth` request. Contains health
    # information for the requested domain.
    #
    # @!attribute [rw] domain_state
    #   The current state of the domain.
    #
    #   * `Processing` - The domain has updates in progress.
    #
    #   * `Active` - Requested changes have been processed and deployed to
    #     the domain.
    #   @return [String]
    #
    # @!attribute [rw] availability_zone_count
    #   The number of Availability Zones configured for the domain. If the
    #   service is unable to fetch this information, it will return
    #   `NotAvailable`.
    #   @return [String]
    #
    # @!attribute [rw] active_availability_zone_count
    #   The number of active Availability Zones configured for the domain.
    #   If the service is unable to fetch this information, it will return
    #   `NotAvailable`.
    #   @return [String]
    #
    # @!attribute [rw] stand_by_availability_zone_count
    #   The number of standby Availability Zones configured for the domain.
    #   If the service is unable to fetch this information, it will return
    #   `NotAvailable`.
    #   @return [String]
    #
    # @!attribute [rw] data_node_count
    #   The number of data nodes configured for the domain. If the service
    #   is unable to fetch this information, it will return `NotAvailable`.
    #   @return [String]
    #
    # @!attribute [rw] dedicated_master
    #   A boolean that indicates if dedicated master nodes are activated for
    #   the domain.
    #   @return [Boolean]
    #
    # @!attribute [rw] master_eligible_node_count
    #   The number of nodes that can be elected as a master node. If
    #   dedicated master nodes is turned on, this value is the number of
    #   dedicated master nodes configured for the domain. If the service is
    #   unable to fetch this information, it will return `NotAvailable`.
    #   @return [String]
    #
    # @!attribute [rw] warm_node_count
    #   The number of warm nodes configured for the domain.
    #   @return [String]
    #
    # @!attribute [rw] master_node
    #   Indicates whether the domain has an elected master node.
    #
    #   * **Available** - The domain has an elected master node.
    #
    #   * **UnAvailable** - The master node hasn't yet been elected, and a
    #     quorum to elect a new master node hasn't been reached.
    #   @return [String]
    #
    # @!attribute [rw] cluster_health
    #   The current health status of your cluster.
    #
    #   * `Red` - At least one primary shard is not allocated to any node.
    #
    #   * `Yellow` - All primary shards are allocated to nodes, but some
    #     replicas aren’t.
    #
    #   * `Green` - All primary shards and their replicas are allocated to
    #     nodes.
    #
    #   * `NotAvailable` - Unable to retrieve cluster health.
    #   @return [String]
    #
    # @!attribute [rw] total_shards
    #   The total number of primary and replica shards for the domain.
    #   @return [String]
    #
    # @!attribute [rw] total_un_assigned_shards
    #   The total number of primary and replica shards not allocated to any
    #   of the nodes for the cluster.
    #   @return [String]
    #
    # @!attribute [rw] environment_information
    #   A list of `EnvironmentInfo` for the domain.
    #   @return [Array<Types::EnvironmentInfo>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainHealthResponse AWS API Documentation
    #
    class DescribeDomainHealthResponse < Struct.new(
      :domain_state,
      :availability_zone_count,
      :active_availability_zone_count,
      :stand_by_availability_zone_count,
      :data_node_count,
      :dedicated_master,
      :master_eligible_node_count,
      :warm_node_count,
      :master_node,
      :cluster_health,
      :total_shards,
      :total_un_assigned_shards,
      :environment_information)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeDomainNodes` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainNodesRequest AWS API Documentation
    #
    class DescribeDomainNodesRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `DescribeDomainNodes` request. Contains information
    # about the nodes on the requested domain.
    #
    # @!attribute [rw] domain_nodes_status_list
    #   Contains nodes information list `DomainNodesStatusList` with details
    #   about the all nodes on the requested domain.
    #   @return [Array<Types::DomainNodesStatus>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainNodesResponse AWS API Documentation
    #
    class DescribeDomainNodesResponse < Struct.new(
      :domain_nodes_status_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeDomain` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain that you want information about.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainRequest AWS API Documentation
    #
    class DescribeDomainRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Contains the status of the domain specified in the request.
    #
    # @!attribute [rw] domain_status
    #   List that contains the status of each specified OpenSearch Service
    #   domain.
    #   @return [Types::DomainStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainResponse AWS API Documentation
    #
    class DescribeDomainResponse < Struct.new(
      :domain_status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeDomains` operation.
    #
    # @!attribute [rw] domain_names
    #   Array of OpenSearch Service domain names that you want information
    #   about. You must specify at least one domain name.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainsRequest AWS API Documentation
    #
    class DescribeDomainsRequest < Struct.new(
      :domain_names)
      SENSITIVE = []
      include Aws::Structure
    end

    # Contains the status of the specified domains or all domains owned by
    # the account.
    #
    # @!attribute [rw] domain_status_list
    #   The status of the requested domains.
    #   @return [Array<Types::DomainStatus>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDomainsResponse AWS API Documentation
    #
    class DescribeDomainsResponse < Struct.new(
      :domain_status_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] dry_run_id
    #   The unique identifier of the dry run.
    #   @return [String]
    #
    # @!attribute [rw] load_dry_run_config
    #   Whether to include the configuration of the dry run in the response.
    #   The configuration specifies the updates that you're planning to
    #   make on the domain.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDryRunProgressRequest AWS API Documentation
    #
    class DescribeDryRunProgressRequest < Struct.new(
      :domain_name,
      :dry_run_id,
      :load_dry_run_config)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] dry_run_progress_status
    #   The current status of the dry run, including any validation errors.
    #   @return [Types::DryRunProgressStatus]
    #
    # @!attribute [rw] dry_run_config
    #   Details about the changes you're planning to make on the domain.
    #   @return [Types::DomainStatus]
    #
    # @!attribute [rw] dry_run_results
    #   The results of the dry run.
    #   @return [Types::DryRunResults]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeDryRunProgressResponse AWS API Documentation
    #
    class DescribeDryRunProgressResponse < Struct.new(
      :dry_run_progress_status,
      :dry_run_config,
      :dry_run_results)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeInboundConnections`
    # operation.
    #
    # @!attribute [rw] filters
    #   A list of filters used to match properties for inbound cross-cluster
    #   connections.
    #   @return [Array<Types::Filter>]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `DescribeInboundConnections` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `DescribeInboundConnections` operations, which returns results in
    #   the next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInboundConnectionsRequest AWS API Documentation
    #
    class DescribeInboundConnectionsRequest < Struct.new(
      :filters,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Contains a list of connections matching the filter criteria.
    #
    # @!attribute [rw] connections
    #   List of inbound connections.
    #   @return [Array<Types::InboundConnection>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInboundConnectionsResponse AWS API Documentation
    #
    class DescribeInboundConnectionsResponse < Struct.new(
      :connections,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeInstanceTypeLimits`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain. Only specify if you need the limits for an
    #   existing domain.
    #   @return [String]
    #
    # @!attribute [rw] instance_type
    #   The OpenSearch Service instance type for which you need limit
    #   information.
    #   @return [String]
    #
    # @!attribute [rw] engine_version
    #   Version of OpenSearch or Elasticsearch, in the format
    #   Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest
    #   version of OpenSearch.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInstanceTypeLimitsRequest AWS API Documentation
    #
    class DescribeInstanceTypeLimitsRequest < Struct.new(
      :domain_name,
      :instance_type,
      :engine_version)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters received from the
    # `DescribeInstanceTypeLimits` operation.
    #
    # @!attribute [rw] limits_by_role
    #   Map that contains all applicable instance type limits.`data` refers
    #   to data nodes.`master` refers to dedicated master nodes.
    #   @return [Hash<String,Types::Limits>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeInstanceTypeLimitsResponse AWS API Documentation
    #
    class DescribeInstanceTypeLimitsResponse < Struct.new(
      :limits_by_role)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `DescribeOutboundConnections`
    # operation.
    #
    # @!attribute [rw] filters
    #   List of filter names and values that you can use for requests.
    #   @return [Array<Types::Filter>]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `DescribeOutboundConnections` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `DescribeOutboundConnections` operations, which returns results in
    #   the next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeOutboundConnectionsRequest AWS API Documentation
    #
    class DescribeOutboundConnectionsRequest < Struct.new(
      :filters,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Contains a list of connections matching the filter criteria.
    #
    # @!attribute [rw] connections
    #   List of outbound connections that match the filter criteria.
    #   @return [Array<Types::OutboundConnection>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeOutboundConnectionsResponse AWS API Documentation
    #
    class DescribeOutboundConnectionsResponse < Struct.new(
      :connections,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # A filter to apply to the `DescribePackage` response.
    #
    # @!attribute [rw] name
    #   Any field from `PackageDetails`.
    #   @return [String]
    #
    # @!attribute [rw] value
    #   A non-empty list of values for the specified filter field.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackagesFilter AWS API Documentation
    #
    class DescribePackagesFilter < Struct.new(
      :name,
      :value)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `DescribePackage`
    # operation.
    #
    # @!attribute [rw] filters
    #   Only returns packages that match the `DescribePackagesFilterList`
    #   values.
    #   @return [Array<Types::DescribePackagesFilter>]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `DescribePackageFilters` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `DescribePackageFilters` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackagesRequest AWS API Documentation
    #
    class DescribePackagesRequest < Struct.new(
      :filters,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by the `DescribePackages`
    # operation.
    #
    # @!attribute [rw] package_details_list
    #   Basic information about a package.
    #   @return [Array<Types::PackageDetails>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribePackagesResponse AWS API Documentation
    #
    class DescribePackagesResponse < Struct.new(
      :package_details_list,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to a
    # `DescribeReservedInstanceOfferings` operation.
    #
    # @!attribute [rw] reserved_instance_offering_id
    #   The Reserved Instance identifier filter value. Use this parameter to
    #   show only the available instance types that match the specified
    #   reservation identifier.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `DescribeReservedInstanceOfferings` operation
    #   returns a `nextToken`, you can include the returned `nextToken` in
    #   subsequent `DescribeReservedInstanceOfferings` operations, which
    #   returns results in the next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstanceOfferingsRequest AWS API Documentation
    #
    class DescribeReservedInstanceOfferingsRequest < Struct.new(
      :reserved_instance_offering_id,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for results of a `DescribeReservedInstanceOfferings`
    # request.
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @!attribute [rw] reserved_instance_offerings
    #   List of Reserved Instance offerings.
    #   @return [Array<Types::ReservedInstanceOffering>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstanceOfferingsResponse AWS API Documentation
    #
    class DescribeReservedInstanceOfferingsResponse < Struct.new(
      :next_token,
      :reserved_instance_offerings)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the
    # `DescribeReservedInstances` operation.
    #
    # @!attribute [rw] reserved_instance_id
    #   The reserved instance identifier filter value. Use this parameter to
    #   show only the reservation that matches the specified reserved
    #   OpenSearch instance ID.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `DescribeReservedInstances` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `DescribeReservedInstances` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstancesRequest AWS API Documentation
    #
    class DescribeReservedInstancesRequest < Struct.new(
      :reserved_instance_id,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for results from `DescribeReservedInstances`
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @!attribute [rw] reserved_instances
    #   List of Reserved Instances in the current Region.
    #   @return [Array<Types::ReservedInstance>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstancesResponse AWS API Documentation
    #
    class DescribeReservedInstancesResponse < Struct.new(
      :next_token,
      :reserved_instances)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoint_ids
    #   The unique identifiers of the endpoints to get information about.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeVpcEndpointsRequest AWS API Documentation
    #
    class DescribeVpcEndpointsRequest < Struct.new(
      :vpc_endpoint_ids)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoints
    #   Information about each requested VPC endpoint.
    #   @return [Array<Types::VpcEndpoint>]
    #
    # @!attribute [rw] vpc_endpoint_errors
    #   Any errors associated with the request.
    #   @return [Array<Types::VpcEndpointError>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeVpcEndpointsResponse AWS API Documentation
    #
    class DescribeVpcEndpointsResponse < Struct.new(
      :vpc_endpoints,
      :vpc_endpoint_errors)
      SENSITIVE = []
      include Aws::Structure
    end

    # An error occured because the client wanted to access an unsupported
    # operation.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DisabledOperationException AWS API Documentation
    #
    class DisabledOperationException < Aws::EmptyStructure; end

    # Container for the request parameters to the `DissociatePackage`
    # operation.
    #
    # @!attribute [rw] package_id
    #   Internal ID of the package to dissociate from the domain. Use
    #   `ListPackagesForDomain` to find this value.
    #   @return [String]
    #
    # @!attribute [rw] domain_name
    #   Name of the domain to dissociate the package from.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackageRequest AWS API Documentation
    #
    class DissociatePackageRequest < Struct.new(
      :package_id,
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by an `DissociatePackage`
    # operation.
    #
    # @!attribute [rw] domain_package_details
    #   Information about a package that has been dissociated from the
    #   domain.
    #   @return [Types::DomainPackageDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DissociatePackageResponse AWS API Documentation
    #
    class DissociatePackageResponse < Struct.new(
      :domain_package_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the configuration of an OpenSearch Service domain.
    #
    # @!attribute [rw] engine_version
    #   The OpenSearch or Elasticsearch version that the domain is running.
    #   @return [Types::VersionStatus]
    #
    # @!attribute [rw] cluster_config
    #   Container for the cluster configuration of a the domain.
    #   @return [Types::ClusterConfigStatus]
    #
    # @!attribute [rw] ebs_options
    #   Container for EBS options configured for the domain.
    #   @return [Types::EBSOptionsStatus]
    #
    # @!attribute [rw] access_policies
    #   Specifies the access policies for the domain.
    #   @return [Types::AccessPoliciesStatus]
    #
    # @!attribute [rw] ip_address_type
    #   Choose either dual stack or IPv4 as your IP address type. Dual stack
    #   allows you to share domain resources across IPv4 and IPv6 address
    #   types, and is the recommended option. If you set your IP address
    #   type to dual stack, you can't change your address type later.
    #   @return [Types::IPAddressTypeStatus]
    #
    # @!attribute [rw] snapshot_options
    #   DEPRECATED. Container for parameters required to configure automated
    #   snapshots of domain indexes.
    #   @return [Types::SnapshotOptionsStatus]
    #
    # @!attribute [rw] vpc_options
    #   The current VPC options for the domain and the status of any updates
    #   to their configuration.
    #   @return [Types::VPCDerivedInfoStatus]
    #
    # @!attribute [rw] cognito_options
    #   Container for Amazon Cognito options for the domain.
    #   @return [Types::CognitoOptionsStatus]
    #
    # @!attribute [rw] encryption_at_rest_options
    #   Key-value pairs to enable encryption at rest.
    #   @return [Types::EncryptionAtRestOptionsStatus]
    #
    # @!attribute [rw] node_to_node_encryption_options
    #   Whether node-to-node encryption is enabled or disabled.
    #   @return [Types::NodeToNodeEncryptionOptionsStatus]
    #
    # @!attribute [rw] advanced_options
    #   Key-value pairs to specify advanced configuration options. For more
    #   information, see [Advanced options][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
    #   @return [Types::AdvancedOptionsStatus]
    #
    # @!attribute [rw] log_publishing_options
    #   Key-value pairs to configure log publishing.
    #   @return [Types::LogPublishingOptionsStatus]
    #
    # @!attribute [rw] domain_endpoint_options
    #   Additional options for the domain endpoint, such as whether to
    #   require HTTPS for all traffic.
    #   @return [Types::DomainEndpointOptionsStatus]
    #
    # @!attribute [rw] advanced_security_options
    #   Container for fine-grained access control settings for the domain.
    #   @return [Types::AdvancedSecurityOptionsStatus]
    #
    # @!attribute [rw] auto_tune_options
    #   Container for Auto-Tune settings for the domain.
    #   @return [Types::AutoTuneOptionsStatus]
    #
    # @!attribute [rw] change_progress_details
    #   Container for information about the progress of an existing
    #   configuration change.
    #   @return [Types::ChangeProgressDetails]
    #
    # @!attribute [rw] off_peak_window_options
    #   Container for off-peak window options for the domain.
    #   @return [Types::OffPeakWindowOptionsStatus]
    #
    # @!attribute [rw] software_update_options
    #   Software update options for the domain.
    #   @return [Types::SoftwareUpdateOptionsStatus]
    #
    # @!attribute [rw] modifying_properties
    #   Information about the domain properties that are currently being
    #   modified.
    #   @return [Array<Types::ModifyingProperties>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainConfig AWS API Documentation
    #
    class DomainConfig < Struct.new(
      :engine_version,
      :cluster_config,
      :ebs_options,
      :access_policies,
      :ip_address_type,
      :snapshot_options,
      :vpc_options,
      :cognito_options,
      :encryption_at_rest_options,
      :node_to_node_encryption_options,
      :advanced_options,
      :log_publishing_options,
      :domain_endpoint_options,
      :advanced_security_options,
      :auto_tune_options,
      :change_progress_details,
      :off_peak_window_options,
      :software_update_options,
      :modifying_properties)
      SENSITIVE = []
      include Aws::Structure
    end

    # Options to configure a custom endpoint for an OpenSearch Service
    # domain.
    #
    # @!attribute [rw] enforce_https
    #   True to require that all traffic to the domain arrive over HTTPS.
    #   @return [Boolean]
    #
    # @!attribute [rw] tls_security_policy
    #   Specify the TLS security policy to apply to the HTTPS endpoint of
    #   the domain. The policy can be one of the following values:
    #
    #   * **Policy-Min-TLS-1-0-2019-07:** TLS security policy that supports
    #     TLS version 1.0 to TLS version 1.2
    #
    #   * **Policy-Min-TLS-1-2-2019-07:** TLS security policy that supports
    #     only TLS version 1.2
    #
    #   * **Policy-Min-TLS-1-2-PFS-2023-10:** TLS security policy that
    #     supports TLS version 1.2 to TLS version 1.3 with perfect forward
    #     secrecy cipher suites
    #   @return [String]
    #
    # @!attribute [rw] custom_endpoint_enabled
    #   Whether to enable a custom endpoint for the domain.
    #   @return [Boolean]
    #
    # @!attribute [rw] custom_endpoint
    #   The fully qualified URL for the custom endpoint.
    #   @return [String]
    #
    # @!attribute [rw] custom_endpoint_certificate_arn
    #   The ARN for your security certificate, managed in Amazon Web
    #   Services Certificate Manager (ACM).
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainEndpointOptions AWS API Documentation
    #
    class DomainEndpointOptions < Struct.new(
      :enforce_https,
      :tls_security_policy,
      :custom_endpoint_enabled,
      :custom_endpoint,
      :custom_endpoint_certificate_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # The configured endpoint options for a domain and their current status.
    #
    # @!attribute [rw] options
    #   Options to configure the endpoint for a domain.
    #   @return [Types::DomainEndpointOptions]
    #
    # @!attribute [rw] status
    #   The status of the endpoint options for a domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainEndpointOptionsStatus AWS API Documentation
    #
    class DomainEndpointOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about an OpenSearch Service domain.
    #
    # @!attribute [rw] domain_name
    #   Name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] engine_type
    #   The type of search engine that the domain is running.`OpenSearch`
    #   for an OpenSearch engine, or `Elasticsearch` for a legacy
    #   Elasticsearch OSS engine.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainInfo AWS API Documentation
    #
    class DomainInfo < Struct.new(
      :domain_name,
      :engine_type)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for information about an OpenSearch Service domain.
    #
    # @!attribute [rw] aws_domain_information
    #   Information about an Amazon OpenSearch Service domain.
    #   @return [Types::AWSDomainInformation]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainInformationContainer AWS API Documentation
    #
    class DomainInformationContainer < Struct.new(
      :aws_domain_information)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the domain maintenance details.
    #
    # @!attribute [rw] maintenance_id
    #   The ID of the requested action.
    #   @return [String]
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] action
    #   The name of the action.
    #   @return [String]
    #
    # @!attribute [rw] node_id
    #   The ID of the data node.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The status of the action.
    #   @return [String]
    #
    # @!attribute [rw] status_message
    #   The status message for the action.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The time at which the action was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The time at which the action was updated.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainMaintenanceDetails AWS API Documentation
    #
    class DomainMaintenanceDetails < Struct.new(
      :maintenance_id,
      :domain_name,
      :action,
      :node_id,
      :status,
      :status_message,
      :created_at,
      :updated_at)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for information about nodes on the domain.
    #
    # @!attribute [rw] node_id
    #   The ID of the node.
    #   @return [String]
    #
    # @!attribute [rw] node_type
    #   Indicates whether the nodes is a data, master, or ultrawarm node.
    #   @return [String]
    #
    # @!attribute [rw] availability_zone
    #   The Availability Zone of the node.
    #   @return [String]
    #
    # @!attribute [rw] instance_type
    #   The instance type information of the node.
    #   @return [String]
    #
    # @!attribute [rw] node_status
    #   Indicates if the node is active or in standby.
    #   @return [String]
    #
    # @!attribute [rw] storage_type
    #   Indicates if the node has EBS or instance storage.
    #   @return [String]
    #
    # @!attribute [rw] storage_volume_type
    #   If the nodes has EBS storage, indicates if the volume type is GP2 or
    #   GP3. Only applicable for data nodes.
    #   @return [String]
    #
    # @!attribute [rw] storage_size
    #   The storage size of the node, in GiB.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainNodesStatus AWS API Documentation
    #
    class DomainNodesStatus < Struct.new(
      :node_id,
      :node_type,
      :availability_zone,
      :instance_type,
      :node_status,
      :storage_type,
      :storage_volume_type,
      :storage_size)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about a package that is associated with a domain. For more
    # information, see [Custom packages for Amazon OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/custom-packages.html
    #
    # @!attribute [rw] package_id
    #   Internal ID of the package.
    #   @return [String]
    #
    # @!attribute [rw] package_name
    #   User-specified name of the package.
    #   @return [String]
    #
    # @!attribute [rw] package_type
    #   The type of package.
    #   @return [String]
    #
    # @!attribute [rw] last_updated
    #   Timestamp of the most recent update to the package association
    #   status.
    #   @return [Time]
    #
    # @!attribute [rw] domain_name
    #   Name of the domain that the package is associated with.
    #   @return [String]
    #
    # @!attribute [rw] domain_package_status
    #   State of the association.
    #   @return [String]
    #
    # @!attribute [rw] package_version
    #   The current version of the package.
    #   @return [String]
    #
    # @!attribute [rw] reference_path
    #   The relative path of the package on the OpenSearch Service cluster
    #   nodes. This is `synonym_path` when the package is for synonym files.
    #   @return [String]
    #
    # @!attribute [rw] error_details
    #   Additional information if the package is in an error state. Null
    #   otherwise.
    #   @return [Types::ErrorDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainPackageDetails AWS API Documentation
    #
    class DomainPackageDetails < Struct.new(
      :package_id,
      :package_name,
      :package_type,
      :last_updated,
      :domain_name,
      :domain_package_status,
      :package_version,
      :reference_path,
      :error_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # The current status of an OpenSearch Service domain.
    #
    # @!attribute [rw] domain_id
    #   Unique identifier for the domain.
    #   @return [String]
    #
    # @!attribute [rw] domain_name
    #   Name of the domain. Domain names are unique across all domains owned
    #   by the same account within an Amazon Web Services Region.
    #   @return [String]
    #
    # @!attribute [rw] arn
    #   The Amazon Resource Name (ARN) of the domain. For more information,
    #   see [IAM identifiers ][1] in the *AWS Identity and Access Management
    #   User Guide*.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
    #   @return [String]
    #
    # @!attribute [rw] created
    #   Creation status of an OpenSearch Service domain. True if domain
    #   creation is complete. False if domain creation is still in progress.
    #   @return [Boolean]
    #
    # @!attribute [rw] deleted
    #   Deletion status of an OpenSearch Service domain. True if domain
    #   deletion is complete. False if domain deletion is still in progress.
    #   Once deletion is complete, the status of the domain is no longer
    #   returned.
    #   @return [Boolean]
    #
    # @!attribute [rw] endpoint
    #   Domain-specific endpoint used to submit index, search, and data
    #   upload requests to the domain.
    #   @return [String]
    #
    # @!attribute [rw] endpoint_v2
    #   If `IPAddressType` to set to `dualstack`, a version 2 domain
    #   endpoint is provisioned. This endpoint functions like a normal
    #   endpoint, except that it works with both IPv4 and IPv6 IP addresses.
    #   Normal endpoints work only with IPv4 IP addresses.
    #   @return [String]
    #
    # @!attribute [rw] endpoints
    #   The key-value pair that exists if the OpenSearch Service domain uses
    #   VPC endpoints. Example `key, value`:
    #   `'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'`.
    #   @return [Hash<String,String>]
    #
    # @!attribute [rw] processing
    #   The status of the domain configuration. True if OpenSearch Service
    #   is processing configuration changes. False if the configuration is
    #   active.
    #   @return [Boolean]
    #
    # @!attribute [rw] upgrade_processing
    #   The status of a domain version upgrade to a new version of
    #   OpenSearch or Elasticsearch. True if OpenSearch Service is in the
    #   process of a version upgrade. False if the configuration is active.
    #   @return [Boolean]
    #
    # @!attribute [rw] engine_version
    #   Version of OpenSearch or Elasticsearch that the domain is running,
    #   in the format `Elasticsearch_X.Y` or `OpenSearch_X.Y`.
    #   @return [String]
    #
    # @!attribute [rw] cluster_config
    #   Container for the cluster configuration of the domain.
    #   @return [Types::ClusterConfig]
    #
    # @!attribute [rw] ebs_options
    #   Container for EBS-based storage settings for the domain.
    #   @return [Types::EBSOptions]
    #
    # @!attribute [rw] access_policies
    #   Identity and Access Management (IAM) policy document specifying the
    #   access policies for the domain.
    #   @return [String]
    #
    # @!attribute [rw] ip_address_type
    #   The type of IP addresses supported by the endpoint for the domain.
    #   @return [String]
    #
    # @!attribute [rw] snapshot_options
    #   DEPRECATED. Container for parameters required to configure automated
    #   snapshots of domain indexes.
    #   @return [Types::SnapshotOptions]
    #
    # @!attribute [rw] vpc_options
    #   The VPC configuration for the domain.
    #   @return [Types::VPCDerivedInfo]
    #
    # @!attribute [rw] cognito_options
    #   Key-value pairs to configure Amazon Cognito authentication for
    #   OpenSearch Dashboards.
    #   @return [Types::CognitoOptions]
    #
    # @!attribute [rw] encryption_at_rest_options
    #   Encryption at rest settings for the domain.
    #   @return [Types::EncryptionAtRestOptions]
    #
    # @!attribute [rw] node_to_node_encryption_options
    #   Whether node-to-node encryption is enabled or disabled.
    #   @return [Types::NodeToNodeEncryptionOptions]
    #
    # @!attribute [rw] advanced_options
    #   Key-value pairs that specify advanced configuration options.
    #   @return [Hash<String,String>]
    #
    # @!attribute [rw] log_publishing_options
    #   Log publishing options for the domain.
    #   @return [Hash<String,Types::LogPublishingOption>]
    #
    # @!attribute [rw] service_software_options
    #   The current status of the domain's service software.
    #   @return [Types::ServiceSoftwareOptions]
    #
    # @!attribute [rw] domain_endpoint_options
    #   Additional options for the domain endpoint, such as whether to
    #   require HTTPS for all traffic.
    #   @return [Types::DomainEndpointOptions]
    #
    # @!attribute [rw] advanced_security_options
    #   Settings for fine-grained access control.
    #   @return [Types::AdvancedSecurityOptions]
    #
    # @!attribute [rw] auto_tune_options
    #   Auto-Tune settings for the domain.
    #   @return [Types::AutoTuneOptionsOutput]
    #
    # @!attribute [rw] change_progress_details
    #   Information about a configuration change happening on the domain.
    #   @return [Types::ChangeProgressDetails]
    #
    # @!attribute [rw] off_peak_window_options
    #   Options that specify a custom 10-hour window during which OpenSearch
    #   Service can perform configuration changes on the domain.
    #   @return [Types::OffPeakWindowOptions]
    #
    # @!attribute [rw] software_update_options
    #   Service software update options for the domain.
    #   @return [Types::SoftwareUpdateOptions]
    #
    # @!attribute [rw] domain_processing_status
    #   The status of any changes that are currently in progress for the
    #   domain.
    #   @return [String]
    #
    # @!attribute [rw] modifying_properties
    #   Information about the domain properties that are currently being
    #   modified.
    #   @return [Array<Types::ModifyingProperties>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DomainStatus AWS API Documentation
    #
    class DomainStatus < Struct.new(
      :domain_id,
      :domain_name,
      :arn,
      :created,
      :deleted,
      :endpoint,
      :endpoint_v2,
      :endpoints,
      :processing,
      :upgrade_processing,
      :engine_version,
      :cluster_config,
      :ebs_options,
      :access_policies,
      :ip_address_type,
      :snapshot_options,
      :vpc_options,
      :cognito_options,
      :encryption_at_rest_options,
      :node_to_node_encryption_options,
      :advanced_options,
      :log_publishing_options,
      :service_software_options,
      :domain_endpoint_options,
      :advanced_security_options,
      :auto_tune_options,
      :change_progress_details,
      :off_peak_window_options,
      :software_update_options,
      :domain_processing_status,
      :modifying_properties)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about the progress of a pre-upgrade dry run analysis.
    #
    # @!attribute [rw] dry_run_id
    #   The unique identifier of the dry run.
    #   @return [String]
    #
    # @!attribute [rw] dry_run_status
    #   The current status of the dry run.
    #   @return [String]
    #
    # @!attribute [rw] creation_date
    #   The timestamp when the dry run was initiated.
    #   @return [String]
    #
    # @!attribute [rw] update_date
    #   The timestamp when the dry run was last updated.
    #   @return [String]
    #
    # @!attribute [rw] validation_failures
    #   Any validation failures that occurred as a result of the dry run.
    #   @return [Array<Types::ValidationFailure>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DryRunProgressStatus AWS API Documentation
    #
    class DryRunProgressStatus < Struct.new(
      :dry_run_id,
      :dry_run_status,
      :creation_date,
      :update_date,
      :validation_failures)
      SENSITIVE = []
      include Aws::Structure
    end

    # Results of a dry run performed in an update domain request.
    #
    # @!attribute [rw] deployment_type
    #   Specifies the way in which OpenSearch Service will apply an update.
    #   Possible values are:
    #
    #   * **Blue/Green** - The update requires a blue/green deployment.
    #
    #   * **DynamicUpdate** - No blue/green deployment required
    #
    #   * **Undetermined** - The domain is in the middle of an update and
    #     can't predict the deployment type. Try again after the update is
    #     complete.
    #
    #   * **None** - The request doesn't include any configuration changes.
    #   @return [String]
    #
    # @!attribute [rw] message
    #   A message corresponding to the deployment type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DryRunResults AWS API Documentation
    #
    class DryRunResults < Struct.new(
      :deployment_type,
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # The duration of a maintenance schedule. For more information, see
    # [Auto-Tune for Amazon OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
    #
    # @!attribute [rw] value
    #   Integer to specify the value of a maintenance schedule duration.
    #   @return [Integer]
    #
    # @!attribute [rw] unit
    #   The unit of measurement for the duration of a maintenance schedule.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/Duration AWS API Documentation
    #
    class Duration < Struct.new(
      :value,
      :unit)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters required to enable EBS-based storage for
    # an OpenSearch Service domain.
    #
    # @!attribute [rw] ebs_enabled
    #   Indicates whether EBS volumes are attached to data nodes in an
    #   OpenSearch Service domain.
    #   @return [Boolean]
    #
    # @!attribute [rw] volume_type
    #   Specifies the type of EBS volumes attached to data nodes.
    #   @return [String]
    #
    # @!attribute [rw] volume_size
    #   Specifies the size (in GiB) of EBS volumes attached to data nodes.
    #   @return [Integer]
    #
    # @!attribute [rw] iops
    #   Specifies the baseline input/output (I/O) performance of EBS volumes
    #   attached to data nodes. Applicable only for the `gp3` and
    #   provisioned IOPS EBS volume types.
    #   @return [Integer]
    #
    # @!attribute [rw] throughput
    #   Specifies the throughput (in MiB/s) of the EBS volumes attached to
    #   data nodes. Applicable only for the `gp3` volume type.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/EBSOptions AWS API Documentation
    #
    class EBSOptions < Struct.new(
      :ebs_enabled,
      :volume_type,
      :volume_size,
      :iops,
      :throughput)
      SENSITIVE = []
      include Aws::Structure
    end

    # The status of the EBS options for the specified OpenSearch Service
    # domain.
    #
    # @!attribute [rw] options
    #   The configured EBS options for the specified domain.
    #   @return [Types::EBSOptions]
    #
    # @!attribute [rw] status
    #   The status of the EBS options for the specified domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/EBSOptionsStatus AWS API Documentation
    #
    class EBSOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    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.
    #
    # @!attribute [rw] enabled
    #   True to enable encryption at rest.
    #   @return [Boolean]
    #
    # @!attribute [rw] kms_key_id
    #   The KMS key ID. Takes the form
    #   `1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a`.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/EncryptionAtRestOptions AWS API Documentation
    #
    class EncryptionAtRestOptions < Struct.new(
      :enabled,
      :kms_key_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Status of the encryption at rest options for the specified OpenSearch
    # Service domain.
    #
    # @!attribute [rw] options
    #   Encryption at rest options for the specified domain.
    #   @return [Types::EncryptionAtRestOptions]
    #
    # @!attribute [rw] status
    #   The status of the encryption at rest options for the specified
    #   domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/EncryptionAtRestOptionsStatus AWS API Documentation
    #
    class EncryptionAtRestOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about the active domain environment.
    #
    # @!attribute [rw] availability_zone_information
    #   A list of `AvailabilityZoneInfo` for the domain.
    #   @return [Array<Types::AvailabilityZoneInfo>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/EnvironmentInfo AWS API Documentation
    #
    class EnvironmentInfo < Struct.new(
      :availability_zone_information)
      SENSITIVE = []
      include Aws::Structure
    end

    # Additional information if the package is in an error state. Null
    # otherwise.
    #
    # @!attribute [rw] error_type
    #   The type of error that occurred.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   A message describing the error.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ErrorDetails AWS API Documentation
    #
    class ErrorDetails < Struct.new(
      :error_type,
      :error_message)
      SENSITIVE = []
      include Aws::Structure
    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.
    #
    # @!attribute [rw] name
    #   The name of the filter.
    #   @return [String]
    #
    # @!attribute [rw] values
    #   One or more values for the filter.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/Filter AWS API Documentation
    #
    class Filter < Struct.new(
      :name,
      :values)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to `GetCompatibleVersions`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The name of an existing domain. Provide this parameter to limit the
    #   results to a single domain.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCompatibleVersionsRequest AWS API Documentation
    #
    class GetCompatibleVersionsRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by the `GetCompatibleVersions`
    # operation.
    #
    # @!attribute [rw] compatible_versions
    #   A map of OpenSearch or Elasticsearch versions and the versions you
    #   can upgrade them to.
    #   @return [Array<Types::CompatibleVersionsMap>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetCompatibleVersionsResponse AWS API Documentation
    #
    class GetCompatibleVersionsResponse < Struct.new(
      :compatible_versions)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `GetDataSource` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name of the data source to get information about.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDataSourceRequest AWS API Documentation
    #
    class GetDataSourceRequest < Struct.new(
      :domain_name,
      :name)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `GetDataSource` operation.
    #
    # @!attribute [rw] data_source_type
    #   The type of data source.
    #   @return [Types::DataSourceType]
    #
    # @!attribute [rw] name
    #   The name of the data source.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A description of the data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDataSourceResponse AWS API Documentation
    #
    class GetDataSourceResponse < Struct.new(
      :data_source_type,
      :name,
      :description)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `GetDomainMaintenanceStatus`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] maintenance_id
    #   The request ID of the maintenance action.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDomainMaintenanceStatusRequest AWS API Documentation
    #
    class GetDomainMaintenanceStatusRequest < Struct.new(
      :domain_name,
      :maintenance_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `GetDomainMaintenanceStatus` request that information
    # about the requested action.
    #
    # @!attribute [rw] status
    #   The status of the maintenance action.
    #   @return [String]
    #
    # @!attribute [rw] status_message
    #   The status message of the maintenance action.
    #   @return [String]
    #
    # @!attribute [rw] node_id
    #   The node ID of the maintenance action.
    #   @return [String]
    #
    # @!attribute [rw] action
    #   The action name.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The time at which the action was created.
    #   @return [Time]
    #
    # @!attribute [rw] updated_at
    #   The time at which the action was updated.
    #   @return [Time]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetDomainMaintenanceStatusResponse AWS API Documentation
    #
    class GetDomainMaintenanceStatusResponse < Struct.new(
      :status,
      :status_message,
      :node_id,
      :action,
      :created_at,
      :updated_at)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `GetPackageVersionHistory`
    # operation.
    #
    # @!attribute [rw] package_id
    #   The unique identifier of the package.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `GetPackageVersionHistory` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `GetPackageVersionHistory` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetPackageVersionHistoryRequest AWS API Documentation
    #
    class GetPackageVersionHistoryRequest < Struct.new(
      :package_id,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for response returned by `GetPackageVersionHistory`
    # operation.
    #
    # @!attribute [rw] package_id
    #   The unique identifier of the package.
    #   @return [String]
    #
    # @!attribute [rw] package_version_history_list
    #   A list of package versions, along with their creation time and
    #   commit message.
    #   @return [Array<Types::PackageVersionHistory>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetPackageVersionHistoryResponse AWS API Documentation
    #
    class GetPackageVersionHistoryResponse < Struct.new(
      :package_id,
      :package_version_history_list,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `GetUpgradeHistory`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The name of an existing domain.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `GetUpgradeHistory` operation returns a `nextToken`,
    #   you can include the returned `nextToken` in subsequent
    #   `GetUpgradeHistory` operations, which returns results in the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeHistoryRequest AWS API Documentation
    #
    class GetUpgradeHistoryRequest < Struct.new(
      :domain_name,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by the `GetUpgradeHistory`
    # operation.
    #
    # @!attribute [rw] upgrade_histories
    #   A list of objects corresponding to each upgrade or upgrade
    #   eligibility check performed on a domain.
    #   @return [Array<Types::UpgradeHistory>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeHistoryResponse AWS API Documentation
    #
    class GetUpgradeHistoryResponse < Struct.new(
      :upgrade_histories,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `GetUpgradeStatus`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The domain of the domain to get upgrade status information for.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeStatusRequest AWS API Documentation
    #
    class GetUpgradeStatusRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by the `GetUpgradeStatus`
    # operation.
    #
    # @!attribute [rw] upgrade_step
    #   One of three steps that an upgrade or upgrade eligibility check goes
    #   through.
    #   @return [String]
    #
    # @!attribute [rw] step_status
    #   The status of the current step that an upgrade is on.
    #   @return [String]
    #
    # @!attribute [rw] upgrade_name
    #   A string that describes the update.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/GetUpgradeStatusResponse AWS API Documentation
    #
    class GetUpgradeStatusResponse < Struct.new(
      :upgrade_step,
      :step_status,
      :upgrade_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # The IP address type status for the domain.
    #
    # @!attribute [rw] options
    #   The IP address options for the domain.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   Provides the current status of an entity.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/IPAddressTypeStatus AWS API Documentation
    #
    class IPAddressTypeStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Describes an inbound cross-cluster connection for Amazon OpenSearch
    # Service. For more information, see [Cross-cluster search for Amazon
    # OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/cross-cluster-search.html
    #
    # @!attribute [rw] local_domain_info
    #   Information about the source (local) domain.
    #   @return [Types::DomainInformationContainer]
    #
    # @!attribute [rw] remote_domain_info
    #   Information about the destination (remote) domain.
    #   @return [Types::DomainInformationContainer]
    #
    # @!attribute [rw] connection_id
    #   The unique identifier of the connection.
    #   @return [String]
    #
    # @!attribute [rw] connection_status
    #   The current status of the connection.
    #   @return [Types::InboundConnectionStatus]
    #
    # @!attribute [rw] connection_mode
    #   The connection mode.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InboundConnection AWS API Documentation
    #
    class InboundConnection < Struct.new(
      :local_domain_info,
      :remote_domain_info,
      :connection_id,
      :connection_status,
      :connection_mode)
      SENSITIVE = []
      include Aws::Structure
    end

    # The status of an inbound cross-cluster connection for OpenSearch
    # Service.
    #
    # @!attribute [rw] status_code
    #   The status code for the connection. Can be one of the following:
    #
    #   * **PENDING\_ACCEPTANCE** - Inbound connection is not yet accepted
    #     by the remote domain owner.
    #
    #   * **APPROVED**: Inbound connection is pending acceptance by the
    #     remote domain owner.
    #
    #   * **PROVISIONING**: Inbound connection is being provisioned.
    #
    #   * **ACTIVE**: Inbound connection is active and ready to use.
    #
    #   * **REJECTING**: Inbound connection rejection is in process.
    #
    #   * **REJECTED**: Inbound connection is rejected.
    #
    #   * **DELETING**: Inbound connection deletion is in progress.
    #
    #   * **DELETED**: Inbound connection is deleted and can no longer be
    #     used.
    #   @return [String]
    #
    # @!attribute [rw] message
    #   Information about the connection.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InboundConnectionStatus AWS API Documentation
    #
    class InboundConnectionStatus < Struct.new(
      :status_code,
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Limits on the number of instances that can be created in OpenSearch
    # Service for a given instance type.
    #
    # @!attribute [rw] minimum_instance_count
    #   The maximum allowed number of instances.
    #   @return [Integer]
    #
    # @!attribute [rw] maximum_instance_count
    #   The minimum allowed number of instances.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InstanceCountLimits AWS API Documentation
    #
    class InstanceCountLimits < Struct.new(
      :minimum_instance_count,
      :maximum_instance_count)
      SENSITIVE = []
      include Aws::Structure
    end

    # Instance-related attributes that are available for a given instance
    # type.
    #
    # @!attribute [rw] instance_count_limits
    #   Limits on the number of instances that can be created for a given
    #   instance type.
    #   @return [Types::InstanceCountLimits]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InstanceLimits AWS API Documentation
    #
    class InstanceLimits < Struct.new(
      :instance_count_limits)
      SENSITIVE = []
      include Aws::Structure
    end

    # Lists all instance types and available features for a given OpenSearch
    # or Elasticsearch version.
    #
    # @!attribute [rw] instance_type
    #   The instance type.
    #   @return [String]
    #
    # @!attribute [rw] encryption_enabled
    #   Whether encryption at rest and node-to-node encryption are supported
    #   for the instance type.
    #   @return [Boolean]
    #
    # @!attribute [rw] cognito_enabled
    #   Whether Amazon Cognito access is supported for the instance type.
    #   @return [Boolean]
    #
    # @!attribute [rw] app_logs_enabled
    #   Whether logging is supported for the instance type.
    #   @return [Boolean]
    #
    # @!attribute [rw] advanced_security_enabled
    #   Whether fine-grained access control is supported for the instance
    #   type.
    #   @return [Boolean]
    #
    # @!attribute [rw] warm_enabled
    #   Whether UltraWarm is supported for the instance type.
    #   @return [Boolean]
    #
    # @!attribute [rw] instance_role
    #   Whether the instance acts as a data node, a dedicated master node,
    #   or an UltraWarm node.
    #   @return [Array<String>]
    #
    # @!attribute [rw] availability_zones
    #   The supported Availability Zones for the instance type.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InstanceTypeDetails AWS API Documentation
    #
    class InstanceTypeDetails < Struct.new(
      :instance_type,
      :encryption_enabled,
      :cognito_enabled,
      :app_logs_enabled,
      :advanced_security_enabled,
      :warm_enabled,
      :instance_role,
      :availability_zones)
      SENSITIVE = []
      include Aws::Structure
    end

    # Request processing failed because of an unknown error, exception, or
    # internal failure.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InternalException AWS API Documentation
    #
    class InternalException < Aws::EmptyStructure; end

    # Request processing failed because you provided an invalid pagination
    # token.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InvalidPaginationTokenException AWS API Documentation
    #
    class InvalidPaginationTokenException < Aws::EmptyStructure; end

    # An exception for trying to create or access a sub-resource that's
    # either invalid or not supported.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/InvalidTypeException AWS API Documentation
    #
    class InvalidTypeException < Aws::EmptyStructure; end

    # An exception for trying to create more than the allowed number of
    # resources or sub-resources.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/LimitExceededException AWS API Documentation
    #
    class LimitExceededException < Aws::EmptyStructure; end

    # Limits for a given instance type and for each of its roles.
    #
    # @!attribute [rw] storage_types
    #   Storage-related attributes that are available for a given instance
    #   type.
    #   @return [Array<Types::StorageType>]
    #
    # @!attribute [rw] instance_limits
    #   The limits for a given instance type.
    #   @return [Types::InstanceLimits]
    #
    # @!attribute [rw] additional_limits
    #   List of additional limits that are specific to a given instance type
    #   for each of its instance roles.
    #   @return [Array<Types::AdditionalLimit>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/Limits AWS API Documentation
    #
    class Limits < Struct.new(
      :storage_types,
      :instance_limits,
      :additional_limits)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `ListDataSources` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDataSourcesRequest AWS API Documentation
    #
    class ListDataSourcesRequest < Struct.new(
      :domain_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `ListDataSources` operation.
    #
    # @!attribute [rw] data_sources
    #   A list of data sources associated with specified domain.
    #   @return [Array<Types::DataSourceDetails>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDataSourcesResponse AWS API Documentation
    #
    class ListDataSourcesResponse < Struct.new(
      :data_sources)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `ListDomainMaintenances`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] action
    #   The name of the action.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The status of the action.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `ListDomainMaintenances` operation returns a
    #   `nextToken`, include the returned `nextToken` in subsequent
    #   `ListDomainMaintenances` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainMaintenancesRequest AWS API Documentation
    #
    class ListDomainMaintenancesRequest < Struct.new(
      :domain_name,
      :action,
      :status,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `ListDomainMaintenances` request that contains
    # information about the requested actions.
    #
    # @!attribute [rw] domain_maintenances
    #   A list of the submitted maintenance actions.
    #   @return [Array<Types::DomainMaintenanceDetails>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainMaintenancesResponse AWS API Documentation
    #
    class ListDomainMaintenancesResponse < Struct.new(
      :domain_maintenances,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `ListDomainNames` operation.
    #
    # @!attribute [rw] engine_type
    #   Filters the output by domain engine type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNamesRequest AWS API Documentation
    #
    class ListDomainNamesRequest < Struct.new(
      :engine_type)
      SENSITIVE = []
      include Aws::Structure
    end

    # The results of a `ListDomainNames` operation. Contains the names of
    # all domains owned by this account and their respective engine types.
    #
    # @!attribute [rw] domain_names
    #   The names of all OpenSearch Service domains owned by the current
    #   user and their respective engine types.
    #   @return [Array<Types::DomainInfo>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainNamesResponse AWS API Documentation
    #
    class ListDomainNamesResponse < Struct.new(
      :domain_names)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `ListDomainsForPackage`
    # operation.
    #
    # @!attribute [rw] package_id
    #   The unique identifier of the package for which to list associated
    #   domains.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `ListDomainsForPackage` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `ListDomainsForPackage` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainsForPackageRequest AWS API Documentation
    #
    class ListDomainsForPackageRequest < Struct.new(
      :package_id,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response parameters to the `ListDomainsForPackage`
    # operation.
    #
    # @!attribute [rw] domain_package_details_list
    #   Information about all domains associated with a package.
    #   @return [Array<Types::DomainPackageDetails>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListDomainsForPackageResponse AWS API Documentation
    #
    class ListDomainsForPackageResponse < Struct.new(
      :domain_package_details_list,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] engine_version
    #   The version of OpenSearch or Elasticsearch, in the format
    #   Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest
    #   version of OpenSearch.
    #   @return [String]
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `ListInstanceTypeDetails` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `ListInstanceTypeDetails` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @!attribute [rw] retrieve_a_zs
    #   An optional parameter that specifies the Availability Zones for the
    #   domain.
    #   @return [Boolean]
    #
    # @!attribute [rw] instance_type
    #   An optional parameter that lists information for a given instance
    #   type.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetailsRequest AWS API Documentation
    #
    class ListInstanceTypeDetailsRequest < Struct.new(
      :engine_version,
      :domain_name,
      :max_results,
      :next_token,
      :retrieve_a_zs,
      :instance_type)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] instance_type_details
    #   Lists all supported instance types and features for the given
    #   OpenSearch or Elasticsearch version.
    #   @return [Array<Types::InstanceTypeDetails>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListInstanceTypeDetailsResponse AWS API Documentation
    #
    class ListInstanceTypeDetailsResponse < Struct.new(
      :instance_type_details,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `ListPackagesForDomain`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain for which you want to list associated
    #   packages.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `ListPackagesForDomain` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `ListPackagesForDomain` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListPackagesForDomainRequest AWS API Documentation
    #
    class ListPackagesForDomainRequest < Struct.new(
      :domain_name,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response parameters to the `ListPackagesForDomain`
    # operation.
    #
    # @!attribute [rw] domain_package_details_list
    #   List of all packages associated with a domain.
    #   @return [Array<Types::DomainPackageDetails>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListPackagesForDomainResponse AWS API Documentation
    #
    class ListPackagesForDomainResponse < Struct.new(
      :domain_package_details_list,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `ListScheduledActions` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `ListScheduledActions` operations, which returns results in the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListScheduledActionsRequest AWS API Documentation
    #
    class ListScheduledActionsRequest < Struct.new(
      :domain_name,
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] scheduled_actions
    #   A list of actions that are scheduled for the domain.
    #   @return [Array<Types::ScheduledAction>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListScheduledActionsResponse AWS API Documentation
    #
    class ListScheduledActionsResponse < Struct.new(
      :scheduled_actions,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `ListTags` operation.
    #
    # @!attribute [rw] arn
    #   Amazon Resource Name (ARN) for the domain to view tags for.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListTagsRequest AWS API Documentation
    #
    class ListTagsRequest < Struct.new(
      :arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # The results of a `ListTags` operation.
    #
    # @!attribute [rw] tag_list
    #   List of resource tags associated with the specified domain.
    #   @return [Array<Types::Tag>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListTagsResponse AWS API Documentation
    #
    class ListTagsResponse < Struct.new(
      :tag_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `ListVersions` operation.
    #
    # @!attribute [rw] max_results
    #   An optional parameter that specifies the maximum number of results
    #   to return. You can use `nextToken` to get the next page of results.
    #   @return [Integer]
    #
    # @!attribute [rw] next_token
    #   If your initial `ListVersions` operation returns a `nextToken`, you
    #   can include the returned `nextToken` in subsequent `ListVersions`
    #   operations, which returns results in the next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVersionsRequest AWS API Documentation
    #
    class ListVersionsRequest < Struct.new(
      :max_results,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters for response received from the
    # `ListVersions` operation.
    #
    # @!attribute [rw] versions
    #   A list of all versions of OpenSearch and Elasticsearch that Amazon
    #   OpenSearch Service supports.
    #   @return [Array<String>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVersionsResponse AWS API Documentation
    #
    class ListVersionsResponse < Struct.new(
      :versions,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_name
    #   The name of the OpenSearch Service domain to retrieve access
    #   information for.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If your initial `ListVpcEndpointAccess` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `ListVpcEndpointAccess` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpointAccessRequest AWS API Documentation
    #
    class ListVpcEndpointAccessRequest < Struct.new(
      :domain_name,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] authorized_principal_list
    #   A list of [IAM principals][1] that can currently access the domain.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html
    #   @return [Array<Types::AuthorizedPrincipal>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpointAccessResponse AWS API Documentation
    #
    class ListVpcEndpointAccessResponse < Struct.new(
      :authorized_principal_list,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_name
    #   The name of the domain to list associated VPC endpoints for.
    #   @return [String]
    #
    # @!attribute [rw] next_token
    #   If your initial `ListEndpointsForDomain` operation returns a
    #   `nextToken`, you can include the returned `nextToken` in subsequent
    #   `ListEndpointsForDomain` operations, which returns results in the
    #   next page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpointsForDomainRequest AWS API Documentation
    #
    class ListVpcEndpointsForDomainRequest < Struct.new(
      :domain_name,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoint_summary_list
    #   Information about each endpoint associated with the domain.
    #   @return [Array<Types::VpcEndpointSummary>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpointsForDomainResponse AWS API Documentation
    #
    class ListVpcEndpointsForDomainResponse < Struct.new(
      :vpc_endpoint_summary_list,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] next_token
    #   If your initial `ListVpcEndpoints` operation returns a `nextToken`,
    #   you can include the returned `nextToken` in subsequent
    #   `ListVpcEndpoints` operations, which returns results in the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpointsRequest AWS API Documentation
    #
    class ListVpcEndpointsRequest < Struct.new(
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoint_summary_list
    #   Information about each endpoint.
    #   @return [Array<Types::VpcEndpointSummary>]
    #
    # @!attribute [rw] next_token
    #   When `nextToken` is returned, there are more results available. The
    #   value of `nextToken` is a unique pagination token for each page.
    #   Make the call again using the returned token to retrieve the next
    #   page.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListVpcEndpointsResponse AWS API Documentation
    #
    class ListVpcEndpointsResponse < Struct.new(
      :vpc_endpoint_summary_list,
      :next_token)
      SENSITIVE = []
      include Aws::Structure
    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][1].
    #
    # <note markdown="1"> After you enable log publishing, you still have to enable the
    # collection of slow logs using the OpenSearch REST API.
    #
    #  </note>
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createdomain-configure-slow-logs.html
    #
    # @!attribute [rw] cloud_watch_logs_log_group_arn
    #   The Amazon Resource Name (ARN) of the CloudWatch Logs group to
    #   publish logs to.
    #   @return [String]
    #
    # @!attribute [rw] enabled
    #   Whether the log should be published.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/LogPublishingOption AWS API Documentation
    #
    class LogPublishingOption < Struct.new(
      :cloud_watch_logs_log_group_arn,
      :enabled)
      SENSITIVE = []
      include Aws::Structure
    end

    # The configured log publishing options for the domain and their current
    # status.
    #
    # @!attribute [rw] options
    #   The log publishing options configured for the domain.
    #   @return [Hash<String,Types::LogPublishingOption>]
    #
    # @!attribute [rw] status
    #   The status of the log publishing options for the domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/LogPublishingOptionsStatus AWS API Documentation
    #
    class LogPublishingOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Credentials for the master user for a domain.
    #
    # @!attribute [rw] master_user_arn
    #   Amazon Resource Name (ARN) for the master user. Only specify if
    #   `InternalUserDatabaseEnabled` is `false`.
    #   @return [String]
    #
    # @!attribute [rw] master_user_name
    #   User name for the master user. Only specify if
    #   `InternalUserDatabaseEnabled` is `true`.
    #   @return [String]
    #
    # @!attribute [rw] master_user_password
    #   Password for the master user. Only specify if
    #   `InternalUserDatabaseEnabled` is `true`.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/MasterUserOptions AWS API Documentation
    #
    class MasterUserOptions < Struct.new(
      :master_user_arn,
      :master_user_name,
      :master_user_password)
      SENSITIVE = [:master_user_name, :master_user_password]
      include Aws::Structure
    end

    # Information about the domain properties that are currently being
    # modified.
    #
    # @!attribute [rw] name
    #   The name of the property that is currently being modified.
    #   @return [String]
    #
    # @!attribute [rw] active_value
    #   The current value of the domain property that is being modified.
    #   @return [String]
    #
    # @!attribute [rw] pending_value
    #   The value that the property that is currently being modified will
    #   eventually have.
    #   @return [String]
    #
    # @!attribute [rw] value_type
    #   The type of value that is currently being modified. Properties can
    #   have two types:
    #
    #   * `PLAIN_TEXT`: Contain direct values such as "1", "True", or
    #     "c5.large.search".
    #
    #   * `STRINGIFIED_JSON`: Contain content in JSON format, such as
    #     \\\{"Enabled":"True"\\}".
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ModifyingProperties AWS API Documentation
    #
    class ModifyingProperties < Struct.new(
      :name,
      :active_value,
      :pending_value,
      :value_type)
      SENSITIVE = []
      include Aws::Structure
    end

    # Enables or disables node-to-node encryption. For more information, see
    # [Node-to-node encryption for Amazon OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html
    #
    # @!attribute [rw] enabled
    #   True to enable node-to-node encryption.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/NodeToNodeEncryptionOptions AWS API Documentation
    #
    class NodeToNodeEncryptionOptions < Struct.new(
      :enabled)
      SENSITIVE = []
      include Aws::Structure
    end

    # Status of the node-to-node encryption options for the specified
    # domain.
    #
    # @!attribute [rw] options
    #   The node-to-node encryption options for the specified domain.
    #   @return [Types::NodeToNodeEncryptionOptions]
    #
    # @!attribute [rw] status
    #   The status of the node-to-node encryption options for the specified
    #   domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/NodeToNodeEncryptionOptionsStatus AWS API Documentation
    #
    class NodeToNodeEncryptionOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html
    #
    # @!attribute [rw] window_start_time
    #   A custom start time for the off-peak window, in Coordinated
    #   Universal Time (UTC). The window length will always be 10 hours, so
    #   you can't specify an end time. For example, if you specify 11:00
    #   P.M. UTC as a start time, the end time will automatically be set to
    #   9:00 A.M.
    #   @return [Types::WindowStartTime]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindow AWS API Documentation
    #
    class OffPeakWindow < Struct.new(
      :window_start_time)
      SENSITIVE = []
      include Aws::Structure
    end

    # Options for a domain's [off-peak window][1], during which OpenSearch
    # Service can perform mandatory configuration changes on the domain.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
    #
    # @!attribute [rw] enabled
    #   Whether to enable an off-peak window.
    #
    #   This option is only available when modifying a domain created prior
    #   to February 16, 2023, not when creating a new domain. All domains
    #   created after this date have the off-peak window enabled by default.
    #   You can't disable the off-peak window after it's enabled for a
    #   domain.
    #   @return [Boolean]
    #
    # @!attribute [rw] off_peak_window
    #   Off-peak window settings for the domain.
    #   @return [Types::OffPeakWindow]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindowOptions AWS API Documentation
    #
    class OffPeakWindowOptions < Struct.new(
      :enabled,
      :off_peak_window)
      SENSITIVE = []
      include Aws::Structure
    end

    # The status of [off-peak window][1] options for a domain.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
    #
    # @!attribute [rw] options
    #   The domain's off-peak window configuration.
    #   @return [Types::OffPeakWindowOptions]
    #
    # @!attribute [rw] status
    #   The current status of off-peak window options.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OffPeakWindowOptionsStatus AWS API Documentation
    #
    class OffPeakWindowOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Provides the current status of an entity.
    #
    # @!attribute [rw] creation_date
    #   The timestamp when the entity was created.
    #   @return [Time]
    #
    # @!attribute [rw] update_date
    #   The timestamp of the last time the entity was updated.
    #   @return [Time]
    #
    # @!attribute [rw] update_version
    #   The latest version of the entity.
    #   @return [Integer]
    #
    # @!attribute [rw] state
    #   The state of the entity.
    #   @return [String]
    #
    # @!attribute [rw] pending_deletion
    #   Indicates whether the entity is being deleted.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OptionStatus AWS API Documentation
    #
    class OptionStatus < Struct.new(
      :creation_date,
      :update_date,
      :update_version,
      :state,
      :pending_deletion)
      SENSITIVE = []
      include Aws::Structure
    end

    # Specifies details about an outbound cross-cluster connection.
    #
    # @!attribute [rw] local_domain_info
    #   Information about the source (local) domain.
    #   @return [Types::DomainInformationContainer]
    #
    # @!attribute [rw] remote_domain_info
    #   Information about the destination (remote) domain.
    #   @return [Types::DomainInformationContainer]
    #
    # @!attribute [rw] connection_id
    #   Unique identifier of the connection.
    #   @return [String]
    #
    # @!attribute [rw] connection_alias
    #   Name of the connection.
    #   @return [String]
    #
    # @!attribute [rw] connection_status
    #   Status of the connection.
    #   @return [Types::OutboundConnectionStatus]
    #
    # @!attribute [rw] connection_mode
    #   The connection mode.
    #   @return [String]
    #
    # @!attribute [rw] connection_properties
    #   Properties for the outbound connection.
    #   @return [Types::ConnectionProperties]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OutboundConnection AWS API Documentation
    #
    class OutboundConnection < Struct.new(
      :local_domain_info,
      :remote_domain_info,
      :connection_id,
      :connection_alias,
      :connection_status,
      :connection_mode,
      :connection_properties)
      SENSITIVE = []
      include Aws::Structure
    end

    # The status of an outbound cross-cluster connection.
    #
    # @!attribute [rw] status_code
    #   The status code for the outbound connection. Can be one of the
    #   following:
    #
    #   * **VALIDATING** - The outbound connection request is being
    #     validated.
    #
    #   * **VALIDATION\_FAILED** - Validation failed for the connection
    #     request.
    #
    #   * **PENDING\_ACCEPTANCE**: Outbound connection request is validated
    #     and is not yet accepted by the remote domain owner.
    #
    #   * **APPROVED** - Outbound connection has been approved by the remote
    #     domain owner for getting provisioned.
    #
    #   * **PROVISIONING** - Outbound connection request is in process.
    #
    #   * **ACTIVE** - Outbound connection is active and ready to use.
    #
    #   * **REJECTING** - Outbound connection rejection by remote domain
    #     owner is in progress.
    #
    #   * **REJECTED** - Outbound connection request is rejected by remote
    #     domain owner.
    #
    #   * **DELETING** - Outbound connection deletion is in progress.
    #
    #   * **DELETED** - Outbound connection is deleted and can no longer be
    #     used.
    #   @return [String]
    #
    # @!attribute [rw] message
    #   Verbose information for the outbound connection.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/OutboundConnectionStatus AWS API Documentation
    #
    class OutboundConnectionStatus < Struct.new(
      :status_code,
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Basic information about a package.
    #
    # @!attribute [rw] package_id
    #   The unique identifier of the package.
    #   @return [String]
    #
    # @!attribute [rw] package_name
    #   The user-specified name of the package.
    #   @return [String]
    #
    # @!attribute [rw] package_type
    #   The type of package.
    #   @return [String]
    #
    # @!attribute [rw] package_description
    #   User-specified description of the package.
    #   @return [String]
    #
    # @!attribute [rw] package_status
    #   The current status of the package. The available options are
    #   `AVAILABLE`, `COPYING`, `COPY_FAILED`, `VALIDATNG`,
    #   `VALIDATION_FAILED`, `DELETING`, and `DELETE_FAILED`.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The timestamp when the package was created.
    #   @return [Time]
    #
    # @!attribute [rw] last_updated_at
    #   Date and time when the package was last updated.
    #   @return [Time]
    #
    # @!attribute [rw] available_package_version
    #   The package version.
    #   @return [String]
    #
    # @!attribute [rw] error_details
    #   Additional information if the package is in an error state. Null
    #   otherwise.
    #   @return [Types::ErrorDetails]
    #
    # @!attribute [rw] engine_version
    #   Version of OpenSearch or Elasticsearch, in the format
    #   Elasticsearch\_X.Y or OpenSearch\_X.Y. Defaults to the latest
    #   version of OpenSearch.
    #   @return [String]
    #
    # @!attribute [rw] available_plugin_properties
    #   If the package is a `ZIP-PLUGIN` package, additional information
    #   about plugin properties.
    #   @return [Types::PluginProperties]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageDetails AWS API Documentation
    #
    class PackageDetails < Struct.new(
      :package_id,
      :package_name,
      :package_type,
      :package_description,
      :package_status,
      :created_at,
      :last_updated_at,
      :available_package_version,
      :error_details,
      :engine_version,
      :available_plugin_properties)
      SENSITIVE = []
      include Aws::Structure
    end

    # The Amazon S3 location to import the package from.
    #
    # @!attribute [rw] s3_bucket_name
    #   The name of the Amazon S3 bucket containing the package.
    #   @return [String]
    #
    # @!attribute [rw] s3_key
    #   Key (file name) of the package.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageSource AWS API Documentation
    #
    class PackageSource < Struct.new(
      :s3_bucket_name,
      :s3_key)
      SENSITIVE = []
      include Aws::Structure
    end

    # Details about a package version.
    #
    # @!attribute [rw] package_version
    #   The package version.
    #   @return [String]
    #
    # @!attribute [rw] commit_message
    #   A message associated with the package version when it was uploaded.
    #   @return [String]
    #
    # @!attribute [rw] created_at
    #   The date and time when the package was created.
    #   @return [Time]
    #
    # @!attribute [rw] plugin_properties
    #   Additional information about plugin properties if the package is a
    #   `ZIP-PLUGIN` package.
    #   @return [Types::PluginProperties]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PackageVersionHistory AWS API Documentation
    #
    class PackageVersionHistory < Struct.new(
      :package_version,
      :commit_message,
      :created_at,
      :plugin_properties)
      SENSITIVE = []
      include Aws::Structure
    end

    # Basic information about the plugin.
    #
    # @!attribute [rw] name
    #   The name of the plugin.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   The description of the plugin.
    #   @return [String]
    #
    # @!attribute [rw] version
    #   The version of the plugin.
    #   @return [String]
    #
    # @!attribute [rw] class_name
    #   The name of the class to load.
    #   @return [String]
    #
    # @!attribute [rw] uncompressed_size_in_bytes
    #   The uncompressed size of the plugin.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PluginProperties AWS API Documentation
    #
    class PluginProperties < Struct.new(
      :name,
      :description,
      :version,
      :class_name,
      :uncompressed_size_in_bytes)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for request parameters to the
    # `PurchaseReservedInstanceOffering` operation.
    #
    # @!attribute [rw] reserved_instance_offering_id
    #   The ID of the Reserved Instance offering to purchase.
    #   @return [String]
    #
    # @!attribute [rw] reservation_name
    #   A customer-specified identifier to track this reservation.
    #   @return [String]
    #
    # @!attribute [rw] instance_count
    #   The number of OpenSearch instances to reserve.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PurchaseReservedInstanceOfferingRequest AWS API Documentation
    #
    class PurchaseReservedInstanceOfferingRequest < Struct.new(
      :reserved_instance_offering_id,
      :reservation_name,
      :instance_count)
      SENSITIVE = []
      include Aws::Structure
    end

    # Represents the output of a `PurchaseReservedInstanceOffering`
    # operation.
    #
    # @!attribute [rw] reserved_instance_id
    #   The ID of the Reserved Instance offering that was purchased.
    #   @return [String]
    #
    # @!attribute [rw] reservation_name
    #   The customer-specified identifier used to track this reservation.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/PurchaseReservedInstanceOfferingResponse AWS API Documentation
    #
    class PurchaseReservedInstanceOfferingResponse < Struct.new(
      :reserved_instance_id,
      :reservation_name)
      SENSITIVE = []
      include Aws::Structure
    end

    # Contains the specific price and frequency of a recurring charges for
    # an OpenSearch Reserved Instance, or for a Reserved Instance offering.
    #
    # @!attribute [rw] recurring_charge_amount
    #   The monetary amount of the recurring charge.
    #   @return [Float]
    #
    # @!attribute [rw] recurring_charge_frequency
    #   The frequency of the recurring charge.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RecurringCharge AWS API Documentation
    #
    class RecurringCharge < Struct.new(
      :recurring_charge_amount,
      :recurring_charge_frequency)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `RejectInboundConnection`
    # operation.
    #
    # @!attribute [rw] connection_id
    #   The unique identifier of the inbound connection to reject.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RejectInboundConnectionRequest AWS API Documentation
    #
    class RejectInboundConnectionRequest < Struct.new(
      :connection_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Represents the output of a `RejectInboundConnection` operation.
    #
    # @!attribute [rw] connection
    #   Contains details about the rejected inbound connection.
    #   @return [Types::InboundConnection]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RejectInboundConnectionResponse AWS API Documentation
    #
    class RejectInboundConnectionResponse < Struct.new(
      :connection)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `RemoveTags` operation.
    #
    # @!attribute [rw] arn
    #   The Amazon Resource Name (ARN) of the domain from which you want to
    #   delete the specified tags.
    #   @return [String]
    #
    # @!attribute [rw] tag_keys
    #   The list of tag keys to remove from the domain.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RemoveTagsRequest AWS API Documentation
    #
    class RemoveTagsRequest < Struct.new(
      :arn,
      :tag_keys)
      SENSITIVE = []
      include Aws::Structure
    end

    # Details of an OpenSearch Reserved Instance.
    #
    # @!attribute [rw] reservation_name
    #   The customer-specified identifier to track this reservation.
    #   @return [String]
    #
    # @!attribute [rw] reserved_instance_id
    #   The unique identifier for the reservation.
    #   @return [String]
    #
    # @!attribute [rw] billing_subscription_id
    #   The unique identifier of the billing subscription.
    #   @return [Integer]
    #
    # @!attribute [rw] reserved_instance_offering_id
    #   The unique identifier of the Reserved Instance offering.
    #   @return [String]
    #
    # @!attribute [rw] instance_type
    #   The OpenSearch instance type offered by theReserved Instance
    #   offering.
    #   @return [String]
    #
    # @!attribute [rw] start_time
    #   The date and time when the reservation was purchased.
    #   @return [Time]
    #
    # @!attribute [rw] duration
    #   The duration, in seconds, for which the OpenSearch instance is
    #   reserved.
    #   @return [Integer]
    #
    # @!attribute [rw] fixed_price
    #   The upfront fixed charge you will paid to purchase the specific
    #   Reserved Instance offering.
    #   @return [Float]
    #
    # @!attribute [rw] usage_price
    #   The hourly rate at which you're charged for the domain using this
    #   Reserved Instance.
    #   @return [Float]
    #
    # @!attribute [rw] currency_code
    #   The currency code for the offering.
    #   @return [String]
    #
    # @!attribute [rw] instance_count
    #   The number of OpenSearch instances that have been reserved.
    #   @return [Integer]
    #
    # @!attribute [rw] state
    #   The state of the Reserved Instance.
    #   @return [String]
    #
    # @!attribute [rw] payment_option
    #   The payment option as defined in the Reserved Instance offering.
    #   @return [String]
    #
    # @!attribute [rw] recurring_charges
    #   The recurring charge to your account, regardless of whether you
    #   create any domains using the Reserved Instance offering.
    #   @return [Array<Types::RecurringCharge>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ReservedInstance AWS API Documentation
    #
    class ReservedInstance < Struct.new(
      :reservation_name,
      :reserved_instance_id,
      :billing_subscription_id,
      :reserved_instance_offering_id,
      :instance_type,
      :start_time,
      :duration,
      :fixed_price,
      :usage_price,
      :currency_code,
      :instance_count,
      :state,
      :payment_option,
      :recurring_charges)
      SENSITIVE = []
      include Aws::Structure
    end

    # Details of an OpenSearch Reserved Instance offering.
    #
    # @!attribute [rw] reserved_instance_offering_id
    #   The unique identifier of the Reserved Instance offering.
    #   @return [String]
    #
    # @!attribute [rw] instance_type
    #   The OpenSearch instance type offered by the Reserved Instance
    #   offering.
    #   @return [String]
    #
    # @!attribute [rw] duration
    #   The duration, in seconds, for which the offering will reserve the
    #   OpenSearch instance.
    #   @return [Integer]
    #
    # @!attribute [rw] fixed_price
    #   The upfront fixed charge you will pay to purchase the specific
    #   Reserved Instance offering.
    #   @return [Float]
    #
    # @!attribute [rw] usage_price
    #   The hourly rate at which you're charged for the domain using this
    #   Reserved Instance.
    #   @return [Float]
    #
    # @!attribute [rw] currency_code
    #   The currency code for the Reserved Instance offering.
    #   @return [String]
    #
    # @!attribute [rw] payment_option
    #   Payment option for the Reserved Instance offering
    #   @return [String]
    #
    # @!attribute [rw] recurring_charges
    #   The recurring charge to your account, regardless of whether you
    #   creates any domains using the offering.
    #   @return [Array<Types::RecurringCharge>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ReservedInstanceOffering AWS API Documentation
    #
    class ReservedInstanceOffering < Struct.new(
      :reserved_instance_offering_id,
      :instance_type,
      :duration,
      :fixed_price,
      :usage_price,
      :currency_code,
      :payment_option,
      :recurring_charges)
      SENSITIVE = []
      include Aws::Structure
    end

    # An exception for creating a resource that already exists.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ResourceAlreadyExistsException AWS API Documentation
    #
    class ResourceAlreadyExistsException < Aws::EmptyStructure; end

    # An exception for accessing or deleting a resource that doesn't exist.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ResourceNotFoundException AWS API Documentation
    #
    class ResourceNotFoundException < Aws::EmptyStructure; end

    # @!attribute [rw] domain_name
    #   The name of the OpenSearch Service domain.
    #   @return [String]
    #
    # @!attribute [rw] account
    #   The account ID to revoke access from.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RevokeVpcEndpointAccessRequest AWS API Documentation
    #
    class RevokeVpcEndpointAccessRequest < Struct.new(
      :domain_name,
      :account)
      SENSITIVE = []
      include Aws::Structure
    end

    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/RevokeVpcEndpointAccessResponse AWS API Documentation
    #
    class RevokeVpcEndpointAccessResponse < Aws::EmptyStructure; end

    # Information about the Amazon S3 Glue Data Catalog.
    #
    # @!attribute [rw] role_arn
    #   &gt;The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/S3GlueDataCatalog AWS API Documentation
    #
    class S3GlueDataCatalog < Struct.new(
      :role_arn)
      SENSITIVE = []
      include Aws::Structure
    end

    # The SAML identity povider information.
    #
    # @!attribute [rw] metadata_content
    #   The metadata of the SAML application, in XML format.
    #   @return [String]
    #
    # @!attribute [rw] entity_id
    #   The unique entity ID of the application in the SAML identity
    #   provider.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SAMLIdp AWS API Documentation
    #
    class SAMLIdp < Struct.new(
      :metadata_content,
      :entity_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # The SAML authentication configuration for an Amazon OpenSearch Service
    # domain.
    #
    # @!attribute [rw] enabled
    #   True to enable SAML authentication for a domain.
    #   @return [Boolean]
    #
    # @!attribute [rw] idp
    #   The SAML Identity Provider's information.
    #   @return [Types::SAMLIdp]
    #
    # @!attribute [rw] master_user_name
    #   The SAML master user name, which is stored in the domain's internal
    #   user database.
    #   @return [String]
    #
    # @!attribute [rw] master_backend_role
    #   The backend role that the SAML master user is mapped to.
    #   @return [String]
    #
    # @!attribute [rw] subject_key
    #   Element of the SAML assertion to use for the user name. Default is
    #   `NameID`.
    #   @return [String]
    #
    # @!attribute [rw] roles_key
    #   Element of the SAML assertion to use for backend roles. Default is
    #   `roles`.
    #   @return [String]
    #
    # @!attribute [rw] session_timeout_minutes
    #   The duration, in minutes, after which a user session becomes
    #   inactive. Acceptable values are between 1 and 1440, and the default
    #   value is 60.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SAMLOptionsInput AWS API Documentation
    #
    class SAMLOptionsInput < Struct.new(
      :enabled,
      :idp,
      :master_user_name,
      :master_backend_role,
      :subject_key,
      :roles_key,
      :session_timeout_minutes)
      SENSITIVE = [:master_user_name]
      include Aws::Structure
    end

    # Describes the SAML application configured for the domain.
    #
    # @!attribute [rw] enabled
    #   True if SAML is enabled.
    #   @return [Boolean]
    #
    # @!attribute [rw] idp
    #   Describes the SAML identity provider's information.
    #   @return [Types::SAMLIdp]
    #
    # @!attribute [rw] subject_key
    #   The key used for matching the SAML subject attribute.
    #   @return [String]
    #
    # @!attribute [rw] roles_key
    #   The key used for matching the SAML roles attribute.
    #   @return [String]
    #
    # @!attribute [rw] session_timeout_minutes
    #   The duration, in minutes, after which a user session becomes
    #   inactive.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SAMLOptionsOutput AWS API Documentation
    #
    class SAMLOptionsOutput < Struct.new(
      :enabled,
      :idp,
      :subject_key,
      :roles_key,
      :session_timeout_minutes)
      SENSITIVE = []
      include Aws::Structure
    end

    # Information about a scheduled configuration change for an OpenSearch
    # Service domain. This actions can be a [service software update][1] or
    # a [blue/green Auto-Tune enhancement][2].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
    # [2]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html#auto-tune-types
    #
    # @!attribute [rw] id
    #   The unique identifier of the scheduled action.
    #   @return [String]
    #
    # @!attribute [rw] type
    #   The type of action that will be taken on the domain.
    #   @return [String]
    #
    # @!attribute [rw] severity
    #   The severity of the action.
    #   @return [String]
    #
    # @!attribute [rw] scheduled_time
    #   The time when the change is scheduled to happen.
    #   @return [Integer]
    #
    # @!attribute [rw] description
    #   A description of the action to be taken.
    #   @return [String]
    #
    # @!attribute [rw] scheduled_by
    #   Whether the action was scheduled manually (`CUSTOMER`, or by
    #   OpenSearch Service automatically (`SYSTEM`).
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the scheduled action.
    #   @return [String]
    #
    # @!attribute [rw] mandatory
    #   Whether the action is required or optional.
    #   @return [Boolean]
    #
    # @!attribute [rw] cancellable
    #   Whether or not the scheduled action is cancellable.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ScheduledAction AWS API Documentation
    #
    class ScheduledAction < Struct.new(
      :id,
      :type,
      :severity,
      :scheduled_time,
      :description,
      :scheduled_by,
      :status,
      :mandatory,
      :cancellable)
      SENSITIVE = []
      include Aws::Structure
    end

    # Specifies details about a scheduled Auto-Tune action. For more
    # information, see [Auto-Tune for Amazon OpenSearch Service][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html
    #
    # @!attribute [rw] date
    #   The date and time when the Auto-Tune action is scheduled for the
    #   domain.
    #   @return [Time]
    #
    # @!attribute [rw] action_type
    #   The type of Auto-Tune action.
    #   @return [String]
    #
    # @!attribute [rw] action
    #   A description of the Auto-Tune action.
    #   @return [String]
    #
    # @!attribute [rw] severity
    #   The severity of the Auto-Tune action. Valid values are `LOW`,
    #   `MEDIUM`, and `HIGH`.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ScheduledAutoTuneDetails AWS API Documentation
    #
    class ScheduledAutoTuneDetails < Struct.new(
      :date,
      :action_type,
      :action,
      :severity)
      SENSITIVE = []
      include Aws::Structure
    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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/service-software.html
    #
    # @!attribute [rw] current_version
    #   The current service software version present on the domain.
    #   @return [String]
    #
    # @!attribute [rw] new_version
    #   The new service software version, if one is available.
    #   @return [String]
    #
    # @!attribute [rw] update_available
    #   True if you're able to update your service software version. False
    #   if you can't update your service software version.
    #   @return [Boolean]
    #
    # @!attribute [rw] cancellable
    #   True if you're able to cancel your service software version update.
    #   False if you can't cancel your service software update.
    #   @return [Boolean]
    #
    # @!attribute [rw] update_status
    #   The status of your service software update.
    #   @return [String]
    #
    # @!attribute [rw] description
    #   A description of the service software update status.
    #   @return [String]
    #
    # @!attribute [rw] automated_update_date
    #   The timestamp, in Epoch time, until which you can manually request a
    #   service software update. After this date, we automatically update
    #   your service software.
    #   @return [Time]
    #
    # @!attribute [rw] optional_deployment
    #   True if a service software is never automatically updated. False if
    #   a service software is automatically updated after the automated
    #   update date.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ServiceSoftwareOptions AWS API Documentation
    #
    class ServiceSoftwareOptions < Struct.new(
      :current_version,
      :new_version,
      :update_available,
      :cancellable,
      :update_status,
      :description,
      :automated_update_date,
      :optional_deployment)
      SENSITIVE = []
      include Aws::Structure
    end

    # An exception for attempting to schedule a domain action during an
    # unavailable time slot.
    #
    # @!attribute [rw] slot_suggestions
    #   Alternate time slots during which OpenSearch Service has available
    #   capacity to schedule a domain action.
    #   @return [Array<Integer>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SlotNotAvailableException AWS API Documentation
    #
    class SlotNotAvailableException < Struct.new(
      :slot_suggestions)
      SENSITIVE = []
      include Aws::Structure
    end

    # The time, in UTC format, when OpenSearch Service takes a daily
    # automated snapshot of the specified domain. Default is `0` hours.
    #
    # @!attribute [rw] automated_snapshot_start_hour
    #   The time, in UTC format, when OpenSearch Service takes a daily
    #   automated snapshot of the specified domain. Default is `0` hours.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SnapshotOptions AWS API Documentation
    #
    class SnapshotOptions < Struct.new(
      :automated_snapshot_start_hour)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for information about a daily automated snapshot for an
    # OpenSearch Service domain.
    #
    # @!attribute [rw] options
    #   The daily snapshot options specified for the domain.
    #   @return [Types::SnapshotOptions]
    #
    # @!attribute [rw] status
    #   The status of a daily automated snapshot.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SnapshotOptionsStatus AWS API Documentation
    #
    class SnapshotOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Options for configuring service software updates for a domain.
    #
    # @!attribute [rw] auto_software_update_enabled
    #   Whether automatic service software updates are enabled for the
    #   domain.
    #   @return [Boolean]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SoftwareUpdateOptions AWS API Documentation
    #
    class SoftwareUpdateOptions < Struct.new(
      :auto_software_update_enabled)
      SENSITIVE = []
      include Aws::Structure
    end

    # The status of the service software options for a domain.
    #
    # @!attribute [rw] options
    #   The service software update options for a domain.
    #   @return [Types::SoftwareUpdateOptions]
    #
    # @!attribute [rw] status
    #   The status of service software update options, including creation
    #   date and last updated date.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SoftwareUpdateOptionsStatus AWS API Documentation
    #
    class SoftwareUpdateOptionsStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `StartDomainMaintenance`
    # operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] action
    #   The name of the action.
    #   @return [String]
    #
    # @!attribute [rw] node_id
    #   The ID of the data node.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartDomainMaintenanceRequest AWS API Documentation
    #
    class StartDomainMaintenanceRequest < Struct.new(
      :domain_name,
      :action,
      :node_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of a `StartDomainMaintenance` request that information
    # about the requested action.
    #
    # @!attribute [rw] maintenance_id
    #   The request ID of requested action.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartDomainMaintenanceResponse AWS API Documentation
    #
    class StartDomainMaintenanceResponse < Struct.new(
      :maintenance_id)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the
    # `StartServiceSoftwareUpdate` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain that you want to update to the latest service
    #   software.
    #   @return [String]
    #
    # @!attribute [rw] schedule_at
    #   When to start the service software update.
    #
    #   * `NOW` - Immediately schedules the update to happen in the current
    #     hour if there's capacity available.
    #
    #   * `TIMESTAMP` - Lets you specify a custom date and time to apply the
    #     update. If you specify this value, you must also provide a value
    #     for `DesiredStartTime`.
    #
    #   * `OFF_PEAK_WINDOW` - Marks the update to be picked up during an
    #     upcoming off-peak window. There's no guarantee that the update
    #     will happen during the next immediate window. Depending on
    #     capacity, it might happen in subsequent days.
    #
    #   Default: `NOW` if you don't specify a value for `DesiredStartTime`,
    #   and `TIMESTAMP` if you do.
    #   @return [String]
    #
    # @!attribute [rw] desired_start_time
    #   The Epoch timestamp when you want the service software update to
    #   start. You only need to specify this parameter if you set
    #   `ScheduleAt` to `TIMESTAMP`.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartServiceSoftwareUpdateRequest AWS API Documentation
    #
    class StartServiceSoftwareUpdateRequest < Struct.new(
      :domain_name,
      :schedule_at,
      :desired_start_time)
      SENSITIVE = []
      include Aws::Structure
    end

    # Represents the output of a `StartServiceSoftwareUpdate` operation.
    # Contains the status of the update.
    #
    # @!attribute [rw] service_software_options
    #   The current status of the OpenSearch Service software update.
    #   @return [Types::ServiceSoftwareOptions]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StartServiceSoftwareUpdateResponse AWS API Documentation
    #
    class StartServiceSoftwareUpdateResponse < Struct.new(
      :service_software_options)
      SENSITIVE = []
      include Aws::Structure
    end

    # A list of storage types for an Amazon OpenSearch Service domain that
    # are available for a given intance type.
    #
    # @!attribute [rw] storage_type_name
    #   The name of the storage type.
    #   @return [String]
    #
    # @!attribute [rw] storage_sub_type_name
    #   The storage sub-type, such as `gp3` or `io1`.
    #   @return [String]
    #
    # @!attribute [rw] storage_type_limits
    #   Limits that are applicable for the given storage type.
    #   @return [Array<Types::StorageTypeLimit>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StorageType AWS API Documentation
    #
    class StorageType < Struct.new(
      :storage_type_name,
      :storage_sub_type_name,
      :storage_type_limits)
      SENSITIVE = []
      include Aws::Structure
    end

    # Limits that are applicable for the given Amazon OpenSearch Service
    # storage type.
    #
    # @!attribute [rw] limit_name
    #   Name of storage limits that are applicable for the given storage
    #   type. If `StorageType` is `ebs`, the following options are
    #   available:
    #
    #   * **MinimumVolumeSize** - Minimum volume size that is available for
    #     the given storage type. Can be empty if not applicable.
    #
    #   * **MaximumVolumeSize** - Maximum volume size that is available for
    #     the given storage type. Can be empty if not applicable.
    #
    #   * **MaximumIops** - Maximum amount of IOPS that is available for the
    #     given the storage type. Can be empty if not applicable.
    #
    #   * **MinimumIops** - Minimum amount of IOPS that is available for the
    #     given the storage type. Can be empty if not applicable.
    #
    #   * **MaximumThroughput** - Maximum amount of throughput that is
    #     available for the given the storage type. Can be empty if not
    #     applicable.
    #
    #   * **MinimumThroughput** - Minimum amount of throughput that is
    #     available for the given the storage type. Can be empty if not
    #     applicable.
    #   @return [String]
    #
    # @!attribute [rw] limit_values
    #   The limit values.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/StorageTypeLimit AWS API Documentation
    #
    class StorageTypeLimit < Struct.new(
      :limit_name,
      :limit_values)
      SENSITIVE = []
      include Aws::Structure
    end

    # A tag (key-value pair) for an Amazon OpenSearch Service resource.
    #
    # @!attribute [rw] key
    #   The tag key. Tag keys must be unique for the domain to which they
    #   are attached.
    #   @return [String]
    #
    # @!attribute [rw] value
    #   The value assigned to the corresponding tag key. Tag values can be
    #   null and don't have to be unique in a tag set. For example, you can
    #   have a key value pair in a tag set of `project : Trinity` and
    #   `cost-center : Trinity`
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/Tag AWS API Documentation
    #
    class Tag < Struct.new(
      :key,
      :value)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the parameters to the `UpdateDataSource` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain.
    #   @return [String]
    #
    # @!attribute [rw] name
    #   The name of the data source to modify.
    #   @return [String]
    #
    # @!attribute [rw] data_source_type
    #   The type of data source.
    #   @return [Types::DataSourceType]
    #
    # @!attribute [rw] description
    #   A new description of the data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDataSourceRequest AWS API Documentation
    #
    class UpdateDataSourceRequest < Struct.new(
      :domain_name,
      :name,
      :data_source_type,
      :description)
      SENSITIVE = []
      include Aws::Structure
    end

    # The result of an `UpdateDataSource` operation.
    #
    # @!attribute [rw] message
    #   A message associated with the updated data source.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDataSourceResponse AWS API Documentation
    #
    class UpdateDataSourceResponse < Struct.new(
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `UpdateDomain` operation.
    #
    # @!attribute [rw] domain_name
    #   The name of the domain that you're updating.
    #   @return [String]
    #
    # @!attribute [rw] cluster_config
    #   Changes that you want to make to the cluster configuration, such as
    #   the instance type and number of EC2 instances.
    #   @return [Types::ClusterConfig]
    #
    # @!attribute [rw] ebs_options
    #   The type and size of the EBS volume to attach to instances in the
    #   domain.
    #   @return [Types::EBSOptions]
    #
    # @!attribute [rw] snapshot_options
    #   Option to set the time, in UTC format, for the daily automated
    #   snapshot. Default value is `0` hours.
    #   @return [Types::SnapshotOptions]
    #
    # @!attribute [rw] vpc_options
    #   Options to specify the subnets and security groups for a VPC
    #   endpoint. For more information, see [Launching your Amazon
    #   OpenSearch Service domains using a VPC][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
    #   @return [Types::VPCOptions]
    #
    # @!attribute [rw] cognito_options
    #   Key-value pairs to configure Amazon Cognito authentication for
    #   OpenSearch Dashboards.
    #   @return [Types::CognitoOptions]
    #
    # @!attribute [rw] advanced_options
    #   Key-value pairs to specify advanced configuration options. The
    #   following key-value pairs are supported:
    #
    #   * `"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.
    #
    #   For more information, see [Advanced cluster parameters][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options
    #   @return [Hash<String,String>]
    #
    # @!attribute [rw] access_policies
    #   Identity and Access Management (IAM) access policy as a
    #   JSON-formatted string.
    #   @return [String]
    #
    # @!attribute [rw] ip_address_type
    #   Specify either dual stack or IPv4 as your IP address type. Dual
    #   stack allows you to share domain resources across IPv4 and IPv6
    #   address types, and is the recommended option. If your IP address
    #   type is currently set to dual stack, you can't change it.
    #   @return [String]
    #
    # @!attribute [rw] log_publishing_options
    #   Options to publish OpenSearch logs to Amazon CloudWatch Logs.
    #   @return [Hash<String,Types::LogPublishingOption>]
    #
    # @!attribute [rw] encryption_at_rest_options
    #   Encryption at rest options for the domain.
    #   @return [Types::EncryptionAtRestOptions]
    #
    # @!attribute [rw] domain_endpoint_options
    #   Additional options for the domain endpoint, such as whether to
    #   require HTTPS for all traffic.
    #   @return [Types::DomainEndpointOptions]
    #
    # @!attribute [rw] node_to_node_encryption_options
    #   Node-to-node encryption options for the domain.
    #   @return [Types::NodeToNodeEncryptionOptions]
    #
    # @!attribute [rw] advanced_security_options
    #   Options for fine-grained access control.
    #   @return [Types::AdvancedSecurityOptionsInput]
    #
    # @!attribute [rw] auto_tune_options
    #   Options for Auto-Tune.
    #   @return [Types::AutoTuneOptions]
    #
    # @!attribute [rw] dry_run
    #   This flag, when set to True, specifies whether the `UpdateDomain`
    #   request should return the results of a dry run analysis without
    #   actually applying the change. A dry run determines what type of
    #   deployment the update will cause.
    #   @return [Boolean]
    #
    # @!attribute [rw] dry_run_mode
    #   The type of dry run to perform.
    #
    #   * `Basic` only returns the type of deployment (blue/green or
    #     dynamic) that the update will cause.
    #
    #   * `Verbose` runs an additional check to validate the changes you're
    #     making. For more information, see [Validating a domain update][1].
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-configuration-changes#validation-check
    #   @return [String]
    #
    # @!attribute [rw] off_peak_window_options
    #   Off-peak window options for the domain.
    #   @return [Types::OffPeakWindowOptions]
    #
    # @!attribute [rw] software_update_options
    #   Service software update options for the domain.
    #   @return [Types::SoftwareUpdateOptions]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfigRequest AWS API Documentation
    #
    class UpdateDomainConfigRequest < Struct.new(
      :domain_name,
      :cluster_config,
      :ebs_options,
      :snapshot_options,
      :vpc_options,
      :cognito_options,
      :advanced_options,
      :access_policies,
      :ip_address_type,
      :log_publishing_options,
      :encryption_at_rest_options,
      :domain_endpoint_options,
      :node_to_node_encryption_options,
      :advanced_security_options,
      :auto_tune_options,
      :dry_run,
      :dry_run_mode,
      :off_peak_window_options,
      :software_update_options)
      SENSITIVE = []
      include Aws::Structure
    end

    # The results of an `UpdateDomain` request. Contains the status of the
    # domain being updated.
    #
    # @!attribute [rw] domain_config
    #   The status of the updated domain.
    #   @return [Types::DomainConfig]
    #
    # @!attribute [rw] dry_run_results
    #   Results of the dry run performed in the update domain request.
    #   @return [Types::DryRunResults]
    #
    # @!attribute [rw] dry_run_progress_status
    #   The status of the dry run being performed on the domain, if any.
    #   @return [Types::DryRunProgressStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateDomainConfigResponse AWS API Documentation
    #
    class UpdateDomainConfigResponse < Struct.new(
      :domain_config,
      :dry_run_results,
      :dry_run_progress_status)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for request parameters to the `UpdatePackage` operation.
    #
    # @!attribute [rw] package_id
    #   The unique identifier for the package.
    #   @return [String]
    #
    # @!attribute [rw] package_source
    #   Amazon S3 bucket and key for the package.
    #   @return [Types::PackageSource]
    #
    # @!attribute [rw] package_description
    #   A new description of the package.
    #   @return [String]
    #
    # @!attribute [rw] commit_message
    #   Commit message for the updated file, which is shown as part of
    #   `GetPackageVersionHistoryResponse`.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackageRequest AWS API Documentation
    #
    class UpdatePackageRequest < Struct.new(
      :package_id,
      :package_source,
      :package_description,
      :commit_message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by the `UpdatePackage` operation.
    #
    # @!attribute [rw] package_details
    #   Information about a package.
    #   @return [Types::PackageDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdatePackageResponse AWS API Documentation
    #
    class UpdatePackageResponse < Struct.new(
      :package_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] domain_name
    #   The name of the domain to reschedule an action for.
    #   @return [String]
    #
    # @!attribute [rw] action_id
    #   The unique identifier of the action to reschedule. To retrieve this
    #   ID, send a [ListScheduledActions][1] request.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
    #   @return [String]
    #
    # @!attribute [rw] action_type
    #   The type of action to reschedule. Can be one of
    #   `SERVICE_SOFTWARE_UPDATE`, `JVM_HEAP_SIZE_TUNING`, or
    #   `JVM_YOUNG_GEN_TUNING`. To retrieve this value, send a
    #   [ListScheduledActions][1] request.
    #
    #
    #
    #   [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html
    #   @return [String]
    #
    # @!attribute [rw] schedule_at
    #   When to schedule the action.
    #
    #   * `NOW` - Immediately schedules the update to happen in the current
    #     hour if there's capacity available.
    #
    #   * `TIMESTAMP` - Lets you specify a custom date and time to apply the
    #     update. If you specify this value, you must also provide a value
    #     for `DesiredStartTime`.
    #
    #   * `OFF_PEAK_WINDOW` - Marks the action to be picked up during an
    #     upcoming off-peak window. There's no guarantee that the change
    #     will be implemented during the next immediate window. Depending on
    #     capacity, it might happen in subsequent days.
    #   @return [String]
    #
    # @!attribute [rw] desired_start_time
    #   The time to implement the change, in Coordinated Universal Time
    #   (UTC). Only specify this parameter if you set `ScheduleAt` to
    #   `TIMESTAMP`.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateScheduledActionRequest AWS API Documentation
    #
    class UpdateScheduledActionRequest < Struct.new(
      :domain_name,
      :action_id,
      :action_type,
      :schedule_at,
      :desired_start_time)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] scheduled_action
    #   Information about the rescheduled action.
    #   @return [Types::ScheduledAction]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateScheduledActionResponse AWS API Documentation
    #
    class UpdateScheduledActionResponse < Struct.new(
      :scheduled_action)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoint_id
    #   The unique identifier of the endpoint.
    #   @return [String]
    #
    # @!attribute [rw] vpc_options
    #   The security groups and/or subnets to add, remove, or modify.
    #   @return [Types::VPCOptions]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateVpcEndpointRequest AWS API Documentation
    #
    class UpdateVpcEndpointRequest < Struct.new(
      :vpc_endpoint_id,
      :vpc_options)
      SENSITIVE = []
      include Aws::Structure
    end

    # @!attribute [rw] vpc_endpoint
    #   The endpoint to be updated.
    #   @return [Types::VpcEndpoint]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpdateVpcEndpointResponse AWS API Documentation
    #
    class UpdateVpcEndpointResponse < Struct.new(
      :vpc_endpoint)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the request parameters to the `UpgradeDomain` operation.
    #
    # @!attribute [rw] domain_name
    #   Name of the OpenSearch Service domain that you want to upgrade.
    #   @return [String]
    #
    # @!attribute [rw] target_version
    #   OpenSearch or Elasticsearch version to which you want to upgrade, in
    #   the format Opensearch\_X.Y or Elasticsearch\_X.Y.
    #   @return [String]
    #
    # @!attribute [rw] perform_check_only
    #   When true, indicates that an upgrade eligibility check needs to be
    #   performed. Does not actually perform the upgrade.
    #   @return [Boolean]
    #
    # @!attribute [rw] advanced_options
    #   Only supports the `override_main_response_version` parameter and not
    #   other advanced options. You can only include this option when
    #   upgrading to an OpenSearch version. Specifies whether the domain
    #   reports its version as 7.10 so that it continues to work with
    #   Elasticsearch OSS clients and plugins.
    #   @return [Hash<String,String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeDomainRequest AWS API Documentation
    #
    class UpgradeDomainRequest < Struct.new(
      :domain_name,
      :target_version,
      :perform_check_only,
      :advanced_options)
      SENSITIVE = []
      include Aws::Structure
    end

    # Container for the response returned by `UpgradeDomain` operation.
    #
    # @!attribute [rw] upgrade_id
    #   The unique identifier of the domain upgrade.
    #   @return [String]
    #
    # @!attribute [rw] domain_name
    #   The name of the domain that was upgraded.
    #   @return [String]
    #
    # @!attribute [rw] target_version
    #   OpenSearch or Elasticsearch version that the domain was upgraded to.
    #   @return [String]
    #
    # @!attribute [rw] perform_check_only
    #   When true, indicates that an upgrade eligibility check was
    #   performed.
    #   @return [Boolean]
    #
    # @!attribute [rw] advanced_options
    #   The advanced options configuration for the domain.
    #   @return [Hash<String,String>]
    #
    # @!attribute [rw] change_progress_details
    #   Container for information about a configuration change happening on
    #   a domain.
    #   @return [Types::ChangeProgressDetails]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeDomainResponse AWS API Documentation
    #
    class UpgradeDomainResponse < Struct.new(
      :upgrade_id,
      :domain_name,
      :target_version,
      :perform_check_only,
      :advanced_options,
      :change_progress_details)
      SENSITIVE = []
      include Aws::Structure
    end

    # History of the last 10 upgrades and upgrade eligibility checks for an
    # Amazon OpenSearch Service domain.
    #
    # @!attribute [rw] upgrade_name
    #   A string that describes the upgrade.
    #   @return [String]
    #
    # @!attribute [rw] start_timestamp
    #   UTC timestamp at which the upgrade API call was made, in the format
    #   `yyyy-MM-ddTHH:mm:ssZ`.
    #   @return [Time]
    #
    # @!attribute [rw] upgrade_status
    #   The current status of the upgrade. The status can take one of the
    #   following values:
    #
    #   * In Progress
    #
    #   * Succeeded
    #
    #   * Succeeded with Issues
    #
    #   * Failed
    #   @return [String]
    #
    # @!attribute [rw] steps_list
    #   A list of each step performed as part of a specific upgrade or
    #   upgrade eligibility check.
    #   @return [Array<Types::UpgradeStepItem>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeHistory AWS API Documentation
    #
    class UpgradeHistory < Struct.new(
      :upgrade_name,
      :start_timestamp,
      :upgrade_status,
      :steps_list)
      SENSITIVE = []
      include Aws::Structure
    end

    # Represents a single step of an upgrade or upgrade eligibility check
    # workflow.
    #
    # @!attribute [rw] upgrade_step
    #   One of three steps that an upgrade or upgrade eligibility check goes
    #   through:
    #
    #   * PreUpgradeCheck
    #
    #   * Snapshot
    #
    #   * Upgrade
    #   @return [String]
    #
    # @!attribute [rw] upgrade_step_status
    #   The current status of the upgrade. The status can take one of the
    #   following values:
    #
    #   * In Progress
    #
    #   * Succeeded
    #
    #   * Succeeded with Issues
    #
    #   * Failed
    #   @return [String]
    #
    # @!attribute [rw] issues
    #   A list of strings containing detailed information about the errors
    #   encountered in a particular step.
    #   @return [Array<String>]
    #
    # @!attribute [rw] progress_percent
    #   The floating point value representing the progress percentage of a
    #   particular step.
    #   @return [Float]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/UpgradeStepItem AWS API Documentation
    #
    class UpgradeStepItem < Struct.new(
      :upgrade_step,
      :upgrade_step_status,
      :issues,
      :progress_percent)
      SENSITIVE = []
      include Aws::Structure
    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][1]. This information only exists if the
    # domain was created with `VPCOptions`.
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
    #
    # @!attribute [rw] vpc_id
    #   The ID for your VPC. Amazon VPC generates this value when you create
    #   a VPC.
    #   @return [String]
    #
    # @!attribute [rw] subnet_ids
    #   A list of subnet IDs associated with the VPC endpoints for the
    #   domain.
    #   @return [Array<String>]
    #
    # @!attribute [rw] availability_zones
    #   The list of Availability Zones associated with the VPC subnets.
    #   @return [Array<String>]
    #
    # @!attribute [rw] security_group_ids
    #   The list of security group IDs associated with the VPC endpoints for
    #   the domain.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/VPCDerivedInfo AWS API Documentation
    #
    class VPCDerivedInfo < Struct.new(
      :vpc_id,
      :subnet_ids,
      :availability_zones,
      :security_group_ids)
      SENSITIVE = []
      include Aws::Structure
    end

    # Status of the VPC options for a specified domain.
    #
    # @!attribute [rw] options
    #   The VPC options for the specified domain.
    #   @return [Types::VPCDerivedInfo]
    #
    # @!attribute [rw] status
    #   The status of the VPC options for the specified domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/VPCDerivedInfoStatus AWS API Documentation
    #
    class VPCDerivedInfoStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    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][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html
    #
    # @!attribute [rw] subnet_ids
    #   A list of subnet IDs associated with the VPC endpoints for the
    #   domain. If your domain uses multiple Availability Zones, you need to
    #   provide two subnet IDs, one per zone. Otherwise, provide only one.
    #   @return [Array<String>]
    #
    # @!attribute [rw] security_group_ids
    #   The list of security group IDs associated with the VPC endpoints for
    #   the domain. If you do not provide a security group ID, OpenSearch
    #   Service uses the default security group for the VPC.
    #   @return [Array<String>]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/VPCOptions AWS API Documentation
    #
    class VPCOptions < Struct.new(
      :subnet_ids,
      :security_group_ids)
      SENSITIVE = []
      include Aws::Structure
    end

    # An exception for accessing or deleting a resource that doesn't exist.
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ValidationException AWS API Documentation
    #
    class ValidationException < Aws::EmptyStructure; end

    # A validation failure that occurred as the result of a pre-update
    # validation check (verbose dry run) on a domain.
    #
    # @!attribute [rw] code
    #   The error code of the failure.
    #   @return [String]
    #
    # @!attribute [rw] message
    #   A message corresponding to the failure.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ValidationFailure AWS API Documentation
    #
    class ValidationFailure < Struct.new(
      :code,
      :message)
      SENSITIVE = []
      include Aws::Structure
    end

    # The status of the the OpenSearch or Elasticsearch version options for
    # the specified Amazon OpenSearch Service domain.
    #
    # @!attribute [rw] options
    #   The OpenSearch or Elasticsearch version for the specified domain.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The status of the version options for the specified domain.
    #   @return [Types::OptionStatus]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/VersionStatus AWS API Documentation
    #
    class VersionStatus < Struct.new(
      :options,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # The connection endpoint for connecting to an Amazon OpenSearch Service
    # domain through a proxy.
    #
    # @!attribute [rw] vpc_endpoint_id
    #   The unique identifier of the endpoint.
    #   @return [String]
    #
    # @!attribute [rw] vpc_endpoint_owner
    #   The creator of the endpoint.
    #   @return [String]
    #
    # @!attribute [rw] domain_arn
    #   The Amazon Resource Name (ARN) of the domain associated with the
    #   endpoint.
    #   @return [String]
    #
    # @!attribute [rw] vpc_options
    #   Options to specify the subnets and security groups for an Amazon
    #   OpenSearch Service VPC endpoint.
    #   @return [Types::VPCDerivedInfo]
    #
    # @!attribute [rw] status
    #   The current status of the endpoint.
    #   @return [String]
    #
    # @!attribute [rw] endpoint
    #   The connection endpoint ID for connecting to the domain.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/VpcEndpoint AWS API Documentation
    #
    class VpcEndpoint < Struct.new(
      :vpc_endpoint_id,
      :vpc_endpoint_owner,
      :domain_arn,
      :vpc_options,
      :status,
      :endpoint)
      SENSITIVE = []
      include Aws::Structure
    end

    # Error information when attempting to describe an Amazon OpenSearch
    # Service-managed VPC endpoint.
    #
    # @!attribute [rw] vpc_endpoint_id
    #   The unique identifier of the endpoint.
    #   @return [String]
    #
    # @!attribute [rw] error_code
    #   The code associated with the error.
    #   @return [String]
    #
    # @!attribute [rw] error_message
    #   A message describing the error.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/VpcEndpointError AWS API Documentation
    #
    class VpcEndpointError < Struct.new(
      :vpc_endpoint_id,
      :error_code,
      :error_message)
      SENSITIVE = []
      include Aws::Structure
    end

    # Summary information for an Amazon OpenSearch Service-managed VPC
    # endpoint.
    #
    # @!attribute [rw] vpc_endpoint_id
    #   The unique identifier of the endpoint.
    #   @return [String]
    #
    # @!attribute [rw] vpc_endpoint_owner
    #   The creator of the endpoint.
    #   @return [String]
    #
    # @!attribute [rw] domain_arn
    #   The Amazon Resource Name (ARN) of the domain associated with the
    #   endpoint.
    #   @return [String]
    #
    # @!attribute [rw] status
    #   The current status of the endpoint.
    #   @return [String]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/VpcEndpointSummary AWS API Documentation
    #
    class VpcEndpointSummary < Struct.new(
      :vpc_endpoint_id,
      :vpc_endpoint_owner,
      :domain_arn,
      :status)
      SENSITIVE = []
      include Aws::Structure
    end

    # The desired start time for an [off-peak maintenance window][1].
    #
    #
    #
    # [1]: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.html
    #
    # @!attribute [rw] hours
    #   The start hour of the window in Coordinated Universal Time (UTC),
    #   using 24-hour time. For example, `17` refers to 5:00 P.M. UTC.
    #   @return [Integer]
    #
    # @!attribute [rw] minutes
    #   The start minute of the window, in UTC.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/WindowStartTime AWS API Documentation
    #
    class WindowStartTime < Struct.new(
      :hours,
      :minutes)
      SENSITIVE = []
      include Aws::Structure
    end

    # The zone awareness configuration for an Amazon OpenSearch Service
    # domain.
    #
    # @!attribute [rw] availability_zone_count
    #   If you enabled multiple Availability Zones, this value is the number
    #   of zones that you want the domain to use. Valid values are `2` and
    #   `3`. If your domain is provisioned within a VPC, this value be equal
    #   to number of subnets.
    #   @return [Integer]
    #
    # @see http://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ZoneAwarenessConfig AWS API Documentation
    #
    class ZoneAwarenessConfig < Struct.new(
      :availability_zone_count)
      SENSITIVE = []
      include Aws::Structure
    end

  end
end