Amazon CloudSearch Domains API

openapi: 3.1.0
info:
  title: Amazon CloudSearch Domains API
  version: '2013-01-01'
  description: Generated from AWS's published Smithy model for Amazon CloudSearch. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cloudsearch.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /?Action=CreateDomain:
    post:
      operationId: CreateDomain
      summary: Create Domain
      description: Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch
        Developer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateDomainResponse'
        '400':
          description: BaseException; ValidationException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/BaseException'
        '500':
          description: InternalException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InternalException'
        '409':
          description: LimitExceededException; ResourceAlreadyExistsException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: CreateDomain
                  Version:
                    type: string
                    const: '2013-01-01'
              - $ref: '#/components/schemas/CreateDomainRequest'
      tags:
      - Domains
  /?Action=DeleteDomain:
    post:
      operationId: DeleteDomain
      summary: Delete Domain
      description: Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered.
        For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteDomainResponse'
        '400':
          description: BaseException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/BaseException'
        '500':
          description: InternalException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InternalException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteDomain
                  Version:
                    type: string
                    const: '2013-01-01'
              - $ref: '#/components/schemas/DeleteDomainRequest'
      tags:
      - Domains
  /?Action=DescribeDomains:
    post:
      operationId: DescribeDomains
      summary: Describe Domains
      description: 'Gets information about the search domains owned by this account. Can be limited to specific domains. Shows
        all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall
        request to your domain''s search endpoint: q=matchall&q.parser=structured&size=0. For more information, see
        Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeDomainsResponse'
        '400':
          description: BaseException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/BaseException'
        '500':
          description: InternalException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InternalException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DescribeDomains
                  Version:
                    type: string
                    const: '2013-01-01'
              - $ref: '#/components/schemas/DescribeDomainsRequest'
      tags:
      - Domains
  /?Action=IndexDocuments:
    post:
      operationId: IndexDocuments
      summary: Index Documents
      description: Tells the search domain to start indexing its documents using the latest indexing options. This operation
        must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/IndexDocumentsResponse'
        '400':
          description: BaseException; ValidationException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/BaseException'
        '500':
          description: InternalException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InternalException'
        '409':
          description: ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: IndexDocuments
                  Version:
                    type: string
                    const: '2013-01-01'
              - $ref: '#/components/schemas/IndexDocumentsRequest'
      tags:
      - Domains
components:
  securitySchemes:
    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: cloudsearch
  schemas:
    BaseException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
    CreateDomainRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen
            (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.
      required:
      - DomainName
    CreateDomainResponse:
      type: object
      properties:
        DomainStatus:
          $ref: '#/components/schemas/DomainStatus'
    DeleteDomainRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The name of the domain you want to permanently delete.
      required:
      - DomainName
    DeleteDomainResponse:
      type: object
      properties:
        DomainStatus:
          $ref: '#/components/schemas/DomainStatus'
    DescribeDomainsRequest:
      type: object
      properties:
        DomainNames:
          type: array
          items:
            type: string
          description: The names of the domains you want to include in the response.
    DescribeDomainsResponse:
      type: object
      properties:
        DomainStatusList:
          type: array
          items:
            $ref: '#/components/schemas/DomainStatus'
      required:
      - DomainStatusList
    DomainStatus:
      type: object
      properties:
        DomainId:
          type: string
        DomainName:
          type: string
        ARN:
          type: string
        Created:
          type: boolean
          description: True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain
            is called. Newly created search domains are returned from DescribeDomains with a false value for Created until
            domain creation is complete.
        Deleted:
          type: boolean
          description: True if the search domain has been deleted. The system must clean up resources dedicated to the search
            domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true
            value for IsDeleted for several minutes until resource cleanup is complete.
        DocService:
          $ref: '#/components/schemas/ServiceEndpoint'
        SearchService:
          $ref: '#/components/schemas/ServiceEndpoint'
        RequiresIndexDocuments:
          type: boolean
          description: True if IndexDocuments needs to be called to activate the current domain configuration.
        Processing:
          type: boolean
          description: True if processing is being done to activate the current domain configuration.
        SearchInstanceType:
          type: string
          description: The instance type that is being used to process search requests.
        SearchPartitionCount:
          type: integer
          description: The number of partitions across which the search index is spread.
        SearchInstanceCount:
          type: integer
          description: The number of search instances that are available to process search requests.
        Limits:
          $ref: '#/components/schemas/Limits'
      required:
      - DomainId
      - DomainName
      - RequiresIndexDocuments
    IndexDocumentsRequest:
      type: object
      properties:
        DomainName:
          type: string
      required:
      - DomainName
    IndexDocumentsResponse:
      type: object
      properties:
        FieldNames:
          type: array
          items:
            type: string
          description: The names of the fields that are currently being indexed.
    InternalException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
    LimitExceededException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
    Limits:
      type: object
      properties:
        MaximumReplicationCount:
          type: integer
        MaximumPartitionCount:
          type: integer
      required:
      - MaximumReplicationCount
      - MaximumPartitionCount
    ResourceNotFoundException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
    ServiceEndpoint:
      type: object
      properties:
        Endpoint:
          type: string
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cloudsearch/service/2013-01-01/cloudsearch-2013-01-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)