Amazon OpenSearch Service API

The Amazon OpenSearch Service API provides a managed service for deploying, operating, and scaling OpenSearch clusters in the AWS Cloud. The API allows you to create and configure domains, manage cluster settings, configure access policies, set up automated snapshots, upgrade domain versions, and monitor cluster health and performance. It supports log analytics, full-text search, application monitoring, and clickstream analytics with built-in visualization capabilities.

OpenAPI Specification

amazon-opensearch-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: '2015-01-01'
  x-release: v4
  title: Amazon Elasticsearch Service
  description: '<fullname>Amazon Elasticsearch Configuration Service</fullname> <p>Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.</p> <p>For sample
    code that uses the Configuration API, see the <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-samples.html">Amazon Elasticsearch Service Developer Guide</a>.
    The guide also contains <a href="https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-request-signing.html">sample code for sending signed HTTP requests to the Elasticsearch APIs</a>.</p>
    <p>The endpoint for configuration service requests is region-specific: es.<i>region</i>.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,
    see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#elasticsearch-service-regions" target="_blank">Regions and Endpoints</a>.</p>'
  x-logo:
    url: 'https://twitter.com/awscloud/profile_image?size=original'
    backgroundColor: '#FFFFFF'
  termsOfService: 'https://aws.amazon.com/service-terms/'
  contact:
    name: Mike Ralphson
    email: [email protected]
    url: 'https://github.com/mermade/aws2openapi'
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: 'http://www.apache.org/licenses/'
  x-providerName: amazonaws.com
  x-serviceName: es
  x-origin:
  - contentType: application/json
    url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/es-2015-01-01.normal.json'
    converter:
      url: 'https://github.com/mermade/aws2openapi'
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct'
  x-apisguru-categories:
  - cloud
  x-preferred: true
externalDocs:
  description: Amazon Web Services documentation
  url: 'https://docs.aws.amazon.com/es/'
