Amazon OpenSearch Service API Domain API

openapi: 3.2.0
info:
  title: Amazon Opensearch Domain API
  x-refined-note:
  - x-apiClientRegistration differs across the merged source definitions and was not carried
  - x-apisguru-categories differs across the merged source definitions and was not carried
  - x-logo differs across the merged source definitions and was not carried
  - x-origin differs across the merged source definitions and was not carried
  - x-preferred differs across the merged source definitions and was not carried
  - x-providerName differs across the merged source definitions and was not carried
  - x-release differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Domain across 2 of this provider''s published API definitions: amazon-opensearch-openapi.yml, amazon-opensearch-domain-api-openapi.yml. Each path carries the servers of the definition it was published in.'
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)
tags:
- name: Domain
paths:
  /2015-01-01/domain:
    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'
    get:
      operationId: ListDomainNames
      description: Returns the name of all Elasticsearch domains owned by the current user's account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDomainNamesResponse'
              examples:
                ListDomainNames200Example:
                  summary: Default ListDomainNames 200 response
                  x-microcks-default: true
                  value:
                    DomainNames: my-resource
        '480':
          description: BaseException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException'
        '481':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: engineType
        in: query
        required: false
        description: ' Optional parameter to filter the output by domain engine type. Acceptable values are ''Elasticsearch'' and ''OpenSearch''. '
        schema:
          type: string
          enum:
          - OpenSearch
          - Elasticsearch
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon OpenSearch List Domain Names
      tags:
      - Domain
      security:
      - hmac: []
    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)
  /2015-01-01/domain/{DomainName}/packages:
    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'
    get:
      operationId: ListPackagesForDomain
      description: Lists all packages associated with the Amazon ES domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPackagesForDomainResponse'
              examples:
                ListPackagesForDomain200Example:
                  summary: Default ListPackagesForDomain 200 response
                  x-microcks-default: true
                  value:
                    DomainPackageDetailsList: example-string
                    NextToken: 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'
      parameters:
      - name: DomainName
        in: path
        required: true
        description: The name of the domain for which you want to list associated packages.
        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
      - name: maxResults
        in: query
        required: false
        description: Limits results to a maximum number of packages.
        schema:
          type: integer
          description: ' Set this value to limit the number of results returned. '
          maximum: 100
      - name: nextToken
        in: query
        required: false
        description: Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
        schema:
          type: string
          description: ' Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results. '
      - name: MaxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      summary: Amazon OpenSearch List Packages for Domain
      tags:
      - Domain
      security:
      - hmac: []
    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)
  /2021-01-01/domain:
    get:
      operationId: get20210101Domain
      summary: List Domain Names
      description: Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDomainNamesResponse_2'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDomainNamesRequest'
      tags:
      - Domain
      security:
      - sigv4: []
      x-operation-id-source: normalized
      x-operation-id-original: ListDomainNames
    servers:
    - url: https://es.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
  /2021-01-01/packages/{PackageID}/domains:
    get:
      operationId: ListDomainsForPackage
      summary: List Domains For Package
      description: Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDomainsForPackageResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException_2'
        '400':
          description: BaseException; ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseException_2'
        '500':
          description: InternalException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalException_2'
        '409':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDomainsForPackageRequest'
      tags:
      - Domain
      security:
      - sigv4: []
    servers:
    - url: https://es.{region}.amazonaws.com
      variables:
        region:
          default: us-east-1
