Amazon CloudSearch Index Fields API

openapi: 3.1.0
info:
  title: Amazon CloudSearch Index Fields API
  version: '2013-01-01'
  description: Generated from AWS's published Smithy model for Amazon CloudSearch. 3 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=DeleteIndexField:
    post:
      operationId: DeleteIndexField
      summary: Delete Index Field
      description: Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the
        Amazon CloudSearch Developer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteIndexFieldResponse'
        '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: InvalidTypeException; ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidTypeException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DeleteIndexField
                  Version:
                    type: string
                    const: '2013-01-01'
              - $ref: '#/components/schemas/DeleteIndexFieldRequest'
      tags:
      - Index Fields
  /?Action=DescribeIndexFields:
    post:
      operationId: DescribeIndexFields
      summary: Describe Index Fields
      description: Gets information about the index fields configured for the search domain. Can be limited to specific fields
        by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option
        to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information
        in the Amazon CloudSearch Developer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeIndexFieldsResponse'
        '400':
          description: BaseException
          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: DescribeIndexFields
                  Version:
                    type: string
                    const: '2013-01-01'
              - $ref: '#/components/schemas/DescribeIndexFieldsRequest'
      tags:
      - Index Fields
  /?Action=DefineIndexField:
    post:
      operationId: DefineIndexField
      summary: Define Index Field
      description: Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You
        must specify the name of the domain you are configuring and an index field configuration. The index field configuration
        specifies a unique name, the index field type, and the options you want to configure for the field. The options you
        can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more
        information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DefineIndexFieldResponse'
        '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: InvalidTypeException; LimitExceededException; ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidTypeException'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - type: object
                required:
                - Action
                - Version
                properties:
                  Action:
                    type: string
                    const: DefineIndexField
                  Version:
                    type: string
                    const: '2013-01-01'
              - $ref: '#/components/schemas/DefineIndexFieldRequest'
      tags:
      - Index Fields
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
    DateArrayOptions:
      type: object
      properties:
        DefaultValue:
          type: string
          description: A value to use for the field if the field isn't specified for a document.
        SourceFields:
          type: string
          description: A list of source fields to map to the field.
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
    DateOptions:
      type: object
      properties:
        DefaultValue:
          type: string
          description: A value to use for the field if the field isn't specified for a document.
        SourceField:
          type: string
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
        SortEnabled:
          type: boolean
          description: Whether the field can be used to sort the search results.
    DefineIndexFieldRequest:
      type: object
      properties:
        DomainName:
          type: string
        IndexField:
          $ref: '#/components/schemas/IndexField'
      required:
      - DomainName
      - IndexField
    DefineIndexFieldResponse:
      type: object
      properties:
        IndexField:
          $ref: '#/components/schemas/IndexFieldStatus'
      required:
      - IndexField
    DeleteIndexFieldRequest:
      type: object
      properties:
        DomainName:
          type: string
        IndexFieldName:
          type: string
          description: The name of the index field your want to remove from the domain's indexing options.
      required:
      - DomainName
      - IndexFieldName
    DeleteIndexFieldResponse:
      type: object
      properties:
        IndexField:
          $ref: '#/components/schemas/IndexFieldStatus'
      required:
      - IndexField
    DescribeIndexFieldsRequest:
      type: object
      properties:
        DomainName:
          type: string
          description: The name of the domain you want to describe.
        FieldNames:
          type: array
          items:
            type: string
          description: A list of the index fields you want to describe. If not specified, information is returned for all
            configured index fields.
        Deployed:
          type: boolean
          description: Whether to display the deployed configuration (true) or include any pending changes (false). Defaults
            to false.
      required:
      - DomainName
    DescribeIndexFieldsResponse:
      type: object
      properties:
        IndexFields:
          type: array
          items:
            $ref: '#/components/schemas/IndexFieldStatus'
          description: The index fields configured for the domain.
      required:
      - IndexFields
    DoubleArrayOptions:
      type: object
      properties:
        DefaultValue:
          type: number
          description: A value to use for the field if the field isn't specified for a document.
        SourceFields:
          type: string
          description: A list of source fields to map to the field.
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
    DoubleOptions:
      type: object
      properties:
        DefaultValue:
          type: number
          description: A value to use for the field if the field isn't specified for a document. This can be important if
            you are using the field in an expression and that field is not present in every document.
        SourceField:
          type: string
          description: The name of the source field to map to the field.
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
        SortEnabled:
          type: boolean
          description: Whether the field can be used to sort the search results.
    IndexField:
      type: object
      properties:
        IndexFieldName:
          type: string
          description: 'A string that represents the name of an index field. CloudSearch supports regular index fields as
            well as dynamic fields. A dynamic field''s name defines a pattern that begins or ends with a wildcard. Any document
            fields that don''t map to a regular index field but do match a dynamic field''s pattern are configured with the
            dynamic field''s indexing options. Regular field names begin with a letter and can contain the following characters:
            a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard
            can also be the only character in a dynamic fie'
        IndexFieldType:
          type: string
          enum:
          - int
          - double
          - literal
          - text
          - date
          - latlon
          - int-array
          - double-array
          - literal-array
          - text-array
          - date-array
        IntOptions:
          $ref: '#/components/schemas/IntOptions'
        DoubleOptions:
          $ref: '#/components/schemas/DoubleOptions'
        LiteralOptions:
          $ref: '#/components/schemas/LiteralOptions'
        TextOptions:
          $ref: '#/components/schemas/TextOptions'
        DateOptions:
          $ref: '#/components/schemas/DateOptions'
        LatLonOptions:
          $ref: '#/components/schemas/LatLonOptions'
        IntArrayOptions:
          $ref: '#/components/schemas/IntArrayOptions'
        DoubleArrayOptions:
          $ref: '#/components/schemas/DoubleArrayOptions'
        LiteralArrayOptions:
          $ref: '#/components/schemas/LiteralArrayOptions'
        TextArrayOptions:
          $ref: '#/components/schemas/TextArrayOptions'
        DateArrayOptions:
          $ref: '#/components/schemas/DateArrayOptions'
      required:
      - IndexFieldName
      - IndexFieldType
    IndexFieldStatus:
      type: object
      properties:
        Options:
          $ref: '#/components/schemas/IndexField'
        Status:
          $ref: '#/components/schemas/OptionStatus'
      required:
      - Options
      - Status
    IntArrayOptions:
      type: object
      properties:
        DefaultValue:
          type: integer
          description: A value to use for the field if the field isn't specified for a document.
        SourceFields:
          type: string
          description: A list of source fields to map to the field.
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
    IntOptions:
      type: object
      properties:
        DefaultValue:
          type: integer
          description: A value to use for the field if the field isn't specified for a document. This can be important if
            you are using the field in an expression and that field is not present in every document.
        SourceField:
          type: string
          description: The name of the source field to map to the field.
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
        SortEnabled:
          type: boolean
          description: Whether the field can be used to sort the search results.
    InternalException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
    InvalidTypeException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
    LatLonOptions:
      type: object
      properties:
        DefaultValue:
          type: string
          description: A value to use for the field if the field isn't specified for a document.
        SourceField:
          type: string
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
        SortEnabled:
          type: boolean
          description: Whether the field can be used to sort the search results.
    LiteralArrayOptions:
      type: object
      properties:
        DefaultValue:
          type: string
          description: A value to use for the field if the field isn't specified for a document.
        SourceFields:
          type: string
          description: A list of source fields to map to the field.
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
    LiteralOptions:
      type: object
      properties:
        DefaultValue:
          type: string
          description: A value to use for the field if the field isn't specified for a document.
        SourceField:
          type: string
        FacetEnabled:
          type: boolean
          description: Whether facet information can be returned for the field.
        SearchEnabled:
          type: boolean
          description: Whether the contents of the field are searchable.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
        SortEnabled:
          type: boolean
          description: Whether the field can be used to sort the search results.
    OptionStatus:
      type: object
      properties:
        CreationDate:
          type: string
          format: date-time
          description: A timestamp for when this option was created.
        UpdateDate:
          type: string
          format: date-time
          description: A timestamp for when this option was last updated.
        UpdateVersion:
          type: integer
          description: A unique integer that indicates when this option was last updated.
        State:
          type: string
          enum:
          - RequiresIndexDocuments
          - Processing
          - Active
          - FailedToValidate
          description: 'The state of processing a change to an option. Possible values: RequiresIndexDocuments: the option''s
            latest value will not be deployed until IndexDocuments has been called and indexing is complete. Processing: the
            option''s latest value is in the process of being activated. Active: the option''s latest value is completely
            deployed. FailedToValidate: the option value is not compatible with the domain''s data and cannot be used to index
            the data. You must either modify the option value or update or remove the incompatible documents.'
        PendingDeletion:
          type: boolean
          description: Indicates that the option will be deleted once processing is complete.
      required:
      - CreationDate
      - UpdateDate
      - State
    ResourceNotFoundException:
      type: object
      properties:
        Code:
          type: string
        Message:
          type: string
    TextArrayOptions:
      type: object
      properties:
        DefaultValue:
          type: string
          description: A value to use for the field if the field isn't specified for a document.
        SourceFields:
          type: string
          description: A list of source fields to map to the field.
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
        HighlightEnabled:
          type: boolean
          description: Whether highlights can be returned for the field.
        AnalysisScheme:
          type: string
          description: The name of an analysis scheme for a text-array field.
    TextOptions:
      type: object
      properties:
        DefaultValue:
          type: string
          description: A value to use for the field if the field isn't specified for a document.
        SourceField:
          type: string
        ReturnEnabled:
          type: boolean
          description: Whether the contents of the field can be returned in the search results.
        SortEnabled:
          type: boolean
          description: Whether the field can be used to sort the search results.
        HighlightEnabled:
          type: boolean
          description: Whether highlights can be returned for the field.
        AnalysisScheme:
          type: string
          description: The name of an analysis scheme for a text field.
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)