servers:
- url: 'http://es.{region}.amazonaws.com'
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Elasticsearch Service multi-region endpoint
- url: 'https://es.{region}.amazonaws.com'
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Elasticsearch Service multi-region endpoint
- url: 'http://es.{region}.amazonaws.com.cn'
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Elasticsearch Service endpoint for China (Beijing) and China (Ningxia)
- url: 'https://es.{region}.amazonaws.com.cn'
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Elasticsearch Service endpoint for China (Beijing) and China (Ningxia)
paths:
  '/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept':
    put:
      operationId: AcceptInboundCrossClusterSearchConnection
      description: Allows the destination domain owner to accept an inbound cross-cluster search connection request.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptInboundCrossClusterSearchConnectionResponse'
              examples:
                AcceptInboundCrossClusterSearchConnection200Example:
                  summary: Default AcceptInboundCrossClusterSearchConnection 200 response
                  x-microcks-default: true
                  value:
                    CrossClusterSearchConnection: example-string
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '482':
          description: DisabledOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
      parameters:
      - name: ConnectionId
        in: path
        required: true
        description: The id of the inbound connection that you want to accept.
        schema:
          type: string
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon OpenSearch Accept Inbound Cross Cluster Search Connection
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /2015-01-01/tags:
    post:
      operationId: AddTags
      description: 'Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-awsresorcetagging"
        target="_blank"> Tagging Amazon Elasticsearch Service Domains for more information.</a>'
      responses:
        '200':
          description: Success
        '480':
          description: BaseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '481':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '482':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '483':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ARN
              - TagList
              properties:
                ARN:
                  description: 'The Amazon Resource Name (ARN) of the Elasticsearch domain. See <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html" target="_blank">Identifiers
                    for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.'
                  type: string
                TagList:
                  description: 'A list of <code>Tag</code> '
                  type: array
                  items:
                    $ref: '#/components/schemas/Tag'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon OpenSearch Add Tags
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  '/2015-01-01/packages/associate/{PackageID}/{DomainName}':
    post:
      operationId: AssociatePackage
      description: Associates a package with an Amazon ES domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssociatePackageResponse'
              examples:
                AssociatePackage200Example:
                  summary: Default AssociatePackage 200 response
                  x-microcks-default: true
                  value:
                    DomainPackageDetails: example-string
        '480':
          description: BaseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '481':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '485':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
      parameters:
      - name: PackageID
        in: path
        required: true
        description: Internal ID of the package that you want to associate with a domain. Use <code>DescribePackages</code> to find this value.
        schema:
          type: string
      - name: DomainName
        in: path
        required: true
        description: Name of the domain that you want to associate the package with.
        schema:
          type: string
          pattern: '[a-z][a-z0-9\-]+'
          description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain
            the following characters: a-z (lowercase), 0-9, and - (hyphen).'
          minLength: 3
          maxLength: 28
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon OpenSearch Associate Package
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  '/2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess':
    post:
      operationId: AuthorizeVpcEndpointAccess
      description: Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizeVpcEndpointAccessResponse'
              examples:
                AuthorizeVpcEndpointAccess200Example:
                  summary: Default AuthorizeVpcEndpointAccess 200 response
                  x-microcks-default: true
                  value:
                    AuthorizedPrincipal: example-string
        '480':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '481':
          description: DisabledOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
        '482':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '484':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '485':
          description: BaseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
      parameters:
      - name: DomainName
        in: path
        required: true
        description: The name of the OpenSearch Service domain to provide access to.
        schema:
          type: string
          pattern: '[a-z][a-z0-9\-]+'
          description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain
            the following characters: a-z (lowercase), 0-9, and - (hyphen).'
          minLength: 3
          maxLength: 28
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - Account
              properties:
                Account:
                  description: The account ID to grant access to.
                  type: string
                  pattern: '^[0-9]+$'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon OpenSearch Authorize Vpc Endpoint Access
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /2015-01-01/es/serviceSoftwareUpdate/cancel:
    post:
      operationId: CancelElasticsearchServiceSoftwareUpdate
      description: Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the <code>AutomatedUpdateDate</code> and when the 
        <code>UpdateStatus</code> is in the <code>PENDING_UPDATE</code> state.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelElasticsearchServiceSoftwareUpdateResponse'
              examples:
                CancelElasticsearchServiceSoftwareUpdate200Example:
                  summary: Default CancelElasticsearchServiceSoftwareUpdate 200 response
                  x-microcks-default: true
                  value:
                    ServiceSoftwareOptions: example-string
        '480':
          description: BaseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '481':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '482':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '483':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - DomainName
              properties:
                DomainName:
                  description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can
                    contain the following characters: a-z (lowercase), 0-9, and - (hyphen).'
                  type: string
                  pattern: '[a-z][a-z0-9\-]+'
                  minLength: 3
                  maxLength: 28
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon OpenSearch Cancel Elasticsearch Service Software Update
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
  /2015-01-01/es/domain:
    post:
      operationId: CreateElasticsearchDomain
      description: 'Creates a new Elasticsearch domain. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains"
        target="_blank">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateElasticsearchDomainResponse'
              examples:
                CreateElasticsearchDomain200Example:
                  summary: Default CreateElasticsearchDomain 200 response
                  x-microcks-default: true
                  value:
                    DomainStatus: active
        '480':
          description: BaseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '481':
          description: DisabledOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisabledOperationException'
        '482':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException'
        '483':
          description: InvalidTypeException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidTypeException'
        '484':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '485':
          description: ResourceAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
        '486':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - DomainName
              properties:
                DomainName:
                  description: 'The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can
                    contain the following characters: a-z (lowercase), 0-9, and - (hyphen).'
                  type: string
                  pattern: '[a-z][a-z0-9\-]+'
                  minLength: 3
                  maxLength: 28
                ElasticsearchVersion:
                  description: 'String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains"
                    target="_blank">Creating Elasticsearch Domains</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>.'
                  type: string
                  pattern: '^[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$|^OS_[0-9]{1,2}\.[0-9]{1,2}$'
                ElasticsearchClusterConfig:
                  description: 'Specifies the configuration for the domain cluster, such as the type and number of instances.'
                  type: object
                  properties:
                    InstanceType:
                      allOf:
                      - $ref: '#/components/schemas/ESPartitionInstanceType'
                      - description: The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
                    InstanceCount:
                      allOf:
                      - $ref: '#/components/schemas/IntegerClass'
                      - description: The number of instances in the specified domain cluster.
                    DedicatedMasterEnabled:
                      allOf:
                      - $ref: '#/components/schemas/Boolean'
                      - description: 'A boolean value to indicate whether a dedicated master node is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes"
                          target="_blank">About Dedicated Master Nodes</a> for more information.'
                    ZoneAwarenessEnabled:
                      allOf:
                      - $ref: '#/components/schemas/Boolean'
                      - description: 'A boolean value to indicate whether zone awareness is enabled. See <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness"
                          target="_blank">About Zone Awareness</a> for more information.'
                    ZoneAwarenessConfig:
                      allOf:
                      - $ref: '#/components/schemas/ZoneAwarenessConfig'
                      - description: Specifies the zone awareness configuration for a domain when zone awareness is enabled.
                    DedicatedMasterType:
                      allOf:
                      - $ref: '#/components/schemas/ESPartitionInstanceType'
                      - description: The instance type for a dedicated master node.
                    DedicatedMasterCount:
                      allOf:
                      - $ref: '#/components/schemas/IntegerClass'
                      - description: 'Total number of dedicated master nodes, active and on standby, for the cluster.'
                    WarmEnabled:
                      allOf:
                      - $ref: '#/components/schemas/Boolean'
                      - description: True to enable warm storage.
                    WarmType:
                      allOf:
                      - $ref: '#/components/schemas/ESWarmPartitionInstanceType'
                      - description: The instance type for the Elasticsearch cluster's warm nodes.
                    WarmCount:
                      allOf:
                      - $ref: '#/components/schemas/IntegerClass'
                      - description: The number of warm nodes in the cluster.
                    ColdStorageOptions:
                      allOf:
                      - $ref: '#/components/schemas/ColdStorageOptions'
                      - description: Specifies the <code>ColdStorageOptions</code> config for Elasticsearch Domain
                EBSOptions:
                  description: 'Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs"
                    target="_blank"> Configuring EBS-based Storage</a>.'
                  type: object
                  properties:
                    EBSEnabled:
                      allOf:
                      - $ref: '#/components/schemas/Boolean'
                      - description: Specifies whether EBS-based storage is enabled.
                    VolumeType:
                      allOf:
                      - $ref: '#/components/schemas/VolumeType'
                      - description: ' Specifies the volume type for EBS-based storage.'
                    VolumeSize:
                      allOf:
                      - $ref: '#/components/schemas/IntegerClass'
                      - description: ' Integer to specify the size of an EBS volume.'
                    Iops:
                      allOf:
                      - $ref: '#/components/schemas/IntegerClass'
                      - description: Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
                    Throughput:
                      allOf:
                      - $ref: '#/components/schemas/IntegerClass'
                      - description: Specifies the Throughput for GP3 EBS volume (SSD).
                AccessPolicies:
                  description: 'Access policy rules for an Elasticsearch domain service endpoints. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies"
                    target="_blank">Configuring Access Policies</a> in the <i>Amazon Elasticsearch Service Developer Guide</i>. The maximum size of a policy document is 100 KB.'
                  type: string
                SnapshotOptions:
                  description: 'Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.'
                  type: object
                  properties:
                    AutomatedSnapshotStartHour:
                      allOf:
                      - $ref: '#/components/schemas/IntegerClass'
                      - description: 'Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is <code>0</code> hours.'
                VPCOptions:
                  description: 'Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html"
                    target="_blank"> VPC Endpoints for Amazon Elasticsearch Service Domains</a>.'
                  type: object
                  properties:
                    SubnetIds:
                      allOf:
                      - $ref: '#/components/schemas/StringList'
                      - description: Specifies the subnets for VPC endpoint.
                    SecurityGroupIds:
                      allOf:
                      - $ref: '#/components/schemas/StringList'
                      - description: Specifies the security groups for VPC endpoint.
                CognitoOptions:
                  description: 'Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html"
                    target="_blank">Amazon Cognito Authentication for Kibana</a>.'
                  type: object
                  properties:
                    Enabled:
                      allOf:
                      - $ref: '#/components/schemas/Boolean'
                      - description: Specifies the option to enable Cognito for Kibana authentication.
                    UserPoolId:
                      allOf:
                      - $ref: '#/components/schemas/UserPoolId'
                      - description: Specifies the Cognito user pool ID for Kibana authentication.
                    IdentityPoolId:
                      allOf:
                      - $ref: '#/components/schemas/IdentityPoolId'
                      - description: Specifies the Cognito identity pool ID for Kibana authentication.
                    RoleArn:
                      allOf:
                      - $ref: '#/components/schemas/RoleArn'
                      - description: Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
                EncryptionAtRestOptions:
                  description: Specifies the Encryption At Rest Options.
                  type: object
                  properties:
                    Enabled:
                      allOf:
                      - $ref: '#/components/schemas/Boolean'
                      - description: Specifies the option to enable Encryption At Rest.
                    KmsKeyId:
                      allOf:
                      - $ref: '#/components/schemas/KmsKeyId'
                      - description: ' Specifies the KMS Key ID for Encryption At Rest options.'
                NodeToNodeEncryptionOptions:
                  description: Specifies the node-to-node encryption options.
                  type: object
                  properties:
                    Enabled:
                      allOf:
                      - $ref: '#/components/schemas/Boolean'
                      - description: Specify true to enable node-to-node encryption.
                AdvancedOptions:
                  description: '<p> Exposes select native Elasticsearch configuration values from <code>elasticsearch.yml</code>. Currently, the following advanced options are available:</p> <ul> <li>Option
                    to allow references to indices in an HTTP request body. Must be <code>false</code> when configuring access to individual sub-resources. By default, the value is <code>true</code>. See
                    <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options" target="_blank">Configuration
                    Advanced Options</a> for more information.</li> <li>Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.</li> </ul>
                    <p>For more information, see <a href="http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options">Configuring
                    Advanced Options</a>.</p>'
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/String'
                LogPublishingOptions:
                  description: 'Map of <code>LogType</code> and <code>LogPublishingOption</code>, each containing options to publish a given type of Elasticsearch log.'
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/LogPublishingOption'
                DomainEndpointOptions:
                  description: Options to configure endpoint for the Elasticsearch domain.
                  type: object
                  properties

# --- truncated at 32 KB (342 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/openapi/amazon-opensearch-openapi.yml