components:
  schemas:
    String:
      type: string
    InternalException: {}
    DomainPackageDetailsList:
      type: array
      items:
        $ref: '#/components/schemas/DomainPackageDetails'
    AccessDeniedException: {}
    PackageType:
      type: string
      enum:
      - TXT-DICTIONARY
    ListPackagesForDomainResponse:
      type: object
      properties:
        DomainPackageDetailsList:
          allOf:
          - $ref: '#/components/schemas/DomainPackageDetailsList'
          - description: List of <code>DomainPackageDetails</code> objects.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Pagination token that needs to be supplied to the next call to get the next page of results.
      description: ' Container for response parameters to <code> <a>ListPackagesForDomain</a> </code> operation. '
    EngineType:
      type: string
      enum:
      - OpenSearch
      - Elasticsearch
    PackageName:
      type: string
      pattern: '[a-z][a-z0-9\-]+'
      minLength: 3
      maxLength: 28
    PackageVersion:
      type: string
    ErrorType:
      type: string
    PackageID:
      type: string
    BaseException: {}
    ReferencePath:
      type: string
    ErrorMessage:
      type: string
    ValidationException: {}
    ErrorDetails:
      type: object
      properties:
        ErrorType:
          $ref: '#/components/schemas/ErrorType'
        ErrorMessage:
          $ref: '#/components/schemas/ErrorMessage'
    LastUpdated:
      type: string
      format: date-time
    DomainPackageDetails:
      type: object
      properties:
        PackageID:
          allOf:
          - $ref: '#/components/schemas/PackageID'
          - description: Internal ID of the package.
        PackageName:
          allOf:
          - $ref: '#/components/schemas/PackageName'
          - description: User specified name of the package.
        PackageType:
          allOf:
          - $ref: '#/components/schemas/PackageType'
          - description: Currently supports only TXT-DICTIONARY.
        LastUpdated:
          allOf:
          - $ref: '#/components/schemas/LastUpdated'
          - description: Timestamp of the most-recent update to the association status.
        DomainName:
          allOf:
          - $ref: '#/components/schemas/DomainName'
          - description: Name of the domain you've associated a package with.
        DomainPackageStatus:
          allOf:
          - $ref: '#/components/schemas/DomainPackageStatus'
          - description: State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
        PackageVersion:
          $ref: '#/components/schemas/PackageVersion'
        ReferencePath:
          allOf:
          - $ref: '#/components/schemas/ReferencePath'
          - description: The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
        ErrorDetails:
          allOf:
          - $ref: '#/components/schemas/ErrorDetails'
          - description: Additional information if the package is in an error state. Null otherwise.
      description: Information on a package that is associated with a domain.
    DomainInfoList:
      type: array
      description: ' Contains the list of Elasticsearch domain information.'
      items:
        $ref: '#/components/schemas/DomainInfo'
    DomainInfo:
      type: object
      properties:
        DomainName:
          allOf:
          - $ref: '#/components/schemas/DomainName'
          - description: ' Specifies the <code>DomainName</code>.'
        EngineType:
          allOf:
          - $ref: '#/components/schemas/EngineType'
          - description: ' Specifies the <code>EngineType</code> of the domain.'
    DomainPackageStatus:
      type: string
      enum:
      - ASSOCIATING
      - ASSOCIATION_FAILED
      - ACTIVE
      - DISSOCIATING
      - DISSOCIATION_FAILED
    DomainName:
      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
    ResourceNotFoundException: {}
    ListDomainNamesResponse:
      type: object
      properties:
        DomainNames:
          allOf:
          - $ref: '#/components/schemas/DomainInfoList'
          - description: List of domain names and respective engine types.
      description: The result of a <code>ListDomainNames</code> operation. Contains the names of all domains owned by this account and their respective engine types.
    InternalException_2:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    DomainInfo_2:
      type: object
      properties:
        DomainName:
          type: string
          description: Name of the domain.
        EngineType:
          type: string
          enum:
          - OpenSearch
          - Elasticsearch
          description: The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
    KeyStoreAccessOption:
      type: object
      properties:
        KeyAccessRoleArn:
          type: string
          description: Role ARN to access the KeyStore Key
        KeyStoreAccessEnabled:
          type: boolean
          description: This indicates whether Key Store access is enabled
      required:
      - KeyStoreAccessEnabled
    AccessDeniedException_2:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    BaseException_2:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    ListDomainsForPackageResponse:
      type: object
      properties:
        DomainPackageDetailsList:
          type: array
          items:
            $ref: '#/components/schemas/DomainPackageDetails_2'
          description: Information about all domains associated with a package.
        NextToken:
          type: string
          description: When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
    ListDomainsForPackageRequest:
      type: object
      properties:
        PackageID:
          type: string
          description: The unique identifier of the package for which to list associated domains.
        MaxResults:
          type: integer
          description: An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
        NextToken:
          type: string
          description: 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.
      required:
      - PackageID
    ListDomainNamesRequest:
      type: object
      properties:
        EngineType:
          type: string
          enum:
          - OpenSearch
          - Elasticsearch
          description: Filters the output by domain engine type.
    PackageAssociationConfiguration:
      type: object
      properties:
        KeyStoreAccessOption:
          $ref: '#/components/schemas/KeyStoreAccessOption'
    ResourceNotFoundException_2:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
    ListDomainNamesResponse_2:
      type: object
      properties:
        DomainNames:
          type: array
          items:
            $ref: '#/components/schemas/DomainInfo_2'
          description: The names of all OpenSearch Service domains owned by the current user and their respective engine types.
    ErrorDetails_2:
      type: object
      properties:
        ErrorType:
          type: string
          description: The type of error that occurred.
        ErrorMessage:
          type: string
          description: A message describing the error.
    DomainPackageDetails_2:
      type: object
      properties:
        PackageID:
          type: string
          description: Internal ID of the package.
        PackageName:
          type: string
          description: User-specified name of the package.
        PackageType:
          type: string
          enum:
          - TXT-DICTIONARY
          - ZIP-PLUGIN
          - PACKAGE-LICENSE
          - PACKAGE-CONFIG
          description: The type of package.
        LastUpdated:
          type: string
          format: date-time
          description: Timestamp of the most recent update to the package association status.
        DomainName:
          type: string
          description: Name of the domain that the package is associated with.
        DomainPackageStatus:
          type: string
          enum:
          - ASSOCIATING
          - ASSOCIATION_FAILED
          - ACTIVE
          - DISSOCIATING
          - DISSOCIATION_FAILED
          description: State of the association.
        PackageVersion:
          type: string
          description: The current version of the package.
        PrerequisitePackageIDList:
          type: array
          items:
            type: string
          description: A list of package IDs that must be associated with the domain before or with the package can be associated.
        ReferencePath:
          type: string
          description: The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
        ErrorDetails:
          $ref: '#/components/schemas/ErrorDetails_2'
        AssociationConfiguration:
          $ref: '#/components/schemas/PackageAssociationConfiguration'
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: es
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/es/
x-refined-from:
- amazon-opensearch-openapi.yml
- amazon-opensearch-domain-api-openapi.yml